use more pathlib

Author: timvink

src/mkdocs_git_revision_date_localized_plugin/plugin.py

@@ -10,6 +10,7 @@
 import os
 import time
 import multiprocessing
+from pathlib import Path
 
 from mkdocs import __version__ as mkdocs_version
 from mkdocs.config import config_options
@@ -28,7 +29,7 @@
 
 from packaging.version import Version
 
-HERE = os.path.dirname(os.path.abspath(__file__))
+HERE = Path(__file__).parent.absolute()
 
 
 class GitRevisionDateLocalizedPlugin(BasePlugin):
@@ -147,12 +148,13 @@ def on_config(self, config: config_options.Config, **kwargs) -> Dict[str, Any]:
     def parallel_compute_commit_timestamps(self, files, original_source: Optional[Dict] = None, is_first_commit=False):
         pool = multiprocessing.Pool(processes=min(10, multiprocessing.cpu_count()))
         results = []
-        for file in files:
-            if file.is_documentation_page():
-                abs_src_path = file.abs_src_path
+        for f in files:
+            if f.is_documentation_page():
+                abs_src_path = f.abs_src_path
                 # Support plugins like monorep that might have moved the files from the original source that is under git
                 if original_source and abs_src_path in original_source:
                     abs_src_path = original_source[abs_src_path]
+                abs_src_path = Path(abs_src_path).absolute()
                 result = pool.apply_async(self.util.get_git_commit_timestamp, args=(abs_src_path, is_first_commit))
                 results.append((abs_src_path, result))
         pool.close()
@@ -374,8 +376,8 @@ def on_post_build(self, config: Dict[str, Any], **kwargs) -> None:
                 "js/timeago_mkdocs_material.js",
                 "css/timeago.css",
             ]
-            for file in files:
-                dest_file_path = os.path.join(config["site_dir"], file)
-                src_file_path = os.path.join(HERE, file)
-                assert os.path.exists(src_file_path)
-                copy_file(src_file_path, dest_file_path)
+            for f in files:
+                dest_file_path = Path(config["site_dir"]) / f
+                src_file_path = HERE / f
+                assert src_file_path.exists()
+                copy_file(str(src_file_path), str(dest_file_path))

src/mkdocs_git_revision_date_localized_plugin/util.py

@@ -3,6 +3,7 @@
 import logging
 import os
 import time
+from pathlib import Path
 
 from mkdocs_git_revision_date_localized_plugin.ci import raise_ci_warnings
 from mkdocs_git_revision_date_localized_plugin.dates import get_date_formats
@@ -34,7 +35,7 @@ def __init__(self, config: Dict, mkdocs_dir: str):
         self.repo_cache = {}
 
         ignore_commits_file = self.config.get("ignored_commits_file")
-        ignore_commits_filepath = os.path.join(mkdocs_dir, ignore_commits_file) if ignore_commits_file else None
+        ignore_commits_filepath = Path(mkdocs_dir) / ignore_commits_file if ignore_commits_file else None
         self.ignored_commits = self.parse_git_ignore_revs(ignore_commits_filepath) if ignore_commits_file else []
 
     def _get_repo(self, path: str) -> Git:

tests/test_builds.py

@@ -144,8 +144,7 @@ def setup_commit_history(testproject_path):
     Returns:
         repo (repo): git.Repo object
     """
-    assert not os.path.exists(str(testproject_path / ".git"))
-    testproject_path = str(testproject_path)
+    assert not (testproject_path / ".git").exists()
 
     repo = git.Repo.init(testproject_path, bare=False)
     repo.git.checkout("-b", "master")
@@ -159,7 +158,7 @@ def setup_commit_history(testproject_path):
                 message="add homepage", author=author, date="1500854705"
             )  # Mon Jul 24 2017 00:05:05 GMT+0000
 
-            file_name = os.path.join(testproject_path, "docs/page_with_tag.md")
+            file_name = testproject_path / "docs/page_with_tag.md"
             with open(file_name, "a") as the_file:
                 the_file.write("test\n")
             repo.git.add("docs/page_with_tag.md")
@@ -175,10 +174,10 @@ def setup_commit_history(testproject_path):
             )  # 	Sun Jan 23 2022 04:10:26 GMT+0000
 
         if os.path.exists("docs/page_with_renamed.md"):
-            bf_file_name = os.path.join(testproject_path, "docs/page_with_renamed.md")
-            af_file_name = os.path.join(testproject_path, "docs/subfolder/page_with_renamed.md")
+            bf_file_name = testproject_path / "docs/page_with_renamed.md"
+            af_file_name = testproject_path / "docs/subfolder/page_with_renamed.md"
             # Since git.mv would actually remove the file, move page_with_renamed.md back to docs if it has been moved
-            if os.path.exists(af_file_name):
+            if af_file_name.exists():
                 os.replace(af_file_name, bf_file_name)
             repo.git.add("docs/page_with_renamed.md")
             repo.git.commit(
@@ -192,7 +191,7 @@ def setup_commit_history(testproject_path):
         if os.path.exists("docs/first_page.md"):
             repo.git.add("docs/first_page.md")
             repo.git.commit(message="first page", author=author, date="1500854705")  # Mon Jul 24 2017 00:05:05 GMT+0000
-            file_name = os.path.join(testproject_path, "docs/first_page.md")
+            file_name = testproject_path / "docs/first_page.md"
             with open(file_name, "w+") as the_file:
                 the_file.write("Hello\n")
             repo.git.add("docs/first_page.md")
@@ -211,7 +210,7 @@ def setup_commit_history(testproject_path):
             message="add mkdocs", author=author, date="1500854705 -0700"
         )  # Mon Jul 24 2017 00:05:05 GMT+0000
 
-        if os.path.exists("docs/second_page.md"):
+        if Path("docs/second_page.md").exists():
             repo.git.add("docs/second_page.md")
             repo.git.commit(
                 message="second page", author=author, date="1643911026"