pydoctor.model.Module

class documentation

class Module(CanContainImportsDocumentable):

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

View In Hierarchy

Undocumented

Method docformat.setter Undocumented
Method setup Undocumented
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 privacy​Class How visible this object should be.
Method _local​Name​To​Full​Name Undocumented
Instance Variable ​_docformat Undocumented

Inherited from CanContainImportsDocumentable:

Instance Variable _local​Name​To​Full​Name_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 expand​Name Return a fully qualified name for the possibly-dotted `name`.
Method full​Name Undocumented
Method reparent Undocumented
Method report Log an error or warning about this documentable object.
Method resolve​Name Return the object named by "name" (using Python's lookup rules) in this context, if any is known to pydoctor.
Method set​Docstring Undocumented
Method set​Line​Number Undocumented
Class Variable kind Undocumented
Class Variable parsed​_docstring 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 linenumber Undocumented
Instance Variable name Undocumented
Instance Variable parent Undocumented
Instance Variable parent​Mod Undocumented
Instance Variable source​_path Undocumented
Instance Variable source​Href Undocumented
Instance Variable system The system the object is part of.
Property description A string describing our source location to the user.
Property doctarget Undocumented
Property is​Private Is this object considered private API?
Property is​Visible 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
Instance Variable ​_deprecated​_info Undocumented
@docformat.setter
def docformat(self, value):

Undocumented

Parameters
value:strUndocumented
def setup(self):
overrides pydoctor.model.CanContainImportsDocumentable.setup
overridden in pydoctor.zopeinterface.ZopeInterfaceModule

Undocumented

all: Optional[Collection[str]] =

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: Optional[str] =

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 =
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 =
overrides pydoctor.model.Documentable.privacyClass
How visible this object should be.
def _localNameToFullName(self, name):
overrides pydoctor.model.Documentable._localNameToFullName

Undocumented

Parameters
name:strUndocumented
Returns
strUndocumented
_docformat =

Undocumented