epydoc.uid

Package epydoc :: Module uid |
[show private | hide private]
[frames | no frames]

## 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. UIDs should be always created using the `make_uid` function; do not create UIDs directly. The `Link` class uses UIDs to implement crossreferencing between `ObjDoc`s.

Bugs:

- UIDs are not generated correctly for nested classes; and in general, nested classes are not well supported. (E.g., they are listed under their module, not their containing class). The effect of this bug is that docstring "`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
| ``make_uid`(object, base_uid, shortname)` Create a globally unique identifier for the given object.
`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`.
`None` | ``reset_uid_cache`()` Reset the internal cache of UIDs for objects.

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 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. If no container is specified, then `__builtin__` is used. (type=`UID` or `None`) `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`)

### reset_uid_cache() Reset the internal cache of UIDs for objects. Returns: `None`

Generated by Epydoc 2.1 on Sat Mar 20 17:46:15 2004 | http://epydoc.sf.net