File: test_augment_defaults.py

package info (click to toggle)
sphinx-toolbox 3.9.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,924 kB
  • sloc: python: 11,636; sh: 26; javascript: 25; makefile: 16
file content (39 lines) | stat: -rw-r--r-- 1,004 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# 3rd party
import pytest
from sphinx.errors import ExtensionError

# this package
from sphinx_toolbox import __version__
from sphinx_toolbox.more_autodoc import augment_defaults
from sphinx_toolbox.testing import Sphinx, run_setup


def test_setup():
	try:
		Sphinx.extensions = []  # type: ignore[attr-defined]

		setup_ret, directives, roles, additional_nodes, app = run_setup(augment_defaults.setup)

		assert setup_ret == {"parallel_read_safe": True, "version": __version__}

		assert directives == {}
		assert roles == {}
		assert additional_nodes == set()

	finally:
		del Sphinx.extensions  # type: ignore[attr-defined]


def test_setup_wrong_order():
	try:
		Sphinx.extensions = ["sphinx.ext.autodoc"]  # type: ignore[attr-defined]

		with pytest.raises(
				ExtensionError,
				match="'sphinx_toolbox.more_autodoc.augment_defaults' "
				"must be loaded before 'sphinx.ext.autodoc'.",
				):
			run_setup(augment_defaults.setup)

	finally:
		del Sphinx.extensions  # type: ignore[attr-defined]