xdoctest.utils.util_misc module

Utilities that are mainly used in self-testing

class xdoctest.utils.util_misc.TempDoctest(docstr: str, modname: str | None = None)

Bases: object

Creates a temporary file containing a module-level doctest for testing

Example

>>> from xdoctest import core
>>> self = TempDoctest('>>> a = 1')
>>> doctests = list(core.parse_doctestables(self.modpath))
>>> assert len(doctests) == 1

class xdoctest.utils.util_misc.TempModule(module_text: str, modname: str | None = None)

Bases: object

Creates a temporary directory with a python module.

Example

>>> from xdoctest import core
>>> self = TempDoctest('>>> a = 1')
>>> doctests = list(core.parse_doctestables(self.modpath))
>>> assert len(doctests) == 1

print_contents() → None

For debugging on windows

xdoctest.utils.util_misc._run_case(source: str, style: str = 'auto') → str | None

Runs all doctests in a source block

Parameters:

source (str) – source code of an entire file

TODO: run case is over-duplicated and should be separated into a test utils directory