1
<?xml version="1.0" encoding="ascii"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
"DTD/xhtml1-transitional.dtd">
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
<title>epydoc.apidoc.NamespaceDoc</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css" />
8
<script type="text/javascript" src="epydoc.js"></script>
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
13
<!-- ==================== NAVIGATION BAR ==================== -->
14
<table class="navbar" border="0" width="100%" cellpadding="0"
15
bgcolor="#a0c0ff" cellspacing="0">
18
<th> <a
19
href="epydoc-module.html">Home</a> </th>
22
<th> <a
23
href="module-tree.html">Trees</a> </th>
26
<th> <a
27
href="identifier-index.html">Indices</a> </th>
30
<th> <a
31
href="help.html">Help</a> </th>
33
<!-- Project homepage -->
34
<th class="navbar" align="right" width="100%">
35
<table border="0" cellpadding="0" cellspacing="0">
36
<tr><th class="navbar" align="center"
37
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
41
<table width="100%" cellpadding="0" cellspacing="0">
44
<span class="breadcrumbs">
45
<a href="epydoc-module.html">Package epydoc</a> ::
46
<a href="epydoc.apidoc-module.html">Module apidoc</a> ::
47
Class NamespaceDoc
51
<table cellpadding="0" cellspacing="0">
52
<!-- hide/show private -->
53
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
54
onclick="toggle_private();">hide private</a>]</span></td></tr>
55
<tr><td align="right"><span class="options"
56
>[<a href="frames.html" target="_top">frames</a
57
>] | <a href="epydoc.apidoc.NamespaceDoc-class.html"
58
target="_top">no frames</a>]</span></td></tr>
63
<!-- ==================== CLASS DESCRIPTION ==================== -->
64
<h1 class="epydoc">Class NamespaceDoc</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.apidoc-pysrc.html#NamespaceDoc">source code</a></span></p>
66
<center> <map id="uml_class_diagram_for_epydoc_a_7" name="uml_class_diagram_for_epydoc_a_7">
67
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#docstring" title="The documented item's docstring." alt="" coords="419,28,792,47" />
68
<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="419,47,792,65" />
69
<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="419,65,792,84" />
70
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#metadata" title="Metadata about the documented item, extracted from fields in its docstring." alt="" coords="419,84,792,103" />
71
<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="419,103,792,121" />
72
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__setattr__" title="Modify an APIDoc's attribute." alt="" coords="419,124,792,143" />
73
<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="419,143,792,161" />
74
<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="419,161,792,180" />
75
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#specialize_to" title="Change self's class to cls." alt="" coords="419,180,792,199" />
76
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="hash(x)" alt="" coords="419,199,792,217" />
77
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="epydoc.apidoc.APIDoc.__cmp__" alt="" coords="419,217,792,236" />
78
<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="419,236,792,255" />
79
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html" title="API documentation information for a single element of a Python program." alt="" coords="407,5,804,261" />
80
<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="5,408,189,445" />
81
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#descr" title="epydoc.apidoc.APIDoc.descr" alt="" coords="149,273,182,287" />
82
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#descr" title="descr" alt="" coords="413,168,421,176" />
83
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#descr" title="descr" alt="" coords="93,409,101,417" />
84
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#summary" title="epydoc.apidoc.APIDoc.summary" alt="" coords="244,273,300,287" />
85
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#summary" title="summary" alt="" coords="413,185,421,193" />
86
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#summary" title="summary" alt="" coords="101,409,109,417" />
87
<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="219,408,435,445" />
88
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#extra_docstring_fields" title="epydoc.apidoc.APIDoc.extra_docstring_fields" alt="" coords="468,273,599,287" />
89
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#extra_docstring_fields" title="extra_docstring_fields" alt="" coords="479,252,487,260" />
90
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#extra_docstring_fields" title="extra_docstring_fields" alt="" coords="335,409,343,417" />
91
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#pyval" title="A pointer to the actual Python object described by this ValueDoc." alt="" coords="476,321,735,340" />
92
<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="476,340,735,359" />
93
<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="476,359,735,377" />
94
<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="476,377,735,396" />
95
<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="476,396,735,415" />
96
<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="476,415,735,433" />
97
<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="476,433,735,452" />
98
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#__repr__" title="repr(x)" alt="" coords="476,455,735,473" />
99
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#__setstate__" title="epydoc.apidoc.ValueDoc.__setstate__" alt="" coords="476,473,735,492" />
100
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#__getstate__" title="State serializer for the pickle module." alt="" coords="476,492,735,511" />
101
<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="476,511,735,529" />
102
<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="476,529,735,548" />
103
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html" title="API documentation information about a single Python value." alt="" coords="464,299,747,555" />
104
<area shape="rect" href="epydoc.apidoc.ModuleDoc-class.html" title="API documentation information about a single module." alt="" coords="579,829,683,867" />
105
<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="767,673,879,711" />
106
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html" title="API documentation information about a single Python variable." alt="" coords="737,829,847,867" />
107
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#sort_spec" title="The order in which variables should be listed, encoded as a list of names." alt="" coords="520,615,689,633" />
108
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#group_specs" title="The groups that are defined by this namespace's docstrings." alt="" coords="520,633,689,652" />
109
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#__init__" title="Construct a new APIDoc object." alt="" coords="520,655,689,673" />
110
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#is_detailed" title="Does this object deserve a box with extra details?" alt="" coords="520,673,689,692" />
111
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-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="520,692,689,711" />
112
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#init_sorted_variables" title="Initialize the sorted_variables attribute, based on the variables and sort_spec attributes." alt="" coords="520,711,689,729" />
113
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#init_variable_groups" title="Initialize the variable_groups attribute, based on the sorted_variables and group_specs attributes." alt="" coords="520,729,689,748" />
114
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#group_names" title="Return a list of the group names defined by this namespace, in the order in which they should be listed, with no duplicates." alt="" coords="520,748,689,767" />
115
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#report_unused_groups" title="Issue a warning for any @group items that were not used by _init_grouping()." alt="" coords="520,767,689,785" />
116
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html" title="API documentation information about a singe Python namespace value." alt="" coords="508,592,737,792" />
117
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#variables" title="epydoc.apidoc.NamespaceDoc.variables" alt="" coords="893,803,947,818" />
118
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#variables" title="variables" alt="" coords="724,709,732,717" />
119
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#variables" title="variables" alt="" coords="832,839,840,847" />
120
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#sorted_variables" title="epydoc.apidoc.NamespaceDoc.sorted_variables" alt="" coords="657,803,756,818" />
121
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#sorted_variables" title="*" alt="" coords="729,821,735,835" />
122
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#sorted_variables" title="sorted_variables" alt="" coords="628,783,636,791" />
123
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#sorted_variables" title="*" alt="" coords="744,836,752,844" />
124
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#variable_groups" title="epydoc.apidoc.NamespaceDoc.variable_groups" alt="" coords="768,803,864,818" />
125
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#variable_groups" title="*" alt="" coords="776,807,781,822" />
126
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#variable_groups" title="variable_groups" alt="" coords="724,755,732,763" />
127
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#variable_groups" title="*" alt="" coords="779,831,787,839" />
128
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html" title="API documentation information about a single class." alt="" coords="456,829,549,867" />
129
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#defining_module" title="epydoc.apidoc.ValueDoc.defining_module" alt="" coords="395,685,493,699" />
130
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#defining_module" title="defining_module" alt="" coords="471,531,479,539" />
131
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#defining_module" title="defining_module" alt="" coords="585,832,593,840" />
132
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#canonical_name" title="epydoc.apidoc.ValueDoc.canonical_name" alt="" coords="746,566,843,581" />
133
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#canonical_name" title="canonical_name" alt="" coords="721,545,729,553" />
134
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#canonical_name" title="canonical_name" alt="" coords="811,675,819,683" />
135
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#proxy_for" title="epydoc.apidoc.ValueDoc.proxy_for" alt="" coords="676,566,732,581" />
136
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#proxy_for" title="proxy_for" alt="" coords="641,545,649,553" />
137
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#proxy_for" title="proxy_for" alt="" coords="813,675,821,683" />
139
<img src="uml_class_diagram_for_epydoc_a_7.gif" alt='' usemap="#uml_class_diagram_for_epydoc_a_7" ismap="ismap" class="graph-without-title" />
143
<p>API documentation information about a singe Python namespace value.
144
(I.e., a module or a class).</p>
146
<!-- ==================== INSTANCE METHODS ==================== -->
147
<a name="section-InstanceMethods"></a>
148
<table class="summary" border="1" cellpadding="3"
149
cellspacing="0" width="100%" bgcolor="white">
150
<tr bgcolor="#70b0f0" class="table-header">
151
<td colspan="2" class="table-header">
152
<table border="0" cellpadding="0" cellspacing="0" width="100%">
154
<td align="left"><span class="table-header">Instance Methods</span></td>
155
<td align="right" valign="top"
156
><span class="options">[<a href="#section-InstanceMethods"
157
class="privatelink" onclick="toggle_private();"
158
>hide private</a>]</span></td>
164
<td width="15%" align="right" valign="top" class="summary">
165
<span class="summary-type"> </span>
166
</td><td class="summary">
167
<table width="100%" cellpadding="0" cellspacing="0" border="0">
169
<td><span class="summary-sig"><a href="epydoc.apidoc.NamespaceDoc-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
170
<span class="summary-sig-arg">**kwargs</span>)</span><br />
171
Construct a new <code>APIDoc</code> object.</td>
172
<td align="right" valign="top">
173
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#NamespaceDoc.__init__">source code</a></span>
174
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___4-summary-div');return false;">call graph</a></span>
178
<div style="display:none" id="call_graph_for___init___4-summary-div"><center>
179
<table border="0" cellpadding="0" cellspacing="0">
180
<tr><td><center> <map id="call_graph_for___init___4" name="call_graph_for___init___4">
181
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__init__" title="APIDoc.__init__()" alt="" coords="437,118,600,150" />
182
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#specialize_to" title="APIDoc.specialize_to()" alt="" coords="25,6,223,38" />
183
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#__init__" title="__init__()" alt="" coords="292,118,388,150" />
184
<area shape="rect" href="epydoc.docparser-module.html#_import_var" title="docparser._import_var()" alt="" coords="23,62,225,94" />
185
<area shape="rect" href="epydoc.docparser-module.html#_proxy_base" title="docparser._proxy_base()" alt="" coords="21,118,227,150" />
186
<area shape="rect" href="epydoc.docparser-module.html#parse_docs" title="docparser.parse_docs()" alt="" coords="27,174,221,206" />
187
<area shape="rect" href="epydoc.docparser-module.html#process_classdef" title="docparser.process_classdef()" alt="" coords="5,230,243,262" />
189
<img src="call_graph_for___init___4.gif" alt='' usemap="#call_graph_for___init___4" ismap="ismap" class="graph-without-title" />
191
<tr><th>Call Graph</th></tr>
198
<td width="15%" align="right" valign="top" class="summary">
199
<span class="summary-type"><code>bool</code></span>
200
</td><td class="summary">
201
<table width="100%" cellpadding="0" cellspacing="0" border="0">
203
<td><span class="summary-sig"><a href="epydoc.apidoc.NamespaceDoc-class.html#is_detailed" class="summary-sig-name">is_detailed</a>(<span class="summary-sig-arg">self</span>)</span><br />
204
Does this object deserve a box with extra details?</td>
205
<td align="right" valign="top">
206
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#NamespaceDoc.is_detailed">source code</a></span>
207
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_is_detailed_3-summary-div');return false;">call graph</a></span>
211
<div style="display:none" id="call_graph_for_is_detailed_3-summary-div"><center>
212
<table border="0" cellpadding="0" cellspacing="0">
213
<tr><td><center> <map id="call_graph_for_is_detailed_3" name="call_graph_for_is_detailed_3">
214
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#is_detailed" title="is_detailed()" alt="" coords="271,6,385,38" />
215
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#is_detailed" title="VariableDoc.is_detailed()" alt="" coords="5,6,221,38" />
217
<img src="call_graph_for_is_detailed_3.gif" alt='' usemap="#call_graph_for_is_detailed_3" ismap="ismap" class="graph-without-title" />
219
<tr><th>Call Graph</th></tr>
226
<td width="15%" align="right" valign="top" class="summary">
227
<span class="summary-type"> </span>
228
</td><td class="summary">
229
<table width="100%" cellpadding="0" cellspacing="0" border="0">
231
<td><span class="summary-sig"><a href="epydoc.apidoc.NamespaceDoc-class.html#apidoc_links" class="summary-sig-name">apidoc_links</a>(<span class="summary-sig-arg">self</span>,
232
<span class="summary-sig-arg">**filters</span>)</span><br />
233
Return a list of all <code>APIDoc</code>s that are directly linked
234
from this <code>APIDoc</code> (i.e., are contained or pointed to by
235
one or more of this <code>APIDoc</code>'s attributes.)</td>
236
<td align="right" valign="top">
237
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#NamespaceDoc.apidoc_links">source code</a></span>
238
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_apidoc_links_4-summary-div');return false;">call graph</a></span>
242
<div style="display:none" id="call_graph_for_apidoc_links_4-summary-div"><center>
243
<table border="0" cellpadding="0" cellspacing="0">
244
<tr><td><center> <map id="call_graph_for_apidoc_links_4" name="call_graph_for_apidoc_links_4">
245
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#apidoc_links" title="ClassDoc.apidoc_links()" alt="" coords="15,6,220,38" />
246
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#apidoc_links" title="apidoc_links()" alt="" coords="279,34,407,66" />
247
<area shape="rect" href="epydoc.apidoc.ModuleDoc-class.html#apidoc_links" title="ModuleDoc.apidoc_links()" alt="" coords="5,62,229,94" />
249
<img src="call_graph_for_apidoc_links_4.gif" alt='' usemap="#call_graph_for_apidoc_links_4" ismap="ismap" class="graph-without-title" />
251
<tr><th>Call Graph</th></tr>
258
<td width="15%" align="right" valign="top" class="summary">
259
<span class="summary-type"> </span>
260
</td><td class="summary">
261
<table width="100%" cellpadding="0" cellspacing="0" border="0">
263
<td><span class="summary-sig"><a href="epydoc.apidoc.NamespaceDoc-class.html#init_sorted_variables" class="summary-sig-name">init_sorted_variables</a>(<span class="summary-sig-arg">self</span>)</span><br />
265
href="epydoc.apidoc.NamespaceDoc-class.html#sorted_variables"
266
class="link">sorted_variables</a> attribute, based on the <a
267
href="epydoc.apidoc.NamespaceDoc-class.html#variables"
268
class="link">variables</a> and <a
269
href="epydoc.apidoc.NamespaceDoc-class.html#sort_spec"
270
class="link">sort_spec</a> attributes.</td>
271
<td align="right" valign="top">
272
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#NamespaceDoc.init_sorted_variables">source code</a></span>
273
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_init_sorted_var-summary-div');return false;">call graph</a></span>
277
<div style="display:none" id="call_graph_for_init_sorted_var-summary-div"><center>
278
<table border="0" cellpadding="0" cellspacing="0">
279
<tr><td><center> <map id="call_graph_for_init_sorted_var" name="call_graph_for_init_sorted_var">
280
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#init_sorted_variables" title="init_sorted_variables()" alt="" coords="296,6,488,38" />
281
<area shape="rect" href="epydoc.docbuilder-module.html#build_doc_index" title="docbuilder.build_doc_index()" alt="" coords="5,6,248,38" />
283
<img src="call_graph_for_init_sorted_var.gif" alt='' usemap="#call_graph_for_init_sorted_var" ismap="ismap" class="graph-without-title" />
285
<tr><th>Call Graph</th></tr>
292
<td width="15%" align="right" valign="top" class="summary">
293
<span class="summary-type"> </span>
294
</td><td class="summary">
295
<table width="100%" cellpadding="0" cellspacing="0" border="0">
297
<td><span class="summary-sig"><a name="init_variable_groups"></a><span class="summary-sig-name">init_variable_groups</span>(<span class="summary-sig-arg">self</span>)</span><br />
299
href="epydoc.apidoc.NamespaceDoc-class.html#variable_groups"
300
class="link">variable_groups</a> attribute, based on the <a
301
href="epydoc.apidoc.NamespaceDoc-class.html#sorted_variables"
302
class="link">sorted_variables</a> and <a
303
href="epydoc.apidoc.NamespaceDoc-class.html#group_specs"
304
class="link">group_specs</a> attributes.</td>
305
<td align="right" valign="top">
306
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#NamespaceDoc.init_variable_groups">source code</a></span>
307
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_init_variable_g-summary-div');return false;">call graph</a></span>
311
<div style="display:none" id="call_graph_for_init_variable_g-summary-div"><center>
312
<table border="0" cellpadding="0" cellspacing="0">
313
<tr><td><center> <map id="call_graph_for_init_variable_g" name="call_graph_for_init_variable_g">
314
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#_init_grouping" title="_init_grouping()" alt="" coords="535,6,679,38" />
315
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#init_variable_groups" title="init_variable_groups()" alt="" coords="296,6,485,38" />
316
<area shape="rect" href="epydoc.docbuilder-module.html#build_doc_index" title="docbuilder.build_doc_index()" alt="" coords="5,6,248,38" />
318
<img src="call_graph_for_init_variable_g.gif" alt='' usemap="#call_graph_for_init_variable_g" ismap="ismap" class="graph-without-title" />
320
<tr><th>Call Graph</th></tr>
327
<td width="15%" align="right" valign="top" class="summary">
328
<span class="summary-type"> </span>
329
</td><td class="summary">
330
<table width="100%" cellpadding="0" cellspacing="0" border="0">
332
<td><span class="summary-sig"><a name="group_names"></a><span class="summary-sig-name">group_names</span>(<span class="summary-sig-arg">self</span>)</span><br />
333
Return a list of the group names defined by this namespace, in the
334
order in which they should be listed, with no duplicates.</td>
335
<td align="right" valign="top">
336
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#NamespaceDoc.group_names">source code</a></span>
337
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_group_names-summary-div');return false;">call graph</a></span>
341
<div style="display:none" id="call_graph_for_group_names-summary-div"><center>
342
<table border="0" cellpadding="0" cellspacing="0">
343
<tr><td><center> <map id="call_graph_for_group_names" name="call_graph_for_group_names">
344
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#group_names" title="group_names()" alt="" coords="473,34,607,66" />
345
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_list" title="docwriter.html.HTMLWriter.write_module_list()" alt="" coords="20,6,409,38" />
346
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_table" title="docwriter.html.HTMLWriter.write_summary_table()" alt="" coords="7,62,423,94" />
348
<img src="call_graph_for_group_names.gif" alt='' usemap="#call_graph_for_group_names" ismap="ismap" class="graph-without-title" />
350
<tr><th>Call Graph</th></tr>
357
<td width="15%" align="right" valign="top" class="summary">
358
<span class="summary-type"> </span>
359
</td><td class="summary">
360
<table width="100%" cellpadding="0" cellspacing="0" border="0">
362
<td><span class="summary-sig"><a href="epydoc.apidoc.NamespaceDoc-class.html#_init_grouping" class="summary-sig-name" onclick="show_private();">_init_grouping</a>(<span class="summary-sig-arg">self</span>,
363
<span class="summary-sig-arg">elts</span>)</span><br />
364
Divide a given a list of APIDoc objects into groups, as specified by
365
<a href="epydoc.apidoc.NamespaceDoc-class.html#group_specs"
366
class="link">self.group_specs</a>.</td>
367
<td align="right" valign="top">
368
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#NamespaceDoc._init_grouping">source code</a></span>
369
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__init_grouping-summary-div');return false;">call graph</a></span>
373
<div style="display:none" id="call_graph_for__init_grouping-summary-div"><center>
374
<table border="0" cellpadding="0" cellspacing="0">
375
<tr><td><center> <map id="call_graph_for__init_grouping" name="call_graph_for__init_grouping">
376
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="APIDoc.__hash__()" alt="" coords="565,6,736,38" />
377
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__str__" title="DottedName.__str__()" alt="" coords="556,62,745,94" />
378
<area shape="rect" href="epydoc.apidoc.ModuleDoc-class.html#init_submodule_groups" title="ModuleDoc.init_submodule_groups()" alt="" coords="7,34,311,66" />
379
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#_init_grouping" title="_init_grouping()" alt="" coords="361,62,505,94" />
380
<area shape="rect" href="epydoc.log-module.html#warning" title="log.warning()" alt="" coords="589,118,712,150" />
381
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#init_variable_groups" title="init_variable_groups()" alt="" coords="64,90,253,122" />
383
<img src="call_graph_for__init_grouping.gif" alt='' usemap="#call_graph_for__init_grouping" ismap="ismap" class="graph-without-title" />
385
<tr><th>Call Graph</th></tr>
392
<td width="15%" align="right" valign="top" class="summary">
393
<span class="summary-type"> </span>
394
</td><td class="summary">
395
<table width="100%" cellpadding="0" cellspacing="0" border="0">
397
<td><span class="summary-sig"><a name="report_unused_groups"></a><span class="summary-sig-name">report_unused_groups</span>(<span class="summary-sig-arg">self</span>)</span><br />
398
Issue a warning for any @group items that were not used by <a
399
href="epydoc.apidoc.NamespaceDoc-class.html#_init_grouping"
400
class="link" onclick="show_private();">_init_grouping()</a>.</td>
401
<td align="right" valign="top">
402
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#NamespaceDoc.report_unused_groups">source code</a></span>
403
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_report_unused_g-summary-div');return false;">call graph</a></span>
407
<div style="display:none" id="call_graph_for_report_unused_g-summary-div"><center>
408
<table border="0" cellpadding="0" cellspacing="0">
409
<tr><td><center> <map id="call_graph_for_report_unused_g" name="call_graph_for_report_unused_g">
410
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#report_unused_groups" title="report_unused_groups()" alt="" coords="297,6,497,38" />
411
<area shape="rect" href="epydoc.docbuilder-module.html#build_doc_index" title="docbuilder.build_doc_index()" alt="" coords="5,6,248,38" />
413
<img src="call_graph_for_report_unused_g.gif" alt='' usemap="#call_graph_for_report_unused_g" ismap="ismap" class="graph-without-title" />
415
<tr><th>Call Graph</th></tr>
422
<td colspan="2" class="summary">
423
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
424
<code><a href="epydoc.apidoc.ValueDoc-class.html#__getstate__">__getstate__</a></code>,
425
<code><a href="epydoc.apidoc.ValueDoc-class.html#__repr__">__repr__</a></code>,
426
<code><a href="epydoc.apidoc.ValueDoc-class.html#__setstate__">__setstate__</a></code>
428
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b>:
429
<code><a href="epydoc.apidoc.APIDoc-class.html#__cmp__">__cmp__</a></code>,
430
<code><a href="epydoc.apidoc.APIDoc-class.html#__hash__">__hash__</a></code>,
431
<code><a href="epydoc.apidoc.APIDoc-class.html#__setattr__">__setattr__</a></code>,
432
<code><a href="epydoc.apidoc.APIDoc-class.html#__str__">__str__</a></code>,
433
<code><a href="epydoc.apidoc.APIDoc-class.html#merge_and_overwrite">merge_and_overwrite</a></code>,
434
<code><a href="epydoc.apidoc.APIDoc-class.html#pp">pp</a></code>,
435
<code><a href="epydoc.apidoc.APIDoc-class.html#specialize_to">specialize_to</a></code>
437
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b> (private):
438
<code><a href="epydoc.apidoc.APIDoc-class.html#_debug_setattr" onclick="show_private();">_debug_setattr</a></code>
440
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
441
<code>__delattr__</code>,
442
<code>__getattribute__</code>,
443
<code>__new__</code>,
444
<code>__reduce__</code>,
445
<code>__reduce_ex__</code>
449
<tr bgcolor="#e8f0f8" >
450
<th colspan="2" class="group-header"
451
> Value Representation</th></tr>
453
<td colspan="2" class="summary">
454
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
455
<code><a href="epydoc.apidoc.ValueDoc-class.html#pyval_repr">pyval_repr</a></code>,
456
<code><a href="epydoc.apidoc.ValueDoc-class.html#summary_pyval_repr">summary_pyval_repr</a></code>
461
<!-- ==================== CLASS VARIABLES ==================== -->
462
<a name="section-ClassVariables"></a>
463
<table class="summary" border="1" cellpadding="3"
464
cellspacing="0" width="100%" bgcolor="white">
465
<tr bgcolor="#70b0f0" class="table-header">
466
<td colspan="2" class="table-header">
467
<table border="0" cellpadding="0" cellspacing="0" width="100%">
469
<td align="left"><span class="table-header">Class Variables</span></td>
470
<td align="right" valign="top"
471
><span class="options">[<a href="#section-ClassVariables"
472
class="privatelink" onclick="toggle_private();"
473
>hide private</a>]</span></td>
478
<tr bgcolor="#e8f0f8" >
479
<th colspan="2" class="group-header"
480
> Value Representation</th></tr>
482
<td colspan="2" class="summary">
483
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
484
<code><a href="epydoc.apidoc.ValueDoc-class.html#REPR_LINELEN">REPR_LINELEN</a></code>,
485
<code><a href="epydoc.apidoc.ValueDoc-class.html#REPR_MAXLINES">REPR_MAXLINES</a></code>,
486
<code><a href="epydoc.apidoc.ValueDoc-class.html#REPR_MIN_SCORE">REPR_MIN_SCORE</a></code>,
487
<code><a href="epydoc.apidoc.ValueDoc-class.html#SUMMARY_REPR_LINELEN">SUMMARY_REPR_LINELEN</a></code>
492
<!-- ==================== INSTANCE VARIABLES ==================== -->
493
<a name="section-InstanceVariables"></a>
494
<table class="summary" border="1" cellpadding="3"
495
cellspacing="0" width="100%" bgcolor="white">
496
<tr bgcolor="#70b0f0" class="table-header">
497
<td colspan="2" class="table-header">
498
<table border="0" cellpadding="0" cellspacing="0" width="100%">
500
<td align="left"><span class="table-header">Instance Variables</span></td>
501
<td align="right" valign="top"
502
><span class="options">[<a href="#section-InstanceVariables"
503
class="privatelink" onclick="toggle_private();"
504
>hide private</a>]</span></td>
510
<td colspan="2" class="summary">
511
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
512
<code><a href="epydoc.apidoc.ValueDoc-class.html#canonical_name">canonical_name</a></code>,
513
<code><a href="epydoc.apidoc.ValueDoc-class.html#toktree">toktree</a></code>
517
<tr bgcolor="#e8f0f8" >
518
<th colspan="2" class="group-header"
519
> Information about Variables</th></tr>
521
<td width="15%" align="right" valign="top" class="summary">
522
<span class="summary-type"><code>dict</code> from <code>string</code> to <a
523
href="epydoc.apidoc.VariableDoc-class.html"
524
class="link">VariableDoc</a></span>
525
</td><td class="summary">
526
<a href="epydoc.apidoc.NamespaceDoc-class.html#variables" class="summary-name">variables</a> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
527
The contents of the namespace, encoded as a dictionary mapping from
528
identifiers to <code>VariableDoc</code>s.
532
<td width="15%" align="right" valign="top" class="summary">
533
<span class="summary-type"><code>list</code> of <a href="epydoc.apidoc.VariableDoc-class.html"
534
class="link">VariableDoc</a></span>
535
</td><td class="summary">
536
<a href="epydoc.apidoc.NamespaceDoc-class.html#sorted_variables" class="summary-name">sorted_variables</a> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
537
A list of all variables defined by this namespace, in sorted order.
541
<td width="15%" align="right" valign="top" class="summary">
542
<span class="summary-type"><code>list</code> of <code>str</code></span>
543
</td><td class="summary">
544
<a href="epydoc.apidoc.NamespaceDoc-class.html#sort_spec" class="summary-name">sort_spec</a> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
545
The order in which variables should be listed, encoded as a list of
550
<td width="15%" align="right" valign="top" class="summary">
551
<span class="summary-type"><code>list</code> of <code>(str,list)</code></span>
552
</td><td class="summary">
553
<a href="epydoc.apidoc.NamespaceDoc-class.html#group_specs" class="summary-name">group_specs</a> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
554
The groups that are defined by this namespace's docstrings.
558
<td width="15%" align="right" valign="top" class="summary">
559
<span class="summary-type"><code>dict</code> from <code>str</code> to <code>list</code> of <a
560
href="epydoc.apidoc.VariableDoc-class.html"
561
class="link">VariableDoc</a></span>
562
</td><td class="summary">
563
<a href="epydoc.apidoc.NamespaceDoc-class.html#variable_groups" class="summary-name">variable_groups</a> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
564
A dictionary specifying what group each variable belongs to.
567
<tr bgcolor="#e8f0f8" >
568
<th colspan="2" class="group-header"
569
> Value Representation</th></tr>
571
<td colspan="2" class="summary">
572
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
573
<code><a href="epydoc.apidoc.ValueDoc-class.html#parse_repr">parse_repr</a></code>,
574
<code><a href="epydoc.apidoc.ValueDoc-class.html#pyval">pyval</a></code>
578
<tr bgcolor="#e8f0f8" >
579
<th colspan="2" class="group-header"
580
> Context</th></tr>
582
<td colspan="2" class="summary">
583
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
584
<code><a href="epydoc.apidoc.ValueDoc-class.html#defining_module">defining_module</a></code>
588
<tr bgcolor="#e8f0f8" >
589
<th colspan="2" class="group-header"
590
> Information about Imported Variables</th></tr>
592
<td colspan="2" class="summary">
593
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
594
<code><a href="epydoc.apidoc.ValueDoc-class.html#proxy_for">proxy_for</a></code>
598
<tr bgcolor="#e8f0f8" >
599
<th colspan="2" class="group-header"
600
> Docstrings</th></tr>
602
<td colspan="2" class="summary">
603
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b>:
604
<code><a href="epydoc.apidoc.APIDoc-class.html#docstring">docstring</a></code>,
605
<code><a href="epydoc.apidoc.APIDoc-class.html#docstring_lineno">docstring_lineno</a></code>
609
<tr bgcolor="#e8f0f8" >
610
<th colspan="2" class="group-header"
611
> Information Extracted from Docstrings</th></tr>
613
<td colspan="2" class="summary">
614
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b>:
615
<code><a href="epydoc.apidoc.APIDoc-class.html#descr">descr</a></code>,
616
<code><a href="epydoc.apidoc.APIDoc-class.html#extra_docstring_fields">extra_docstring_fields</a></code>,
617
<code><a href="epydoc.apidoc.APIDoc-class.html#metadata">metadata</a></code>,
618
<code><a href="epydoc.apidoc.APIDoc-class.html#other_docs">other_docs</a></code>,
619
<code><a href="epydoc.apidoc.APIDoc-class.html#summary">summary</a></code>
623
<tr bgcolor="#e8f0f8" >
624
<th colspan="2" class="group-header"
625
> Source Information</th></tr>
627
<td colspan="2" class="summary">
628
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b>:
629
<code><a href="epydoc.apidoc.APIDoc-class.html#docs_extracted_by">docs_extracted_by</a></code>
634
<!-- ==================== PROPERTIES ==================== -->
635
<a name="section-Properties"></a>
636
<table class="summary" border="1" cellpadding="3"
637
cellspacing="0" width="100%" bgcolor="white">
638
<tr bgcolor="#70b0f0" class="table-header">
639
<td colspan="2" class="table-header">
640
<table border="0" cellpadding="0" cellspacing="0" width="100%">
642
<td align="left"><span class="table-header">Properties</span></td>
643
<td align="right" valign="top"
644
><span class="options">[<a href="#section-Properties"
645
class="privatelink" onclick="toggle_private();"
646
>hide private</a>]</span></td>
652
<td colspan="2" class="summary">
653
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
654
<code>__class__</code>
659
<!-- ==================== METHOD DETAILS ==================== -->
660
<a name="section-MethodDetails"></a>
661
<table class="details" border="1" cellpadding="3"
662
cellspacing="0" width="100%" bgcolor="white">
663
<tr bgcolor="#70b0f0" class="table-header">
664
<td colspan="2" class="table-header">
665
<table border="0" cellpadding="0" cellspacing="0" width="100%">
667
<td align="left"><span class="table-header">Method Details</span></td>
668
<td align="right" valign="top"
669
><span class="options">[<a href="#section-MethodDetails"
670
class="privatelink" onclick="toggle_private();"
671
>hide private</a>]</span></td>
677
<a name="__init__"></a>
679
<table class="details" border="1" cellpadding="3"
680
cellspacing="0" width="100%" bgcolor="white">
682
<table width="100%" cellpadding="0" cellspacing="0" border="0">
683
<tr valign="top"><td>
684
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
685
<span class="sig-arg">**kwargs</span>)</span>
686
<br /><em class="fname">(Constructor)</em>
688
</td><td align="right" valign="top"
689
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#NamespaceDoc.__init__">source code</a></span>
690
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___4-div');return false;">call graph</a></span> </td>
692
<div style="display:none" id="call_graph_for___init___4-div"><center>
693
<table border="0" cellpadding="0" cellspacing="0">
694
<tr><td><center> <map id="call_graph_for___init___4" name="call_graph_for___init___4">
695
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__init__" title="APIDoc.__init__()" alt="" coords="437,118,600,150" />
696
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#specialize_to" title="APIDoc.specialize_to()" alt="" coords="25,6,223,38" />
697
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#__init__" title="__init__()" alt="" coords="292,118,388,150" />
698
<area shape="rect" href="epydoc.docparser-module.html#_import_var" title="docparser._import_var()" alt="" coords="23,62,225,94" />
699
<area shape="rect" href="epydoc.docparser-module.html#_proxy_base" title="docparser._proxy_base()" alt="" coords="21,118,227,150" />
700
<area shape="rect" href="epydoc.docparser-module.html#parse_docs" title="docparser.parse_docs()" alt="" coords="27,174,221,206" />
701
<area shape="rect" href="epydoc.docparser-module.html#process_classdef" title="docparser.process_classdef()" alt="" coords="5,230,243,262" />
703
<img src="call_graph_for___init___4.gif" alt='' usemap="#call_graph_for___init___4" ismap="ismap" class="graph-without-title" />
705
<tr><th>Call Graph</th></tr>
709
<p>Construct a new <code>APIDoc</code> object. Keyword arguments may be
710
used to initialize the new <code>APIDoc</code>'s attributes.</p>
713
<dd><ul class="nomargin-top">
714
<li><code><strong class='fraise'>TypeError</strong></code> - If a keyword argument is specified that does not correspond to a
715
valid attribute for this (sub)class of <code>APIDoc</code>.</li>
719
<dd><em class="note">(inherited documentation)</em></dd>
724
<a name="is_detailed"></a>
726
<table class="details" border="1" cellpadding="3"
727
cellspacing="0" width="100%" bgcolor="white">
729
<table width="100%" cellpadding="0" cellspacing="0" border="0">
730
<tr valign="top"><td>
731
<h3 class="epydoc"><span class="sig"><span class="sig-name">is_detailed</span>(<span class="sig-arg">self</span>)</span>
733
</td><td align="right" valign="top"
734
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#NamespaceDoc.is_detailed">source code</a></span>
735
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_is_detailed_3-div');return false;">call graph</a></span> </td>
737
<div style="display:none" id="call_graph_for_is_detailed_3-div"><center>
738
<table border="0" cellpadding="0" cellspacing="0">
739
<tr><td><center> <map id="call_graph_for_is_detailed_3" name="call_graph_for_is_detailed_3">
740
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#is_detailed" title="is_detailed()" alt="" coords="271,6,385,38" />
741
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#is_detailed" title="VariableDoc.is_detailed()" alt="" coords="5,6,221,38" />
743
<img src="call_graph_for_is_detailed_3.gif" alt='' usemap="#call_graph_for_is_detailed_3" ismap="ismap" class="graph-without-title" />
745
<tr><th>Call Graph</th></tr>
749
<p>Does this object deserve a box with extra details?</p>
751
<dt>Returns: <code>bool</code></dt>
752
<dd>True if the object needs extra details, else False.</dd>
754
<a href="epydoc.apidoc.APIDoc-class.html#is_detailed">APIDoc.is_detailed</a>
755
<dd><em class="note">(inherited documentation)</em></dd>
760
<a name="apidoc_links"></a>
762
<table class="details" border="1" cellpadding="3"
763
cellspacing="0" width="100%" bgcolor="white">
765
<table width="100%" cellpadding="0" cellspacing="0" border="0">
766
<tr valign="top"><td>
767
<h3 class="epydoc"><span class="sig"><span class="sig-name">apidoc_links</span>(<span class="sig-arg">self</span>,
768
<span class="sig-arg">**filters</span>)</span>
770
</td><td align="right" valign="top"
771
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#NamespaceDoc.apidoc_links">source code</a></span>
772
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_apidoc_links_4-div');return false;">call graph</a></span> </td>
774
<div style="display:none" id="call_graph_for_apidoc_links_4-div"><center>
775
<table border="0" cellpadding="0" cellspacing="0">
776
<tr><td><center> <map id="call_graph_for_apidoc_links_4" name="call_graph_for_apidoc_links_4">
777
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#apidoc_links" title="ClassDoc.apidoc_links()" alt="" coords="15,6,220,38" />
778
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#apidoc_links" title="apidoc_links()" alt="" coords="279,34,407,66" />
779
<area shape="rect" href="epydoc.apidoc.ModuleDoc-class.html#apidoc_links" title="ModuleDoc.apidoc_links()" alt="" coords="5,62,229,94" />
781
<img src="call_graph_for_apidoc_links_4.gif" alt='' usemap="#call_graph_for_apidoc_links_4" ismap="ismap" class="graph-without-title" />
783
<tr><th>Call Graph</th></tr>
787
<p>Return a list of all <code>APIDoc</code>s that are directly linked
788
from this <code>APIDoc</code> (i.e., are contained or pointed to by one
789
or more of this <code>APIDoc</code>'s attributes.)</p>
790
<p>Keyword argument <code>filters</code> can be used to selectively
791
exclude certain categories of attribute value. For example, using
792
<code>includes=False</code> will exclude variables that were imported
793
from other modules; and <code>subclasses=False</code> will exclude
794
subclasses. The filter categories currently supported by epydoc are:</p>
797
<code>imports</code>: Imported variables.
800
<code>packages</code>: Containing packages for modules.
803
<code>submodules</code>: Contained submodules for packages.
806
<code>bases</code>: Bases for classes.
809
<code>subclasses</code>: Subclasses for classes.
812
<code>variables</code>: All variables.
815
<code>private</code>: Private variables.
818
<code>overrides</code>: Points from class variables to the variables
819
they override. This filter is False by default.
824
<a href="epydoc.apidoc.APIDoc-class.html#apidoc_links">APIDoc.apidoc_links</a>
825
<dd><em class="note">(inherited documentation)</em></dd>
830
<a name="init_sorted_variables"></a>
832
<table class="details" border="1" cellpadding="3"
833
cellspacing="0" width="100%" bgcolor="white">
835
<table width="100%" cellpadding="0" cellspacing="0" border="0">
836
<tr valign="top"><td>
837
<h3 class="epydoc"><span class="sig"><span class="sig-name">init_sorted_variables</span>(<span class="sig-arg">self</span>)</span>
839
</td><td align="right" valign="top"
840
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#NamespaceDoc.init_sorted_variables">source code</a></span>
841
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_init_sorted_var-div');return false;">call graph</a></span> </td>
843
<div style="display:none" id="call_graph_for_init_sorted_var-div"><center>
844
<table border="0" cellpadding="0" cellspacing="0">
845
<tr><td><center> <map id="call_graph_for_init_sorted_var" name="call_graph_for_init_sorted_var">
846
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#init_sorted_variables" title="init_sorted_variables()" alt="" coords="296,6,488,38" />
847
<area shape="rect" href="epydoc.docbuilder-module.html#build_doc_index" title="docbuilder.build_doc_index()" alt="" coords="5,6,248,38" />
849
<img src="call_graph_for_init_sorted_var.gif" alt='' usemap="#call_graph_for_init_sorted_var" ismap="ismap" class="graph-without-title" />
851
<tr><th>Call Graph</th></tr>
856
href="epydoc.apidoc.NamespaceDoc-class.html#sorted_variables"
857
class="link">sorted_variables</a> attribute, based on the <a
858
href="epydoc.apidoc.NamespaceDoc-class.html#variables"
859
class="link">variables</a> and <a
860
href="epydoc.apidoc.NamespaceDoc-class.html#sort_spec"
861
class="link">sort_spec</a> attributes. This should usually be called
862
after all variables have been added to <code>variables</code> (including
863
any inherited variables for classes).</p>
868
<a name="_init_grouping"></a>
869
<div class="private">
870
<table class="details" border="1" cellpadding="3"
871
cellspacing="0" width="100%" bgcolor="white">
873
<table width="100%" cellpadding="0" cellspacing="0" border="0">
874
<tr valign="top"><td>
875
<h3 class="epydoc"><span class="sig"><span class="sig-name">_init_grouping</span>(<span class="sig-arg">self</span>,
876
<span class="sig-arg">elts</span>)</span>
878
</td><td align="right" valign="top"
879
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#NamespaceDoc._init_grouping">source code</a></span>
880
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__init_grouping-div');return false;">call graph</a></span> </td>
882
<div style="display:none" id="call_graph_for__init_grouping-div"><center>
883
<table border="0" cellpadding="0" cellspacing="0">
884
<tr><td><center> <map id="call_graph_for__init_grouping" name="call_graph_for__init_grouping">
885
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="APIDoc.__hash__()" alt="" coords="565,6,736,38" />
886
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__str__" title="DottedName.__str__()" alt="" coords="556,62,745,94" />
887
<area shape="rect" href="epydoc.apidoc.ModuleDoc-class.html#init_submodule_groups" title="ModuleDoc.init_submodule_groups()" alt="" coords="7,34,311,66" />
888
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#_init_grouping" title="_init_grouping()" alt="" coords="361,62,505,94" />
889
<area shape="rect" href="epydoc.log-module.html#warning" title="log.warning()" alt="" coords="589,118,712,150" />
890
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#init_variable_groups" title="init_variable_groups()" alt="" coords="64,90,253,122" />
892
<img src="call_graph_for__init_grouping.gif" alt='' usemap="#call_graph_for__init_grouping" ismap="ismap" class="graph-without-title" />
894
<tr><th>Call Graph</th></tr>
898
<p>Divide a given a list of APIDoc objects into groups, as specified by
899
<a href="epydoc.apidoc.NamespaceDoc-class.html#group_specs"
900
class="link">self.group_specs</a>.</p>
903
<dd><ul class="nomargin-top">
904
<li><strong class="pname"><code>elts</code></strong> - A list of tuples <code>(name, apidoc)</code>.</li>
907
<dd>A list of tuples <code>(groupname, elts)</code>, where
908
<code>groupname</code> is the name of a group and
909
<code>elts</code> is a list of <code>APIDoc</code>s in that
910
group. The first tuple has name <code>''</code>, and is used for
911
ungrouped elements. The remaining tuples are listed in the order
912
that they appear in <code>self.group_specs</code>. Within each
913
tuple, the elements are listed in the order that they appear in
914
<code>api_docs</code>.</dd>
919
<!-- ==================== INSTANCE VARIABLE DETAILS ==================== -->
920
<a name="section-InstanceVariableDetails"></a>
921
<table class="details" border="1" cellpadding="3"
922
cellspacing="0" width="100%" bgcolor="white">
923
<tr bgcolor="#70b0f0" class="table-header">
924
<td colspan="2" class="table-header">
925
<table border="0" cellpadding="0" cellspacing="0" width="100%">
927
<td align="left"><span class="table-header">Instance Variable Details</span></td>
928
<td align="right" valign="top"
929
><span class="options">[<a href="#section-InstanceVariableDetails"
930
class="privatelink" onclick="toggle_private();"
931
>hide private</a>]</span></td>
937
<a name="variables"></a>
939
<table class="details" border="1" cellpadding="3"
940
cellspacing="0" width="100%" bgcolor="white">
942
<h3 class="epydoc">variables</h3>
943
The contents of the namespace, encoded as a dictionary mapping from
944
identifiers to <code>VariableDoc</code>s. This dictionary contains all
945
names defined by the namespace, including imported variables, aliased
946
variables, and variables inherited from base classes (once <a
947
href="epydoc.docbuilder-module.html#inherit_docs"
948
class="link">inherit_docs()</a> has added them).
951
<dd><code>dict</code> from <code>string</code> to <a
952
href="epydoc.apidoc.VariableDoc-class.html"
953
class="link">VariableDoc</a></dd>
957
<dd><table><tr><td><pre class="variable">
959
</pre></td></tr></table>
964
<a name="sorted_variables"></a>
966
<table class="details" border="1" cellpadding="3"
967
cellspacing="0" width="100%" bgcolor="white">
969
<h3 class="epydoc">sorted_variables</h3>
970
A list of all variables defined by this namespace, in sorted order. The
971
elements of this list should exactly match the values of <a
972
href="epydoc.apidoc.NamespaceDoc-class.html#variables"
973
class="link">variables</a>. The sort order for this list is defined as
977
Any variables listed in a <code>@sort</code> docstring field are
978
listed in the order given by that field.
981
These are followed by any variables that were found while parsing the
982
source code, in the order in which they were defined in the source
986
Finally, any remaining variables are listed in alphabetical order.
991
<dd><code>list</code> of <a href="epydoc.apidoc.VariableDoc-class.html"
992
class="link">VariableDoc</a></dd>
996
<dd><table><tr><td><pre class="variable">
998
</pre></td></tr></table>
1003
<a name="sort_spec"></a>
1005
<table class="details" border="1" cellpadding="3"
1006
cellspacing="0" width="100%" bgcolor="white">
1008
<h3 class="epydoc">sort_spec</h3>
1009
The order in which variables should be listed, encoded as a list of
1010
names. Any variables whose names are not included in this list should be
1011
listed alphabetically, following the variables that are included.
1014
<dd><code>list</code> of <code>str</code></dd>
1018
<dd><table><tr><td><pre class="variable">
1019
_Sentinel('UNKNOWN')
1020
</pre></td></tr></table>
1025
<a name="group_specs"></a>
1027
<table class="details" border="1" cellpadding="3"
1028
cellspacing="0" width="100%" bgcolor="white">
1030
<h3 class="epydoc">group_specs</h3>
1031
The groups that are defined by this namespace's docstrings.
1032
<code>group_specs</code> is encoded as an ordered list of tuples
1033
<code>(group_name, elt_names)</code>, where <code>group_name</code> is
1035
<p>name of a group and <code>elt_names</code> is a list of element names
1036
in that group. (An element can be a variable or a submodule.) A '*' in
1037
an element name will match any string of characters.</p>
1040
<dd><code>list</code> of <code>(str,list)</code></dd>
1044
<dd><table><tr><td><pre class="variable">
1045
_Sentinel('UNKNOWN')
1046
</pre></td></tr></table>
1051
<a name="variable_groups"></a>
1053
<table class="details" border="1" cellpadding="3"
1054
cellspacing="0" width="100%" bgcolor="white">
1056
<h3 class="epydoc">variable_groups</h3>
1057
A dictionary specifying what group each variable belongs to. The keys of
1058
the dictionary are group names, and the values are lists of
1059
<code>VariableDoc</code>s. The order that groups should be listed in
1060
should be taken from <a
1061
href="epydoc.apidoc.NamespaceDoc-class.html#group_specs"
1062
class="link">group_specs</a>.
1065
<dd><code>dict</code> from <code>str</code> to <code>list</code> of <a
1066
href="epydoc.apidoc.VariableDoc-class.html"
1067
class="link">VariableDoc</a></dd>
1071
<dd><table><tr><td><pre class="variable">
1072
_Sentinel('UNKNOWN')
1073
</pre></td></tr></table>
1079
<!-- ==================== NAVIGATION BAR ==================== -->
1080
<table class="navbar" border="0" width="100%" cellpadding="0"
1081
bgcolor="#a0c0ff" cellspacing="0">
1082
<tr valign="middle">
1084
<th> <a
1085
href="epydoc-module.html">Home</a> </th>
1088
<th> <a
1089
href="module-tree.html">Trees</a> </th>
1092
<th> <a
1093
href="identifier-index.html">Indices</a> </th>
1096
<th> <a
1097
href="help.html">Help</a> </th>
1099
<!-- Project homepage -->
1100
<th class="navbar" align="right" width="100%">
1101
<table border="0" cellpadding="0" cellspacing="0">
1102
<tr><th class="navbar" align="center"
1103
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
1107
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
1109
<td align="left" class="footer">
1110
<a href="epydoc-log.html">Generated by Epydoc
1111
3.0.1 on Wed Jan 30 14:07:24 2008</a>
1113
<td align="right" class="footer">
1114
<a target="mainFrame" href="http://epydoc.sourceforge.net"
1115
>http://epydoc.sourceforge.net</a>
1120
<script type="text/javascript">
1122
// Private objects are initially displayed (because if
1123
// javascript is turned off then we want them to be
1124
// visible); but by default, we want to hide them. So hide
1125
// them unless we have a cookie that says to show them.
added
removed
doc/api/epydoc.apidoc.NamespaceDoc-class.html
