Home | Trees | Indices | Help |
|
---|
|
Classes for encoding API documentation about Python programs. These classes are used as a common representation for combining information derived from introspection and from parsing.
The API documentation for a Python program is encoded using a graph of
APIDoc
objects, each of which encodes information about a single Python variable
or value. APIDoc
has two direct subclasses: VariableDoc,
for documenting variables; and ValueDoc, for
documenting values. The ValueDoc
class is subclassed
further, to define the different pieces of information that should be
recorded about each value type:
![]() |
Class Hierarchy for APIDoc |
The distinction between variables and values is intentionally made
explicit. This allows us to distinguish information about a variable
itself (such as whether it should be considered 'public' in its
containing namespace) from information about the value it contains (such
as what type the value has). This distinction is also important because
several variables can contain the same value: each variable should be
described by a separate VariableDoc
; but we only need one
ValueDoc
, since they share a single value.
To Do: Add a cache to canonical name lookup?
|
|||
DottedName A sequence of identifiers, separated by periods, used to name a Python variable, value, or argument. |
|||
_Sentinel A unique value that won't compare equal to any other value. |
|||
APIDoc API documentation information for a single element of a Python program. |
|||
VariableDoc API documentation information about a single Python variable. |
|||
ValueDoc API documentation information about a single Python value. |
|||
GenericValueDoc API documentation about a 'generic' value, i.e., one that does not have its own docstring or any information other than its value and parse representation. |
|||
NamespaceDoc API documentation information about a singe Python namespace value. |
|||
ModuleDoc API documentation information about a single module. |
|||
ClassDoc API documentation information about a single class. |
|||
RoutineDoc API documentation information about a single routine. |
|||
ClassMethodDoc | |||
StaticMethodDoc | |||
PropertyDoc API documentation information about a single property. |
|||
DocIndex [xx] out of date. |
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|
|||
UNKNOWN = _Sentinel('UNKNOWN') A special value used to indicate that a given piece of information about an object is unknown. |
|
Return a list of all
|
|
|
UNKNOWNA special value used to indicate that a given piece of information about an object is unknown. This is used as the default value for all instance variables.
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Fri Jun 13 23:49:16 2008 | http://epydoc.sourceforge.net |