pydoctor.model.System

class documentation

class System:

Known subclasses: pydoctor.zopeinterface.ZopeInterfaceSystem

A collection of related documentable objects.

PyDoctor documents collections of objects, often the contents of a package.

Method	`__init__`	Undocumented
Method	`addModuleFromPath`	Undocumented
Method	`addObject`	Add `object` to the system.
Method	`addPackage`	Undocumented
Method	`analyzeModule`	Undocumented
Method	`fetchIntersphinxInventories`	Download and parse intersphinx inventories based on configuration.
Method	`find_object`	Look up an object using a potentially outdated full name.
Method	`getProcessedModule`	Undocumented
Method	`handleDuplicate`	This is called when we see two objects with the same .fullName(), for example:
Method	`introspectModule`	Undocumented
Method	`msg`	Undocumented
Method	`objectsOfType`	Iterate over all instances of `cls` present in the system.
Method	`objForFullName`	Undocumented
Method	`postProcess`	Called when there are no more unprocessed modules.
Method	`privacyClass`	Undocumented
Method	`process`	Undocumented
Method	`processModule`	Undocumented
Method	`progress`	Undocumented
Method	`setSourceHref`	Undocumented
Method	`verbosity`	Undocumented
Class Variable	`defaultBuilder`	Undocumented
Class Variable	`sourcebase`	Undocumented
Instance Variable	`allobjects`	Undocumented
Instance Variable	`buildtime`	Undocumented
Instance Variable	`docstring_syntax_errors`	FullNames of objects for which the docstring failed to parse.
Instance Variable	`intersphinx`	Undocumented
Instance Variable	`module_count`	Undocumented
Instance Variable	`needsnl`	Undocumented
Instance Variable	`once_msgs`	Undocumented
Instance Variable	`options`	Undocumented
Instance Variable	`processing_modules`	Undocumented
Instance Variable	`projectname`	Undocumented
Instance Variable	`rootobjects`	Undocumented
Instance Variable	`unprocessed_modules`	Undocumented
Instance Variable	`verboselevel`	Undocumented
Instance Variable	`violations`	No summary
Property	`root_names`	The top-level package/module names in this system.
Method	`_introspectThing`	Undocumented
Method	`_warning`	Undocumented

def __init__(self, options=None):

Undocumented

Parameters
options:`Optional[Values]`	Undocumented

def addModuleFromPath(self, path, package):

Undocumented

Parameters
path:`Path`	Undocumented
package:`Optional[_PackageT]`	Undocumented

def addObject(self, obj):

Add object to the system.

Parameters
obj:`Documentable`	Undocumented

def addPackage(self, package_path, parentPackage=None):

Undocumented

Parameters
package_path:`Path`	Undocumented
parentPackage:`Optional[_PackageT]`	Undocumented

def analyzeModule(self, modpath, modname, parentPackage=None, is_package=False):

Undocumented

Parameters
modpath:`Path`	Undocumented
modname:`str`	Undocumented
parentPackage:`Optional[_PackageT]`	Undocumented
is_package:`bool`	Undocumented
Returns
`_ModuleT`	Undocumented

def fetchIntersphinxInventories(self, cache):

Download and parse intersphinx inventories based on configuration.

Parameters
cache:`CacheT`	Undocumented

def find_object(self, full_name):

Look up an object using a potentially outdated full name.

A name can become outdated if the object is reparented: objForFullName() will only be able to find it under its new name, but we might still have references to the old name.

Parameters
full_name:`str`	The fully qualified name of the object.
Returns
`Optional[Documentable]`	The object, or `None` if the name is external (it does not match any of the roots of this system).
Raises
`LookupError`	If the object is not found, while its name does match one of the roots of this system.

def getProcessedModule(self, modname):

Undocumented

Parameters
modname:`str`	Undocumented
Returns
`Optional[_ModuleT]`	Undocumented

def handleDuplicate(self, obj):

This is called when we see two objects with the same .fullName(), for example:

    class C:
        if something:
            def meth(self):
                implementation 1
        else:
            def meth(self):
                implementation 2

The default is that the second definition "wins".

Parameters
obj:`Documentable`	Undocumented

def introspectModule(self, path, module_name, package):

Undocumented

Parameters
path:`Path`	Undocumented
module_name:`str`	Undocumented
package:`Optional[_PackageT]`	Undocumented
Returns
`_ModuleT`	Undocumented

def msg(self, section, msg, thresh=0, topthresh=100, nonl=False, wantsnl=True, once=False):

Undocumented

Parameters
section:`str`	Undocumented
msg:`str`	Undocumented
thresh:`int`	Undocumented
topthresh:`int`	Undocumented
nonl:`bool`	Undocumented
wantsnl:`bool`	Undocumented
once:`bool`	Undocumented

def objectsOfType(self, cls):

Iterate over all instances of cls present in the system.

Parameters
cls:`Type[T]`	Undocumented
Returns
`Iterator[T]`	Undocumented

def objForFullName(self, fullName):

Undocumented

Parameters
fullName:`str`	Undocumented
Returns
`Optional[Documentable]`	Undocumented

def postProcess(self):

overridden in pydoctor.zopeinterface.ZopeInterfaceSystem

Called when there are no more unprocessed modules.

Analysis of relations between documentables can be done here, without the risk of drawing incorrect conclusions because modules were not fully processed yet.

def privacyClass(self, ob):

Undocumented

Parameters
ob:`Documentable`	Undocumented
Returns
`PrivacyClass`	Undocumented

def process(self):

Undocumented

def processModule(self, mod):

Undocumented

Parameters
mod:`_ModuleT`	Undocumented

def progress(self, section, i, n, msg):

Undocumented

Parameters
section:`str`	Undocumented
i:`int`	Undocumented
n:`Optional[int]`	Undocumented
msg:`str`	Undocumented

def setSourceHref(self, mod, source_path):

Undocumented

Parameters
mod:`_ModuleT`	Undocumented
source_path:`Path`	Undocumented

def verbosity(self, section):

Undocumented

Parameters
section:`Union[str, Iterable[str]]`	Undocumented
Returns
`int`	Undocumented

defaultBuilder: Type[ASTBuilder] =

Undocumented

sourcebase: Optional[str] =

Undocumented

allobjects: Dict[str, Documentable] =

Undocumented

buildtime =

Undocumented

docstring_syntax_errors: Set[str] =

FullNames of objects for which the docstring failed to parse.

intersphinx =

Undocumented

module_count: int =

Undocumented

needsnl: bool =

Undocumented

once_msgs: Set[Tuple[str, str]] =

Undocumented

options =

Undocumented

processing_modules: List[str] =

Undocumented

projectname: str =

Undocumented

rootobjects: List[_ModuleT] =

Undocumented

unprocessed_modules: Set[Module] =

Undocumented

verboselevel: int =

Undocumented

violations: int =

The number of docstring problems found. This is used to determine whether to fail the build when using the --warnings-as-errors option, so it should only be increased for problems that the user can fix.

@property
root_names: Collection[str] =

The top-level package/module names in this system.

def _introspectThing(self, thing, parent, parentMod):

Undocumented

Parameters
thing:`object`	Undocumented
parent:`Documentable`	Undocumented
parentMod:`_ModuleT`	Undocumented

def _warning(self, current, message, detail):

Undocumented

Parameters
current:`Optional[Documentable]`	Undocumented
message:`str`	Undocumented
detail:`str`	Undocumented