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.
|
|
Call Graph |
|
|
|
|
|
Call Graph |
|
|
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 |
|
bool
|
|
Call Graph |
|
Inherited from APIDoc :
__cmp__ ,
__hash__ ,
__setattr__ ,
__str__ ,
merge_and_overwrite ,
pp ,
specialize_to
Inherited from object :
__delattr__ ,
__getattribute__ ,
__new__ ,
__reduce__ ,
__reduce_ex__
|
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.
|
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
|
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.)
|
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.
|
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?
|
Inherited from APIDoc :
docstring ,
docstring_lineno
|
Inherited from APIDoc :
docs_extracted_by
|