IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Clean up global state in SphinxTestApp

Browse Source
This commit is contained in:
Adam Turner 2024-01-18 23:30:22 +00:00
parent a8f35bb463
commit e3b613aa37
2 changed files with 29 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
sphinx/testing/util.py
View File

@ -10,8 +10,12 @@ from typing import IO, TYPE_CHECKING, Any
from xml.etree import ElementTree from xml.etree import ElementTree
from docutils import nodes from docutils import nodes
from docutils.parsers.rst import directives, roles
from sphinx import application import sphinx.application
import sphinx.locale
import sphinx.pycode
from sphinx.util.docutils import additional_nodes
if TYPE_CHECKING: if TYPE_CHECKING:
from io import StringIO from io import StringIO
@ -68,7 +72,7 @@ def etree_parse(path: str) -> Any:
return ElementTree.parse(path) # NoQA: S314 # using known data in tests return ElementTree.parse(path) # NoQA: S314 # using known data in tests
class SphinxTestApp(application.Sphinx): class SphinxTestApp(sphinx.application.Sphinx):
""" """
A subclass of :class:`Sphinx` that runs on the test root, with some A subclass of :class:`Sphinx` that runs on the test root, with some
better default values for the initialization parameters. better default values for the initialization parameters.
@ -120,18 +124,8 @@ class SphinxTestApp(application.Sphinx):
raise raise
def cleanup(self, doctrees: bool = False) -> None: def cleanup(self, doctrees: bool = False) -> None:
# ModuleAnalyzer.cache.clear() sys.path[:] = self._saved_path
# locale.translators.clear() _clean_up_global_state()
# sys.path[:] = self._saved_path
# sys.modules.pop('autodoc_fodder', None)
# directives._directives.clear() # type: ignore[attr-defined]
# roles._roles.clear() # type: ignore[attr-defined]
# for node in additional_nodes:
# delattr(nodes.GenericNodeVisitor, f'visit_{node.__name__}')
# delattr(nodes.GenericNodeVisitor, f'depart_{node.__name__}')
# delattr(nodes.SparseNodeVisitor, f'visit_{node.__name__}')
# delattr(nodes.SparseNodeVisitor, f'depart_{node.__name__}')
# additional_nodes.clear()
with contextlib.suppress(FileNotFoundError): with contextlib.suppress(FileNotFoundError):
os.remove(self.docutils_conf_path) os.remove(self.docutils_conf_path)
@ -165,3 +159,22 @@ class SphinxTestAppWrapperForSkipBuilding:
def strip_escseq(text: str) -> str: def strip_escseq(text: str) -> str:
return re.sub('\x1b.*?m', '', text) return re.sub('\x1b.*?m', '', text)
def _clean_up_global_state() -> None:
# clean up Docutils global state
directives._directives.clear() # type: ignore[attr-defined]
roles._roles.clear() # type: ignore[attr-defined]
for node in additional_nodes:
delattr(nodes.GenericNodeVisitor, f'visit_{node.__name__}')
delattr(nodes.GenericNodeVisitor, f'depart_{node.__name__}')
delattr(nodes.SparseNodeVisitor, f'visit_{node.__name__}')
delattr(nodes.SparseNodeVisitor, f'depart_{node.__name__}')
additional_nodes.clear()
# clean up Sphinx global state
sphinx.locale.translators.clear()
# clean up autodoc global state
sphinx.pycode.ModuleAnalyzer.cache.clear()
sys.modules.pop('autodoc_fodder', None)

19
tests/conftest.py
View File

@ -4,13 +4,11 @@ from pathlib import Path
import docutils import docutils
import pytest import pytest
from docutils import nodes
from docutils.parsers.rst import directives, roles
import sphinx import sphinx
import sphinx.locale import sphinx.locale
import sphinx.pycode import sphinx.pycode
from sphinx.util.docutils import additional_nodes from sphinx.testing.util import _clean_up_global_state
def _init_console(locale_dir=sphinx.locale._LOCALE_DIR, catalog='sphinx'): def _init_console(locale_dir=sphinx.locale._LOCALE_DIR, catalog='sphinx'):
@ -51,17 +49,4 @@ def _cleanup_docutils():
yield # run the test yield # run the test
sys.path[:] = saved_path sys.path[:] = saved_path
# clean up Docutils global state _clean_up_global_state()
directives._directives.clear() # type: ignore[attr-defined]
roles._roles.clear() # type: ignore[attr-defined]
for node in additional_nodes:
delattr(nodes.GenericNodeVisitor, f'visit_{node.__name__}')
delattr(nodes.GenericNodeVisitor, f'depart_{node.__name__}')
delattr(nodes.SparseNodeVisitor, f'visit_{node.__name__}')
delattr(nodes.SparseNodeVisitor, f'depart_{node.__name__}')
additional_nodes.clear()
# clean up Sphinx global state
sphinx.locale.translators.clear()
sphinx.pycode.ModuleAnalyzer.cache.clear()
sys.modules.pop('autodoc_fodder', None)