docspec.Module

class documentation

class Module(HasMembers): (source)

View In Hierarchy

Represents a module, basically a named container for code/API objects. Modules may be nested in other modules. Be aware that for historical reasons, some loaders lile #docspec_python by default do not return nested modules, even if nesting would be appropriate (and instead the #Module.name simply contains the fully qualified name).

Class Variable members Undocumented

Inherited from HasMembers:

Method sync_hierarchy Synchronize the hierarchy of this API object and all of it's children. This should be called when the #HasMembers.members are updated to ensure that all child objects reference the right #parent. Loaders are expected to return #ApiObject#s in a fully synchronized state such that the user does not have to call this method unless they are doing modifications to the tree.
Instance Variable parent Returns the parent of the #HasMembers. Note that if you make any modifications to the API object tree, you will need to call #sync_hierarchy() afterwards because adding to #Class.members or #Module.members does not automatically keep the #parent property in sync.

Inherited from ApiObject (via HasMembers):

Method __post_init__ Undocumented
Method parent.setter Undocumented
Class Variable docstring Undocumented
Class Variable location Undocumented
Class Variable name Undocumented
Property path Returns a list of all of this API object's parents, from top to bottom. The list includes *self* as the last item.
Instance Variable _parent Undocumented