pydoctor.model.Module

class documentation

class Module(CanContainImportsDocumentable): (source)

Known subclasses: pydoctor.extensions.zopeinterface.ZopeInterfaceModule, pydoctor.model.Package

Constructor: Module(system, name, parent, source_path)

View In Hierarchy

Undocumented

Method docformat.setter Undocumented
Method setup Undocumented
Method submodules Returns an iterator over the visible submodules.
Instance Variable all Names listed in the __all__ variable of this module.
Property docformat The name of the format to be used for parsing docstrings in this module.
Property module This object's Module.
Property privacyClass How visible this object should be.
Method _localNameToFullName Undocumented
Instance Variable _docformat Undocumented
Instance Variable _is_c_module Whether this module is a C-extension.
Instance Variable _py_mod The live module if the module was built from introspection.
Instance Variable _py_string The module string if the module was built from text.

Inherited from CanContainImportsDocumentable:

Method isNameDefined Is the given name defined in the globals/locals of self-context? Only the first name of a dotted name is checked.
Method localNames Undocumented
Instance Variable _localNameToFullName_map Undocumented

Inherited from Documentable (via CanContainImportsDocumentable):

Method __init__ Undocumented
Method __repr__ Undocumented
Method docsources Objects that can be considered as a source of documentation.
Method expandAnnotationName Like expandName but gives precedence to the module scope when a name is defined both in the current scope and the module scope.
Method expandName Return a fully qualified name for the possibly-dotted `name`.
Method fullName Undocumented
Method reparent Undocumented
Method report Log an error or warning about this documentable object.
Method resolveName Return the object named by "name" (using Python's lookup rules) in this context, if any is known to pydoctor.
Method setDocstring Undocumented
Method setLineNumber Save the linenumber of this object.
Class Variable kind Undocumented
Class Variable parsed_summary Undocumented
Class Variable parsed_type Undocumented
Instance Variable contents Undocumented
Instance Variable docstring The object's docstring. But also see docsources.
Instance Variable docstring_lineno Undocumented
Instance Variable extra_info A list to store extra informations about this documentable, as ParsedDocstring.
Instance Variable linenumber Undocumented
Instance Variable name Undocumented
Instance Variable parent Undocumented
Instance Variable parentMod Undocumented
Instance Variable parsed_docstring Undocumented
Instance Variable source_path Undocumented
Instance Variable sourceHref Undocumented
Instance Variable system The system the object is part of.
Property description A string describing our source location to the user.
Property docstring_linker Returns an instance of DocstringLinker suitable for resolving names in the context of the object.
Property doctarget Undocumented
Property isPrivate Is this object considered private API?
Property isVisible Is this object so private as to be not shown at all?
Property page_object The documentable to which the page we're documented on belongs. For example methods are documented on the page of their class, functions are documented in their module's page etc.
Property url Relative URL at which the documentation for this Documentable can be found.
Method _handle_reparenting_post Undocumented
Method _handle_reparenting_pre Undocumented
Method _setDocstringValue Undocumented
Instance Variable _linker Undocumented
@docformat.setter
def docformat(self, value: str): (source)

Undocumented

def setup(self): (source)
overrides pydoctor.model.CanContainImportsDocumentable.setup
overridden in pydoctor.extensions.zopeinterface.ZopeInterfaceModule

Undocumented

def submodules(self) -> Iterator[Module]: (source)

Returns an iterator over the visible submodules.

all: Collection[str] | None = (source)

Names listed in the __all__ variable of this module.

These names are considered to be exported by the module, both for the purpose of from <module> import * and for the purpose of publishing names from private modules.

If no __all__ variable was found in the module, or its contents could not be parsed, this is None.

@property
docformat: str | None = (source)

The name of the format to be used for parsing docstrings in this module.

The docformat value are inherited from packages if a __docformat__ variable is defined in the __init__.py file.

If no __docformat__ variable was found or its contents could not be parsed, this is None.

@property
module: Module = (source)
overrides pydoctor.model.Documentable.module

This object's Module.

For modules, this returns the object itself, otherwise the module containing the object is returned.

@property
privacyClass: PrivacyClass = (source)
overrides pydoctor.model.Documentable.privacyClass

How visible this object should be.

def _localNameToFullName(self, name: str) -> str: (source)
overrides pydoctor.model.Documentable._localNameToFullName

Undocumented

_docformat: str | None = (source)

Undocumented

_is_c_module: bool = (source)

Whether this module is a C-extension.

_py_mod: types.ModuleType | None = (source)

The live module if the module was built from introspection.

_py_string: str | None = (source)

The module string if the module was built from text.