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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
from __future__ import annotations
import gettext
import os
import sys
from pathlib import Path
from types import SimpleNamespace
from typing import TYPE_CHECKING
import docutils
import pytest
import sphinx
import sphinx.locale
import sphinx.pycode
from sphinx.testing.util import _clean_up_global_state
if TYPE_CHECKING:
from collections.abc import Iterator
_TESTS_ROOT = Path(__file__).resolve().parent
if 'CI' in os.environ and (_TESTS_ROOT / 'roots-read-only').is_dir():
_ROOTS_DIR = _TESTS_ROOT / 'roots-read-only'
else:
_ROOTS_DIR = _TESTS_ROOT / 'roots'
def _init_console(
locale_dir: str | os.PathLike[str] | None = sphinx.locale._LOCALE_DIR,
catalog: str = 'sphinx',
) -> tuple[gettext.NullTranslations, bool]:
"""Monkeypatch ``init_console`` to skip its action.
Some tests rely on warning messages in English. We don't want
CLI tests to bleed over those tests and make their warnings
translated.
"""
return gettext.NullTranslations(), False
sphinx.locale.init_console = _init_console
pytest_plugins = ['sphinx.testing.fixtures']
# Exclude 'roots' dirs for pytest test collector
collect_ignore = ['roots']
os.environ['SPHINX_AUTODOC_RELOAD_MODULES'] = '1'
@pytest.fixture(scope='session')
def rootdir() -> Path:
return _ROOTS_DIR
def pytest_report_header(config: pytest.Config) -> str:
lines = [
f'libraries: Sphinx-{sphinx.__display_version__}, docutils-{docutils.__version__}',
]
if sys.version_info[:2] >= (3, 13):
lines.append(f'GIL enabled?: {sys._is_gil_enabled()}')
lines.append(f'test roots directory: {_ROOTS_DIR}')
if hasattr(config, '_tmp_path_factory'):
lines.append(f'base tmp_path: {config._tmp_path_factory.getbasetemp()}')
return '\n'.join(lines)
@pytest.fixture(autouse=True)
def _cleanup_docutils() -> Iterator[None]:
saved_path = sys.path
yield # run the test
sys.path[:] = saved_path
_clean_up_global_state()
@pytest.fixture
def _http_teapot(monkeypatch: pytest.MonkeyPatch) -> Iterator[None]:
"""Short-circuit HTTP requests.
Windows takes too long to fail on connections, hence this fixture.
"""
# https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/418
response = SimpleNamespace(status_code=418)
def _request(*args, **kwargs):
return response
with monkeypatch.context() as m:
m.setattr('sphinx.util.requests._Session.request', _request)
yield
@pytest.fixture
def make_app_with_empty_project(make_app, tmp_path):
(tmp_path / 'conf.py').touch()
def _make_app(*args, **kw):
kw.setdefault('srcdir', Path(tmp_path))
return make_app(*args, **kw)
return _make_app
|
