Package       Module       Class       Trees       Index       Help   
epydoc
[show private | hide private]

Module epydoc.uid

Unique identifiers and crossreference links for Python objects. Each Python object is identified by a globally unique identifier, implemented with the UID class. It is important that each object have a single unique identifier, because one object may have more than one name. These UIDs are used the Link class to implement crossreferencing between ObjDocs.

See also: epydoc.objdoc

Classes
UID A globally unique identifier used to refer to a Python object.
Link A cross-reference link between documentation.

Function Summary
UID or None findUID(name, container, docmap)
Attempt to find the UID for the object that can be accessed with the name name from the module module.

Function Details

findUID

findUID(name, container, docmap=None)

Attempt to find the UID for the object that can be accessed with the name name from the module module.
Parameters:
name - The name used to identify the object.
           (type=string)
container - The UID of the class or module containing the object.
           (type=UID)
docmap - A documentation map, which is used to check if name is the name of a module variable, class variable, or instance variable.
           (type=objdoc.DocMap)
Returns:
The UID for the object that can be accessed with the name name from the module module; or None if no object was found.
           (type=UID or None)

   Package       Module       Class       Trees       Index       Help   
epydoc
Generated by Epydoc on Sun Oct 6 03:32:15 2002 http://epydoc.sf.net