pydoctor.model.ISystemBuilder

class documentation

class ISystemBuilder(abc.ABC): (source)

Known subclasses: pydoctor.model.SystemBuilder

Constructor: ISystemBuilder(system)

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: System): (source)
overridden in pydoctor.model.SystemBuilder

Create the builder.

@abc.abstractmethod
def addModule(self, path: Path, parent_name: str | None = 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.

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

Add a module from text to the system.

@abc.abstractmethod
def buildModules(self): (source)
overridden in pydoctor.model.SystemBuilder

Build the modules.