<?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.apidoc.RoutineDoc</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.apidoc-module.html">Module apidoc</a> ::
Class RoutineDoc
</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.apidoc.RoutineDoc-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class RoutineDoc</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.apidoc-pysrc.html#RoutineDoc">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_epydoc_a_9" name="uml_class_diagram_for_epydoc_a_9">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#docstring" title="The documented item's docstring." alt="" coords="56,28,429,47" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#docstring_lineno" title="The line number on which the documented item's docstring begins." alt="" coords="56,47,429,66" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#other_docs" title="A flag indicating if the entire docstring body (except tags if any) is entirely included in the summary." alt="" coords="56,66,429,84" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#metadata" title="Metadata about the documented item, extracted from fields in its docstring." alt="" coords="56,84,429,103" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#docs_extracted_by" title="Information about where the information contained by this APIDoc came from." alt="" coords="56,103,429,122" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__init__" title="Construct a new APIDoc object." alt="" coords="56,124,429,143" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__setattr__" title="Modify an APIDoc's attribute." alt="" coords="56,143,429,162" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#pp" title="Return a pretty-printed string representation for the information contained in this APIDoc." alt="" coords="56,162,429,180" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__str__" title="Return a pretty-printed string representation for the information contained in this APIDoc." alt="" coords="56,180,429,199" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#specialize_to" title="Change self's class to cls." alt="" coords="56,199,429,218" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="hash(x)" alt="" coords="56,218,429,236" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="epydoc.apidoc.APIDoc.__cmp__" alt="" coords="56,236,429,255" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#merge_and_overwrite" title="Combine self and other into a merged object, such that any changes made to one will affect the other." alt="" coords="56,255,429,274" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html" title="API documentation information for a single element of a Python program." alt="" coords="44,6,441,280" />
<area shape="rect" href="epydoc.markup.ParsedDocstring-class.html" title="A standard intermediate representation for parsed docstrings that can be used to generate output." alt="" coords="419,904,603,942" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#descr" title="epydoc.apidoc.APIDoc.descr" alt="" coords="830,604,863,618" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#descr" title="descr" alt="" coords="427,171,435,179" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#descr" title="descr" alt="" coords="588,915,596,923" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#summary" title="epydoc.apidoc.APIDoc.summary" alt="" coords="701,604,757,618" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#summary" title="summary" alt="" coords="420,271,428,279" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#summary" title="summary" alt="" coords="588,906,596,914" />
<area shape="rect" href="epydoc.docstringparser.DocstringField-class.html" title="A simple docstring field, which can be used to describe specific information about an object, such as its author or its version." alt="" coords="873,436,1089,474" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#extra_docstring_fields" title="epydoc.apidoc.APIDoc.extra_docstring_fields" alt="" coords="867,292,997,306" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#extra_docstring_fields" title="extra_docstring_fields" alt="" coords="427,171,435,179" />
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#extra_docstring_fields" title="extra_docstring_fields" alt="" coords="971,438,979,446" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#pyval" title="A pointer to the actual Python object described by this ValueDoc." alt="" coords="113,340,372,359" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#parse_repr" title="A text representation of this value, extracted from parsing its source code." alt="" coords="113,359,372,378" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#REPR_MAXLINES" title="The maximum number of lines of text that should be generated by pyval_repr()." alt="" coords="113,378,372,396" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#REPR_LINELEN" title="The maximum number of characters for lines of text that should be generated by pyval_repr()." alt="" coords="113,396,372,415" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#SUMMARY_REPR_LINELEN" title="The maximum number of characters for the single-line text representation generated by summary_pyval_repr()." alt="" coords="113,415,372,434" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#REPR_MIN_SCORE" title="The minimum score that a value representation based on pyval should have in order to be used instead of parse_repr as the canonical representation for this ValueDoc's value." alt="" coords="113,434,372,452" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#toktree" title="This is currently used to extract values from __all__, etc, in the docparser module; maybe I should specialize process_assignment and extract it there? Although, for __all__, it's not clear where I'd put the value, since I just use it to set private/public/imported attribs on other vars (that might not exist yet at the time.)" alt="" coords="113,452,372,471" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#__repr__" title="repr(x)" alt="" coords="113,474,372,492" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#__setstate__" title="epydoc.apidoc.ValueDoc.__setstate__" alt="" coords="113,492,372,511" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#__getstate__" title="State serializer for the pickle module." alt="" coords="113,511,372,530" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#pyval_repr" title="Return a formatted representation of the Python object described by this ValueDoc." alt="" coords="113,530,372,548" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#summary_pyval_repr" title="Return a single-line formatted representation of the Python object described by this ValueDoc." alt="" coords="113,548,372,567" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#apidoc_links" title="Return a list of all APIDocs that are directly linked from this APIDoc (i.e., are contained or pointed to by one or more of this APIDoc's attributes.)" alt="" coords="113,567,372,586" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html" title="API documentation information about a single Python value." alt="" coords="101,318,384,592" />
<area shape="rect" href="epydoc.apidoc.ClassMethodDoc-class.html" title="epydoc.apidoc.ClassMethodDoc" alt="" coords="5,904,144,942" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html" title="A sequence of identifiers, separated by periods, used to name a Python variable, value, or argument." alt="" coords="445,730,557,767" />
<area shape="rect" href="epydoc.apidoc.ModuleDoc-class.html" title="API documentation information about a single module." alt="" coords="587,730,691,767" />
<area shape="rect" href="epydoc.apidoc.StaticMethodDoc-class.html" title="epydoc.apidoc.StaticMethodDoc" alt="" coords="173,904,312,942" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#posargs" title="The names of the routine's positional arguments." alt="" coords="116,652,368,671" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#posarg_defaults" title="API documentation for the positional arguments' default values." alt="" coords="116,671,368,690" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#vararg" title="The name of the routine's vararg argument, or None if it has no vararg argument." alt="" coords="116,690,368,708" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#kwarg" title="The name of the routine's keyword argument, or None if it has no keyword argument." alt="" coords="116,708,368,727" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#lineno" title="The line number of the first line of the function's signature." alt="" coords="116,727,368,746" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#decorators" title="A list of names of decorators that were applied to this routine, in the order that they are listed in the source code." alt="" coords="116,746,368,764" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#arg_descrs" title="A list of descriptions of the routine's arguments." alt="" coords="116,764,368,783" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#exception_descrs" title="A list of descriptions of exceptions that the routine might raise." alt="" coords="116,783,368,802" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#callgraph_uid" title="DotGraph.uid of the call graph for the function." alt="" coords="116,802,368,820" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#is_detailed" title="Does this object deserve a box with extra details?" alt="" coords="116,823,368,842" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#all_args" title="Returns: A list of the names of all arguments (positional, vararg, and keyword), in order." alt="" coords="116,842,368,860" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html" title="API documentation information about a single routine." alt="" coords="104,630,416,867" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#arg_types" title="epydoc.apidoc.RoutineDoc.arg_types" alt="" coords="494,878,554,893" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#arg_types" title="arg_types" alt="" coords="403,800,411,808" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#arg_types" title="arg_types" alt="" coords="500,906,508,914" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#return_descr" title="epydoc.apidoc.RoutineDoc.return_descr" alt="" coords="390,878,466,893" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#return_descr" title="return_descr" alt="" coords="340,858,348,866" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#return_descr" title="return_descr" alt="" coords="425,906,433,914" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#return_type" title="epydoc.apidoc.RoutineDoc.return_type" alt="" coords="289,878,357,893" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#return_type" title="return_type" alt="" coords="260,858,268,866" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#return_type" title="return_type" alt="" coords="425,911,433,919" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#canonical_name" title="epydoc.apidoc.ValueDoc.canonical_name" alt="" coords="419,604,517,618" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#canonical_name" title="canonical_name" alt="" coords="369,563,377,571" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#canonical_name" title="canonical_name" alt="" coords="491,731,499,739" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#proxy_for" title="epydoc.apidoc.ValueDoc.proxy_for" alt="" coords="348,604,404,618" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#proxy_for" title="proxy_for" alt="" coords="308,583,316,591" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#proxy_for" title="proxy_for" alt="" coords="493,731,501,739" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#defining_module" title="epydoc.apidoc.ValueDoc.defining_module" alt="" coords="560,604,659,618" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#defining_module" title="defining_module" alt="" coords="369,499,377,507" />
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#defining_module" title="defining_module" alt="" coords="631,731,639,739" />
</map>
<img src="uml_class_diagram_for_epydoc_a_9.gif" alt='' usemap="#uml_class_diagram_for_epydoc_a_9" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>API documentation information about a single routine.</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"><code>bool</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.apidoc.RoutineDoc-class.html#is_detailed" class="summary-sig-name">is_detailed</a>(<span class="summary-sig-arg">self</span>)</span><br />
Does this object deserve a box with extra details?</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#RoutineDoc.is_detailed">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_is_detailed_5-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_is_detailed_5-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_is_detailed_5" name="call_graph_for_is_detailed_5">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#is_detailed" title="APIDoc.is_detailed()" alt="" coords="435,6,616,38" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#is_detailed" title="is_detailed()" alt="" coords="271,6,385,38" />
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#is_detailed" title="VariableDoc.is_detailed()" alt="" coords="5,6,221,38" />
</map>
<img src="call_graph_for_is_detailed_5.gif" alt='' usemap="#call_graph_for_is_detailed_5" 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 href="epydoc.apidoc.RoutineDoc-class.html#all_args" class="summary-sig-name">all_args</a>(<span class="summary-sig-arg">self</span>)</span><br />
Returns:
A list of the names of all arguments (positional, vararg, and
keyword), in order.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#RoutineDoc.all_args">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_all_args-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_all_args-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_all_args" name="call_graph_for_all_args">
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#find" title="DocIndex.find()" alt="" coords="148,6,292,38" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#all_args" title="all_args()" alt="" coords="483,90,576,122" />
<area shape="rect" href="epydoc.apidoc-module.html#_flatten" title="_flatten()" alt="" coords="626,90,716,122" />
<area shape="rect" href="epydoc.docstringparser-module.html#check_type_fields" title="docstringparser.check_type_fields()" alt="" coords="76,62,364,94" />
<area shape="rect" href="epydoc.docstringparser-module.html#process_arg_field" title="docstringparser.process_arg_field()" alt="" coords="78,118,363,150" />
<area shape="rect" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#_failed_xref" title="docwriter.html._HTMLDocstringLinker._failed_xref()" alt="" coords="6,174,435,206" />
</map>
<img src="call_graph_for_all_args.gif" alt='' usemap="#call_graph_for_all_args" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
<code><a href="epydoc.apidoc.ValueDoc-class.html#__getstate__">__getstate__</a></code>,
<code><a href="epydoc.apidoc.ValueDoc-class.html#__repr__">__repr__</a></code>,
<code><a href="epydoc.apidoc.ValueDoc-class.html#__setstate__">__setstate__</a></code>,
<code><a href="epydoc.apidoc.ValueDoc-class.html#apidoc_links">apidoc_links</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b>:
<code><a href="epydoc.apidoc.APIDoc-class.html#__cmp__">__cmp__</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#__hash__">__hash__</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#__init__">__init__</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#__setattr__">__setattr__</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#__str__">__str__</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#merge_and_overwrite">merge_and_overwrite</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#pp">pp</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#specialize_to">specialize_to</a></code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b> (private):
<code><a href="epydoc.apidoc.APIDoc-class.html#_debug_setattr" onclick="show_private();">_debug_setattr</a></code>
</p></div>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__getattribute__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>
</p>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Value Representation</th></tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
<code><a href="epydoc.apidoc.ValueDoc-class.html#pyval_repr">pyval_repr</a></code>,
<code><a href="epydoc.apidoc.ValueDoc-class.html#summary_pyval_repr">summary_pyval_repr</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></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">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Value Representation</th></tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
<code><a href="epydoc.apidoc.ValueDoc-class.html#REPR_LINELEN">REPR_LINELEN</a></code>,
<code><a href="epydoc.apidoc.ValueDoc-class.html#REPR_MAXLINES">REPR_MAXLINES</a></code>,
<code><a href="epydoc.apidoc.ValueDoc-class.html#REPR_MIN_SCORE">REPR_MIN_SCORE</a></code>,
<code><a href="epydoc.apidoc.ValueDoc-class.html#SUMMARY_REPR_LINELEN">SUMMARY_REPR_LINELEN</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== INSTANCE VARIABLES ==================== -->
<a name="section-InstanceVariables"></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 Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceVariables"
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"><code>str</code></span>
</td><td class="summary">
<a name="callgraph_uid"></a><span class="summary-name">callgraph_uid</span> = <code title="None">None</code><br />
<a href="epydoc.docwriter.dotgraph.DotGraph-class.html"
class="link">DotGraph</a>.uid of the call graph for the function.
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
<code><a href="epydoc.apidoc.ValueDoc-class.html#canonical_name">canonical_name</a></code>,
<code><a href="epydoc.apidoc.ValueDoc-class.html#toktree">toktree</a></code>
</p>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Signature</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>list</code></span>
</td><td class="summary">
<a href="epydoc.apidoc.RoutineDoc-class.html#posargs" class="summary-name">posargs</a> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
The names of the routine's positional arguments.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>list</code> of <code>ValueDoc</code> or <code>None</code></span>
</td><td class="summary">
<a href="epydoc.apidoc.RoutineDoc-class.html#posarg_defaults" class="summary-name">posarg_defaults</a> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
API documentation for the positional arguments' default values.
</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">
<a name="vararg"></a><span class="summary-name">vararg</span> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
The name of the routine's vararg argument, or <code>None</code> if it
has no vararg argument.
</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">
<a name="kwarg"></a><span class="summary-name">kwarg</span> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
The name of the routine's keyword argument, or <code>None</code> if
it has no keyword argument.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<a href="epydoc.apidoc.RoutineDoc-class.html#lineno" class="summary-name">lineno</a> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
The line number of the first line of the function's signature.
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Decorators</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>list</code> of <code>string</code></span>
</td><td class="summary">
<a href="epydoc.apidoc.RoutineDoc-class.html#decorators" class="summary-name">decorators</a> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
A list of names of decorators that were applied to this routine, in
the order that they are listed in the source code.
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Information Extracted from Docstrings</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>list</code></span>
</td><td class="summary">
<a href="epydoc.apidoc.RoutineDoc-class.html#arg_descrs" class="summary-name">arg_descrs</a> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
A list of descriptions of the routine's arguments.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>dict</code> from <code>string</code> to <a
href="epydoc.markup.ParsedDocstring-class.html"
class="link">ParsedDocstring</a></span>
</td><td class="summary">
<a name="arg_types"></a><span class="summary-name">arg_types</span> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
Descriptions of the expected types for the routine's arguments,
encoded as a dictionary mapping from argument names to type
descriptions.
</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">
<a name="return_descr"></a><span class="summary-name">return_descr</span> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
A description of the value returned by this routine.
</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">
<a name="return_type"></a><span class="summary-name">return_type</span> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
A description of expected type for the value returned by this
routine.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>list</code></span>
</td><td class="summary">
<a href="epydoc.apidoc.RoutineDoc-class.html#exception_descrs" class="summary-name">exception_descrs</a> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
A list of descriptions of exceptions that the routine might raise.
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b>:
<code><a href="epydoc.apidoc.APIDoc-class.html#descr">descr</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#extra_docstring_fields">extra_docstring_fields</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#metadata">metadata</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#other_docs">other_docs</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#summary">summary</a></code>
</p>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Value Representation</th></tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
<code><a href="epydoc.apidoc.ValueDoc-class.html#parse_repr">parse_repr</a></code>,
<code><a href="epydoc.apidoc.ValueDoc-class.html#pyval">pyval</a></code>
</p>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Context</th></tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
<code><a href="epydoc.apidoc.ValueDoc-class.html#defining_module">defining_module</a></code>
</p>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Information about Imported Variables</th></tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
<code><a href="epydoc.apidoc.ValueDoc-class.html#proxy_for">proxy_for</a></code>
</p>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Docstrings</th></tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b>:
<code><a href="epydoc.apidoc.APIDoc-class.html#docstring">docstring</a></code>,
<code><a href="epydoc.apidoc.APIDoc-class.html#docstring_lineno">docstring_lineno</a></code>
</p>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Source Information</th></tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b>:
<code><a href="epydoc.apidoc.APIDoc-class.html#docs_extracted_by">docs_extracted_by</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></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">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</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="is_detailed"></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">is_detailed</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#RoutineDoc.is_detailed">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_is_detailed_5-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_is_detailed_5-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_is_detailed_5" name="call_graph_for_is_detailed_5">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#is_detailed" title="APIDoc.is_detailed()" alt="" coords="435,6,616,38" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#is_detailed" title="is_detailed()" alt="" coords="271,6,385,38" />
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#is_detailed" title="VariableDoc.is_detailed()" alt="" coords="5,6,221,38" />
</map>
<img src="call_graph_for_is_detailed_5.gif" alt='' usemap="#call_graph_for_is_detailed_5" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Does this object deserve a box with extra details?</p>
<dl class="fields">
<dt>Returns: <code>bool</code></dt>
<dd>True if the object needs extra details, else False.</dd>
<dt>Overrides:
<a href="epydoc.apidoc.APIDoc-class.html#is_detailed">APIDoc.is_detailed</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="all_args"></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">all_args</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#RoutineDoc.all_args">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_all_args-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_all_args-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_all_args" name="call_graph_for_all_args">
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#find" title="DocIndex.find()" alt="" coords="148,6,292,38" />
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#all_args" title="all_args()" alt="" coords="483,90,576,122" />
<area shape="rect" href="epydoc.apidoc-module.html#_flatten" title="_flatten()" alt="" coords="626,90,716,122" />
<area shape="rect" href="epydoc.docstringparser-module.html#check_type_fields" title="docstringparser.check_type_fields()" alt="" coords="76,62,364,94" />
<area shape="rect" href="epydoc.docstringparser-module.html#process_arg_field" title="docstringparser.process_arg_field()" alt="" coords="78,118,363,150" />
<area shape="rect" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#_failed_xref" title="docwriter.html._HTMLDocstringLinker._failed_xref()" alt="" coords="6,174,435,206" />
</map>
<img src="call_graph_for_all_args.gif" alt='' usemap="#call_graph_for_all_args" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<dl class="fields">
<dt>Returns:</dt>
<dd>A list of the names of all arguments (positional, vararg, and
keyword), in order. If a positional argument consists of a tuple
of names, then that tuple will be flattened.</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== INSTANCE VARIABLE DETAILS ==================== -->
<a name="section-InstanceVariableDetails"></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">Instance Variable Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceVariableDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="posargs"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">posargs</h3>
The names of the routine's positional arguments. If an argument list
contains "unpacking" arguments, then their names will be
specified using nested lists. E.g., if a function's argument list is
<code>((x1,y1), (x2,y2))</code>, then posargs will be <code>[['x1','y1'],
['x2','y2']]</code>.
<dl class="fields">
<dt>Type:</dt>
<dd><code>list</code></dd>
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
_Sentinel('UNKNOWN')
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="posarg_defaults"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">posarg_defaults</h3>
API documentation for the positional arguments' default values. This
list has the same length as <code>posargs</code>, and each element of
<code>posarg_defaults</code> describes the corresponding argument in
<code>posargs</code>. For positional arguments with no default,
<code>posargs_defaults</code> will contain None.
<dl class="fields">
<dt>Type:</dt>
<dd><code>list</code> of <code>ValueDoc</code> or <code>None</code></dd>
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
_Sentinel('UNKNOWN')
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="lineno"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">lineno</h3>
The line number of the first line of the function's signature. For
Python functions, this is equal to
<code>func.func_code.co_firstlineno</code>. The first line of a file is
considered line 1.
<dl class="fields">
<dt>Type:</dt>
<dd><code>int</code></dd>
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
_Sentinel('UNKNOWN')
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="decorators"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">decorators</h3>
A list of names of decorators that were applied to this routine, in the
order that they are listed in the source code. (I.e., in the reverse of
the order that they were applied in.)
<dl class="fields">
<dt>Type:</dt>
<dd><code>list</code> of <code>string</code></dd>
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
_Sentinel('UNKNOWN')
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="arg_descrs"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">arg_descrs</h3>
A list of descriptions of the routine's arguments. Each element of this
list is a tuple <code>(args, descr)</code>, where <code>args</code> is a
list of argument names; and <code>descr</code> is a <a
href="epydoc.markup.ParsedDocstring-class.html"
class="link">ParsedDocstring</a> describing the argument(s) specified by
<code>arg</code>.
<dl class="fields">
<dt>Type:</dt>
<dd><code>list</code></dd>
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
_Sentinel('UNKNOWN')
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="exception_descrs"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">exception_descrs</h3>
A list of descriptions of exceptions that the routine might raise. Each
element of this list is a tuple <code>(exc, descr)</code>, where
<code>exc</code> is a string contianing the exception name; and
<code>descr</code> is a <a
href="epydoc.markup.ParsedDocstring-class.html"
class="link">ParsedDocstring</a> describing the circumstances under which
the exception specified by <code>exc</code> is raised.
<dl class="fields">
<dt>Type:</dt>
<dd><code>list</code></dd>
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
_Sentinel('UNKNOWN')
</pre></td></tr></table>
</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:07:28 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>
