pydocspec.basebuilder.BaseCollector

class documentation

class BaseCollector(Generic[ModuleT, ApiObjectT]): (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method current.setter Undocumented
Method last.setter Undocumented
Method pop Exit an object.
Method push Enter an object. We can push attributes, but we can't push other stuff inside it.
Instance Variable current Undocumented
Instance Variable last Undocumented
Instance Variable module The new module.
Instance Variable state Undocumented
Property stack Undocumented
def __init__(self, module=None): (source)

Undocumented

Parameters
module:Optional[ModuleT]Undocumented
@current.setter
def current(self, ob): (source)

Undocumented

Parameters
ob:ApiObjectTUndocumented
@last.setter
def last(self, ob): (source)

Undocumented

Parameters
ob:ApiObjectTUndocumented
def pop(self, ob): (source)

Exit an object.

Parameters
ob:ApiObjectTUndocumented
def push(self, ob): (source)

Enter an object. We can push attributes, but we can't push other stuff inside it.

Parameters
ob:ApiObjectTUndocumented
@property
current = (source)

Undocumented

@property
last = (source)

Undocumented

module = (source)

The new module.

state: TreeWalkingState[ApiObjectT] = (source)

Undocumented

@property
stack: List[ApiObjectT] = (source)

Undocumented