Consistently use pathlib for bibfiles.

Author: mcmtroffaes

src/sphinxcontrib/bibtex/bibfile.py

@@ -17,17 +17,14 @@
 """
 
 import math
-import os.path
-from typing import TYPE_CHECKING, Dict, List, NamedTuple, Set
+from pathlib import Path
+from typing import Dict, List, NamedTuple, Set
 
 from docutils.nodes import make_id
 from pybtex.database import BibliographyData, BibliographyDataError
 from pybtex.database.input.bibtex import Parser
 from sphinx.util.logging import getLogger
 
-if TYPE_CHECKING:
-    from sphinx.environment import BuildEnvironment
-
 
 logger = getLogger(__name__)
 
@@ -43,30 +40,25 @@ class BibData(NamedTuple):
     """Contains information about a collection of bib files."""
 
     encoding: str  #: Encoding of all bib files.
-    bibfiles: Dict[str, BibFile]  #: Maps bib filename to information about it.
+    bibfiles: Dict[Path, BibFile]  #: Maps bib filename to information about it.
     data: BibliographyData  #: Data parsed from all bib files.
 
 
-def normpath_filename(env: "BuildEnvironment", filename: str) -> str:
-    """Return normalised path to *filename* for the given environment *env*."""
-    return os.path.normpath(env.relfn2path(filename.strip())[1])
-
-
-def get_mtime(bibfilename: str) -> float:
+def get_mtime(bibfilename: Path) -> float:
     try:
-        return os.path.getmtime(bibfilename)
+        return bibfilename.lstat().st_mtime
     except OSError:
         return -math.inf
 
 
-def parse_bibdata(bibfilenames: List[str], encoding: str) -> BibData:
+def parse_bibdata(bibfilenames: List[Path], encoding: str) -> BibData:
     """Parse *bibfilenames* with given *encoding*, and return parsed data."""
     parser = Parser(encoding)
-    bibfiles: Dict[str, BibFile] = {}
+    bibfiles: Dict[Path, BibFile] = {}
     keys: Dict[str, None] = {}
     for filename in bibfilenames:
         logger.info("parsing bibtex file {0}... ".format(filename), nonl=True)
-        if not os.path.isfile(filename):
+        if not filename.is_file():
             logger.warning(
                 "could not open bibtex file {0}.".format(filename),
                 type="bibtex",
@@ -91,7 +83,7 @@ def parse_bibdata(bibfilenames: List[str], encoding: str) -> BibData:
 
 
 def is_bibdata_outdated(
-    bibdata: BibData, bibfilenames: List[str], encoding: str
+    bibdata: BibData, bibfilenames: List[Path], encoding: str
 ) -> bool:
     return (
         bibdata.encoding != encoding
@@ -104,7 +96,7 @@ def is_bibdata_outdated(
 
 
 def process_bibdata(
-    bibdata: BibData, bibfilenames: List[str], encoding: str
+    bibdata: BibData, bibfilenames: List[Path], encoding: str
 ) -> BibData:
     """Parse *bibfilenames* and store parsed data in *bibdata*."""
     logger.info("checking bibtex cache... ", nonl=True)

src/sphinxcontrib/bibtex/directives.py

@@ -19,7 +19,7 @@
 import sphinx.util
 from docutils.parsers.rst import Directive
 
-from .bibfile import _make_ids, normpath_filename
+from .bibfile import _make_ids
 from .nodes import bibliography as bibliography_node
 
 if TYPE_CHECKING:
@@ -42,7 +42,7 @@ class BibliographyValue(NamedTuple):
     """Contains information about a bibliography directive."""
 
     line: int  #: Line number of the directive in the document.
-    bibfiles: List[str]  #: List of bib files for this directive.
+    bibfiles: List[Path]  #: List of bib files for this directive.
     style: str  #: The pybtex style.
     list_: str  #: The list type.
     enumtype: str  #: The sequence type (for enumerated lists).
@@ -147,23 +147,23 @@ def run(self) -> Sequence[docutils.nodes.Node]:
         domain = cast("BibtexDomain", env.get_domain("cite"))
         filter_ = self._get_filter()
         if self.arguments:
-            bibfiles = []
-            for bibfile in self.arguments[0].split():
-                normbibfile = str(Path(normpath_filename(env, bibfile)).resolve())
-                if normbibfile not in domain.bibdata.bibfiles:
+            bibfiles: list[Path] = []
+            for bibfile_str in self.arguments[0].split():
+                bibfile = Path(env.relfn2path(bibfile_str)[1]).resolve()
+                if bibfile not in domain.bibdata.bibfiles:
                     logger.warning(
                         "{0} not found or not configured"
-                        " in bibtex_bibfiles".format(bibfile),
+                        " in bibtex_bibfiles".format(bibfile_str),
                         location=(env.docname, self.lineno),
                         type="bibtex",
                         subtype="bibfile_error",
                     )
                 else:
-                    bibfiles.append(normbibfile)
+                    bibfiles.append(bibfile)
         else:
             bibfiles = list(domain.bibdata.bibfiles.keys())
         for bibfile in bibfiles:
-            env.note_dependency(bibfile)
+            env.note_dependency(str(bibfile))
         # generate nodes and ids
         keyprefix: str = self.options.get("keyprefix", "")
         list_: str = self.options.get("list", "citation")

src/sphinxcontrib/bibtex/domain.py

@@ -303,7 +303,7 @@ def __init__(self, env: "BuildEnvironment"):
             raise ExtensionError("You must configure the bibtex_bibfiles setting")
         # canonicalize bibfile paths relative to confdir
         bibfiles = [
-            str((Path(env.app.confdir) / bibfile).resolve())
+            (Path(env.app.confdir) / bibfile).resolve()
             for bibfile in env.app.config.bibtex_bibfiles
         ]
         # update bib file information in the cache
@@ -495,7 +495,7 @@ def get_all_cited_keys(self, docnames):
             for target in citation_ref.targets:
                 yield target.key
 
-    def get_entries(self, bibfiles: List[str]) -> Iterable["Entry"]:
+    def get_entries(self, bibfiles: List[Path]) -> Iterable["Entry"]:
         """Return all bibliography entries from the bib files, unsorted (i.e.
         in order of appearance in the bib files).
         """