sphinx.ext.autodoc.mock

module documentation
(source)

mock for autodoc

Class MockFinder A finder for mocking.
Class MockLoader A loader for mocking.
Function ismock Check if the object is mocked.
Function ismockmodule Check if the object is a mocked module.
Function mock Insert mock modules during context::
Function undecorate Unwrap mock if *subject* is decorated by mocked object.
Variable logger Undocumented
Class _MockModule Used by autodoc_mock_imports.
Class _MockObject Used by autodoc_mock_imports.
Function _make_subclass Undocumented
def ismock(subject): (source)

Check if the object is mocked.

Parameters
subject:AnyUndocumented
Returns
boolUndocumented
def ismockmodule(subject): (source)

Check if the object is a mocked module.

Parameters
subject:AnyUndocumented
Returns
boolUndocumented
@contextlib.contextmanager
def mock(modnames): (source)

Insert mock modules during context:: with mock(['target.module.name']): # mock modules are enabled here ...

Parameters
modnames:list[str]Undocumented
Returns
Generator[None, None, None]Undocumented
def undecorate(subject): (source)

Unwrap mock if *subject* is decorated by mocked object. If not decorated, returns given *subject* itself.

Parameters
subject:_MockObjectUndocumented
Returns
AnyUndocumented
logger = (source)

Undocumented

def _make_subclass(name, module, superclass=_MockObject, attributes=None, decorator_args=()): (source)

Undocumented

Parameters
name:strUndocumented
module:strUndocumented
superclass:AnyUndocumented
attributes:AnyUndocumented
decorator_args:tupleUndocumented
Returns
AnyUndocumented