Use _StrPath in sphinx.environment

Author: AA-Turner

sphinx/environment/__init__.py

@@ -4,7 +4,6 @@
 
 import functools
 import os
-import os.path
 import pickle
 from collections import defaultdict
 from copy import copy
@@ -28,7 +27,7 @@
 from sphinx.util.docutils import LoggingReporter
 from sphinx.util.i18n import CatalogRepository, docname_to_domain
 from sphinx.util.nodes import is_translatable
-from sphinx.util.osutil import _last_modified_time, canon_path, os_path
+from sphinx.util.osutil import _last_modified_time, _relative_path, canon_path
 
 if TYPE_CHECKING:
     from collections.abc import Callable, Iterable, Iterator
@@ -419,17 +418,15 @@ def relfn2path(self, filename: str, docname: str | None = None) -> tuple[str, st
         source dir, while relative filenames are relative to the dir of the
         containing document.
         """
-        filename = os_path(filename)
-        if filename.startswith(('/', os.sep)):
-            rel_fn = filename[1:]
+        filename = canon_path(filename)
+        if filename.startswith('/'):
+            abs_fn = (self.srcdir / filename[1:]).resolve()
         else:
-            docdir = os.path.dirname(self.doc2path(docname or self.docname, base=False))
-            rel_fn = os.path.join(docdir, filename)
+            doc_dir = self.doc2path(docname or self.docname, base=False).parent
+            abs_fn = (self.srcdir / doc_dir / filename).resolve()
 
-        return (
-            canon_path(os.path.normpath(rel_fn)),
-            os.path.normpath(os.path.join(self.srcdir, rel_fn)),
-        )
+        rel_fn = _relative_path(abs_fn, self.srcdir)
+        return canon_path(rel_fn), os.fspath(abs_fn)
 
     @property
     def found_docs(self) -> set[str]:
@@ -492,8 +489,8 @@ def get_outdated_files(
                     added.add(docname)
                     continue
                 # if the doctree file is not there, rebuild
-                filename = os.path.join(self.doctreedir, docname + '.doctree')
-                if not os.path.isfile(filename):
+                filename = self.doctreedir / f'{docname}.doctree'
+                if not filename.is_file():
                     logger.debug('[build target] changed %r', docname)
                     changed.add(docname)
                     continue
@@ -518,21 +515,21 @@ def get_outdated_files(
                 for dep in self.dependencies[docname]:
                     try:
                         # this will do the right thing when dep is absolute too
-                        deppath = os.path.join(self.srcdir, dep)
-                        if not os.path.isfile(deppath):
+                        dep_path = self.srcdir / dep
+                        if not dep_path.is_file():
                             logger.debug(
                                 '[build target] changed %r missing dependency %r',
                                 docname,
-                                deppath,
+                                dep_path,
                             )
                             changed.add(docname)
                             break
-                        depmtime = _last_modified_time(deppath)
+                        depmtime = _last_modified_time(dep_path)
                         if depmtime > mtime:
                             logger.debug(
                                 '[build target] outdated %r from dependency %r: %s -> %s',
                                 docname,
-                                deppath,
+                                dep_path,
                                 _format_rfc3339_microseconds(mtime),
                                 _format_rfc3339_microseconds(depmtime),
                             )
@@ -632,7 +629,7 @@ def get_doctree(self, docname: str) -> nodes.document:
         try:
             serialised = self._pickled_doctree_cache[docname]
         except KeyError:
-            filename = os.path.join(self.doctreedir, docname + '.doctree')
+            filename = self.doctreedir / f'{docname}.doctree'
             with open(filename, 'rb') as f:
                 serialised = self._pickled_doctree_cache[docname] = f.read()
 

sphinx/util/osutil.py

@@ -169,6 +169,22 @@ def relpath(
         return str(path)
 
 
+def _relative_path(path: Path, root: Path, /) -> Path:
+    """Return a relative filepath to *path* from the given *root* directory.
+
+    This is an alternative of ``Path.relative_to``.
+    It returns the original path if *path* and *root* are on different drives,
+    which may happen on Windows.
+    """
+    if path.anchor != root.anchor or '..' in root.parts:
+        # If the drives are different, no relative path exists.
+        # Path.relative_to() requires fully-resolved paths (no '..').
+        return path
+    if sys.version_info[:2] < (3, 12):
+        return Path(os.path.relpath(path, root))
+    return path.relative_to(root, walk_up=True)
+
+
 safe_relpath = relpath  # for compatibility
 fs_encoding = sys.getfilesystemencoding() or sys.getdefaultencoding()