STY: Use pathlib (#1668)

See https://stackoverflow.com/a/60086137/562769

Author: MartinThoma

pyproject.toml

@@ -134,8 +134,8 @@ ignore = [
     "D101",  # Missing docstring in public class
     "D102", # Missing docstring in public method
     "D103",  # Missing docstring in public function
-    "SLF",
-    "PTH", "PLR", "FBT", "PT", "N", "ARG", "TRY", "S", "EM", "RET", "TID",
+    "SLF001",
+    "PLR", "PTH123", "FBT", "PT", "N", "ARG", "TRY", "S", "EM", "RET", "TID",
     "C901", "PGH", "DTZ", "TCH", "B", "G", "BLE", "SIM", "E", "INP", "A", "RUF",
     "PLW", "PLE"
 ]
@@ -146,6 +146,7 @@ ignore = [
 "json_consistency.py" = ["T201"]
 "tests/test_workflows.py" =  ["T201"]
 "sample-files/*" = ["D100"]
+"docs/conf.py" = ["PTH"]
 
 [tool.docformatter]
 pre-summary-newline = true

sample-files

@@ -1,6 +1,6 @@
-import os
 import ssl
 import urllib.request
+from pathlib import Path
 from typing import List
 from urllib.error import HTTPError
 
@@ -25,17 +25,17 @@ def get_pdf_from_url(url: str, name: str) -> bytes:
     if url.startswith("file://"):
         with open(url[7:].replace("\\", "/"), "rb") as fp:
             return fp.read()
-    cache_dir = os.path.join(os.path.dirname(__file__), "pdf_cache")
-    if not os.path.exists(cache_dir):
-        os.mkdir(cache_dir)
-    cache_path = os.path.join(cache_dir, name)
-    if not os.path.exists(cache_path):
+    cache_dir = Path(__file__).parent / "pdf_cache"
+    if not cache_dir.exists():
+        cache_dir.mkdir()
+    cache_path = cache_dir / name
+    if not cache_path.exists():
         ssl._create_default_https_context = ssl._create_unverified_context
         cpt = 3
         while cpt > 0:
             try:
-                with urllib.request.urlopen(url) as response, open(
-                    cache_path, "wb"
+                with urllib.request.urlopen(url) as response, cache_path.open(
+                    "wb"
                 ) as out_file:
                     out_file.write(response.read())
                 cpt = 0

tests/__init__.py

@@ -1,5 +1,4 @@
 """Test the pypdf.generic module."""
-import os
 from io import BytesIO
 from pathlib import Path
 from unittest.mock import patch
@@ -701,7 +700,7 @@ def test_issue_997(mock_logger_warning):
     merger.close()
 
     # cleanup
-    os.remove(merged_filename)
+    Path(merged_filename).unlink()
 
 
 def test_annotation_builder_free_text():
@@ -744,7 +743,7 @@ def test_annotation_builder_free_text():
     with open(target, "wb") as fp:
         writer.write(fp)
 
-    os.remove(target)  # comment this out for manual inspection
+    Path(target).unlink()  # comment this out for manual inspection
 
 
 def test_annotation_builder_polygon():
@@ -772,7 +771,7 @@ def test_annotation_builder_polygon():
     with open(target, "wb") as fp:
         writer.write(fp)
 
-    os.remove(target)  # comment this out for manual inspection
+    Path(target).unlink()  # comment this out for manual inspection
 
 
 def test_annotation_builder_line():
@@ -797,7 +796,7 @@ def test_annotation_builder_line():
     with open(target, "wb") as fp:
         writer.write(fp)
 
-    os.remove(target)  # comment this out for manual inspection
+    Path(target).unlink()  # comment this out for manual inspection
 
 
 def test_annotation_builder_square():
@@ -824,7 +823,7 @@ def test_annotation_builder_square():
     with open(target, "wb") as fp:
         writer.write(fp)
 
-    os.remove(target)  # comment this out for manual inspection
+    Path(target).unlink()  # comment this out for manual inspection
 
 
 def test_annotation_builder_circle():
@@ -852,7 +851,7 @@ def test_annotation_builder_circle():
     with open(target, "wb") as fp:
         writer.write(fp)
 
-    os.remove(target)  # comment this out for manual inspection
+    Path(target).unlink()  # comment this out for manual inspection
 
 
 def test_annotation_builder_link():
@@ -910,7 +909,7 @@ def test_annotation_builder_link():
     with open(target, "wb") as fp:
         writer.write(fp)
 
-    os.remove(target)  # comment this out for manual inspection
+    Path(target).unlink()  # comment this out for manual inspection
 
 
 def test_annotation_builder_text():
@@ -934,7 +933,7 @@ def test_annotation_builder_text():
     with open(target, "wb") as fp:
         writer.write(fp)
 
-    os.remove(target)  # comment this out for manual inspection
+    Path(target).unlink()  # comment this out for manual inspection
 
 
 def test_CheckboxRadioButtonAttributes_opt():

tests/test_generic.py

@@ -1,5 +1,4 @@
 """Test the pypdf._merger module."""
-import os
 import sys
 from io import BytesIO
 from pathlib import Path
@@ -192,7 +191,7 @@ def test_merger_operations_by_semi_traditional_usage(tmp_path):
         merger.write(path)  # Act
 
     # Assert
-    assert os.path.isfile(path)
+    assert Path(path).is_file()
     check_outline(path)
 
 
@@ -204,7 +203,7 @@ def test_merger_operations_by_semi_traditional_usage_with_writer(tmp_path):
         merger.write(path)  # Act
 
     # Assert
-    assert os.path.isfile(path)
+    assert Path(path).is_file()
     check_outline(path)
 
 
@@ -213,7 +212,7 @@ def test_merger_operation_by_new_usage(tmp_path):
     with PdfMerger(fileobj=path) as merger:
         merger_operate(merger)
     # Assert
-    assert os.path.isfile(path)
+    assert Path(path).is_file()
     check_outline(path)
 
 
@@ -223,7 +222,7 @@ def test_merger_operation_by_new_usage_with_writer(tmp_path):
         merger_operate(merger)
 
     # Assert
-    assert os.path.isfile(path)
+    assert Path(path).is_file()
     check_outline(path)
 
 
@@ -311,7 +310,7 @@ def test_merge_write_closed_fh_with_writer():
     merger.set_page_mode("/UseNone")
     merger.add_outline_item("An outline item", 0)
 
-    os.unlink("stream1.pdf")
+    Path("stream1.pdf").unlink()
 
 
 @pytest.mark.external
@@ -325,7 +324,7 @@ def test_trim_outline_list():
     merger.close()
 
     # cleanup
-    os.remove("tmp-merger-do-not-commit.pdf")
+    Path("tmp-merger-do-not-commit.pdf").unlink()
 
 
 @pytest.mark.external
@@ -339,7 +338,7 @@ def test_trim_outline_list_with_writer():
     merger.close()
 
     # cleanup
-    os.remove("tmp-merger-do-not-commit.pdf")
+    Path("tmp-merger-do-not-commit.pdf").unlink()
 
 
 @pytest.mark.external
@@ -353,7 +352,7 @@ def test_zoom():
     merger.close()
 
     # cleanup
-    os.remove("tmp-merger-do-not-commit.pdf")
+    Path("tmp-merger-do-not-commit.pdf").unlink()
 
 
 @pytest.mark.external
@@ -367,7 +366,7 @@ def test_zoom_with_writer():
     merger.close()
 
     # cleanup
-    os.remove("tmp-merger-do-not-commit.pdf")
+    Path("tmp-merger-do-not-commit.pdf").unlink()
 
 
 @pytest.mark.external
@@ -381,7 +380,7 @@ def test_zoom_xyz_no_left():
     merger.close()
 
     # cleanup
-    os.remove("tmp-merger-do-not-commit.pdf")
+    Path("tmp-merger-do-not-commit.pdf").unlink()
 
 
 @pytest.mark.external
@@ -395,7 +394,7 @@ def test_zoom_xyz_no_left_with_writer():
     merger.close()
 
     # cleanup
-    os.remove("tmp-merger-do-not-commit.pdf")
+    Path("tmp-merger-do-not-commit.pdf").unlink()
 
 
 @pytest.mark.external
@@ -409,7 +408,7 @@ def test_outline_item():
     merger.close()
 
     # cleanup
-    os.remove("tmp-merger-do-not-commit.pdf")
+    Path("tmp-merger-do-not-commit.pdf").unlink()
 
 
 @pytest.mark.external
@@ -424,7 +423,7 @@ def test_outline_item_with_writer():
     merger.close()
 
     # cleanup
-    os.remove("tmp-merger-do-not-commit.pdf")
+    Path("tmp-merger-do-not-commit.pdf").unlink()
 
 
 @pytest.mark.external
@@ -439,7 +438,7 @@ def test_trim_outline():
     merger.close()
 
     # cleanup
-    os.remove("tmp-merger-do-not-commit.pdf")
+    Path("tmp-merger-do-not-commit.pdf").unlink()
 
 
 @pytest.mark.external
@@ -454,7 +453,7 @@ def test_trim_outline_with_writer():
     merger.close()
 
     # cleanup
-    os.remove("tmp-merger-do-not-commit.pdf")
+    Path("tmp-merger-do-not-commit.pdf").unlink()
 
 
 @pytest.mark.external
@@ -469,7 +468,7 @@ def test1():
     merger.close()
 
     # cleanup
-    os.remove("tmp-merger-do-not-commit.pdf")
+    Path("tmp-merger-do-not-commit.pdf").unlink()
 
 
 @pytest.mark.external
@@ -484,7 +483,7 @@ def test1_with_writer():
     merger.close()
 
     # cleanup
-    os.remove("tmp-merger-do-not-commit.pdf")
+    Path("tmp-merger-do-not-commit.pdf").unlink()
 
 
 @pytest.mark.external
@@ -503,7 +502,7 @@ def test_sweep_recursion1():
     reader2.pages
 
     # cleanup
-    os.remove("tmp-merger-do-not-commit.pdf")
+    Path("tmp-merger-do-not-commit.pdf").unlink()
 
 
 @pytest.mark.external
@@ -522,7 +521,7 @@ def test_sweep_recursion1_with_writer():
     reader2.pages
 
     # cleanup
-    os.remove("tmp-merger-do-not-commit.pdf")
+    Path("tmp-merger-do-not-commit.pdf").unlink()
 
 
 @pytest.mark.external
@@ -552,7 +551,7 @@ def test_sweep_recursion2(url, name):
     reader2.pages
 
     # cleanup
-    os.remove("tmp-merger-do-not-commit.pdf")
+    Path("tmp-merger-do-not-commit.pdf").unlink()
 
 
 @pytest.mark.external
@@ -582,7 +581,7 @@ def test_sweep_recursion2_with_writer(url, name):
     reader2.pages
 
     # cleanup
-    os.remove("tmp-merger-do-not-commit.pdf")
+    Path("tmp-merger-do-not-commit.pdf").unlink()
 
 
 @pytest.mark.external
@@ -600,7 +599,7 @@ def test_sweep_indirect_list_newobj_is_none(caplog):
     reader2.pages
 
     # cleanup
-    os.remove("tmp-merger-do-not-commit.pdf")
+    Path("tmp-merger-do-not-commit.pdf").unlink()
 
 
 @pytest.mark.external
@@ -618,7 +617,7 @@ def test_sweep_indirect_list_newobj_is_none_with_writer(caplog):
     reader2.pages
 
     # cleanup
-    os.remove("tmp-merger-do-not-commit.pdf")
+    Path("tmp-merger-do-not-commit.pdf").unlink()
 
 
 @pytest.mark.external

tests/test_merger.py

@@ -1,6 +1,5 @@
 """Test the pypdf._page module."""
 import json
-import os
 import random
 from copy import deepcopy
 from io import BytesIO
@@ -34,7 +33,7 @@
 
 def get_all_sample_files():
     meta_file = SAMPLE_ROOT / "files.json"
-    if not os.path.isfile(meta_file):
+    if not Path(meta_file).is_file():
         return {"data": []}
     with open(meta_file) as fp:
         data = fp.read()
@@ -853,7 +852,7 @@ def test_annotation_setter():
         writer.write(fp)
 
     # Cleanup
-    os.remove(target)  # remove for testing
+    Path(target).unlink()  # remove for testing
 
 
 @pytest.mark.external