<?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>epydoc.markup.Field</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"> <!-- Home link --> <th> <a href="epydoc-module.html">Home</a> </th> <!-- 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> <!-- Project homepage --> <th class="navbar" align="right" width="100%"> <table border="0" cellpadding="0" cellspacing="0"> <tr><th class="navbar" align="center" ><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th> </tr></table></th> </tr> </table> <table width="100%" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="100%"> <span class="breadcrumbs"> <a href="epydoc-module.html">Package epydoc</a> :: <a href="epydoc.markup-module.html">Package markup</a> :: Class Field </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="epydoc.markup.Field-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class Field</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.markup-pysrc.html#Field">source code</a></span></p> <p>The contents of a docstring's field. Docstring fields are used to describe specific aspects of an object, such as a parameter of a function or the author of a module. Each field consists of a tag, an optional argument, and a body:</p> <ul> <li> The tag specifies the type of information that the field encodes. </li> <li> The argument specifies the object that the field describes. The argument may be <code>None</code> or a <code>string</code>. </li> <li> The body contains the field's information. </li> </ul> <p>Tags are automatically downcased and stripped; and arguments are automatically stripped.</p> <!-- ==================== INSTANCE METHODS ==================== --> <a name="section-InstanceMethods"></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">Instance Methods</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-InstanceMethods" 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"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">tag</span>, <span class="summary-sig-arg">arg</span>, <span class="summary-sig-arg">body</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="epydoc.markup-pysrc.html#Field.__init__">source code</a></span> <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___31-summary-div');return false;">call graph</a></span> </td> </tr> </table> <div style="display:none" id="call_graph_for___init___31-summary-div"><center> <table border="0" cellpadding="0" cellspacing="0"> <tr><td><center> <map id="call_graph_for___init___31" name="call_graph_for___init___31"> <area shape="rect" href="epydoc.markup.Field-class.html#__init__" title="__init__()" alt="" coords="463,34,559,66" /> <area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#split_fields" title="epytext.ParsedEpytextDocstring.split_fields()" alt="" coords="28,6,391,38" /> <area shape="rect" href="epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#_add_field" title="restructuredtext._SplitFieldsTranslator._add_field()" alt="" coords="7,62,412,94" /> </map> <img src="call_graph_for___init___31.gif" alt='' usemap="#call_graph_for___init___31" ismap="ismap" class="graph-without-title" /> </center></td></tr> <tr><th>Call Graph</th></tr> </table><br /> </center></div> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><code>string</code></span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="epydoc.markup.Field-class.html#tag" class="summary-sig-name">tag</a>(<span class="summary-sig-arg">self</span>)</span><br /> Returns: This field's tag.</td> <td align="right" valign="top"> <span class="codelink"><a href="epydoc.markup-pysrc.html#Field.tag">source code</a></span> <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_tag-summary-div');return false;">call graph</a></span> </td> </tr> </table> <div style="display:none" id="call_graph_for_tag-summary-div"><center> <table border="0" cellpadding="0" cellspacing="0"> <tr><td><center> <map id="call_graph_for_tag" name="call_graph_for_tag"> <area shape="rect" href="epydoc.docstringparser-module.html#parse_docstring" title="docstringparser.parse_docstring()" alt="" coords="5,6,277,38" /> <area shape="rect" href="epydoc.markup.Field-class.html#tag" title="tag()" alt="" coords="327,34,383,66" /> <area shape="rect" href="epydoc.docstringparser-module.html#split_init_fields" title="docstringparser.split_init_fields()" alt="" coords="7,62,276,94" /> </map> <img src="call_graph_for_tag.gif" alt='' usemap="#call_graph_for_tag" ismap="ismap" class="graph-without-title" /> </center></td></tr> <tr><th>Call Graph</th></tr> </table><br /> </center></div> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><code>string</code> or <code>None</code></span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="epydoc.markup.Field-class.html#arg" class="summary-sig-name">arg</a>(<span class="summary-sig-arg">self</span>)</span><br /> Returns: This field's argument, or <code>None</code> if this field has no argument.</td> <td align="right" valign="top"> <span class="codelink"><a href="epydoc.markup-pysrc.html#Field.arg">source code</a></span> <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_arg-summary-div');return false;">call graph</a></span> </td> </tr> </table> <div style="display:none" id="call_graph_for_arg-summary-div"><center> <table border="0" cellpadding="0" cellspacing="0"> <tr><td><center> <map id="call_graph_for_arg" name="call_graph_for_arg"> <area shape="rect" href="epydoc.docstringparser-module.html#parse_docstring" title="docstringparser.parse_docstring()" alt="" coords="5,6,277,38" /> <area shape="rect" href="epydoc.markup.Field-class.html#arg" title="arg()" alt="" coords="325,34,384,66" /> <area shape="rect" href="epydoc.docstringparser-module.html#split_init_fields" title="docstringparser.split_init_fields()" alt="" coords="7,62,276,94" /> </map> <img src="call_graph_for_arg.gif" alt='' usemap="#call_graph_for_arg" ismap="ismap" class="graph-without-title" /> </center></td></tr> <tr><th>Call Graph</th></tr> </table><br /> </center></div> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><a href="epydoc.markup.ParsedDocstring-class.html" class="link">ParsedDocstring</a></span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="epydoc.markup.Field-class.html#body" class="summary-sig-name">body</a>(<span class="summary-sig-arg">self</span>)</span><br /> Returns: This field's body.</td> <td align="right" valign="top"> <span class="codelink"><a href="epydoc.markup-pysrc.html#Field.body">source code</a></span> <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_body-summary-div');return false;">call graph</a></span> </td> </tr> </table> <div style="display:none" id="call_graph_for_body-summary-div"><center> <table border="0" cellpadding="0" cellspacing="0"> <tr><td><center> <map id="call_graph_for_body" name="call_graph_for_body"> <area shape="rect" href="epydoc.docstringparser-module.html#parse_docstring" title="docstringparser.parse_docstring()" alt="" coords="5,6,277,38" /> <area shape="rect" href="epydoc.markup.Field-class.html#body" title="body()" alt="" coords="327,6,399,38" /> </map> <img src="call_graph_for_body.gif" alt='' usemap="#call_graph_for_body" ismap="ismap" class="graph-without-title" /> </center></td></tr> <tr><th>Call Graph</th></tr> </table><br /> </center></div> </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="__repr__"></a><span class="summary-sig-name">__repr__</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="epydoc.markup-pysrc.html#Field.__repr__">source code</a></span> </td> </tr> </table> </td> </tr> </table> <!-- ==================== METHOD DETAILS ==================== --> <a name="section-MethodDetails"></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">Method Details</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-MethodDetails" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> </table> <a name="tag"></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">tag</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="epydoc.markup-pysrc.html#Field.tag">source code</a></span> <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_tag-div');return false;">call graph</a></span> </td> </tr></table> <div style="display:none" id="call_graph_for_tag-div"><center> <table border="0" cellpadding="0" cellspacing="0"> <tr><td><center> <map id="call_graph_for_tag" name="call_graph_for_tag"> <area shape="rect" href="epydoc.docstringparser-module.html#parse_docstring" title="docstringparser.parse_docstring()" alt="" coords="5,6,277,38" /> <area shape="rect" href="epydoc.markup.Field-class.html#tag" title="tag()" alt="" coords="327,34,383,66" /> <area shape="rect" href="epydoc.docstringparser-module.html#split_init_fields" title="docstringparser.split_init_fields()" alt="" coords="7,62,276,94" /> </map> <img src="call_graph_for_tag.gif" alt='' usemap="#call_graph_for_tag" ismap="ismap" class="graph-without-title" /> </center></td></tr> <tr><th>Call Graph</th></tr> </table><br /> </center></div> <dl class="fields"> <dt>Returns: <code>string</code></dt> <dd>This field's tag.</dd> </dl> </td></tr></table> </div> <a name="arg"></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">arg</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="epydoc.markup-pysrc.html#Field.arg">source code</a></span> <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_arg-div');return false;">call graph</a></span> </td> </tr></table> <div style="display:none" id="call_graph_for_arg-div"><center> <table border="0" cellpadding="0" cellspacing="0"> <tr><td><center> <map id="call_graph_for_arg" name="call_graph_for_arg"> <area shape="rect" href="epydoc.docstringparser-module.html#parse_docstring" title="docstringparser.parse_docstring()" alt="" coords="5,6,277,38" /> <area shape="rect" href="epydoc.markup.Field-class.html#arg" title="arg()" alt="" coords="325,34,384,66" /> <area shape="rect" href="epydoc.docstringparser-module.html#split_init_fields" title="docstringparser.split_init_fields()" alt="" coords="7,62,276,94" /> </map> <img src="call_graph_for_arg.gif" alt='' usemap="#call_graph_for_arg" ismap="ismap" class="graph-without-title" /> </center></td></tr> <tr><th>Call Graph</th></tr> </table><br /> </center></div> <dl class="fields"> <dt>Returns: <code>string</code> or <code>None</code></dt> <dd>This field's argument, or <code>None</code> if this field has no argument.</dd> </dl> </td></tr></table> </div> <a name="body"></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">body</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="epydoc.markup-pysrc.html#Field.body">source code</a></span> <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_body-div');return false;">call graph</a></span> </td> </tr></table> <div style="display:none" id="call_graph_for_body-div"><center> <table border="0" cellpadding="0" cellspacing="0"> <tr><td><center> <map id="call_graph_for_body" name="call_graph_for_body"> <area shape="rect" href="epydoc.docstringparser-module.html#parse_docstring" title="docstringparser.parse_docstring()" alt="" coords="5,6,277,38" /> <area shape="rect" href="epydoc.markup.Field-class.html#body" title="body()" alt="" coords="327,6,399,38" /> </map> <img src="call_graph_for_body.gif" alt='' usemap="#call_graph_for_body" ismap="ismap" class="graph-without-title" /> </center></td></tr> <tr><th>Call Graph</th></tr> </table><br /> </center></div> <dl class="fields"> <dt>Returns: <a href="epydoc.markup.ParsedDocstring-class.html" class="link">ParsedDocstring</a></dt> <dd>This field's body.</dd> </dl> </td></tr></table> </div> <br /> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Home link --> <th> <a href="epydoc-module.html">Home</a> </th> <!-- 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> <!-- Project homepage --> <th class="navbar" align="right" width="100%"> <table border="0" cellpadding="0" cellspacing="0"> <tr><th class="navbar" align="center" ><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th> </tr></table></th> </tr> </table> <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> <a href="epydoc-log.html">Generated by Epydoc 3.0.1 on Wed Jan 30 14:08:25 2008</a> </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>