pydocspec.TreeRoot

class documentation

class TreeRoot(_model.TreeRoot): (source)

View In Hierarchy

A collection of related documentable objects, also known as "the system".

This special object provides a single view on all referencable objects in the tree and root modules.

Note
A reference to the root instance is kept on all API objects as ApiObject.root.
Class Variable all_objects All objects of the tree in a mapping full_name -> ApiObject.
Class Variable root_modules The root modules of the tree.

Inherited from TreeRoot:

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.
all_objects: dupsafedict.DuplicateSafeDict[str, ApiObject] = (source)
overrides pydocspec._model.TreeRoot.all_objects

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[Module] = (source)
overrides pydocspec._model.TreeRoot.root_modules

The root modules of the tree.