sphinx.ext.autodoc.importer

module documentation

Importer utilities for autodoc

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Variable logger Undocumented
Class ​Attribute Undocumented
Function get​_class​_members Get members and attributes of target class.
Function get​_module​_members Get members of target module.
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.
logger =

Undocumented

def get_class_members(subject, objpath, attrgetter):
Get members and attributes of target class.
Parameters
subject:AnyUndocumented
objpath:List[str]Undocumented
attrgetter:CallableUndocumented
Returns
Dict[str, ObjectMember]Undocumented
def get_module_members(module):
Get members of target module.
Parameters
module:AnyUndocumented
Returns
List[Tuple[str, Any]]Undocumented
def get_object_members(subject, objpath, attrgetter, analyzer=None):
Get members and attributes of target object.
Parameters
subject:AnyUndocumented
objpath:List[str]Undocumented
attrgetter:CallableUndocumented
analyzer:ModuleAnalyzerUndocumented
Returns
Dict[str, Attribute]Undocumented
def import_module(modname, warningiserror=False):
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):

Undocumented

Parameters
modname:strUndocumented
objpath:List[str]Undocumented
objtype:strUndocumented
attrgetter:Callable[[Any, str], Any]Undocumented
warningiserror:boolUndocumented
Returns
AnyUndocumented
def mangle(subject, name):
Mangle the given name.
Parameters
subject:AnyUndocumented
name:strUndocumented
Returns
strUndocumented
def unmangle(subject, name):
Unmangle the given name.
Parameters
subject:AnyUndocumented
name:strUndocumented
Returns
Optional[str]Undocumented