sphinx.ext.autodoc.importer

module documentation
(source)

Importer utilities for autodoc

Class Attribute Undocumented
Function get_class_members Get members and attributes of target class.
Function get_object_members Get members and attributes of target object.
Function import_module Call importlib.import_module(modname), convert exceptions to ImportError
Function import_object Undocumented
Function mangle Mangle the given name.
Function unmangle Unmangle the given name.
Variable logger Undocumented
def get_class_members(subject, objpath, attrgetter, inherit_docstrings=True): (source)

Get members and attributes of target class.

Parameters
subject:AnyUndocumented
objpath:list[str]Undocumented
attrgetter:CallableUndocumented
inherit_docstrings:boolUndocumented
Returns
dict[str, ObjectMember]Undocumented
def get_object_members(subject, objpath, attrgetter, analyzer=None): (source)

Get members and attributes of target object.

Parameters
subject:AnyUndocumented
objpath:list[str]Undocumented
attrgetter:CallableUndocumented
analyzer:ModuleAnalyzer|NoneUndocumented
Returns
dict[str, Attribute]Undocumented
def import_module(modname, warningiserror=False): (source)

Call importlib.import_module(modname), convert exceptions to ImportError

Parameters
modname:strUndocumented
warningiserror:boolUndocumented
Returns
AnyUndocumented
def import_object(modname, objpath, objtype='', attrgetter=safe_getattr, warningiserror=False): (source)

Undocumented

Parameters
modname:strUndocumented
objpath:list[str]Undocumented
objtype:strUndocumented
attrgetter:Callable[[Any, str], Any]Undocumented
warningiserror:boolUndocumented
Returns
AnyUndocumented
def mangle(subject, name): (source)

Mangle the given name.

Parameters
subject:AnyUndocumented
name:strUndocumented
Returns
strUndocumented
def unmangle(subject, name): (source)

Unmangle the given name.

Parameters
subject:AnyUndocumented
name:strUndocumented
Returns
str|NoneUndocumented
logger = (source)

Undocumented