Normalise sys.path manipulation in tests (#12665)

tests/js/roots/titles/conf.py

@@ -1,6 +1,6 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['sphinx.ext.autodoc']

tests/roots/test-add_enumerable_node/conf.py

@@ -1,7 +1,8 @@
-import os
 import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path.cwd().resolve()))
 
-sys.path.insert(0, os.path.abspath('.'))
 extensions = ['enumerable_node']
 
 numfig = True

tests/roots/test-add_source_parser-conflicts-with-users-setting/conf.py

@@ -1,9 +1,9 @@
-import os
 import sys
+from pathlib import Path
 
-from docutils.parsers import Parser
+sys.path.insert(0, str(Path.cwd().resolve()))
 
-sys.path.insert(0, os.path.abspath('.'))
+from docutils.parsers import Parser
 
 
 class DummyTestParser(Parser):

tests/roots/test-add_source_parser/conf.py

@@ -1,7 +1,6 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
-
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['source_parser']

tests/roots/test-api-set-translator/conf.py

@@ -1,7 +1,7 @@
 # set this by test
-# import os
 # import sys
-# sys.path.insert(0, os.path.abspath('.'))
+# from pathlib import Path
+# sys.path.insert(0, str(Path.cwd().resolve()))
 
 from docutils.writers.docutils_xml import XMLTranslator
 

tests/roots/test-api-set-translator/nonext/conf.py

@@ -1,6 +1,6 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.dirname(os.path.abspath('.')))
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 project = 'test'

tests/roots/test-autosummary/conf.py

@@ -1,7 +1,7 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['sphinx.ext.autosummary']
 

tests/roots/test-environment-record-dependencies/conf.py

@@ -1,5 +1,6 @@
-import os
 import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path.cwd().resolve()))
 
-sys.path.insert(0, os.path.abspath('.'))
 extensions = ['sphinx.ext.autodoc']

tests/roots/test-ext-autodoc/conf.py

@@ -1,7 +1,7 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['sphinx.ext.autodoc']
 

tests/roots/test-ext-autosummary-filename-map/conf.py

@@ -1,7 +1,7 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['sphinx.ext.autosummary']
 autosummary_generate = True

tests/roots/test-ext-autosummary-import_cycle/conf.py

@@ -1,7 +1,7 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['sphinx.ext.autosummary']
 autosummary_generate = False

tests/roots/test-ext-autosummary-imported_members/conf.py

@@ -1,7 +1,7 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['sphinx.ext.autosummary']
 autosummary_generate = True

tests/roots/test-ext-autosummary-mock_imports/conf.py

@@ -1,7 +1,7 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['sphinx.ext.autosummary']
 autosummary_generate = True

tests/roots/test-ext-autosummary-module_all/conf.py

@@ -1,7 +1,7 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['sphinx.ext.autosummary']
 autosummary_generate = True

tests/roots/test-ext-autosummary-module_prefix/conf.py

@@ -1,7 +1,7 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = [
     'sphinx.ext.autosummary',

tests/roots/test-ext-autosummary-recursive/conf.py

@@ -1,7 +1,7 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['sphinx.ext.autosummary']
 autosummary_generate = True

tests/roots/test-ext-autosummary-skip-member/conf.py

@@ -1,8 +1,7 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
-
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['sphinx.ext.autosummary']
 autosummary_generate = True

tests/roots/test-ext-autosummary-template/conf.py

@@ -1,8 +1,7 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
-
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['sphinx.ext.autosummary']
 autosummary_generate = True

tests/roots/test-ext-autosummary/conf.py

@@ -1,7 +1,7 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['sphinx.ext.autosummary']
 autosummary_generate = True

tests/roots/test-ext-coverage/conf.py

@@ -1,7 +1,7 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage']
 

tests/roots/test-ext-doctest-with-autodoc/conf.py

@@ -1,7 +1,7 @@
 import sys
-from os import path
+from pathlib import Path
 
-sys.path.insert(0, path.abspath(path.dirname(__file__)))
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 project = 'test project for doctest + autodoc reporting'
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest']

tests/roots/test-ext-imgmockconverter/conf.py

@@ -1,5 +1,6 @@
-import os
 import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path.cwd().resolve()))
 
-sys.path.insert(0, os.path.abspath('.'))
 extensions = ['mocksvgconverter']

tests/roots/test-ext-inheritance_diagram/conf.py

@@ -1,6 +1,6 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['sphinx.ext.inheritance_diagram', 'sphinx.ext.intersphinx']

tests/roots/test-ext-napoleon-paramtype/conf.py

@@ -1,7 +1,8 @@
-import os
 import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path.cwd().resolve()))
 
-sys.path.insert(0, os.path.abspath('.'))
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',
@@ -12,4 +13,4 @@
 # in order to avoid creating a real HTTP connection
 intersphinx_mapping = {}
 intersphinx_cache_limit = 0
-intersphinx_disabled_reftypes = []
+intersphinx_disabled_reftypes = []

tests/roots/test-ext-napoleon/conf.py

@@ -1,5 +1,6 @@
-import os
 import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path.cwd().resolve()))
 
-sys.path.insert(0, os.path.abspath('.'))
 extensions = ['sphinx.ext.napoleon']

tests/roots/test-ext-viewcode/conf.py

@@ -1,9 +1,8 @@
-import os
 import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path.cwd().resolve()))
 
-source_dir = os.path.abspath('.')
-if source_dir not in sys.path:
-    sys.path.insert(0, source_dir)
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
 exclude_patterns = ['_build']
 

tests/roots/test-extensions/conf.py

@@ -1,4 +1,4 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, str(Path.cwd().resolve()))

tests/roots/test-inheritance/conf.py

@@ -1,6 +1,6 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['sphinx.ext.inheritance_diagram']

tests/roots/test-latex-labels-before-module/conf.py

@@ -1,7 +1,7 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['sphinx.ext.autodoc']
 

tests/roots/test-prolog/conf.py

@@ -1,8 +1,7 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath('.'))
-
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['prolog_markdown_parser']
 

tests/roots/test-root/conf.py

@@ -1,13 +1,13 @@
-import os
 import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 from docutils import nodes
 from docutils.parsers.rst import Directive
 
 from sphinx import addnodes
 
-sys.path.append(os.path.abspath('.'))
-
 extensions = ['sphinx.ext.autodoc',
               'sphinx.ext.todo',
               'sphinx.ext.coverage',

tests/roots/test-util-copyasset_overwrite/conf.py

@@ -1,6 +1,7 @@
-import os
 import sys
-sys.path.insert(0, os.path.abspath('.'))
+from pathlib import Path
+
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['myext']
 html_static_path = ['user_static']

tests/roots/test-warnings/conf.py

@@ -1,6 +1,6 @@
-import os
 import sys
+from pathlib import Path
 
-sys.path.append(os.path.abspath('.'))
+sys.path.insert(0, str(Path.cwd().resolve()))
 
 extensions = ['sphinx.ext.autodoc']

tests/test_application.py

@@ -33,15 +33,15 @@ def test_instantiation(
     if rootdir and not src_dir.exists():
         shutil.copytree(Path(str(rootdir)) / 'test-root', src_dir)
 
-    syspath = sys.path[:]
+    saved_path = sys.path.copy()
 
     # When
     app_ = SphinxTestApp(
         srcdir=src_dir,
         status=StringIO(),
         warning=StringIO(),
     )
-    sys.path[:] = syspath
+    sys.path[:] = saved_path
     app_.cleanup()
 
     # Then

tests/test_extensions/test_ext_inheritance_diagram.py

@@ -289,8 +289,9 @@ def test_import_classes(rootdir):
     from sphinx.parsers import Parser, RSTParser
     from sphinx.util.i18n import CatalogInfo
 
+    saved_path = sys.path.copy()
+    sys.path.insert(0, str(rootdir / 'test-ext-inheritance_diagram'))
     try:
-        sys.path.append(str(rootdir / 'test-ext-inheritance_diagram'))
         from example.sphinx import DummyClass
 
         # got exception for unknown class or module
@@ -339,4 +340,4 @@ def test_import_classes(rootdir):
         classes = import_classes('sphinx', 'example')
         assert classes == [DummyClass]
     finally:
-        sys.path.pop()
+        sys.path[:] = saved_path

tests/test_pycode/test_pycode.py

@@ -40,14 +40,14 @@ def test_ModuleAnalyzer_for_module(rootdir):
     assert analyzer.srcname in (SPHINX_MODULE_PATH,
                                 os.path.abspath(SPHINX_MODULE_PATH))
 
-    path = str(rootdir / 'test-pycode')
-    sys.path.insert(0, path)
+    saved_path = sys.path.copy()
+    sys.path.insert(0, str(rootdir / 'test-pycode'))
     try:
         analyzer = ModuleAnalyzer.for_module('cp_1251_coded')
         docs = analyzer.find_attr_docs()
         assert docs == {('', 'X'): ['It MUST look like X="\u0425"', '']}
     finally:
-        sys.path.pop(0)
+        sys.path[:] = saved_path
 
 
 def test_ModuleAnalyzer_find_tags():