| Home | Trees | Index | Help |  | 
|---|
| Package epydoc :: Module uid | 
 | 
UID class. It is important that each object 
have a single unique identifier, because one object may have more than 
one name. UIDs should be always created using the make_uid function; do not create UIDs 
directly. The Link class uses UIDs to implement 
crossreferencing between ObjDocs.
Bugs:
L{links}" that refer to the nested 
class using its normal name (e.g. 
ContainerClass.NestedClass) won't be resolved correctly. But 
you should be able to link to it with just NestedClass.
PropertyDoc usually creates an incorrect UID for its 
fget, fset, and fdel accessors. This arises because they are represented 
as functions, not methods; so epydoc doesn't have any way to tell what 
class they were defined in. As a result, it just assumes that they were 
installed at the module level. The effect of this bug is that the 
hyperlinks from property accessor methods don't point to the right 
targets.
  See Also: epydoc.objdoc
| Classes | |
|---|---|
| ObjectUID | A globally unique identifier used to refer to a Python object. | 
| Unique Identifiers | |
| UID | A globally unique identifier. | 
| RelativeUID | A globally unique identifier used to refer to a variable, relative to a Python object. | 
| VariableUID | |
| PropertyUID | |
| StaticMethodUID | |
| ClassMethodUID | |
| Crossreferences | |
| Link | A cross-reference link between documentation. | 
| Function Summary | |
|---|---|
| Create a globally unique identifier for the given object. | |
| UIDorNone | Attempt to find the UID for the object that can be accessed with the name namefrom the modulemodule. | 
| None | Reset the internal cache of UIDs for objects. | 
| module | Return the module that defines the given builtin object. | 
| UIDorNone | Search for a child object named namein the class whose 
UID iscontainer, given the DocMapdocmap. | 
| module | Return the module that defines the given function. | 
| _find_name_in(obj,
          module) | |
| Search for an object or variable named namein the given 
module, given the DocMapdocmap. | |
| UIDorNone | Search for a variable named namein the module or class 
whose UID iscontainer, given the DocMapdocmap. | 
| boolean | Return true if nameis the name of a parameter for the routinecontainer, given the DocMapdocmap. | 
| Variable Summary | |
|---|---|
| dict | _find_builtin_obj_module_cache={135227264: <module 'ty... | 
| dict | _name_to_uid={'Tkinter.Toplevel': <UID: Tkinter.Toplev... | 
| dict | _object_uids={(139460820, 139457492): <UID: epydoc.htm... | 
| dict | _variable_uids={(137736676, 'AUTHOR'): <UID: epydoc.ch... | 
| Function Details | 
|---|
| make_uid(object, base_uid=None, shortname=None)Create a globally unique identifier for the given object. | 
| findUID(name, container=None, docmap=None)Attempt to find the UID for the object that can be accessed with the namenamefrom the modulemodule.
 | 
| reset_uid_cache()Reset the internal cache of UIDs for objects.
 | 
| _find_builtin_obj_module(obj, show_warnings=1)
 | 
| _find_class_child(name, container, docmap)Search for a child object namednamein the class whose 
  UID iscontainer, given the DocMapdocmap.
 | 
| _find_function_module(func)
 | 
| _find_object_in_module(name, module, docmap)Search for an object or variable namednamein the 
  given module, given the DocMapdocmap. | 
| _find_variable_in(name, container, docmap)Search for a variable namednamein the module or class 
  whose UID iscontainer, given the DocMapdocmap.
 | 
| _is_parameter_for(name, container, docmap)
 | 
| Variable Details | 
|---|
| _name_to_uid
 | 
| _object_uids
 | 
| _variable_uids
 | 
| Home | Trees | Index | Help |  | 
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:15 2004 | http://epydoc.sf.net |