Package epydoc :: Module apidoc :: Class ClassDoc

[hide private]
[frames] | no frames]

# Class ClassDoc

source code

API documentation information about a single class.

Instance Methods | [hide private]

apidoc_links(self, **filters) Return a list of all `APIDoc`s that are directly linked from this `APIDoc` (i.e., are contained or pointed to by one or more of this `APIDoc`'s attributes.) | source code call graph

Call Graph

is_type(self) | source code call graph

Call Graph

is_exception(self) | source code call graph

Call Graph

is_newstyle_class(self) | source code call graph

Call Graph

mro(self, warn_about_bad_bases=False) | source code call graph

Call Graph

_dfs_bases(self, mro, seen, warn_about_bad_bases) | source code call graph

Call Graph

_c3_mro(self, warn_about_bad_bases) Compute the class precedence list (mro) according to C3. | source code call graph

Call Graph

_report_bad_base(self, base) | source code

_c3_merge(self, seqs) Helper function for _c3_mro. | source code call graph

Call Graph

select_variables(self, group=None, value_type=None, inherited=None, public=None, imported=None, detailed=None) Return a specified subset of this class's sorted_variables list. | source code call graph

Call Graph

Inherited from `NamespaceDoc`: `__init__`, `group_names`, `init_sorted_variables`, `init_variable_groups`, `is_detailed`, `report_unused_groups`

Inherited from `NamespaceDoc` (private): `_init_grouping`

Inherited from `ValueDoc`: `__getstate__`, `__repr__`, `__setstate__`

Inherited from `APIDoc`: `__cmp__`, `__hash__`, `__setattr__`, `__str__`, `merge_and_overwrite`, `pp`, `specialize_to`

Inherited from `APIDoc` (private): `_debug_setattr`

Inherited from `object`: `__delattr__`, `__getattribute__`, `__new__`, `__reduce__`, `__reduce_ex__`

Value Representation
Inherited from `ValueDoc`: `pyval_repr`, `summary_pyval_repr`

Class Variables | [hide private]

Value Representation
Inherited from `ValueDoc`: `REPR_LINELEN`, `REPR_MAXLINES`, `REPR_MIN_SCORE`, `SUMMARY_REPR_LINELEN`

Instance Variables | [hide private]

Inherited from `ValueDoc`: `canonical_name`, `toktree`
Information about Base Classes
`list` of ClassDoc | bases = `_Sentinel('UNKNOWN')` API documentation for the class's base classes.
Information about Subclasses
`list` of ClassDoc | subclasses = `_Sentinel('UNKNOWN')` API documentation for the class's known subclasses.
Information about Variables
Inherited from `NamespaceDoc`: `group_specs`, `sort_spec`, `sorted_variables`, `variable_groups`, `variables`
Value Representation
Inherited from `ValueDoc`: `parse_repr`, `pyval`
Context
Inherited from `ValueDoc`: `defining_module`
Information about Imported Variables
Inherited from `ValueDoc`: `proxy_for`
Docstrings
Inherited from `APIDoc`: `docstring`, `docstring_lineno`
Information Extracted from Docstrings
Inherited from `APIDoc`: `descr`, `extra_docstring_fields`, `metadata`, `other_docs`, `summary`
Source Information
Inherited from `APIDoc`: `docs_extracted_by`

Properties | [hide private]

Inherited from `object`: `__class__`

Method Details | [hide private]

### apidoc_links(self, **filters)

source code
call graph

Call Graph

Return a list of all `APIDoc`s that are directly linked from this `APIDoc` (i.e., are contained or pointed to by one or more of this `APIDoc`'s attributes.)

Keyword argument `filters` can be used to selectively exclude certain categories of attribute value. For example, using `includes=False` will exclude variables that were imported from other modules; and `subclasses=False` will exclude subclasses. The filter categories currently supported by epydoc are:

- `imports`: Imported variables.
- `packages`: Containing packages for modules.
- `submodules`: Contained submodules for packages.
- `bases`: Bases for classes.
- `subclasses`: Subclasses for classes.
- `variables`: All variables.
- `private`: Private variables.
- `overrides`: Points from class variables to the variables they override. This filter is False by default.

Overrides: APIDoc.apidoc_links
  (inherited documentation)

### _c3_mro(self, warn_about_bad_bases)

source code
call graph

Call Graph

Compute the class precedence list (mro) according to C3.

See Also: http://www.python.org/2.3/mro.html

### select_variables(self, group=None, value_type=None, inherited=None, public=None, imported=None, detailed=None)

source code
call graph

Call Graph

Return a specified subset of this class's sorted_variables list. If `value_type` is given, then only return variables whose values have the specified type. If `group` is given, then only return variables that belong to the specified group. If `inherited` is True, then only return inherited variables; if `inherited` is False, then only return local variables.

Parameters:
  - `value_type` (`string`) - A string specifying the value type for which variables should be returned. Valid values are:
    - 'instancemethod' - variables whose values are instance methods.
    - 'classmethod' - variables whose values are class methods.
    - 'staticmethod' - variables whose values are static methods.
    - 'properties' - variables whose values are properties.
    - 'class' - variables whose values are nested classes (including exceptions and types).
    - 'instancevariable' - instance variables. This includes any variables that are explicitly marked as instance variables with docstring fields; and variables with docstrings that are initialized in the constructor.
    - 'classvariable' - class variables. This includes any variables that are not included in any of the above categories.
  - `group` (`string`) - The name of the group for which variables should be returned. A complete list of the groups defined by this `ClassDoc` is available in the group_names instance variable. The first element of this list is always the special group name `''`, which is used for variables that do not belong to any group.
  - `inherited` - If `None`, then return both inherited and local variables; if `True`, then return only inherited variables; if `False`, then return only local variables.
  - `detailed` (`bool`) - If True (False), return only the variables deserving (not deserving) a detailed informative box. If `None`, don't care.

Requires: The sorted_variables and variable_groups attributes must be initialized before this method can be used. See init_sorted_variables() and init_variable_groups().