pydocspec.basebuilder.Collector

class documentation

class Collector(BaseCollector[_model.Module, _model.ApiObject]): (source)

Known subclasses: pydocspec.astbuilder.BuilderVisitor, pydocspec.converter._ConverterVisitor

View In Hierarchy

Base class to organize a tree of pydocspec objects.

Maintains a stack of objects and incrementally build one Module instance.

See Also
pydocspec.TreeRoot.add_object
Method __init__ Undocumented
Method add_object See TreeRoot.add_object.
Instance Variable module Undocumented
Instance Variable root The root of the tree.
def __init__(self, root, module=None): (source)
overridden in pydocspec.astbuilder.BuilderVisitor

Undocumented

Parameters
root:_model.TreeRootUndocumented
module:Optional[_model.Module]Undocumented
def add_object(self, ob, push=True, parent=None): (source)

See TreeRoot.add_object.

Parameters
ob:_model.ApiObjectUndocumented
push:boolUndocumented
parent:Optional[_model.ApiObject]Undocumented
module = (source)
overridden in pydocspec.astbuilder.BuilderVisitor

Undocumented

root = (source)

The root of the tree.

Can be used to access the root.factory attribute and create new instances.