epydoc.apidoc.VariableDoc

Package epydoc :: Module apidoc :: Class VariableDoc

Class VariableDoc
source code

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.

__repr__(self)
repr(x)...

_get_canonical_name(self)

_get_defining_module(self)

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.)

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__

Class Variables	[hide private]

Inherited from object: __class__

Instance Variables	[hide private]

Basic Variable Information

name The name of this variable in its containing namespace.

container API documentation for the namespace that contains this variable.

value The API documentation for this variable's value.

Information Extracted from Docstrings

type_descr A description of the variable's expected type, extracted from its docstring.

Inherited from APIDoc: descr, extra_docstring_fields, metadata, summary

Information about Imported Variables

imported_from The fully qualified dotted name of the variable that this variable's value was imported from.

is_imported 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

is_instvar If true, then this variable is an instance variable; if false, then this variable is a class variable.

overrides The API documentation for the variable that is overridden by this variable.

Flags

is_alias Is this variable an alias for another variable with the same value? If so, then this variable will be dispreferred when assigning canonical names.

is_public 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]

canonical_name

A read-only property that can be used to get the variable's canonical name.

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.

Overrides: APIDoc.__init__: (inherited documentation)

repr(self)
(Representation operator)

source code

repr(x)

Overrides: APIDoc.__repr__

_get_canonical_name(self)

source code
call graph

_get_defining_module(self)

source code
call graph

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: APIDoc.apidoc_links: (inherited documentation)

Instance Variable Details	[hide private]

name

The name of this variable in its containing namespace.

Type:: str

Value:

epydoc.apidoc.UNKNOWN

container

API documentation for the namespace that contains this variable.

Type:: ValueDoc

Value:

epydoc.apidoc.UNKNOWN

value

The API documentation for this variable's value.

Type:: ValueDoc

Value:

epydoc.apidoc.UNKNOWN

type_descr

A description of the variable's expected type, extracted from its docstring.

Type:: ParsedDocstring

Value:

epydoc.apidoc.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:

epydoc.apidoc.UNKNOWN

is_imported

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.)

Type:: bool

Value:

epydoc.apidoc.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:

epydoc.apidoc.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:

epydoc.apidoc.UNKNOWN

is_alias

Is this variable an alias for another variable with the same value? If so, then this variable will be dispreferred when assigning canonical names.

Type:: bool

Value:

epydoc.apidoc.UNKNOWN

is_public

Is this variable part of its container's public API?

Type:: bool

Value:

epydoc.apidoc.UNKNOWN

Property Details	[hide private]

canonical_name


A read-only property that can be used to get the variable's
canonical name.  This is formed by taking the varaible's
container's cannonical name, and adding the variable's name
to it.


Get Method:: epydoc.apidoc.VariableDoc._get_canonical_name(self)
Set Method:: None
Delete Method:: None

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:: epydoc.apidoc.VariableDoc._get_defining_module(self)
Set Method:: None
Delete Method:: None

Class VariableDoc source code

__init__(self, **kwargs) (Constructor)

__repr__(self) (Representation operator)

_get_canonical_name(self)

_get_defining_module(self)

apidoc_links(self, **filters)

name

container

value

type_descr

imported_from

is_imported

is_instvar

overrides

is_alias

is_public

canonical_name

defining_module

Class VariableDoc
source code

init(self, **kwargs)
(Constructor)

repr(self)
(Representation operator)