pydocspec._model.TreeRoot

class documentation

class TreeRoot: (source)

Known subclasses: pydocspec.TreeRoot

Undocumented

Method	`__init__`	Undocumented
Method	`__repr__`	Undocumented
Method	`__str__`	Undocumented
Method	`add_object`	Add a newly created object to the tree. Responsible to add the object to the parent namespace, setup parent attribute, setup the new object to the root instance and respectively.
Class Variable	`factory`	The factory used to create this collection of objects.
Instance Variable	`all_objects`	All objects of the tree in a mapping `full_name` -> `ApiObject`.
Instance Variable	`root_modules`	The root modules of the tree.

def __init__(self): (source)

Undocumented

def __repr__(self): (source)

Undocumented

Returns
`str`	Undocumented

def __str__(self): (source)

Undocumented

Returns
`str`	Undocumented

def add_object(self, ob, parent): (source)

Add a newly created object to the tree. Responsible to add the object to the parent namespace, setup parent attribute, setup the new object to the root instance and respectively.

If parent is None, the object passed will be treated as a root module.

Parameters
ob:`ApiObject`	Undocumented
parent:`Optional[ApiObject]`	Undocumented

factory: ClassVar[specfactory.Factory] = (source)

The factory used to create this collection of objects.

all_objects: DuplicateSafeDict[str, pydocspec.ApiObject] = (source)

overridden in pydocspec.TreeRoot

All objects of the tree in a mapping full_name -> ApiObject.

Note
Special care is taken in order no to shadow objects with duplicate names, see `DuplicateSafeDict`.

root_modules: List[pydocspec.Module] = (source)

overridden in pydocspec.TreeRoot

The root modules of the tree.