pydocspec.processor.data

module documentation

(source)

Helpers to populate attributes of Variable instances.

Function	`doc_sources`	all sources of documentation for this data/function, including self and others coming from superclasses. must be called after mro
Function	`is_alias`	check if the value of this data is an alias to another name.
Function	`is_class_variable`	CLASS_VARIABLE in semantic_hints?
Function	`is_constant`	a constant is a all caps varaible or if using Final qualifier, uses name resolution.
Function	`is_instance_variable`	INSTANCE_VARIABLE in ob.semantic_hints?
Function	`is_module_variable`	check if the parent of this data is a module.
Function	`is_type_alias`	Undocumented
Function	`process_aliases`	if the data is an alias, try to resolve it to an apiobject and add `ob` to the list of aliases of the targeted object, uses name resolution.

def doc_sources(ob): (source)

all sources of documentation for this data/function, including self and others coming from superclasses. must be called after mro

def is_alias(ob): (source)

check if the value of this data is an alias to another name.

def is_class_variable(ob): (source)

CLASS_VARIABLE in semantic_hints?

def is_constant(ob): (source)

a constant is a all caps varaible or if using Final qualifier, uses name resolution.

def is_instance_variable(ob): (source)

INSTANCE_VARIABLE in ob.semantic_hints?

def is_module_variable(ob): (source)

check if the parent of this data is a module.

def is_type_alias(ob): (source)

Undocumented

def process_aliases(ob): (source)

if the data is an alias, try to resolve it to an apiobject and add ob to the list of aliases of the targeted object, uses name resolution.

Parameters
ob:`pydocspec.Variable`	Undocumented

pydocspec.processor.data_attr