Package epydoc :: Module apidoc :: Class VariableDoc

type VariableDoc

API documentation information about a single Python variable.

Note: The only time a VariableDoc will have its own docstring is if that variable was created using an assignment statement, and that assignment statement had a docstring-comment or was followed by a pseudo-docstring.

Instance Methods

[hide private]

__init__(self, **kwargs)
Construct a new APIDoc object. source code
call graph

__repr__(self)

source code

_get_defining_module(self)

source code
call graph

apidoc_links(self, **filters)
Return a list of all APIDocs 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

bool

is_detailed(self)
Does this object deserve a box with extra details?

source code
call graph

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

Inherited from APIDoc (private): _debug_setattr

Instance Variables

[hide private]

Basic Variable Information

str name = _Sentinel('UNKNOWN')
The name of this variable in its containing namespace.

ValueDoc container = _Sentinel('UNKNOWN')
API documentation for the namespace that contains this variable.

DottedName canonical_name = _Sentinel('UNKNOWN')
A dotted name that serves as a unique identifier for this VariableDoc.

ValueDoc value = _Sentinel('UNKNOWN')
The API documentation for this variable's value.

Information Extracted from Docstrings

ParsedDocstring type_descr = _Sentinel('UNKNOWN')
A description of the variable's expected type, extracted from its docstring.

Inherited from APIDoc: descr, extra_docstring_fields, metadata, other_docs, summary

Information about Imported Variables

DottedName imported_from = _Sentinel('UNKNOWN')
The fully qualified dotted name of the variable that this variable's value was imported from.

bool is_imported = _Sentinel('UNKNOWN')
Was this variable's value imported from another module? (Exception: variables that are explicitly included in __all__ have is_imported set to False, even if they are in fact imported.)

Information about Variables in Classes

bool is_instvar = _Sentinel('UNKNOWN')
If true, then this variable is an instance variable; if false, then this variable is a class variable.

VariableDoc overrides = _Sentinel('UNKNOWN')
The API documentation for the variable that is overridden by this variable.

Flags

bool is_alias = _Sentinel('UNKNOWN')
Is this variable an alias for another variable with the same value? If so, then this variable will be dispreferred when assigning canonical names.

bool is_public = _Sentinel('UNKNOWN')
Is this variable part of its container's public API?

Docstrings

Inherited from APIDoc: docstring, docstring_lineno

Source Information

Inherited from APIDoc: docs_extracted_by

Properties

[hide private]

defining_module
A read-only property that can be used to get the variable's defining module.

Method Details

[hide private]

init(self, **kwargs)
(Constructor)

source code
call graph

Construct a new APIDoc object. Keyword arguments may be used to initialize the new APIDoc's attributes.

Raises:

TypeError - If a keyword argument is specified that does not correspond to a valid attribute for this (sub)class of APIDoc.

Overrides: APIDoc.__init__

(inherited documentation)

repr(self)
(Representation operator)

source code

Overrides: APIDoc.__repr__

apidoc_links(self, **filters)

source code
call graph

Return a list of all APIDocs 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)

is_detailed(self)

source code
call graph

Does this object deserve a box with extra details?

Returns: bool: True if the object needs extra details, else False.
Overrides: APIDoc.is_detailed: (inherited documentation)

Instance Variable Details

[hide private]

canonical_name

A dotted name that serves as a unique identifier for this VariableDoc. It should be formed by concatenating the VariableDoc's container with its name.

Type:: DottedName

Value:

_Sentinel('UNKNOWN')

imported_from

The fully qualified dotted name of the variable that this variable's value was imported from. This attribute should only be defined if is_instvar is true.

Type:: DottedName

Value:

_Sentinel('UNKNOWN')

is_instvar

If true, then this variable is an instance variable; if false, then this variable is a class variable. This attribute should only be defined if the containing namespace is a class

Type:: bool

Value:

_Sentinel('UNKNOWN')

overrides

The API documentation for the variable that is overridden by this variable. This attribute should only be defined if the containing namespace is a class.

Type:: VariableDoc

Value:

_Sentinel('UNKNOWN')

Property Details

[hide private]

defining_module

A read-only property that can be used to get the variable's defining module. This is defined as the defining module of the variable's container.

Get Method:: _get_defining_module(self)

type VariableDoc

__init__(self, **kwargs) (Constructor)

__repr__(self) (Representation operator)

apidoc_links(self, **filters)

is_detailed(self)

canonical_name

imported_from

is_instvar

overrides

defining_module

init(self, **kwargs)
(Constructor)

repr(self)
(Representation operator)