<?xml version="1.0" encoding="ascii"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <title>Bio.EUtils.sourcegen</title> <link rel="stylesheet" href="epydoc.css" type="text/css" /> <script type="text/javascript" src="epydoc.js"></script> </head> <body bgcolor="white" text="black" link="blue" vlink="#204080" alink="#204080"> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <th class="navbar" width="100%"></th> </tr> </table> <table width="100%" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="100%"> <span class="breadcrumbs"> <a href="Bio-module.html">Package Bio</a> :: <a href="Bio.EUtils-module.html">Package EUtils</a> :: Module sourcegen </span> </td> <td> <table cellpadding="0" cellspacing="0"> <!-- hide/show private --> <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" onclick="toggle_private();">hide private</a>]</span></td></tr> <tr><td align="right"><span class="options" >[<a href="frames.html" target="_top">frames</a >] | <a href="Bio.EUtils.sourcegen-module.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== MODULE DESCRIPTION ==================== --> <h1 class="epydoc">Module sourcegen</h1><p class="nomargin-top"><span class="codelink"><a href="Bio.EUtils.sourcegen-pysrc.html">source code</a></span></p> <p>This module can be used to generate python source code. It has an interface similar to the "new" module.</p> <!-- ==================== CLASSES ==================== --> <a name="section-Classes"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Classes</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-Classes" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.sourcegen.SourceGen-class.html" class="summary-name">SourceGen</a><br /> SourceGen(outfile, [bangline]) An instance of this SourceGen class is a factory for generating python source code, by writing to a file object. </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.sourcegen.FunctionHolder-class.html" class="summary-name">FunctionHolder</a> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.sourcegen.MethodHolder-class.html" class="summary-name">MethodHolder</a> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.sourcegen.ClassHolder-class.html" class="summary-name">ClassHolder</a> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="Bio.EUtils.sourcegen.SourceFile-class.html" class="summary-name">SourceFile</a> </td> </tr> </table> <!-- ==================== FUNCTIONS ==================== --> <a name="section-Functions"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Functions</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-Functions" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="_tuplestr"></a><span class="summary-sig-name">_tuplestr</span>(<span class="summary-sig-arg">tup</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.EUtils.sourcegen-pysrc.html#_tuplestr">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="Bio.EUtils.sourcegen-module.html#genClass" class="summary-sig-name">genClass</a>(<span class="summary-sig-arg">klassname</span>, <span class="summary-sig-arg">parents</span>, <span class="summary-sig-arg">attribs</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">doc</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">methods</span>=<span class="summary-sig-default">None</span>)</span><br /> genClass(name, parents, [attribs, [doc, [methods]]]) Return a string of Python source code defineing a class object.</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.EUtils.sourcegen-pysrc.html#genClass">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="genFunc"></a><span class="summary-sig-name">genFunc</span>(<span class="summary-sig-arg">funcname</span>, <span class="summary-sig-arg">params</span>, <span class="summary-sig-arg">body</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">globals</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">doc</span>=<span class="summary-sig-default">None</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.EUtils.sourcegen-pysrc.html#genFunc">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="genMethod"></a><span class="summary-sig-name">genMethod</span>(<span class="summary-sig-arg">funcname</span>, <span class="summary-sig-arg">params</span>, <span class="summary-sig-arg">body</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">globals</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">doc</span>=<span class="summary-sig-default">None</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.EUtils.sourcegen-pysrc.html#genMethod">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="genComment"></a><span class="summary-sig-name">genComment</span>(<span class="summary-sig-arg">text</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.EUtils.sourcegen-pysrc.html#genComment">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="genImport"></a><span class="summary-sig-name">genImport</span>(<span class="summary-sig-arg">module</span>, <span class="summary-sig-arg">obj</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">indent</span>=<span class="summary-sig-default">0</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.EUtils.sourcegen-pysrc.html#genImport">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="get_generator"></a><span class="summary-sig-name">get_generator</span>(<span class="summary-sig-arg">outfile</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.EUtils.sourcegen-pysrc.html#get_generator">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="get_sourcefile"></a><span class="summary-sig-name">get_sourcefile</span>(<span class="summary-sig-arg">outfile</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">bangline</span>=<span class="summary-sig-default">None</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.EUtils.sourcegen-pysrc.html#get_sourcefile">source code</a></span> </td> </tr> </table> </td> </tr> </table> <!-- ==================== VARIABLES ==================== --> <a name="section-Variables"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Variables</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-Variables" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="BANGLINE"></a><span class="summary-name">BANGLINE</span> = <code title="'''#!/usr/bin/env python '''"><code class="variable-quote">'</code><code class="variable-string">#!/usr/bin/env python\n</code><code class="variable-quote">'</code></code> </td> </tr> </table> <!-- ==================== FUNCTION DETAILS ==================== --> <a name="section-FunctionDetails"></a> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Function Details</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-FunctionDetails" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> </table> <a name="genClass"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">genClass</span>(<span class="sig-arg">klassname</span>, <span class="sig-arg">parents</span>, <span class="sig-arg">attribs</span>=<span class="sig-default">None</span>, <span class="sig-arg">doc</span>=<span class="sig-default">None</span>, <span class="sig-arg">methods</span>=<span class="sig-default">None</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Bio.EUtils.sourcegen-pysrc.html#genClass">source code</a></span> </td> </tr></table> <pre class="literalblock"> genClass(name, parents, [attribs, [doc, [methods]]]) Return a string of Python source code defineing a class object. Where: name = class name (string) parents = tuple of parent class objects or strings. attribs = class-global attributes to define, contained in a dictionary. doc = a doc string (optional) methods = list of methods strings. </pre> <dl class="fields"> </dl> </td></tr></table> </div> <br /> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <th class="navbar" width="100%"></th> </tr> </table> <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> Generated by Epydoc 3.0.1 on Mon Sep 15 09:26:23 2008 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" >http://epydoc.sourceforge.net</a> </td> </tr> </table> <script type="text/javascript"> <!-- // Private objects are initially displayed (because if // javascript is turned off then we want them to be // visible); but by default, we want to hide them. So hide // them unless we have a cookie that says to show them. checkCookie(); // --> </script> </body> </html>