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">
6
<title>epydoc.uid.ObjectUID</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12
<!-- =========== START OF NAVBAR =========== -->
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
15
<th class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </th>
16
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
17
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
18
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
19
<th class="navbar" align="right" width="100%">
20
<table border="0" cellpadding="0" cellspacing="0">
21
<tr><th class="navbar" align="center">
23
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
24
</p></th></tr></table>
28
<table width="100%" cellpadding="0" cellspacing="0">
31
<font size="-1"><b class="breadcrumbs">
32
<a href="epydoc-module.html">Package epydoc</a> ::
33
<a href="epydoc.uid-module.html">Module uid</a> ::
37
<td><table cellpadding="0" cellspacing="0">
38
<tr><td align="right"><font size="-2">[<a href="../private/epydoc.uid.ObjectUID-class.html">show private</a> | hide private]</font></td></tr>
39
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="epydoc.uid.ObjectUID-class.html" target="_top">no frames</a>]</font></td></tr>
43
<!-- =========== START OF CLASS DESCRIPTION =========== -->
44
<h2 class="class">Class ObjectUID</h2>
46
<pre class="base-tree">
47
<a href="epydoc.uid.UID-class.html"><code>UID</code></a> --+
54
A globally unique identifier used to refer to a Python object.
58
<!-- =========== START OF METHOD SUMMARY =========== -->
59
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
60
<tr bgcolor="#70b0f0" class="summary">
61
<th colspan="2">Method Summary</th></tr>
62
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
63
<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
64
<span class=summary-sig-arg>object</span>)</span></code>
66
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
67
<td><code><a name="__eq__"></a><span class="summary-sig"><span class="summary-sig-name">__eq__</span>(<span class=summary-sig-arg>self</span>,
68
<span class=summary-sig-arg>other</span>)</span></code>
70
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
71
<td><code><a name="__hash__"></a><span class="summary-sig"><span class="summary-sig-name">__hash__</span>(<span class=summary-sig-arg>self</span>)</span></code>
73
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.uid.UID-class.html"
74
class="link"><code>UID</code></a> or <code>None</code>
76
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#cls" class="summary-sig-name"><code>cls</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
78
Return the UID of the class that contains the object identified by this UID;
79
or <code>None</code> if the object identified by this UID is not part of
81
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>boolean</code>
83
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#descendant_of" class="summary-sig-name"><code>descendant_of</code></a>(<span class=summary-sig-arg>self</span>,
84
<span class=summary-sig-arg>ancestor</span>)</span></code>
86
Return true if the object identified by this UID is a descendant of
87
<code>ancestor</code>.</td></tr>
88
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>int</code>
90
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#id" class="summary-sig-name"><code>id</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
92
Return the Python internal identifier for this UID's object.</td></tr>
93
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>boolean</code>
95
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#is_builtin_function" class="summary-sig-name"><code>is_builtin_function</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
97
Return true if this is the UID for a builtin function.</td></tr>
98
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>boolean</code>
100
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#is_builtin_method" class="summary-sig-name"><code>is_builtin_method</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
102
Return true if this is the UID for a builtin method.</td></tr>
103
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>boolean</code>
105
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#is_class" class="summary-sig-name"><code>is_class</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
107
Return true if this is the UID for a class or a type.</td></tr>
108
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
109
<td><code><a name="is_classmethod"></a><span class="summary-sig"><span class="summary-sig-name">is_classmethod</span>(<span class=summary-sig-arg>self</span>)</span></code>
111
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>boolean</code>
113
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#is_function" class="summary-sig-name"><code>is_function</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
115
Return true if this is the UID for a function.</td></tr>
116
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>boolean</code>
118
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#is_method" class="summary-sig-name"><code>is_method</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
120
Return true if this is the UID for a method.</td></tr>
121
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>boolean</code>
123
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#is_module" class="summary-sig-name"><code>is_module</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
125
Return true if this is the UID for a module or a package.</td></tr>
126
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>boolean</code>
128
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#is_package" class="summary-sig-name"><code>is_package</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
130
Return true if this is the UID for a package.</td></tr>
131
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>boolean</code>
133
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#is_property" class="summary-sig-name"><code>is_property</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
135
Return true if this is the UID for a property.</td></tr>
136
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>boolean</code>
138
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#is_routine" class="summary-sig-name"><code>is_routine</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
140
Return true if this is the UID for a function, a method, a builtin function,
141
or a builtin method.</td></tr>
142
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
143
<td><code><a name="is_staticmethod"></a><span class="summary-sig"><span class="summary-sig-name">is_staticmethod</span>(<span class=summary-sig-arg>self</span>)</span></code>
145
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>boolean</code>
147
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#is_type" class="summary-sig-name"><code>is_type</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
149
Return true if this is the UID for a type.</td></tr>
150
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>boolean</code>
152
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#is_variable" class="summary-sig-name"><code>is_variable</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
154
Return true if this is the UID for a variable.</td></tr>
155
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.uid.UID-class.html"
156
class="link"><code>UID</code></a>
158
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#module" class="summary-sig-name"><code>module</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
160
Return the UID of the module that contains the object identified by this UID;
161
or <code>None</code> if the object identified by this UID is a module or
163
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
165
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#name" class="summary-sig-name"><code>name</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
167
Return the globally unique name for this identifier.</td></tr>
168
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.uid.UID-class.html"
169
class="link"><code>UID</code></a>
171
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#package" class="summary-sig-name"><code>package</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
173
Return the UID of the package that contains the object identified by this
174
UID; or <code>None</code> if the object identified by this UID is not
175
part of a package.</td></tr>
176
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
177
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#parent" class="summary-sig-name"><code>parent</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
179
Return the UID of the object that contains the object identified by this UID;
180
or <code>None</code> if the object identified by this UID is not
181
contained by any other object.</td></tr>
182
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
184
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#shortname" class="summary-sig-name"><code>shortname</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
186
Return the short name for this UID.</td></tr>
187
<tr><td align="right" valign="top" width="15%"><font size="-1"> any
189
<td><code><span class="summary-sig"><a href="epydoc.uid.ObjectUID-class.html#value" class="summary-sig-name"><code>value</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
191
Return the value of the object or variable specified by this UID.</td></tr>
193
<b>Inherited from <a href="epydoc.uid.UID-class.html"><code>UID</code></a>:</b>
194
<a href="epydoc.uid.UID-class.html#__cmp__"><code>__cmp__</code></a>,
195
<a href="epydoc.uid.UID-class.html#__repr__"><code>__repr__</code></a>,
196
<a href="epydoc.uid.UID-class.html#__str__"><code>__str__</code></a>,
197
<a href="epydoc.uid.UID-class.html#is_any_function"><code>is_any_function</code></a>,
198
<a href="epydoc.uid.UID-class.html#is_any_method"><code>is_any_method</code></a>,
199
<a href="epydoc.uid.UID-class.html#is_private"><code>is_private</code></a>,
200
<a href="epydoc.uid.UID-class.html#is_public"><code>is_public</code></a>
205
<!-- =========== START OF METHOD DETAILS =========== -->
206
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
207
<tr bgcolor="#70b0f0" class="details">
208
<th colspan="2">Method Details</th></tr>
212
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
213
<h3><span class="sig"><span class="sig-name">cls</span>(<span class=sig-arg>self</span>)</span>
216
<dl><dt><b>Returns:</b></dt>
218
The UID of the class that contains the object identified by
219
this UID; or <code>None</code> if the object identified by this
220
UID is not part of a class.
221
<br /><i>
222
(type=<a href="epydoc.uid.UID-class.html"
223
class="link"><code>UID</code></a> or <code>None</code>)</i>
226
<dl><dt><b>Overrides:</b></dt>
227
<dd><a href="epydoc.uid.UID-class.html#cls"><code>epydoc.uid.UID.cls</code></a> <i>(inherited documentation)</i>
233
<a name="descendant_of"></a>
234
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
235
<h3><span class="sig"><span class="sig-name">descendant_of</span>(<span class=sig-arg>self</span>,
236
<span class=sig-arg>ancestor</span>)</span>
239
<dl><dt><b>Parameters:</b></dt>
240
<dd><code><b>ancestor</b></code> -
241
The UID of the potential ancestor.
242
<br /><i>
243
(type=<a href="epydoc.uid.UID-class.html"
244
class="link"><code>UID</code></a>)</i>
247
<dl><dt><b>Returns:</b></dt>
249
True if the object identified by this UID is a descendant of
250
<code>ancestor</code>. <i class="math">d</i> is a descendant of
251
<i class="math">a</i> if <i class="math">d</i>=<i
252
class="math">a</i>; or if <i class="math">d</i> is a descendent
253
of an object contained by <i class="math">a</i>.
254
<br /><i>
255
(type=<code>boolean</code>)</i>
258
<dl><dt><b>Overrides:</b></dt>
259
<dd><a href="epydoc.uid.UID-class.html#descendant_of"><code>epydoc.uid.UID.descendant_of</code></a> <i>(inherited documentation)</i>
266
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
267
<h3><span class="sig"><span class="sig-name">id</span>(<span class=sig-arg>self</span>)</span>
270
<dl><dt><b>Returns:</b></dt>
272
the Python internal identifier for this UID's object.
273
<br /><i>
274
(type=<code>int</code>)</i>
280
<a name="is_builtin_function"></a>
281
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
282
<h3><span class="sig"><span class="sig-name">is_builtin_function</span>(<span class=sig-arg>self</span>)</span>
285
<dl><dt><b>Returns:</b></dt>
287
True if this is the UID for a builtin function.
288
<br /><i>
289
(type=<code>boolean</code>)</i>
292
<dl><dt><b>Overrides:</b></dt>
293
<dd><a href="epydoc.uid.UID-class.html#is_builtin_function"><code>epydoc.uid.UID.is_builtin_function</code></a> <i>(inherited documentation)</i>
299
<a name="is_builtin_method"></a>
300
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
301
<h3><span class="sig"><span class="sig-name">is_builtin_method</span>(<span class=sig-arg>self</span>)</span>
304
<dl><dt><b>Returns:</b></dt>
306
True if this is the UID for a builtin method.
307
<br /><i>
308
(type=<code>boolean</code>)</i>
311
<dl><dt><b>Overrides:</b></dt>
312
<dd><a href="epydoc.uid.UID-class.html#is_builtin_method"><code>epydoc.uid.UID.is_builtin_method</code></a> <i>(inherited documentation)</i>
318
<a name="is_class"></a>
319
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
320
<h3><span class="sig"><span class="sig-name">is_class</span>(<span class=sig-arg>self</span>)</span>
323
<dl><dt><b>Returns:</b></dt>
325
True if this is the UID for a class or a type.
326
<br /><i>
327
(type=<code>boolean</code>)</i>
330
<dl><dt><b>Overrides:</b></dt>
331
<dd><a href="epydoc.uid.UID-class.html#is_class"><code>epydoc.uid.UID.is_class</code></a> <i>(inherited documentation)</i>
337
<a name="is_function"></a>
338
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
339
<h3><span class="sig"><span class="sig-name">is_function</span>(<span class=sig-arg>self</span>)</span>
342
<dl><dt><b>Returns:</b></dt>
344
True if this is the UID for a function.
345
<br /><i>
346
(type=<code>boolean</code>)</i>
349
<dl><dt><b>Overrides:</b></dt>
350
<dd><a href="epydoc.uid.UID-class.html#is_function"><code>epydoc.uid.UID.is_function</code></a> <i>(inherited documentation)</i>
356
<a name="is_method"></a>
357
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
358
<h3><span class="sig"><span class="sig-name">is_method</span>(<span class=sig-arg>self</span>)</span>
361
<dl><dt><b>Returns:</b></dt>
363
True if this is the UID for a method.
364
<br /><i>
365
(type=<code>boolean</code>)</i>
368
<dl><dt><b>Overrides:</b></dt>
369
<dd><a href="epydoc.uid.UID-class.html#is_method"><code>epydoc.uid.UID.is_method</code></a> <i>(inherited documentation)</i>
375
<a name="is_module"></a>
376
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
377
<h3><span class="sig"><span class="sig-name">is_module</span>(<span class=sig-arg>self</span>)</span>
380
<dl><dt><b>Returns:</b></dt>
382
True if this is the UID for a module or a package.
383
<br /><i>
384
(type=<code>boolean</code>)</i>
387
<dl><dt><b>Overrides:</b></dt>
388
<dd><a href="epydoc.uid.UID-class.html#is_module"><code>epydoc.uid.UID.is_module</code></a> <i>(inherited documentation)</i>
394
<a name="is_package"></a>
395
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
396
<h3><span class="sig"><span class="sig-name">is_package</span>(<span class=sig-arg>self</span>)</span>
399
<dl><dt><b>Returns:</b></dt>
401
True if this is the UID for a package.
402
<br /><i>
403
(type=<code>boolean</code>)</i>
406
<dl><dt><b>Overrides:</b></dt>
407
<dd><a href="epydoc.uid.UID-class.html#is_package"><code>epydoc.uid.UID.is_package</code></a> <i>(inherited documentation)</i>
413
<a name="is_property"></a>
414
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
415
<h3><span class="sig"><span class="sig-name">is_property</span>(<span class=sig-arg>self</span>)</span>
418
<dl><dt><b>Returns:</b></dt>
420
True if this is the UID for a property.
421
<br /><i>
422
(type=<code>boolean</code>)</i>
425
<dl><dt><b>Overrides:</b></dt>
426
<dd><a href="epydoc.uid.UID-class.html#is_property"><code>epydoc.uid.UID.is_property</code></a> <i>(inherited documentation)</i>
432
<a name="is_routine"></a>
433
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
434
<h3><span class="sig"><span class="sig-name">is_routine</span>(<span class=sig-arg>self</span>)</span>
437
<dl><dt><b>Returns:</b></dt>
439
True if this is the UID for a function, a method, a builtin
440
function, or a builtin method.
441
<br /><i>
442
(type=<code>boolean</code>)</i>
445
<dl><dt><b>Overrides:</b></dt>
446
<dd><a href="epydoc.uid.UID-class.html#is_routine"><code>epydoc.uid.UID.is_routine</code></a> <i>(inherited documentation)</i>
452
<a name="is_type"></a>
453
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
454
<h3><span class="sig"><span class="sig-name">is_type</span>(<span class=sig-arg>self</span>)</span>
457
<dl><dt><b>Returns:</b></dt>
459
True if this is the UID for a type.
460
<br /><i>
461
(type=<code>boolean</code>)</i>
464
<dl><dt><b>Overrides:</b></dt>
465
<dd><a href="epydoc.uid.UID-class.html#is_type"><code>epydoc.uid.UID.is_type</code></a> <i>(inherited documentation)</i>
471
<a name="is_variable"></a>
472
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
473
<h3><span class="sig"><span class="sig-name">is_variable</span>(<span class=sig-arg>self</span>)</span>
476
<dl><dt><b>Returns:</b></dt>
478
True if this is the UID for a variable.
479
<br /><i>
480
(type=<code>boolean</code>)</i>
483
<dl><dt><b>Overrides:</b></dt>
484
<dd><a href="epydoc.uid.UID-class.html#is_variable"><code>epydoc.uid.UID.is_variable</code></a> <i>(inherited documentation)</i>
490
<a name="module"></a>
491
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
492
<h3><span class="sig"><span class="sig-name">module</span>(<span class=sig-arg>self</span>)</span>
495
<dl><dt><b>Returns:</b></dt>
497
The UID of the module that contains the object identified by
498
this UID; or <code>None</code> if the object identified by this
499
UID is a module or a package.
500
<br /><i>
501
(type=<a href="epydoc.uid.UID-class.html"
502
class="link"><code>UID</code></a>)</i>
505
<dl><dt><b>Overrides:</b></dt>
506
<dd><a href="epydoc.uid.UID-class.html#module"><code>epydoc.uid.UID.module</code></a> <i>(inherited documentation)</i>
513
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
514
<h3><span class="sig"><span class="sig-name">name</span>(<span class=sig-arg>self</span>)</span>
517
<dl><dt><b>Returns:</b></dt>
519
The globally unique name for this identifier. This name
520
consists of several pieces, joined by periods, which indicate
521
where the object is defined. For example, the UID for this class
522
has the name <code>'epydoc.uid.UID'</code>, since it is named
523
<code>UID</code>, and defined in the <code>uid</code> module of
524
the <code>epydoc</code> package.
525
<br /><i>
526
(type=<code>string</code>)</i>
529
<dl><dt><b>Overrides:</b></dt>
530
<dd><a href="epydoc.uid.UID-class.html#name"><code>epydoc.uid.UID.name</code></a> <i>(inherited documentation)</i>
536
<a name="package"></a>
537
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
538
<h3><span class="sig"><span class="sig-name">package</span>(<span class=sig-arg>self</span>)</span>
541
<dl><dt><b>Returns:</b></dt>
543
The UID of the package that contains the object identified by
544
this UID; or <code>None</code> if the object identified by this
545
UID is not part of a package.
546
<br /><i>
547
(type=<a href="epydoc.uid.UID-class.html"
548
class="link"><code>UID</code></a>)</i>
551
<dl><dt><b>Overrides:</b></dt>
552
<dd><a href="epydoc.uid.UID-class.html#package"><code>epydoc.uid.UID.package</code></a> <i>(inherited documentation)</i>
558
<a name="parent"></a>
559
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
560
<h3><span class="sig"><span class="sig-name">parent</span>(<span class=sig-arg>self</span>)</span>
563
<dl><dt><b>Returns:</b></dt>
565
The UID of the object that contains the object identified by
566
this UID; or <code>None</code> if the object identified by this
567
UID is not contained by any other object. For methods, class
568
variables, and instance variables, the parent is the containing
569
class; for functions and classes, it is the containing module;
570
and for modules, it is the containing package.
573
<dl><dt><b>Overrides:</b></dt>
574
<dd><a href="epydoc.uid.UID-class.html#parent"><code>epydoc.uid.UID.parent</code></a> <i>(inherited documentation)</i>
580
<a name="shortname"></a>
581
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
582
<h3><span class="sig"><span class="sig-name">shortname</span>(<span class=sig-arg>self</span>)</span>
585
<dl><dt><b>Returns:</b></dt>
587
The short name for this UID. A UID's short name is the last
588
piece of its globally unique name, as returned by <a
589
href="epydoc.uid.UID-class.html#name"
590
class="link"><code>name</code></a>. This is typically the name
591
that was used when definining the object. For example, the UID
592
for this class has the name <code>'UID'</code>.
593
<br /><i>
594
(type=<code>string</code>)</i>
597
<dl><dt><b>Overrides:</b></dt>
598
<dd><a href="epydoc.uid.UID-class.html#shortname"><code>epydoc.uid.UID.shortname</code></a> <i>(inherited documentation)</i>
605
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
606
<h3><span class="sig"><span class="sig-name">value</span>(<span class=sig-arg>self</span>)</span>
609
<dl><dt><b>Returns:</b></dt>
611
The value of the object or variable specified by this UID.
612
<br /><i>
616
<dl><dt><b>Overrides:</b></dt>
617
<dd><a href="epydoc.uid.UID-class.html#value"><code>epydoc.uid.UID.value</code></a> <i>(inherited documentation)</i>
625
<!-- =========== START OF NAVBAR =========== -->
626
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
628
<th class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </th>
629
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
630
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
631
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
632
<th class="navbar" align="right" width="100%">
633
<table border="0" cellpadding="0" cellspacing="0">
634
<tr><th class="navbar" align="center">
636
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
637
</p></th></tr></table>
642
<table border="0" cellpadding="0" cellspacing="0" width="100%">
644
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Mar 20 17:46:17 2004</font></td>
645
<td align="right"><a href="http://epydoc.sourceforge.net"
646
><font size="-2">http://epydoc.sf.net</font></a></td>
added
removed
doc/api/public/epydoc.uid.ObjectUID-class.html
