~ubuntu-branches/debian/lenny/epydoc/lenny

« back to all changes in this revision

Viewing changes to doc/api/private/epydoc.uid-module.html

  • Committer: Bazaar Package Importer
  • Author(s): Kenneth J. Pronovici
  • Date: 2008-02-03 13:22:12 UTC
  • mfrom: (1.2.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080203132212-u2uohl6rswmlz2ra
Tags: 3.0.1-1
* New upstream release.
* Removed #! from top of epydoc/gui.py
* Got rid of version mangling in debian/watch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?xml version="1.0" encoding="iso-8859-1"?>
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">
5
 
<head>
6
 
  <title>epydoc.uid</title>
7
 
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
8
 
</head>
9
 
<body bgcolor="white" text="black" link="blue" vlink="#204080"
10
 
      alink="#204080">
11
 
 
12
 
<!-- =========== START OF NAVBAR =========== -->
13
 
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
14
 
  <tr valign="center">
15
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="epydoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
16
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
17
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
18
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
19
 
    <th class="navbar" align="right" width="100%">
20
 
      <table border="0" cellpadding="0" cellspacing="0">
21
 
      <tr><th class="navbar" align="center">
22
 
        <p class="nomargin">
23
 
          <a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
24
 
      </p></th></tr></table>
25
 
    </th>
26
 
  </tr>
27
 
</table>
28
 
<table width="100%" cellpadding="0" cellspacing="0">
29
 
  <tr valign="top">
30
 
    <td width="100%">
31
 
      <font size="-1"><b class="breadcrumbs">
32
 
        <a href="epydoc-module.html">Package&nbsp;epydoc</a> ::
33
 
        Module&nbsp;uid
34
 
      </b></font></br>
35
 
    </td>
36
 
    <td><table cellpadding="0" cellspacing="0">
37
 
      <tr><td align="right"><font size="-2">[show&nbsp;private&nbsp;|&nbsp;<a href="../public/epydoc.uid-module.html">hide&nbsp;private</a>]</font></td></tr>
38
 
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="epydoc.uid-module.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
39
 
    </table></td>
40
 
</tr></table>
41
 
 
42
 
<!-- =========== START OF MODULE DESCRIPTION =========== -->
43
 
<h2 class="module">Module epydoc.uid</h2>
44
 
 
45
 
Unique identifiers and crossreference links for Python objects. Each 
46
 
Python object is identified by a globally unique identifier, implemented 
47
 
with the <a href="epydoc.uid.UID-class.html" 
48
 
class="link"><code>UID</code></a> class. It is important that each object 
49
 
have a single unique identifier, because one object may have more than 
50
 
one name. UIDs should be always created using the <a 
51
 
href="epydoc.uid-module.html#make_uid" 
52
 
class="link"><code>make_uid</code></a> function; do not create UIDs 
53
 
directly. The <a href="epydoc.uid.Link-class.html" 
54
 
class="link"><code>Link</code></a> class uses UIDs to implement 
55
 
crossreferencing between <code>ObjDoc</code>s.
56
 
<hr/>
57
 
<p><b>Bugs:</b>
58
 
<ul>
59
 
  <li>UIDs are not generated correctly for nested classes; and in general, 
60
 
nested classes are not well supported. (E.g., they are listed under their 
61
 
module, not their containing class). The effect of this bug is that 
62
 
docstring &quot;<code>L{links}</code>&quot; that refer to the nested 
63
 
class using its normal name (e.g. 
64
 
<code>ContainerClass.NestedClass</code>) won't be resolved correctly. But 
65
 
you should be able to link to it with just <code>NestedClass</code>.
66
 
</li>
67
 
  <li><code>PropertyDoc</code> usually creates an incorrect UID for its 
68
 
fget, fset, and fdel accessors. This arises because they are represented 
69
 
as functions, not methods; so epydoc doesn't have any way to tell what 
70
 
class they were defined in. As a result, it just assumes that they were 
71
 
installed at the module level. The effect of this bug is that the 
72
 
hyperlinks from property accessor methods don't point to the right 
73
 
targets.
74
 
 
75
 
  </li>
76
 
</ul></p>
77
 
 
78
 
<p><b>See Also:</b> <a href="epydoc.objdoc-module.html" 
79
 
class="link"><code>epydoc.objdoc</code></a>
80
 
</p>
81
 
 
82
 
 
83
 
<!-- =========== START OF CLASSES =========== -->
84
 
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
85
 
<tr bgcolor="#70b0f0" class="summary">
86
 
  <th colspan="2">Classes</th></tr>
87
 
<tr><td width="15%">
88
 
  <b><a href="epydoc.uid.ObjectUID-class.html"><code>ObjectUID</code></a></b></td>
89
 
  <td>A globally unique identifier used to refer to a Python object.</td></tr>
90
 
<tr bgcolor="#e8f0f8" class="group">
91
 
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Unique Identifiers</th></tr>
92
 
<tr><td width="15%">
93
 
  <b><a href="epydoc.uid.UID-class.html"><code>UID</code></a></b></td>
94
 
  <td>A globally unique identifier.</td></tr>
95
 
<tr><td width="15%">
96
 
  <b><a href="epydoc.uid.RelativeUID-class.html"><code>RelativeUID</code></a></b></td>
97
 
  <td>A globally unique identifier used to refer to a variable, relative to 
98
 
a Python object.</td></tr>
99
 
<tr><td width="15%">
100
 
  <b><a href="epydoc.uid.VariableUID-class.html"><code>VariableUID</code></a></b></td>
101
 
  <td>&nbsp;</td></tr>
102
 
<tr><td width="15%">
103
 
  <b><a href="epydoc.uid.PropertyUID-class.html"><code>PropertyUID</code></a></b></td>
104
 
  <td>&nbsp;</td></tr>
105
 
<tr><td width="15%">
106
 
  <b><a href="epydoc.uid.StaticMethodUID-class.html"><code>StaticMethodUID</code></a></b></td>
107
 
  <td>&nbsp;</td></tr>
108
 
<tr><td width="15%">
109
 
  <b><a href="epydoc.uid.ClassMethodUID-class.html"><code>ClassMethodUID</code></a></b></td>
110
 
  <td>&nbsp;</td></tr>
111
 
<tr bgcolor="#e8f0f8" class="group">
112
 
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Crossreferences</th></tr>
113
 
<tr><td width="15%">
114
 
  <b><a href="epydoc.uid.Link-class.html"><code>Link</code></a></b></td>
115
 
  <td>A cross-reference link between documentation.</td></tr>
116
 
</table><br />
117
 
 
118
 
 
119
 
<!-- =========== START OF FUNCTION SUMMARY =========== -->
120
 
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
121
 
<tr bgcolor="#70b0f0" class="summary">
122
 
  <th colspan="2">Function Summary</th></tr>
123
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
124
 
  <td><code><span class="summary-sig"><a href="epydoc.uid-module.html#make_uid" class="summary-sig-name"><code>make_uid</code></a>(<span class=summary-sig-arg>object</span>,
125
 
          <span class=summary-sig-arg>base_uid</span>,
126
 
          <span class=summary-sig-arg>shortname</span>)</span></code>
127
 
<br />
128
 
Create a globally unique identifier for the given object.</td></tr>
129
 
<tr><td align="right" valign="top" width="15%"><font size="-1">        <a href="epydoc.uid.UID-class.html" 
130
 
        class="link"><code>UID</code></a> or <code>None</code>
131
 
</font></td>
132
 
  <td><code><span class="summary-sig"><a href="epydoc.uid-module.html#findUID" class="summary-sig-name"><code>findUID</code></a>(<span class=summary-sig-arg>name</span>,
133
 
          <span class=summary-sig-arg>container</span>,
134
 
          <span class=summary-sig-arg>docmap</span>)</span></code>
135
 
<br />
136
 
Attempt to find the UID for the object that can be accessed with the 
137
 
name <code>name</code> from the module <code>module</code>.</td></tr>
138
 
<tr><td align="right" valign="top" width="15%"><font size="-1">        <code>None</code>
139
 
</font></td>
140
 
  <td><code><span class="summary-sig"><a href="epydoc.uid-module.html#reset_uid_cache" class="summary-sig-name"><code>reset_uid_cache</code></a>()</span></code>
141
 
<br />
142
 
Reset the internal cache of UIDs for objects.</td></tr>
143
 
<tr><td align="right" valign="top" width="15%"><font size="-1">        <code>module</code>
144
 
</font></td>
145
 
  <td><code><span class="summary-sig"><a href="../private/epydoc.uid-module.html#_find_builtin_obj_module" class="summary-sig-name"><code>_find_builtin_obj_module</code></a>(<span class=summary-sig-arg>obj</span>,
146
 
          <span class=summary-sig-arg>show_warnings</span>)</span></code>
147
 
<br />
148
 
Return the module that defines the given builtin object.</td></tr>
149
 
<tr><td align="right" valign="top" width="15%"><font size="-1">        <a href="epydoc.uid.UID-class.html" 
150
 
        class="link"><code>UID</code></a> or <code>None</code>
151
 
</font></td>
152
 
  <td><code><span class="summary-sig"><a href="../private/epydoc.uid-module.html#_find_class_child" class="summary-sig-name"><code>_find_class_child</code></a>(<span class=summary-sig-arg>name</span>,
153
 
          <span class=summary-sig-arg>container</span>,
154
 
          <span class=summary-sig-arg>docmap</span>)</span></code>
155
 
<br />
156
 
Search for a child object named <code>name</code> in the class whose 
157
 
UID is <code>container</code>, given the DocMap <code>docmap</code>.</td></tr>
158
 
<tr><td align="right" valign="top" width="15%"><font size="-1">        <code>module</code>
159
 
</font></td>
160
 
  <td><code><span class="summary-sig"><a href="../private/epydoc.uid-module.html#_find_function_module" class="summary-sig-name"><code>_find_function_module</code></a>(<span class=summary-sig-arg>func</span>)</span></code>
161
 
<br />
162
 
Return the module that defines the given function.</td></tr>
163
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
164
 
  <td><code><a name="_find_name_in"></a><span class="summary-sig"><span class="summary-sig-name">_find_name_in</span>(<span class=summary-sig-arg>obj</span>,
165
 
          <span class=summary-sig-arg>module</span>)</span></code>
166
 
</td></tr>
167
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
168
 
  <td><code><span class="summary-sig"><a href="../private/epydoc.uid-module.html#_find_object_in_module" class="summary-sig-name"><code>_find_object_in_module</code></a>(<span class=summary-sig-arg>name</span>,
169
 
          <span class=summary-sig-arg>module</span>,
170
 
          <span class=summary-sig-arg>docmap</span>)</span></code>
171
 
<br />
172
 
Search for an object or variable named <code>name</code> in the given 
173
 
module, given the DocMap <code>docmap</code>.</td></tr>
174
 
<tr><td align="right" valign="top" width="15%"><font size="-1">        <a href="epydoc.uid.UID-class.html" 
175
 
        class="link"><code>UID</code></a> or <code>None</code>
176
 
</font></td>
177
 
  <td><code><span class="summary-sig"><a href="../private/epydoc.uid-module.html#_find_variable_in" class="summary-sig-name"><code>_find_variable_in</code></a>(<span class=summary-sig-arg>name</span>,
178
 
          <span class=summary-sig-arg>container</span>,
179
 
          <span class=summary-sig-arg>docmap</span>)</span></code>
180
 
<br />
181
 
Search for a variable named <code>name</code> in the module or class 
182
 
whose UID is <code>container</code>, given the DocMap 
183
 
<code>docmap</code>.</td></tr>
184
 
<tr><td align="right" valign="top" width="15%"><font size="-1">        <code>boolean</code>
185
 
</font></td>
186
 
  <td><code><span class="summary-sig"><a href="../private/epydoc.uid-module.html#_is_parameter_for" class="summary-sig-name"><code>_is_parameter_for</code></a>(<span class=summary-sig-arg>name</span>,
187
 
          <span class=summary-sig-arg>container</span>,
188
 
          <span class=summary-sig-arg>docmap</span>)</span></code>
189
 
<br />
190
 
Return true if <code>name</code> is the name of a parameter for the routine 
191
 
<code>container</code>, given the DocMap <code>docmap</code>.</td></tr>
192
 
</table><br />
193
 
 
194
 
 
195
 
<!-- =========== START OF VARIABLE SUMMARY =========== -->
196
 
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
197
 
<tr bgcolor="#70b0f0" class="summary">
198
 
  <th colspan="2">Variable Summary</th></tr>
199
 
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
200
 
<td><b><a href="../private/epydoc.uid-module.html#_find_builtin_obj_module_cache"><code>_find_builtin_obj_module_cache</code></a></b> = <span title="{135227264: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;, 135219520: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;, 138468136: &lt;module 'thread' (built-in)&gt;, 135227456: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;, 135227744: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;, 135174176: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;, 135275016: &lt;module 'sys' (built-in)&gt;, 135209504: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;, 135213248: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;, 135276344: &lt;module 'sys' (built-in)&gt;, 135275704: &lt;module 'sys'..."><code>{135227264:&nbsp;&lt;module&nbsp;'ty<span class="variable-ellipsis">...</span></code>
201
 
</span></td></tr>
202
 
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
203
 
<td><b><a href="../private/epydoc.uid-module.html#_name_to_uid"><code>_name_to_uid</code></a></b> = <span title="{'Tkinter.Toplevel': &lt;UID: Tkinter.Toplevel&gt;, 'epydoc.markup.epytext.ParsedEpytextDocstring._to_latex': &lt;UID: epydoc.markup.epytext.ParsedEpytextDocstring._to_latex&gt;, 'epydoc.gui.LISTBOX_CONFIG': &lt;UID: epydoc.gui.LISTBOX_CONFIG&gt;, 'epydoc.gui.VERTICAL': &lt;UID: epydoc.gui.VERTICAL&gt;, 'docutils.Component': &lt;UID: docutils.Component&gt;, 'docutils.writers.html4css1.HTMLTranslator.depart_version': &lt;UID: docutils.writers.html4css1.HTMLTranslator.depart_version&gt;, 'epydoc.markup.wordwrap': &lt;UID: epydoc.markup.wordwrap&gt;, 'epydoc.imports._DevNull.__init__': &lt;UID: epydoc.imports._DevNull.__init__&gt;, 'epydoc...."><code>{'Tkinter.Toplevel':&nbsp;&lt;UID:&nbsp;Tkinter.Toplev<span class="variable-ellipsis">...</span></code>
204
 
</span></td></tr>
205
 
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
206
 
<td><b><a href="../private/epydoc.uid-module.html#_object_uids"><code>_object_uids</code></a></b> = <span title="{(139460820, 139457492): &lt;UID: epydoc.html.HTMLFormatter._write_class_summary_row&gt;, (137853172, 139457492): &lt;UID: epydoc.html.HTMLFormatter._write_var_summary&gt;, (136674596, 136674308): &lt;UID: epydoc.objdoc.ClassDoc._add_inheritance_groups&gt;, 135821316: &lt;UID: docutils.frontend&gt;, 135902892: &lt;UID: epydoc.markup.DocstringLinker&gt;, (136355516, 137858164): &lt;UID: epydoc.html._DevNull.close&gt;, (136064188, 136091004): &lt;UID: docutils.writers.html4css1.HTMLTranslator.visit_transition&gt;, 136980492: &lt;UID: epydoc.cli._version&gt;, (136073148, 136091004): &lt;UID: docutils.writers.html4css1.HTMLTranslator.visit_foot..."><code>{(139460820,&nbsp;139457492):&nbsp;&lt;UID:&nbsp;epydoc.htm<span class="variable-ellipsis">...</span></code>
207
 
</span></td></tr>
208
 
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
209
 
<td><b><a href="../private/epydoc.uid-module.html#_variable_uids"><code>_variable_uids</code></a></b> = <span title="{(137736676, 'AUTHOR'): &lt;UID: epydoc.checker.DocChecker.AUTHOR&gt;, (137460204, 'settings_defaults'): &lt;UID: docutils.SettingsSpec.settings_defaults&gt;, (137857892, 'HTML_HELP'): &lt;UID: epydoc.help.HTML_HELP&gt;, (135672180, '__url__'): &lt;UID: epydoc.__url__&gt;, (137903116, '_name_to_uid'): &lt;UID: epydoc.uid._name_to_uid&gt;, (136458884, '__builtins__'): &lt;UID: epydoc.markup.javadoc.__builtins__&gt;, (137903116, '__doc__'): &lt;UID: epydoc.uid.__doc__&gt;, (135274748, 'exc_traceback'): &lt;UID: sys.exc_traceback&gt;, (137785684, 'BOTH'): &lt;UID: epydoc.gui.BOTH&gt;, (139452988, 'indent'): &lt;UID: epydoc.markup.epytext.Token.inden..."><code>{(137736676,&nbsp;'AUTHOR'):&nbsp;&lt;UID:&nbsp;epydoc.ch<span class="variable-ellipsis">...</span></code>
210
 
</span></td></tr>
211
 
</table><br />
212
 
 
213
 
 
214
 
<!-- =========== START OF FUNCTION DETAILS =========== -->
215
 
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
216
 
<tr bgcolor="#70b0f0" class="details">
217
 
  <th colspan="2">Function Details</th></tr>
218
 
</table>
219
 
 
220
 
<a name="make_uid"></a>
221
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
222
 
  <h3><span class="sig"><span class="sig-name">make_uid</span>(<span class=sig-arg>object</span>,
223
 
          <span class=sig-arg>base_uid</span>=<span class=sig-default>None</span>,
224
 
          <span class=sig-arg>shortname</span>=<span class=sig-default>None</span>)</span>
225
 
  </h3>
226
 
  Create a globally unique identifier for the given object.
227
 
  <dl><dt></dt><dd>
228
 
  </dd></dl>
229
 
</td></tr></table>
230
 
 
231
 
<a name="findUID"></a>
232
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
233
 
  <h3><span class="sig"><span class="sig-name">findUID</span>(<span class=sig-arg>name</span>,
234
 
          <span class=sig-arg>container</span>=<span class=sig-default>None</span>,
235
 
          <span class=sig-arg>docmap</span>=<span class=sig-default>None</span>)</span>
236
 
  </h3>
237
 
  Attempt to find the UID for the object that can be accessed with the 
238
 
  name <code>name</code> from the module <code>module</code>.
239
 
  <dl><dt></dt><dd>
240
 
    <dl><dt><b>Parameters:</b></dt>
241
 
      <dd><code><b>name</b></code> -
242
 
         The name used to identify the object.
243
 
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
244
 
        (type=<code>string</code>)</i>
245
 
      <dd><code><b>container</b></code> -
246
 
         The UID of the class or module containing the object. If no 
247
 
        container is specified, then <code>__builtin__</code> is 
248
 
        used.
249
 
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
250
 
        (type=<a href="epydoc.uid.UID-class.html" 
251
 
              class="link"><code>UID</code></a> or <code>None</code>)</i>
252
 
      <dd><code><b>docmap</b></code> -
253
 
         A documentation map, which is used to check if 
254
 
        <code>name</code> is the name of a module variable, class 
255
 
        variable, or instance variable.
256
 
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
257
 
        (type=<a href="epydoc.objdoc.DocMap-class.html" 
258
 
              class="link"><code>objdoc.DocMap</code></a>)</i>
259
 
      </dd>
260
 
    </dl>
261
 
    <dl><dt><b>Returns:</b></dt>
262
 
      <dd>
263
 
        The UID for the object that can be accessed with the name 
264
 
        <code>name</code> from the module <code>module</code>; or 
265
 
        <code>None</code> if no object was found.
266
 
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
267
 
        (type=<a href="epydoc.uid.UID-class.html" 
268
 
        class="link"><code>UID</code></a> or <code>None</code>)</i>
269
 
      </dd>
270
 
    </dl>
271
 
  </dd></dl>
272
 
</td></tr></table>
273
 
 
274
 
<a name="reset_uid_cache"></a>
275
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
276
 
  <h3><span class="sig"><span class="sig-name">reset_uid_cache</span>()</span>
277
 
  </h3>
278
 
  Reset the internal cache of UIDs for objects.
279
 
  <dl><dt></dt><dd>
280
 
    <dl><dt><b>Returns:</b></dt>
281
 
      <dd>
282
 
        <code>None</code>
283
 
      </dd>
284
 
    </dl>
285
 
  </dd></dl>
286
 
</td></tr></table>
287
 
 
288
 
<a name="_find_builtin_obj_module"></a>
289
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
290
 
  <h3><span class="sig"><span class="sig-name">_find_builtin_obj_module</span>(<span class=sig-arg>obj</span>,
291
 
          <span class=sig-arg>show_warnings</span>=<span class=sig-default>1</span>)</span>
292
 
  </h3>
293
 
  <dl><dt></dt><dd>
294
 
    <dl><dt><b>Parameters:</b></dt>
295
 
      <dd><code><b>obj</b></code> -
296
 
         The object whose module should be found.
297
 
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
298
 
        (type=<code>builtin object</code>)</i>
299
 
      </dd>
300
 
    </dl>
301
 
    <dl><dt><b>Returns:</b></dt>
302
 
      <dd>
303
 
        The module that defines the given builtin object.
304
 
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
305
 
        (type=<code>module</code>)</i>
306
 
      </dd>
307
 
    </dl>
308
 
  </dd></dl>
309
 
</td></tr></table>
310
 
 
311
 
<a name="_find_class_child"></a>
312
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
313
 
  <h3><span class="sig"><span class="sig-name">_find_class_child</span>(<span class=sig-arg>name</span>,
314
 
          <span class=sig-arg>container</span>,
315
 
          <span class=sig-arg>docmap</span>)</span>
316
 
  </h3>
317
 
  Search for a child object named <code>name</code> in the class whose 
318
 
  UID is <code>container</code>, given the DocMap 
319
 
  <code>docmap</code>.
320
 
  <dl><dt></dt><dd>
321
 
    <dl><dt><b>Returns:</b></dt>
322
 
      <dd>
323
 
        The UID of the variable named <code>name</code>, if it exists; 
324
 
        or <code>None</code> if it doesn't.
325
 
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
326
 
        (type=<a href="epydoc.uid.UID-class.html" 
327
 
        class="link"><code>UID</code></a> or <code>None</code>)</i>
328
 
      </dd>
329
 
    </dl>
330
 
  </dd></dl>
331
 
</td></tr></table>
332
 
 
333
 
<a name="_find_function_module"></a>
334
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
335
 
  <h3><span class="sig"><span class="sig-name">_find_function_module</span>(<span class=sig-arg>func</span>)</span>
336
 
  </h3>
337
 
  <dl><dt></dt><dd>
338
 
    <dl><dt><b>Parameters:</b></dt>
339
 
      <dd><code><b>func</b></code> -
340
 
         The function whose module should be found.
341
 
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
342
 
        (type=<code>function</code>)</i>
343
 
      </dd>
344
 
    </dl>
345
 
    <dl><dt><b>Returns:</b></dt>
346
 
      <dd>
347
 
        The module that defines the given function.
348
 
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
349
 
        (type=<code>module</code>)</i>
350
 
      </dd>
351
 
    </dl>
352
 
  </dd></dl>
353
 
</td></tr></table>
354
 
 
355
 
<a name="_find_object_in_module"></a>
356
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
357
 
  <h3><span class="sig"><span class="sig-name">_find_object_in_module</span>(<span class=sig-arg>name</span>,
358
 
          <span class=sig-arg>module</span>,
359
 
          <span class=sig-arg>docmap</span>)</span>
360
 
  </h3>
361
 
  Search for an object or variable named <code>name</code> in the 
362
 
  given module, given the DocMap <code>docmap</code>.
363
 
  <dl><dt></dt><dd>
364
 
  </dd></dl>
365
 
</td></tr></table>
366
 
 
367
 
<a name="_find_variable_in"></a>
368
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
369
 
  <h3><span class="sig"><span class="sig-name">_find_variable_in</span>(<span class=sig-arg>name</span>,
370
 
          <span class=sig-arg>container</span>,
371
 
          <span class=sig-arg>docmap</span>)</span>
372
 
  </h3>
373
 
  Search for a variable named <code>name</code> in the module or class 
374
 
  whose UID is <code>container</code>, given the DocMap 
375
 
  <code>docmap</code>.
376
 
  <dl><dt></dt><dd>
377
 
    <dl><dt><b>Returns:</b></dt>
378
 
      <dd>
379
 
        The UID of the variable named <code>name</code>, if it exists; 
380
 
        or <code>None</code> if it doesn't.
381
 
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
382
 
        (type=<a href="epydoc.uid.UID-class.html" 
383
 
        class="link"><code>UID</code></a> or <code>None</code>)</i>
384
 
      </dd>
385
 
    </dl>
386
 
  </dd></dl>
387
 
</td></tr></table>
388
 
 
389
 
<a name="_is_parameter_for"></a>
390
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
391
 
  <h3><span class="sig"><span class="sig-name">_is_parameter_for</span>(<span class=sig-arg>name</span>,
392
 
          <span class=sig-arg>container</span>,
393
 
          <span class=sig-arg>docmap</span>)</span>
394
 
  </h3>
395
 
  <dl><dt></dt><dd>
396
 
    <dl><dt><b>Returns:</b></dt>
397
 
      <dd>
398
 
        True if <code>name</code> is the name of a parameter for the 
399
 
        routine <code>container</code>, given the DocMap 
400
 
        <code>docmap</code>.
401
 
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
402
 
        (type=<code>boolean</code>)</i>
403
 
      </dd>
404
 
    </dl>
405
 
  </dd></dl>
406
 
</td></tr></table>
407
 
<br />
408
 
 
409
 
 
410
 
<!-- =========== START OF VARIABLE DETAILS =========== -->
411
 
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
412
 
<tr bgcolor="#70b0f0" class="details">
413
 
  <th colspan="2">Variable Details</th></tr>
414
 
</table>
415
 
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
416
 
<a name="_find_builtin_obj_module_cache"></a>
417
 
<h3>_find_builtin_obj_module_cache</h3>
418
 
<dl>
419
 
  <dt></dt>
420
 
  <dd>
421
 
    <dl>
422
 
      <dt><b>Type:</b></dt>
423
 
      <dd>
424
 
          <code>dict</code>
425
 
 
426
 
      </dd>
427
 
<span title="{135227264: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;, 135219520: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;, 138468136: &lt;module 'thread' (built-in)&gt;, 135227456: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;, 135227744: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;, 135174176: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;, 135275016: &lt;module 'sys' (built-in)&gt;, 135209504: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;, 135213248: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;, 135276344: &lt;module 'sys' (built-in)&gt;, 135275704: &lt;module 'sys'...">      <dt><b>Value:</b></dt>
428
 
      <dd><table><tr><td>
429
 
<pre class="variable">
430
 
{135139808: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;,
431
 
 135174176: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;,
432
 
 135174720: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;,
433
 
 135184096: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;,
434
 
 135209504: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;,
435
 
 135209920: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;,
436
 
 135210400: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;,
437
 
 135210688: &lt;module 'types' from '/usr/lib/python2.2/types.pyc'&gt;,
438
 
<span class="variable-ellipsis">...</span>                                                                    </pre>
439
 
        </td></tr></table></dd>
440
 
</span>    </dl>
441
 
  </dd>
442
 
</dl></td></tr></table>
443
 
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
444
 
<a name="_name_to_uid"></a>
445
 
<h3>_name_to_uid</h3>
446
 
<dl>
447
 
  <dt></dt>
448
 
  <dd>
449
 
    <dl>
450
 
      <dt><b>Type:</b></dt>
451
 
      <dd>
452
 
          <code>dict</code>
453
 
 
454
 
      </dd>
455
 
<span title="{'Tkinter.Toplevel': &lt;UID: Tkinter.Toplevel&gt;, 'epydoc.markup.epytext.ParsedEpytextDocstring._to_latex': &lt;UID: epydoc.markup.epytext.ParsedEpytextDocstring._to_latex&gt;, 'epydoc.gui.LISTBOX_CONFIG': &lt;UID: epydoc.gui.LISTBOX_CONFIG&gt;, 'epydoc.gui.VERTICAL': &lt;UID: epydoc.gui.VERTICAL&gt;, 'docutils.Component': &lt;UID: docutils.Component&gt;, 'docutils.writers.html4css1.HTMLTranslator.depart_version': &lt;UID: docutils.writers.html4css1.HTMLTranslator.depart_version&gt;, 'epydoc.markup.wordwrap': &lt;UID: epydoc.markup.wordwrap&gt;, 'epydoc.imports._DevNull.__init__': &lt;UID: epydoc.imports._DevNull.__init__&gt;, 'epydoc....">      <dt><b>Value:</b></dt>
456
 
      <dd><table><tr><td>
457
 
<pre class="variable">
458
 
{'Tkinter.Toplevel': &lt;UID: Tkinter.Toplevel&gt;,
459
 
 'docutils.Component': &lt;UID: docutils.Component&gt;,
460
 
 'docutils.writers.html4css1.HTMLTranslator.depart_version': &lt;UID: doc<span class="variable-linewrap">\</span>
461
 
utils.writers.html4css1.HTMLTranslator.depart_version&gt;,
462
 
 'epydoc.gui.LISTBOX_CONFIG': &lt;UID: epydoc.gui.LISTBOX_CONFIG&gt;,
463
 
 'epydoc.gui.VERTICAL': &lt;UID: epydoc.gui.VERTICAL&gt;,
464
 
 'epydoc.imports._DevNull.__init__': &lt;UID: epydoc.imports._DevNull.__i<span class="variable-linewrap">\</span>
465
 
nit__&gt;,
466
 
<span class="variable-ellipsis">...</span>                                                                    </pre>
467
 
        </td></tr></table></dd>
468
 
</span>    </dl>
469
 
  </dd>
470
 
</dl></td></tr></table>
471
 
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
472
 
<a name="_object_uids"></a>
473
 
<h3>_object_uids</h3>
474
 
<dl>
475
 
  <dt></dt>
476
 
  <dd>
477
 
    <dl>
478
 
      <dt><b>Type:</b></dt>
479
 
      <dd>
480
 
          <code>dict</code>
481
 
 
482
 
      </dd>
483
 
<span title="{(139460820, 139457492): &lt;UID: epydoc.html.HTMLFormatter._write_class_summary_row&gt;, (137853172, 139457492): &lt;UID: epydoc.html.HTMLFormatter._write_var_summary&gt;, (136674596, 136674308): &lt;UID: epydoc.objdoc.ClassDoc._add_inheritance_groups&gt;, 135821316: &lt;UID: docutils.frontend&gt;, 135902892: &lt;UID: epydoc.markup.DocstringLinker&gt;, (136355516, 137858164): &lt;UID: epydoc.html._DevNull.close&gt;, (136064188, 136091004): &lt;UID: docutils.writers.html4css1.HTMLTranslator.visit_transition&gt;, 136980492: &lt;UID: epydoc.cli._version&gt;, (136073148, 136091004): &lt;UID: docutils.writers.html4css1.HTMLTranslator.visit_foot...">      <dt><b>Value:</b></dt>
484
 
      <dd><table><tr><td>
485
 
<pre class="variable">
486
 
{135821316: &lt;UID: docutils.frontend&gt;,
487
 
 135902892: &lt;UID: epydoc.markup.DocstringLinker&gt;,
488
 
 136980492: &lt;UID: epydoc.cli._version&gt;,
489
 
 (136064188, 136091004): &lt;UID: docutils.writers.html4css1.HTMLTranslat<span class="variable-linewrap">\</span>
490
 
or.visit_transition&gt;,
491
 
 (136073148, 136091004): &lt;UID: docutils.writers.html4css1.HTMLTranslat<span class="variable-linewrap">\</span>
492
 
or.visit_footnote_reference&gt;,
493
 
 (136355516, 137858164): &lt;UID: epydoc.html._DevNull.close&gt;,
494
 
<span class="variable-ellipsis">...</span>                                                                    </pre>
495
 
        </td></tr></table></dd>
496
 
</span>    </dl>
497
 
  </dd>
498
 
</dl></td></tr></table>
499
 
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
500
 
<a name="_variable_uids"></a>
501
 
<h3>_variable_uids</h3>
502
 
<dl>
503
 
  <dt></dt>
504
 
  <dd>
505
 
    <dl>
506
 
      <dt><b>Type:</b></dt>
507
 
      <dd>
508
 
          <code>dict</code>
509
 
 
510
 
      </dd>
511
 
<span title="{(137736676, 'AUTHOR'): &lt;UID: epydoc.checker.DocChecker.AUTHOR&gt;, (137460204, 'settings_defaults'): &lt;UID: docutils.SettingsSpec.settings_defaults&gt;, (137857892, 'HTML_HELP'): &lt;UID: epydoc.help.HTML_HELP&gt;, (135672180, '__url__'): &lt;UID: epydoc.__url__&gt;, (137903116, '_name_to_uid'): &lt;UID: epydoc.uid._name_to_uid&gt;, (136458884, '__builtins__'): &lt;UID: epydoc.markup.javadoc.__builtins__&gt;, (137903116, '__doc__'): &lt;UID: epydoc.uid.__doc__&gt;, (135274748, 'exc_traceback'): &lt;UID: sys.exc_traceback&gt;, (137785684, 'BOTH'): &lt;UID: epydoc.gui.BOTH&gt;, (139452988, 'indent'): &lt;UID: epydoc.markup.epytext.Token.inden...">      <dt><b>Value:</b></dt>
512
 
      <dd><table><tr><td>
513
 
<pre class="variable">
514
 
{(135274748, 'exc_traceback'): &lt;UID: sys.exc_traceback&gt;,
515
 
 (135672180, '__url__'): &lt;UID: epydoc.__url__&gt;,
516
 
 (136458884, '__builtins__'): &lt;UID: epydoc.markup.javadoc.__builtins__<span class="variable-linewrap">\</span>
517
 
&gt;,
518
 
 (137460204, 'settings_defaults'): &lt;UID: docutils.SettingsSpec.setting<span class="variable-linewrap">\</span>
519
 
s_defaults&gt;,
520
 
 (137736676, 'AUTHOR'): &lt;UID: epydoc.checker.DocChecker.AUTHOR&gt;,
521
 
 (137785684, 'BOTH'): &lt;UID: epydoc.gui.BOTH&gt;,
522
 
<span class="variable-ellipsis">...</span>                                                                    </pre>
523
 
        </td></tr></table></dd>
524
 
</span>    </dl>
525
 
  </dd>
526
 
</dl></td></tr></table>
527
 
<br />
528
 
 
529
 
 
530
 
<!-- =========== START OF NAVBAR =========== -->
531
 
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
532
 
  <tr valign="center">
533
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="epydoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
534
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
535
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
536
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
537
 
    <th class="navbar" align="right" width="100%">
538
 
      <table border="0" cellpadding="0" cellspacing="0">
539
 
      <tr><th class="navbar" align="center">
540
 
        <p class="nomargin">
541
 
          <a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
542
 
      </p></th></tr></table>
543
 
    </th>
544
 
  </tr>
545
 
</table>
546
 
 
547
 
<table border="0" cellpadding="0" cellspacing="0" width="100%">
548
 
  <tr>
549
 
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Mar 20 17:46:15 2004</font></td>
550
 
    <td align="right"><a href="http://epydoc.sourceforge.net"
551
 
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
552
 
  </tr>
553
 
</table>
554
 
</body>
555
 
</html>