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.ClassDoc</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> ::
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.ClassDoc-class.html"
58
target="_top">no frames</a>]</span></td></tr>
63
<!-- ==================== CLASS DESCRIPTION ==================== -->
64
<h1 class="epydoc">Class ClassDoc</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.apidoc-pysrc.html#ClassDoc">source code</a></span></p>
66
<center> <map id="uml_class_diagram_for_epydoc_a_2" name="uml_class_diagram_for_epydoc_a_2">
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="245,273,301,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="472,273,603,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.ClassDoc-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="257,841,953,860" />
105
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#is_type" title="epydoc.apidoc.ClassDoc.is_type" alt="" coords="257,860,953,879" />
106
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#is_exception" title="epydoc.apidoc.ClassDoc.is_exception" alt="" coords="257,879,953,897" />
107
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#is_newstyle_class" title="epydoc.apidoc.ClassDoc.is_newstyle_class" alt="" coords="257,897,953,916" />
108
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#mro" title="epydoc.apidoc.ClassDoc.mro" alt="" coords="257,916,953,935" />
109
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#select_variables" title="Return a specified subset of this class's sorted_variables list." alt="" coords="257,935,953,953" />
110
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html" title="API documentation information about a single class." alt="" coords="245,811,965,960" />
111
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#bases" title="epydoc.apidoc.ClassDoc.bases" alt="" coords="994,878,1030,893" />
112
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#bases" title="*" alt="" coords="971,897,976,911" />
113
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#bases" title="bases" alt="" coords="951,869,959,877" />
114
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#bases" title="*" alt="" coords="951,893,959,901" />
115
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#subclasses" title="epydoc.apidoc.ClassDoc.subclasses" alt="" coords="1031,878,1097,893" />
116
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#subclasses" title="*" alt="" coords="971,914,976,929" />
117
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#subclasses" title="subclasses" alt="" coords="951,852,959,860" />
118
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#subclasses" title="*" alt="" coords="951,911,959,919" />
119
<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="217,664,329,701" />
120
<area shape="rect" href="epydoc.apidoc.ModuleDoc-class.html" title="API documentation information about a single module." alt="" coords="375,664,479,701" />
121
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html" title="API documentation information about a single Python variable." alt="" coords="1145,867,1255,904" />
122
<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" />
123
<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" />
124
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#__init__" title="Construct a new APIDoc object." alt="" coords="520,655,689,673" />
125
<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" />
126
<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,692,689,711" />
127
<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,711,689,729" />
128
<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,729,689,748" />
129
<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,748,689,767" />
130
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html" title="API documentation information about a singe Python namespace value." alt="" coords="508,592,737,773" />
131
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#variables" title="epydoc.apidoc.NamespaceDoc.variables" alt="" coords="1069,785,1123,799" />
132
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#variables" title="variables" alt="" coords="724,693,732,701" />
133
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#variables" title="variables" alt="" coords="1187,868,1195,876" />
134
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#sorted_variables" title="epydoc.apidoc.NamespaceDoc.sorted_variables" alt="" coords="903,785,1001,799" />
135
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#sorted_variables" title="*" alt="" coords="1187,845,1192,859" />
136
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#sorted_variables" title="sorted_variables" alt="" coords="687,721,695,729" />
137
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#sorted_variables" title="*" alt="" coords="1188,868,1196,876" />
138
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#variable_groups" title="epydoc.apidoc.NamespaceDoc.variable_groups" alt="" coords="1143,785,1239,799" />
139
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#variable_groups" title="*" alt="" coords="1192,845,1197,859" />
140
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#variable_groups" title="variable_groups" alt="" coords="724,737,732,745" />
141
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#variable_groups" title="*" alt="" coords="1191,868,1199,876" />
142
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#proxy_for" title="epydoc.apidoc.ValueDoc.proxy_for" alt="" coords="317,566,373,581" />
143
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#proxy_for" title="proxy_for" alt="" coords="471,539,479,547" />
144
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#proxy_for" title="proxy_for" alt="" coords="269,665,277,673" />
145
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#canonical_name" title="epydoc.apidoc.ValueDoc.canonical_name" alt="" coords="397,566,494,581" />
146
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#canonical_name" title="canonical_name" alt="" coords="471,537,479,545" />
147
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#canonical_name" title="canonical_name" alt="" coords="283,665,291,673" />
148
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#defining_module" title="epydoc.apidoc.ValueDoc.defining_module" alt="" coords="504,566,603,581" />
149
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#defining_module" title="defining_module" alt="" coords="507,545,515,553" />
150
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html#defining_module" title="defining_module" alt="" coords="431,665,439,673" />
152
<img src="uml_class_diagram_for_epydoc_a_2.gif" alt='' usemap="#uml_class_diagram_for_epydoc_a_2" ismap="ismap" class="graph-without-title" />
156
<p>API documentation information about a single class.</p>
158
<!-- ==================== INSTANCE METHODS ==================== -->
159
<a name="section-InstanceMethods"></a>
160
<table class="summary" border="1" cellpadding="3"
161
cellspacing="0" width="100%" bgcolor="white">
162
<tr bgcolor="#70b0f0" class="table-header">
163
<td colspan="2" class="table-header">
164
<table border="0" cellpadding="0" cellspacing="0" width="100%">
166
<td align="left"><span class="table-header">Instance Methods</span></td>
167
<td align="right" valign="top"
168
><span class="options">[<a href="#section-InstanceMethods"
169
class="privatelink" onclick="toggle_private();"
170
>hide private</a>]</span></td>
176
<td width="15%" align="right" valign="top" class="summary">
177
<span class="summary-type"> </span>
178
</td><td class="summary">
179
<table width="100%" cellpadding="0" cellspacing="0" border="0">
181
<td><span class="summary-sig"><a href="epydoc.apidoc.ClassDoc-class.html#apidoc_links" class="summary-sig-name">apidoc_links</a>(<span class="summary-sig-arg">self</span>,
182
<span class="summary-sig-arg">**filters</span>)</span><br />
183
Return a list of all <code>APIDoc</code>s that are directly linked
184
from this <code>APIDoc</code> (i.e., are contained or pointed to by
185
one or more of this <code>APIDoc</code>'s attributes.)</td>
186
<td align="right" valign="top">
187
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#ClassDoc.apidoc_links">source code</a></span>
188
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_apidoc_links_2-summary-div');return false;">call graph</a></span>
192
<div style="display:none" id="call_graph_for_apidoc_links_2-summary-div"><center>
193
<table border="0" cellpadding="0" cellspacing="0">
194
<tr><td><center> <map id="call_graph_for_apidoc_links_2" name="call_graph_for_apidoc_links_2">
195
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#apidoc_links" title="apidoc_links()" alt="" coords="359,34,487,66" />
196
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#apidoc_links" title="NamespaceDoc.apidoc_links()" alt="" coords="538,34,788,66" />
197
<area shape="rect" href="epydoc.apidoc-module.html#reachable_valdocs" title="reachable_valdocs()" alt="" coords="71,6,244,38" />
198
<area shape="rect" href="epydoc.docbuilder-module.html#assign_canonical_names" title="docbuilder.assign_canonical_names()" alt="" coords="7,62,308,94" />
200
<img src="call_graph_for_apidoc_links_2.gif" alt='' usemap="#call_graph_for_apidoc_links_2" ismap="ismap" class="graph-without-title" />
202
<tr><th>Call Graph</th></tr>
209
<td width="15%" align="right" valign="top" class="summary">
210
<span class="summary-type"> </span>
211
</td><td class="summary">
212
<table width="100%" cellpadding="0" cellspacing="0" border="0">
214
<td><span class="summary-sig"><a name="is_type"></a><span class="summary-sig-name">is_type</span>(<span class="summary-sig-arg">self</span>)</span></td>
215
<td align="right" valign="top">
216
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#ClassDoc.is_type">source code</a></span>
217
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_is_type-summary-div');return false;">call graph</a></span>
221
<div style="display:none" id="call_graph_for_is_type-summary-div"><center>
222
<table border="0" cellpadding="0" cellspacing="0">
223
<tr><td><center> <map id="call_graph_for_is_type" name="call_graph_for_is_type">
224
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#is_type" title="is_type()" alt="" coords="393,34,481,66" />
225
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__cmp__" title="DottedName.__cmp__()" alt="" coords="532,6,735,38" />
226
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="DottedName.__init__()" alt="" coords="535,62,732,94" />
227
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class" title="docwriter.html.HTMLWriter.write_class()" alt="" coords="5,34,344,66" />
229
<img src="call_graph_for_is_type.gif" alt='' usemap="#call_graph_for_is_type" ismap="ismap" class="graph-without-title" />
231
<tr><th>Call Graph</th></tr>
238
<td width="15%" align="right" valign="top" class="summary">
239
<span class="summary-type"> </span>
240
</td><td class="summary">
241
<table width="100%" cellpadding="0" cellspacing="0" border="0">
243
<td><span class="summary-sig"><a name="is_exception"></a><span class="summary-sig-name">is_exception</span>(<span class="summary-sig-arg">self</span>)</span></td>
244
<td align="right" valign="top">
245
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#ClassDoc.is_exception">source code</a></span>
246
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_is_exception-summary-div');return false;">call graph</a></span>
250
<div style="display:none" id="call_graph_for_is_exception-summary-div"><center>
251
<table border="0" cellpadding="0" cellspacing="0">
252
<tr><td><center> <map id="call_graph_for_is_exception" name="call_graph_for_is_exception">
253
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#is_exception" title="is_exception()" alt="" coords="393,34,521,66" />
254
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__cmp__" title="DottedName.__cmp__()" alt="" coords="572,6,775,38" />
255
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="DottedName.__init__()" alt="" coords="575,62,772,94" />
256
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class" title="docwriter.html.HTMLWriter.write_class()" alt="" coords="5,34,344,66" />
258
<img src="call_graph_for_is_exception.gif" alt='' usemap="#call_graph_for_is_exception" ismap="ismap" class="graph-without-title" />
260
<tr><th>Call Graph</th></tr>
267
<td width="15%" align="right" valign="top" class="summary">
268
<span class="summary-type"> </span>
269
</td><td class="summary">
270
<table width="100%" cellpadding="0" cellspacing="0" border="0">
272
<td><span class="summary-sig"><a name="is_newstyle_class"></a><span class="summary-sig-name">is_newstyle_class</span>(<span class="summary-sig-arg">self</span>)</span></td>
273
<td align="right" valign="top">
274
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#ClassDoc.is_newstyle_class">source code</a></span>
275
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_is_newstyle_cla-summary-div');return false;">call graph</a></span>
279
<div style="display:none" id="call_graph_for_is_newstyle_cla-summary-div"><center>
280
<table border="0" cellpadding="0" cellspacing="0">
281
<tr><td><center> <map id="call_graph_for_is_newstyle_cla" name="call_graph_for_is_newstyle_cla">
282
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#is_newstyle_class" title="is_newstyle_class()" alt="" coords="119,34,287,66" />
283
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__cmp__" title="DottedName.__cmp__()" alt="" coords="338,6,540,38" />
284
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="DottedName.__init__()" alt="" coords="340,62,538,94" />
285
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#mro" title="mro()" alt="" coords="6,34,70,66" />
287
<img src="call_graph_for_is_newstyle_cla.gif" alt='' usemap="#call_graph_for_is_newstyle_cla" ismap="ismap" class="graph-without-title" />
289
<tr><th>Call Graph</th></tr>
296
<td width="15%" align="right" valign="top" class="summary">
297
<span class="summary-type"> </span>
298
</td><td class="summary">
299
<table width="100%" cellpadding="0" cellspacing="0" border="0">
301
<td><span class="summary-sig"><a name="mro"></a><span class="summary-sig-name">mro</span>(<span class="summary-sig-arg">self</span>,
302
<span class="summary-sig-arg">warn_about_bad_bases</span>=<span class="summary-sig-default">False</span>)</span></td>
303
<td align="right" valign="top">
304
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#ClassDoc.mro">source code</a></span>
305
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_mro-summary-div');return false;">call graph</a></span>
309
<div style="display:none" id="call_graph_for_mro-summary-div"><center>
310
<table border="0" cellpadding="0" cellspacing="0">
311
<tr><td><center> <map id="call_graph_for_mro" name="call_graph_for_mro">
312
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#_c3_mro" title="_c3_mro()" alt="" coords="619,62,720,94" />
313
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#_dfs_bases" title="_dfs_bases()" alt="" coords="611,118,728,150" />
314
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#is_newstyle_class" title="is_newstyle_class()" alt="" coords="585,174,753,206" />
315
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#mro" title="mro()" alt="" coords="472,118,536,150" />
316
<area shape="rect" href="epydoc.docbuilder-module.html#find_overrides" title="docbuilder.find_overrides()" alt="" coords="101,6,328,38" />
317
<area shape="rect" href="epydoc.docbuilder-module.html#inherit_docs" title="docbuilder.inherit_docs()" alt="" coords="109,62,320,94" />
318
<area shape="rect" href="epydoc.docwriter.dotgraph-module.html#uml_class_tree_graph" title="docwriter.dotgraph.uml_class_tree_graph()" alt="" coords="43,118,387,150" />
319
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree" title="docwriter.html.HTMLWriter.write_class_tree()" alt="" coords="27,174,403,206" />
320
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_inheritance_list" title="docwriter.html.HTMLWriter.write_inheritance_list()" alt="" coords="7,230,423,262" />
322
<img src="call_graph_for_mro.gif" alt='' usemap="#call_graph_for_mro" ismap="ismap" class="graph-without-title" />
324
<tr><th>Call Graph</th></tr>
331
<td width="15%" align="right" valign="top" class="summary">
332
<span class="summary-type"> </span>
333
</td><td class="summary">
334
<table width="100%" cellpadding="0" cellspacing="0" border="0">
336
<td><span class="summary-sig"><a name="_dfs_bases"></a><span class="summary-sig-name">_dfs_bases</span>(<span class="summary-sig-arg">self</span>,
337
<span class="summary-sig-arg">mro</span>,
338
<span class="summary-sig-arg">seen</span>,
339
<span class="summary-sig-arg">warn_about_bad_bases</span>)</span></td>
340
<td align="right" valign="top">
341
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#ClassDoc._dfs_bases">source code</a></span>
342
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__dfs_bases-summary-div');return false;">call graph</a></span>
346
<div style="display:none" id="call_graph_for__dfs_bases-summary-div"><center>
347
<table border="0" cellpadding="0" cellspacing="0">
348
<tr><td><center> <map id="call_graph_for__dfs_bases" name="call_graph_for__dfs_bases">
349
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="APIDoc.__hash__()" alt="" coords="284,30,455,62" />
350
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#_dfs_bases" title="_dfs_bases()" alt="" coords="117,30,235,62" />
351
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#mro" title="mro()" alt="" coords="5,30,69,62" />
353
<img src="call_graph_for__dfs_bases.gif" alt='' usemap="#call_graph_for__dfs_bases" ismap="ismap" class="graph-without-title" />
355
<tr><th>Call Graph</th></tr>
362
<td width="15%" align="right" valign="top" class="summary">
363
<span class="summary-type"> </span>
364
</td><td class="summary">
365
<table width="100%" cellpadding="0" cellspacing="0" border="0">
367
<td><span class="summary-sig"><a href="epydoc.apidoc.ClassDoc-class.html#_c3_mro" class="summary-sig-name" onclick="show_private();">_c3_mro</a>(<span class="summary-sig-arg">self</span>,
368
<span class="summary-sig-arg">warn_about_bad_bases</span>)</span><br />
369
Compute the class precedence list (mro) according to C3.</td>
370
<td align="right" valign="top">
371
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#ClassDoc._c3_mro">source code</a></span>
372
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__c3_mro-summary-div');return false;">call graph</a></span>
376
<div style="display:none" id="call_graph_for__c3_mro-summary-div"><center>
377
<table border="0" cellpadding="0" cellspacing="0">
378
<tr><td><center> <map id="call_graph_for__c3_mro" name="call_graph_for__c3_mro">
379
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#_c3_merge" title="_c3_merge()" alt="" coords="268,6,385,38" />
380
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#_c3_mro" title="_c3_mro()" alt="" coords="117,6,219,38" />
381
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#mro" title="mro()" alt="" coords="5,6,69,38" />
383
<img src="call_graph_for__c3_mro.gif" alt='' usemap="#call_graph_for__c3_mro" 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_bad_base"></a><span class="summary-sig-name">_report_bad_base</span>(<span class="summary-sig-arg">self</span>,
398
<span class="summary-sig-arg">base</span>)</span></td>
399
<td align="right" valign="top">
400
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#ClassDoc._report_bad_base">source code</a></span>
409
<td width="15%" align="right" valign="top" class="summary">
410
<span class="summary-type"> </span>
411
</td><td class="summary">
412
<table width="100%" cellpadding="0" cellspacing="0" border="0">
414
<td><span class="summary-sig"><a name="_c3_merge"></a><span class="summary-sig-name">_c3_merge</span>(<span class="summary-sig-arg">self</span>,
415
<span class="summary-sig-arg">seqs</span>)</span><br />
416
Helper function for <a
417
href="epydoc.apidoc.ClassDoc-class.html#_c3_mro" class="link"
418
onclick="show_private();">_c3_mro</a>.</td>
419
<td align="right" valign="top">
420
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#ClassDoc._c3_merge">source code</a></span>
421
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__c3_merge-summary-div');return false;">call graph</a></span>
425
<div style="display:none" id="call_graph_for__c3_merge-summary-div"><center>
426
<table border="0" cellpadding="0" cellspacing="0">
427
<tr><td><center> <map id="call_graph_for__c3_merge" name="call_graph_for__c3_merge">
428
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="APIDoc.__cmp__()" alt="" coords="323,6,494,38" />
429
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#_c3_merge" title="_c3_merge()" alt="" coords="156,6,274,38" />
430
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#_c3_mro" title="_c3_mro()" alt="" coords="6,6,107,38" />
432
<img src="call_graph_for__c3_merge.gif" alt='' usemap="#call_graph_for__c3_merge" ismap="ismap" class="graph-without-title" />
434
<tr><th>Call Graph</th></tr>
441
<td width="15%" align="right" valign="top" class="summary">
442
<span class="summary-type"> </span>
443
</td><td class="summary">
444
<table width="100%" cellpadding="0" cellspacing="0" border="0">
446
<td><span class="summary-sig"><a href="epydoc.apidoc.ClassDoc-class.html#select_variables" class="summary-sig-name">select_variables</a>(<span class="summary-sig-arg">self</span>,
447
<span class="summary-sig-arg">group</span>=<span class="summary-sig-default">None</span>,
448
<span class="summary-sig-arg">value_type</span>=<span class="summary-sig-default">None</span>,
449
<span class="summary-sig-arg">inherited</span>=<span class="summary-sig-default">None</span>,
450
<span class="summary-sig-arg">public</span>=<span class="summary-sig-default">None</span>,
451
<span class="summary-sig-arg">imported</span>=<span class="summary-sig-default">None</span>,
452
<span class="summary-sig-arg">detailed</span>=<span class="summary-sig-default">None</span>)</span><br />
453
Return a specified subset of this class's <a
454
href="epydoc.apidoc.NamespaceDoc-class.html#sorted_variables"
455
class="link">sorted_variables</a> list.</td>
456
<td align="right" valign="top">
457
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#ClassDoc.select_variables">source code</a></span>
458
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_select_variable-summary-div');return false;">call graph</a></span>
462
<div style="display:none" id="call_graph_for_select_variable-summary-div"><center>
463
<table border="0" cellpadding="0" cellspacing="0">
464
<tr><td><center> <map id="call_graph_for_select_variable" name="call_graph_for_select_variable">
465
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="APIDoc.__cmp__()" alt="" coords="697,6,868,38" />
466
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#select_variables" title="select_variables()" alt="" coords="473,34,625,66" />
467
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#is_detailed" title="VariableDoc.is_detailed()" alt="" coords="675,62,891,94" />
468
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_list" title="docwriter.html.HTMLWriter.write_details_list()" alt="" coords="24,6,405,38" />
469
<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" />
471
<img src="call_graph_for_select_variable.gif" alt='' usemap="#call_graph_for_select_variable" ismap="ismap" class="graph-without-title" />
473
<tr><th>Call Graph</th></tr>
480
<td colspan="2" class="summary">
481
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.NamespaceDoc-class.html">NamespaceDoc</a></code></b>:
482
<code><a href="epydoc.apidoc.NamespaceDoc-class.html#__init__">__init__</a></code>,
483
<code><a href="epydoc.apidoc.NamespaceDoc-class.html#group_names">group_names</a></code>,
484
<code><a href="epydoc.apidoc.NamespaceDoc-class.html#init_sorted_variables">init_sorted_variables</a></code>,
485
<code><a href="epydoc.apidoc.NamespaceDoc-class.html#init_variable_groups">init_variable_groups</a></code>,
486
<code><a href="epydoc.apidoc.NamespaceDoc-class.html#is_detailed">is_detailed</a></code>,
487
<code><a href="epydoc.apidoc.NamespaceDoc-class.html#report_unused_groups">report_unused_groups</a></code>
489
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.NamespaceDoc-class.html">NamespaceDoc</a></code></b> (private):
490
<code><a href="epydoc.apidoc.NamespaceDoc-class.html#_init_grouping" onclick="show_private();">_init_grouping</a></code>
492
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
493
<code><a href="epydoc.apidoc.ValueDoc-class.html#__getstate__">__getstate__</a></code>,
494
<code><a href="epydoc.apidoc.ValueDoc-class.html#__repr__">__repr__</a></code>,
495
<code><a href="epydoc.apidoc.ValueDoc-class.html#__setstate__">__setstate__</a></code>
497
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b>:
498
<code><a href="epydoc.apidoc.APIDoc-class.html#__cmp__">__cmp__</a></code>,
499
<code><a href="epydoc.apidoc.APIDoc-class.html#__hash__">__hash__</a></code>,
500
<code><a href="epydoc.apidoc.APIDoc-class.html#__setattr__">__setattr__</a></code>,
501
<code><a href="epydoc.apidoc.APIDoc-class.html#__str__">__str__</a></code>,
502
<code><a href="epydoc.apidoc.APIDoc-class.html#merge_and_overwrite">merge_and_overwrite</a></code>,
503
<code><a href="epydoc.apidoc.APIDoc-class.html#pp">pp</a></code>,
504
<code><a href="epydoc.apidoc.APIDoc-class.html#specialize_to">specialize_to</a></code>
506
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b> (private):
507
<code><a href="epydoc.apidoc.APIDoc-class.html#_debug_setattr" onclick="show_private();">_debug_setattr</a></code>
509
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
510
<code>__delattr__</code>,
511
<code>__getattribute__</code>,
512
<code>__new__</code>,
513
<code>__reduce__</code>,
514
<code>__reduce_ex__</code>
518
<tr bgcolor="#e8f0f8" >
519
<th colspan="2" class="group-header"
520
> Value Representation</th></tr>
522
<td colspan="2" class="summary">
523
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
524
<code><a href="epydoc.apidoc.ValueDoc-class.html#pyval_repr">pyval_repr</a></code>,
525
<code><a href="epydoc.apidoc.ValueDoc-class.html#summary_pyval_repr">summary_pyval_repr</a></code>
530
<!-- ==================== CLASS VARIABLES ==================== -->
531
<a name="section-ClassVariables"></a>
532
<table class="summary" border="1" cellpadding="3"
533
cellspacing="0" width="100%" bgcolor="white">
534
<tr bgcolor="#70b0f0" class="table-header">
535
<td colspan="2" class="table-header">
536
<table border="0" cellpadding="0" cellspacing="0" width="100%">
538
<td align="left"><span class="table-header">Class Variables</span></td>
539
<td align="right" valign="top"
540
><span class="options">[<a href="#section-ClassVariables"
541
class="privatelink" onclick="toggle_private();"
542
>hide private</a>]</span></td>
547
<tr bgcolor="#e8f0f8" >
548
<th colspan="2" class="group-header"
549
> Value Representation</th></tr>
551
<td colspan="2" class="summary">
552
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
553
<code><a href="epydoc.apidoc.ValueDoc-class.html#REPR_LINELEN">REPR_LINELEN</a></code>,
554
<code><a href="epydoc.apidoc.ValueDoc-class.html#REPR_MAXLINES">REPR_MAXLINES</a></code>,
555
<code><a href="epydoc.apidoc.ValueDoc-class.html#REPR_MIN_SCORE">REPR_MIN_SCORE</a></code>,
556
<code><a href="epydoc.apidoc.ValueDoc-class.html#SUMMARY_REPR_LINELEN">SUMMARY_REPR_LINELEN</a></code>
561
<!-- ==================== INSTANCE VARIABLES ==================== -->
562
<a name="section-InstanceVariables"></a>
563
<table class="summary" border="1" cellpadding="3"
564
cellspacing="0" width="100%" bgcolor="white">
565
<tr bgcolor="#70b0f0" class="table-header">
566
<td colspan="2" class="table-header">
567
<table border="0" cellpadding="0" cellspacing="0" width="100%">
569
<td align="left"><span class="table-header">Instance Variables</span></td>
570
<td align="right" valign="top"
571
><span class="options">[<a href="#section-InstanceVariables"
572
class="privatelink" onclick="toggle_private();"
573
>hide private</a>]</span></td>
579
<td colspan="2" class="summary">
580
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
581
<code><a href="epydoc.apidoc.ValueDoc-class.html#canonical_name">canonical_name</a></code>,
582
<code><a href="epydoc.apidoc.ValueDoc-class.html#toktree">toktree</a></code>
586
<tr bgcolor="#e8f0f8" >
587
<th colspan="2" class="group-header"
588
> Information about Base Classes</th></tr>
590
<td width="15%" align="right" valign="top" class="summary">
591
<span class="summary-type"><code>list</code> of <a href="epydoc.apidoc.ClassDoc-class.html"
592
class="link">ClassDoc</a></span>
593
</td><td class="summary">
594
<a name="bases"></a><span class="summary-name">bases</span> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
595
API documentation for the class's base classes.
598
<tr bgcolor="#e8f0f8" >
599
<th colspan="2" class="group-header"
600
> Information about Subclasses</th></tr>
602
<td width="15%" align="right" valign="top" class="summary">
603
<span class="summary-type"><code>list</code> of <a href="epydoc.apidoc.ClassDoc-class.html"
604
class="link">ClassDoc</a></span>
605
</td><td class="summary">
606
<a name="subclasses"></a><span class="summary-name">subclasses</span> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
607
API documentation for the class's known subclasses.
610
<tr bgcolor="#e8f0f8" >
611
<th colspan="2" class="group-header"
612
> Information about Variables</th></tr>
614
<td colspan="2" class="summary">
615
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.NamespaceDoc-class.html">NamespaceDoc</a></code></b>:
616
<code><a href="epydoc.apidoc.NamespaceDoc-class.html#group_specs">group_specs</a></code>,
617
<code><a href="epydoc.apidoc.NamespaceDoc-class.html#sort_spec">sort_spec</a></code>,
618
<code><a href="epydoc.apidoc.NamespaceDoc-class.html#sorted_variables">sorted_variables</a></code>,
619
<code><a href="epydoc.apidoc.NamespaceDoc-class.html#variable_groups">variable_groups</a></code>,
620
<code><a href="epydoc.apidoc.NamespaceDoc-class.html#variables">variables</a></code>
624
<tr bgcolor="#e8f0f8" >
625
<th colspan="2" class="group-header"
626
> Value Representation</th></tr>
628
<td colspan="2" class="summary">
629
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
630
<code><a href="epydoc.apidoc.ValueDoc-class.html#parse_repr">parse_repr</a></code>,
631
<code><a href="epydoc.apidoc.ValueDoc-class.html#pyval">pyval</a></code>
635
<tr bgcolor="#e8f0f8" >
636
<th colspan="2" class="group-header"
637
> Context</th></tr>
639
<td colspan="2" class="summary">
640
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
641
<code><a href="epydoc.apidoc.ValueDoc-class.html#defining_module">defining_module</a></code>
645
<tr bgcolor="#e8f0f8" >
646
<th colspan="2" class="group-header"
647
> Information about Imported Variables</th></tr>
649
<td colspan="2" class="summary">
650
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.ValueDoc-class.html">ValueDoc</a></code></b>:
651
<code><a href="epydoc.apidoc.ValueDoc-class.html#proxy_for">proxy_for</a></code>
655
<tr bgcolor="#e8f0f8" >
656
<th colspan="2" class="group-header"
657
> Docstrings</th></tr>
659
<td colspan="2" class="summary">
660
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b>:
661
<code><a href="epydoc.apidoc.APIDoc-class.html#docstring">docstring</a></code>,
662
<code><a href="epydoc.apidoc.APIDoc-class.html#docstring_lineno">docstring_lineno</a></code>
666
<tr bgcolor="#e8f0f8" >
667
<th colspan="2" class="group-header"
668
> Information Extracted from Docstrings</th></tr>
670
<td colspan="2" class="summary">
671
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b>:
672
<code><a href="epydoc.apidoc.APIDoc-class.html#descr">descr</a></code>,
673
<code><a href="epydoc.apidoc.APIDoc-class.html#extra_docstring_fields">extra_docstring_fields</a></code>,
674
<code><a href="epydoc.apidoc.APIDoc-class.html#metadata">metadata</a></code>,
675
<code><a href="epydoc.apidoc.APIDoc-class.html#other_docs">other_docs</a></code>,
676
<code><a href="epydoc.apidoc.APIDoc-class.html#summary">summary</a></code>
680
<tr bgcolor="#e8f0f8" >
681
<th colspan="2" class="group-header"
682
> Source Information</th></tr>
684
<td colspan="2" class="summary">
685
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="epydoc.apidoc.APIDoc-class.html">APIDoc</a></code></b>:
686
<code><a href="epydoc.apidoc.APIDoc-class.html#docs_extracted_by">docs_extracted_by</a></code>
691
<!-- ==================== PROPERTIES ==================== -->
692
<a name="section-Properties"></a>
693
<table class="summary" border="1" cellpadding="3"
694
cellspacing="0" width="100%" bgcolor="white">
695
<tr bgcolor="#70b0f0" class="table-header">
696
<td colspan="2" class="table-header">
697
<table border="0" cellpadding="0" cellspacing="0" width="100%">
699
<td align="left"><span class="table-header">Properties</span></td>
700
<td align="right" valign="top"
701
><span class="options">[<a href="#section-Properties"
702
class="privatelink" onclick="toggle_private();"
703
>hide private</a>]</span></td>
709
<td colspan="2" class="summary">
710
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
711
<code>__class__</code>
716
<!-- ==================== METHOD DETAILS ==================== -->
717
<a name="section-MethodDetails"></a>
718
<table class="details" border="1" cellpadding="3"
719
cellspacing="0" width="100%" bgcolor="white">
720
<tr bgcolor="#70b0f0" class="table-header">
721
<td colspan="2" class="table-header">
722
<table border="0" cellpadding="0" cellspacing="0" width="100%">
724
<td align="left"><span class="table-header">Method Details</span></td>
725
<td align="right" valign="top"
726
><span class="options">[<a href="#section-MethodDetails"
727
class="privatelink" onclick="toggle_private();"
728
>hide private</a>]</span></td>
734
<a name="apidoc_links"></a>
736
<table class="details" border="1" cellpadding="3"
737
cellspacing="0" width="100%" bgcolor="white">
739
<table width="100%" cellpadding="0" cellspacing="0" border="0">
740
<tr valign="top"><td>
741
<h3 class="epydoc"><span class="sig"><span class="sig-name">apidoc_links</span>(<span class="sig-arg">self</span>,
742
<span class="sig-arg">**filters</span>)</span>
744
</td><td align="right" valign="top"
745
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#ClassDoc.apidoc_links">source code</a></span>
746
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_apidoc_links_2-div');return false;">call graph</a></span> </td>
748
<div style="display:none" id="call_graph_for_apidoc_links_2-div"><center>
749
<table border="0" cellpadding="0" cellspacing="0">
750
<tr><td><center> <map id="call_graph_for_apidoc_links_2" name="call_graph_for_apidoc_links_2">
751
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#apidoc_links" title="apidoc_links()" alt="" coords="359,34,487,66" />
752
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#apidoc_links" title="NamespaceDoc.apidoc_links()" alt="" coords="538,34,788,66" />
753
<area shape="rect" href="epydoc.apidoc-module.html#reachable_valdocs" title="reachable_valdocs()" alt="" coords="71,6,244,38" />
754
<area shape="rect" href="epydoc.docbuilder-module.html#assign_canonical_names" title="docbuilder.assign_canonical_names()" alt="" coords="7,62,308,94" />
756
<img src="call_graph_for_apidoc_links_2.gif" alt='' usemap="#call_graph_for_apidoc_links_2" ismap="ismap" class="graph-without-title" />
758
<tr><th>Call Graph</th></tr>
762
<p>Return a list of all <code>APIDoc</code>s that are directly linked
763
from this <code>APIDoc</code> (i.e., are contained or pointed to by one
764
or more of this <code>APIDoc</code>'s attributes.)</p>
765
<p>Keyword argument <code>filters</code> can be used to selectively
766
exclude certain categories of attribute value. For example, using
767
<code>includes=False</code> will exclude variables that were imported
768
from other modules; and <code>subclasses=False</code> will exclude
769
subclasses. The filter categories currently supported by epydoc are:</p>
772
<code>imports</code>: Imported variables.
775
<code>packages</code>: Containing packages for modules.
778
<code>submodules</code>: Contained submodules for packages.
781
<code>bases</code>: Bases for classes.
784
<code>subclasses</code>: Subclasses for classes.
787
<code>variables</code>: All variables.
790
<code>private</code>: Private variables.
793
<code>overrides</code>: Points from class variables to the variables
794
they override. This filter is False by default.
799
<a href="epydoc.apidoc.APIDoc-class.html#apidoc_links">APIDoc.apidoc_links</a>
800
<dd><em class="note">(inherited documentation)</em></dd>
805
<a name="_c3_mro"></a>
806
<div class="private">
807
<table class="details" border="1" cellpadding="3"
808
cellspacing="0" width="100%" bgcolor="white">
810
<table width="100%" cellpadding="0" cellspacing="0" border="0">
811
<tr valign="top"><td>
812
<h3 class="epydoc"><span class="sig"><span class="sig-name">_c3_mro</span>(<span class="sig-arg">self</span>,
813
<span class="sig-arg">warn_about_bad_bases</span>)</span>
815
</td><td align="right" valign="top"
816
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#ClassDoc._c3_mro">source code</a></span>
817
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__c3_mro-div');return false;">call graph</a></span> </td>
819
<div style="display:none" id="call_graph_for__c3_mro-div"><center>
820
<table border="0" cellpadding="0" cellspacing="0">
821
<tr><td><center> <map id="call_graph_for__c3_mro" name="call_graph_for__c3_mro">
822
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#_c3_merge" title="_c3_merge()" alt="" coords="268,6,385,38" />
823
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#_c3_mro" title="_c3_mro()" alt="" coords="117,6,219,38" />
824
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#mro" title="mro()" alt="" coords="5,6,69,38" />
826
<img src="call_graph_for__c3_mro.gif" alt='' usemap="#call_graph_for__c3_mro" ismap="ismap" class="graph-without-title" />
828
<tr><th>Call Graph</th></tr>
832
<p>Compute the class precedence list (mro) according to C3.</p>
835
<div class="fields"> <p><strong>See Also:</strong>
836
<a href="http://www.python.org/2.3/mro.html"
837
target="_top">http://www.python.org/2.3/mro.html</a>
839
</div></td></tr></table>
841
<a name="select_variables"></a>
843
<table class="details" border="1" cellpadding="3"
844
cellspacing="0" width="100%" bgcolor="white">
846
<table width="100%" cellpadding="0" cellspacing="0" border="0">
847
<tr valign="top"><td>
848
<h3 class="epydoc"><span class="sig"><span class="sig-name">select_variables</span>(<span class="sig-arg">self</span>,
849
<span class="sig-arg">group</span>=<span class="sig-default">None</span>,
850
<span class="sig-arg">value_type</span>=<span class="sig-default">None</span>,
851
<span class="sig-arg">inherited</span>=<span class="sig-default">None</span>,
852
<span class="sig-arg">public</span>=<span class="sig-default">None</span>,
853
<span class="sig-arg">imported</span>=<span class="sig-default">None</span>,
854
<span class="sig-arg">detailed</span>=<span class="sig-default">None</span>)</span>
856
</td><td align="right" valign="top"
857
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#ClassDoc.select_variables">source code</a></span>
858
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_select_variable-div');return false;">call graph</a></span> </td>
860
<div style="display:none" id="call_graph_for_select_variable-div"><center>
861
<table border="0" cellpadding="0" cellspacing="0">
862
<tr><td><center> <map id="call_graph_for_select_variable" name="call_graph_for_select_variable">
863
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="APIDoc.__cmp__()" alt="" coords="697,6,868,38" />
864
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#select_variables" title="select_variables()" alt="" coords="473,34,625,66" />
865
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#is_detailed" title="VariableDoc.is_detailed()" alt="" coords="675,62,891,94" />
866
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_list" title="docwriter.html.HTMLWriter.write_details_list()" alt="" coords="24,6,405,38" />
867
<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" />
869
<img src="call_graph_for_select_variable.gif" alt='' usemap="#call_graph_for_select_variable" ismap="ismap" class="graph-without-title" />
871
<tr><th>Call Graph</th></tr>
875
<p>Return a specified subset of this class's <a
876
href="epydoc.apidoc.NamespaceDoc-class.html#sorted_variables"
877
class="link">sorted_variables</a> list. If <code>value_type</code> is
878
given, then only return variables whose values have the specified type.
879
If <code>group</code> is given, then only return variables that belong to
880
the specified group. If <code>inherited</code> is True, then only return
881
inherited variables; if <code>inherited</code> is False, then only return
885
<dd><ul class="nomargin-top">
886
<li><strong class="pname"><code>value_type</code></strong> (<code>string</code>) - A string specifying the value type for which variables should be
887
returned. Valid values are:
890
'instancemethod' - variables whose values are instance
894
'classmethod' - variables whose values are class methods.
897
'staticmethod' - variables whose values are static methods.
900
'properties' - variables whose values are properties.
903
'class' - variables whose values are nested classes
904
(including exceptions and types).
907
'instancevariable' - instance variables. This includes any
908
variables that are explicitly marked as instance variables
909
with docstring fields; and variables with docstrings that are
910
initialized in the constructor.
913
'classvariable' - class variables. This includes any
914
variables that are not included in any of the above
918
<li><strong class="pname"><code>group</code></strong> (<code>string</code>) - The name of the group for which variables should be returned. A
919
complete list of the groups defined by this <code>ClassDoc</code>
920
is available in the <a
921
href="epydoc.apidoc.NamespaceDoc-class.html#group_names"
922
class="link">group_names</a> instance variable. The first
923
element of this list is always the special group name
924
<code>''</code>, which is used for variables that do not belong
926
<li><strong class="pname"><code>inherited</code></strong> - If <code>None</code>, then return both inherited and local
927
variables; if <code>True</code>, then return only inherited
928
variables; if <code>False</code>, then return only local
930
<li><strong class="pname"><code>detailed</code></strong> (<code>bool</code>) - If True (False), return only the variables deserving (not
931
deserving) a detailed informative box. If <code>None</code>,
935
<div class="fields"> <p><strong>Requires:</strong>
937
href="epydoc.apidoc.NamespaceDoc-class.html#sorted_variables"
938
class="link">sorted_variables</a> and <a
939
href="epydoc.apidoc.NamespaceDoc-class.html#variable_groups"
940
class="link">variable_groups</a> attributes must be initialized
941
before this method can be used. See <a
942
href="epydoc.apidoc.NamespaceDoc-class.html#init_sorted_variables"
943
class="link">init_sorted_variables()</a> and <a
944
href="epydoc.apidoc.NamespaceDoc-class.html#init_variable_groups"
945
class="link">init_variable_groups()</a>.
947
</div></td></tr></table>
950
<!-- ==================== NAVIGATION BAR ==================== -->
951
<table class="navbar" border="0" width="100%" cellpadding="0"
952
bgcolor="#a0c0ff" cellspacing="0">
955
<th> <a
956
href="epydoc-module.html">Home</a> </th>
959
<th> <a
960
href="module-tree.html">Trees</a> </th>
963
<th> <a
964
href="identifier-index.html">Indices</a> </th>
967
<th> <a
968
href="help.html">Help</a> </th>
970
<!-- Project homepage -->
971
<th class="navbar" align="right" width="100%">
972
<table border="0" cellpadding="0" cellspacing="0">
973
<tr><th class="navbar" align="center"
974
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
978
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
980
<td align="left" class="footer">
981
<a href="epydoc-log.html">Generated by Epydoc
982
3.0.1 on Wed Jan 30 14:07:01 2008</a>
984
<td align="right" class="footer">
985
<a target="mainFrame" href="http://epydoc.sourceforge.net"
986
>http://epydoc.sourceforge.net</a>
991
<script type="text/javascript">
993
// Private objects are initially displayed (because if
994
// javascript is turned off then we want them to be
995
// visible); but by default, we want to hide them. So hide
996
// them unless we have a cookie that says to show them.
added
removed
doc/api/epydoc.apidoc.ClassDoc-class.html
