epydoc.uid.ObjectUID

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

## Class ObjectUID

    UID --+
          |
         ObjectUID

A globally unique identifier used to refer to a Python object.

Method Summary
| `__init__(self, object)`
| `__eq__(self, other)`
| `__hash__(self)`
`UID` or `None` | ``cls`(self)` Return the UID of the class that contains the object identified by this UID; or `None` if the object identified by this UID is not part of a class.
`boolean` | ``descendant_of`(self, ancestor)` Return true if the object identified by this UID is a descendant of `ancestor`.
`int` | ``id`(self)` Return the Python internal identifier for this UID's object.
`boolean` | ``is_builtin_function`(self)` Return true if this is the UID for a builtin function.
`boolean` | ``is_builtin_method`(self)` Return true if this is the UID for a builtin method.
`boolean` | ``is_class`(self)` Return true if this is the UID for a class or a type.
| `is_classmethod(self)`
`boolean` | ``is_function`(self)` Return true if this is the UID for a function.
`boolean` | ``is_method`(self)` Return true if this is the UID for a method.
`boolean` | ``is_module`(self)` Return true if this is the UID for a module or a package.
`boolean` | ``is_package`(self)` Return true if this is the UID for a package.
`boolean` | ``is_property`(self)` Return true if this is the UID for a property.
`boolean` | ``is_routine`(self)` Return true if this is the UID for a function, a method, a builtin function, or a builtin method.
| `is_staticmethod(self)`
`boolean` | ``is_type`(self)` Return true if this is the UID for a type.
`boolean` | ``is_variable`(self)` Return true if this is the UID for a variable.
`UID` | ``module`(self)` Return the UID of the module that contains the object identified by this UID; or `None` if the object identified by this UID is a module or a package.
`string` | ``name`(self)` Return the globally unique name for this identifier.
`UID` | ``package`(self)` Return the UID of the package that contains the object identified by this UID; or `None` if the object identified by this UID is not part of a package.
| ``parent`(self)` Return the UID of the object that contains the object identified by this UID; or `None` if the object identified by this UID is not contained by any other object.
`string` | ``shortname`(self)` Return the short name for this UID.
any | ``value`(self)` Return the value of the object or variable specified by this UID.
Inherited from `UID`: `__cmp__`, `__repr__`, `__str__`, `is_any_function`, `is_any_method`, `is_private`, `is_public`

Method Details

### cls(self) Returns: The UID of the class that contains the object identified by this UID; or `None` if the object identified by this UID is not part of a class. (type=`UID` or `None`) Overrides: `epydoc.uid.UID.cls` (inherited documentation)

### descendant_of(self, ancestor) Parameters: `ancestor` - The UID of the potential ancestor. (type=`UID`) Returns: True if the object identified by this UID is a descendant of `ancestor`. d is a descendant of a if d=a; or if d is a descendent of an object contained by a. (type=`boolean`) Overrides: `epydoc.uid.UID.descendant_of` (inherited documentation)

### id(self) Returns: the Python internal identifier for this UID's object. (type=`int`)

### is_builtin_function(self) Returns: True if this is the UID for a builtin function. (type=`boolean`) Overrides: `epydoc.uid.UID.is_builtin_function` (inherited documentation)

### is_builtin_method(self) Returns: True if this is the UID for a builtin method. (type=`boolean`) Overrides: `epydoc.uid.UID.is_builtin_method` (inherited documentation)

### is_class(self) Returns: True if this is the UID for a class or a type. (type=`boolean`) Overrides: `epydoc.uid.UID.is_class` (inherited documentation)

### is_function(self) Returns: True if this is the UID for a function. (type=`boolean`) Overrides: `epydoc.uid.UID.is_function` (inherited documentation)

### is_method(self) Returns: True if this is the UID for a method. (type=`boolean`) Overrides: `epydoc.uid.UID.is_method` (inherited documentation)

### is_module(self) Returns: True if this is the UID for a module or a package. (type=`boolean`) Overrides: `epydoc.uid.UID.is_module` (inherited documentation)

### is_package(self) Returns: True if this is the UID for a package. (type=`boolean`) Overrides: `epydoc.uid.UID.is_package` (inherited documentation)

### is_property(self) Returns: True if this is the UID for a property. (type=`boolean`) Overrides: `epydoc.uid.UID.is_property` (inherited documentation)

### is_routine(self) Returns: True if this is the UID for a function, a method, a builtin function, or a builtin method. (type=`boolean`) Overrides: `epydoc.uid.UID.is_routine` (inherited documentation)

### is_type(self) Returns: True if this is the UID for a type. (type=`boolean`) Overrides: `epydoc.uid.UID.is_type` (inherited documentation)

### is_variable(self) Returns: True if this is the UID for a variable. (type=`boolean`) Overrides: `epydoc.uid.UID.is_variable` (inherited documentation)

### module(self) Returns: The UID of the module that contains the object identified by this UID; or `None` if the object identified by this UID is a module or a package. (type=`UID`) Overrides: `epydoc.uid.UID.module` (inherited documentation)

### name(self) Returns: The globally unique name for this identifier. This name consists of several pieces, joined by periods, which indicate where the object is defined. For example, the UID for this class has the name `'epydoc.uid.UID'`, since it is named `UID`, and defined in the `uid` module of the `epydoc` package. (type=`string`) Overrides: `epydoc.uid.UID.name` (inherited documentation)

### package(self) Returns: The UID of the package that contains the object identified by this UID; or `None` if the object identified by this UID is not part of a package. (type=`UID`) Overrides: `epydoc.uid.UID.package` (inherited documentation)

### parent(self) Returns: The UID of the object that contains the object identified by this UID; or `None` if the object identified by this UID is not contained by any other object. For methods, class variables, and instance variables, the parent is the containing class; for functions and classes, it is the containing module; and for modules, it is the containing package. Overrides: `epydoc.uid.UID.parent` (inherited documentation)

### shortname(self) Returns: The short name for this UID. A UID's short name is the last piece of its globally unique name, as returned by `name`. This is typically the name that was used when definining the object. For example, the UID for this class has the name `'UID'`. (type=`string`) Overrides: `epydoc.uid.UID.shortname` (inherited documentation)

### value(self) Returns: The value of the object or variable specified by this UID. (type=any) Overrides: `epydoc.uid.UID.value` (inherited documentation)

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