Home | Trees | Indices | Help |
|
---|
|
API documentation information about a singe Python namespace value. (I.e., a module or a class).
|
|||
|
|||
bool
|
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from Inherited from Inherited from |
|||
Value Representation | |||
---|---|---|---|
Inherited from |
|
|||
Value Representation | |||
---|---|---|---|
Inherited from |
|
|||
Inherited from |
|||
Information about Variables | |||
---|---|---|---|
dict from string to VariableDoc
|
variables = _Sentinel('UNKNOWN') The contents of the namespace, encoded as a dictionary mapping from identifiers to VariableDoc s.
|
||
list of VariableDoc
|
sorted_variables = _Sentinel('UNKNOWN') A list of all variables defined by this namespace, in sorted order. |
||
list of str
|
sort_spec = _Sentinel('UNKNOWN') The order in which variables should be listed, encoded as a list of names. |
||
list of (str,list)
|
group_specs = _Sentinel('UNKNOWN') The groups that are defined by this namespace's docstrings. |
||
dict from str to list of VariableDoc
|
variable_groups = _Sentinel('UNKNOWN') A dictionary specifying what group each variable belongs to. |
||
Value Representation | |||
Inherited from |
|||
Context | |||
Inherited from |
|||
Information about Imported Variables | |||
Docstrings | |||
Inherited from |
|||
Information Extracted from Docstrings | |||
Inherited from |
|||
Source Information | |||
Inherited from |
|
Construct a new
|
Does this object deserve a box with extra details?
|
Return a list of all Keyword argument
|
Initialize the sorted_variables attribute, based on the variables and sort_spec attributes. This should usually be called
after all variables have been added to |
Divide a given a list of APIDoc objects into groups, as specified by self.group_specs.
|
|
variablesThe contents of the namespace, encoded as a dictionary mapping from identifiers toVariableDoc s. This dictionary contains all
names defined by the namespace, including imported variables, aliased
variables, and variables inherited from base classes (once inherit_docs() has added them).
|
sorted_variablesA list of all variables defined by this namespace, in sorted order. The elements of this list should exactly match the values of variables. The sort order for this list is defined as follows:
|
sort_specThe order in which variables should be listed, encoded as a list of names. Any variables whose names are not included in this list should be listed alphabetically, following the variables that are included.
|
group_specsThe groups that are defined by this namespace's docstrings.group_specs is encoded as an ordered list of tuples
(group_name, elt_names) , where group_name is
the
name of a group and
|
variable_groupsA dictionary specifying what group each variable belongs to. The keys of the dictionary are group names, and the values are lists ofVariableDoc s. The order that groups should be listed in
should be taken from group_specs.
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Fri Jun 13 23:50:58 2008 | http://epydoc.sourceforge.net |