API reference

pytest plugin for doctest w/ reStructuredText and markdown.

See also

• http://www.sphinx-doc.org/en/stable/ext/doctest.html

• https://github.com/sphinx-doc/sphinx/blob/master/sphinx/ext/doctest.py

This is a derivative of my PR https://github.com/thisch/pytest-sphinx/pull/38 to pytest-sphinx (BSD 3-clause), 2022-09-03.

pytest_doctest_docutils.pytest_addoption(parser)

function

function

pytest_doctest_docutils.pytest_addoption(parser)

Add options to py.test for doctest_docutils.

Parameters:

parser (Parser)

Return type:

None

pytest_doctest_docutils.pytest_configure(config)

function

function

pytest_doctest_docutils.pytest_configure(config)

Disable pytest.doctest to prevent running tests twice.

Todo: Find a way to make these plugins cooperate without collecting twice.

Parameters:

config (Config)

Return type:

None

pytest_doctest_docutils._unblock_doctest(config)

function

function

pytest_doctest_docutils._unblock_doctest(config)

Unblock doctest plugin (pytest 8.1+ only).

Re-enables the built-in doctest plugin after it was blocked by pytest_configure. Uses the public unblock() API introduced in pytest 8.1.0.

Parameters:

config (pytest.Config) – The pytest configuration object

Returns:

True if unblocked successfully, False if API not available

Return type:

bool

pytest_doctest_docutils.pytest_unconfigure()

function

function

pytest_doctest_docutils.pytest_unconfigure()

Unconfigure hook for pytest-doctest-docutils.

Return type:

None

pytest_doctest_docutils.pytest_ignore_collect(collection_path)

function

function

pytest_doctest_docutils.pytest_ignore_collect(collection_path)

Skip Sphinx _build/ output during collection.

pytest’s default norecursedirs excludes build but not _build, so Sphinx output (which mirrors sources, broken relative includes and all) would otherwise be collected and abort the session.

>>> import pathlib
>>> pytest_ignore_collect(pathlib.Path("docs/_build/html/history.md"))
True
>>> pytest_ignore_collect(pathlib.Path("docs/history.md")) is None
True

Parameters:

collection_path (Path)

Return type:

bool | None

pytest_doctest_docutils.pytest_collect_file(file_path, parent)

function

function

pytest_doctest_docutils.pytest_collect_file(file_path, parent)

Test collector for pytest-doctest-docutils.

Parameters:

• file_path (Path)

• parent (Collector)

Return type:

DocTestDocutilsFile | DoctestModule | None

pytest_doctest_docutils._is_doctest(config, path, parent)

function

function

pytest_doctest_docutils._is_doctest(config, path, parent)

Parameters:

• config (Config)

• path (Path)

• parent (Collector)

Return type:

bool

pytest_doctest_docutils._init_runner_class()

function

function

pytest_doctest_docutils._init_runner_class()

Return type:

type[DocTestRunner]

pytest_doctest_docutils._get_allow_unicode_flag()

function

function

pytest_doctest_docutils._get_allow_unicode_flag()

Register and return the ALLOW_UNICODE flag.

Return type:

int

pytest_doctest_docutils._get_allow_bytes_flag()

function

function

pytest_doctest_docutils._get_allow_bytes_flag()

Register and return the ALLOW_BYTES flag.

Return type:

int

pytest_doctest_docutils._get_number_flag()

function

function

pytest_doctest_docutils._get_number_flag()

Register and return the NUMBER flag.

Return type:

int

pytest_doctest_docutils._get_flag_lookup()

function

function

pytest_doctest_docutils._get_flag_lookup()

Return type:

dict[str, int]

pytest_doctest_docutils.get_optionflags(config)

function

function

pytest_doctest_docutils.get_optionflags(config)

Fetch optionflags from pytest configuration.

Extracted from pytest.doctest 8.0 (license: MIT).

Parameters:

config (Config)

Return type:

int

pytest_doctest_docutils._get_runner(checker=None, verbose=None, optionflags=0, continue_on_failure=True)

function

function

pytest_doctest_docutils._get_runner(checker=None, verbose=None, optionflags=0, continue_on_failure=True)

Parameters:

• checker (OutputChecker | None)

• verbose (bool | None)

• optionflags (int)

• continue_on_failure (bool)

Return type:

DocTestRunner

class pytest_doctest_docutils.DocutilsDocTestRunner

class

class

class pytest_doctest_docutils.DocutilsDocTestRunner

Bases: DocTestRunner

DocTestRunner for doctest_docutils.

summarize(out, verbose=None)

method

method

summarize(out, verbose=None)

Summarize the test runs.

Parameters:

• out (_Out)

• verbose (bool | None)

Return type:

tuple[int, int]

class pytest_doctest_docutils.DocTestDocutilsFile

class

class

class pytest_doctest_docutils.DocTestDocutilsFile

Bases: Module

Pytest module for doctest_docutils.

obj = None

attribute

attribute

obj = None

collect()

method

method

collect()

Collect tests for pytest module.

Return type:

Iterable[DoctestItem]

_nodeid

attribute

attribute

_nodeid

_store

attribute

attribute

_store

config: Config

attribute

attribute

config: Config

The pytest config object.

name: str

attribute

attribute

name: str

A unique name within the scope of the parent node.

parent

attribute

attribute

parent

The parent collector node.

path: pathlib.Path

attribute

attribute

path: pathlib.Path

Filesystem path where this node was collected from.

session: Session

attribute

attribute

session: Session

The pytest session this node is part of.

_abc_impl = <_abc._abc_data object>

attribute

attribute

_abc_impl = <_abc._abc_data object>