pydoctor.model.ISystemBuilder

class documentation

class ISystemBuilder(abc.ABC): (source)

Known subclasses: pydoctor.model.SystemBuilder

View In Hierarchy

Interface class for building a system.

Method __init__ Create the builder.
Method addModule Add a module or package from file system path to the pydoctor system. If the path points to a directory, adds all submodules recursively.
Method addModuleString Add a module from text to the system.
Method buildModules Build the modules.
@abc.abstractmethod
def __init__(self, system): (source)
overridden in pydoctor.model.SystemBuilder

Create the builder.

Parameters
system:SystemUndocumented
@abc.abstractmethod
def addModule(self, path, parent_name=None): (source)
overridden in pydoctor.model.SystemBuilder

Add a module or package from file system path to the pydoctor system. If the path points to a directory, adds all submodules recursively.

Parameters
path:PathUndocumented
parent_name:Optional[str]Undocumented
Raises
SystemBuildingErrorIf there is an error while adding the module/package.
@abc.abstractmethod
def addModuleString(self, text, modname, parent_name=None, is_package=False): (source)
overridden in pydoctor.model.SystemBuilder

Add a module from text to the system.

Parameters
text:strUndocumented
modname:strUndocumented
parent_name:Optional[str]Undocumented
is_package:boolUndocumented
@abc.abstractmethod
def buildModules(self): (source)
overridden in pydoctor.model.SystemBuilder

Build the modules.