Merge pull request #701 from chinapandaman/PPF-700

PPF-700: audit ruff rules

.ruff.toml

@@ -0,0 +1,35 @@
+[lint]
+select = [
+    "A",
+    "ASYNC",
+    "B",
+    "BLE",
+    "C4",
+    "DTZ",
+    "E",
+    "EM",
+    "F",
+    "FLY",
+    "G",
+    "ISC",
+    "ICN",
+    "INT",
+    "LOG",
+    "N",
+    "PIE",
+    "PT",
+    "PERF",
+    "Q",
+    "R",
+    "RSE",
+    "SLF",
+    "SLOT",
+    "SIM",
+    "T10",
+    "TRY",
+    "TCH",
+    "YTT",
+    "W"
+]
+ignore = ["E501", "N999"]
+preview = true

PyPDFForm/template.py

@@ -118,7 +118,7 @@ def update_text_field_attributes(
 ) -> None:
     """Auto updates text fields' attributes."""
 
-    for _, _widgets in get_widgets_by_page(template_stream).items():
+    for _widgets in get_widgets_by_page(template_stream).values():
         for _widget in _widgets:
             key = get_widget_key(_widget)
 

PyPDFForm/watermark.py

@@ -165,12 +165,7 @@ def create_watermarks_and_draw(
     watermark = buff.read()
     buff.close()
 
-    results = []
-
-    for i in range(len(pdf_file.pages)):
-        results.append(watermark if i == page_number - 1 else b"")
-
-    return results
+    return [watermark if i == page_number - 1 else b"" for i in range(len(pdf_file.pages))]
 
 
 def merge_watermarks_with_pdf(

PyPDFForm/widgets/base.py

@@ -72,8 +72,4 @@ def watermarks(self, stream: bytes) -> List[bytes]:
         canvas.save()
         watermark.seek(0)
 
-        result = []
-        for i in range(page_count):
-            result.append(watermark.read() if i == self.page_number - 1 else b"")
-
-        return result
+        return [watermark.read() if i == self.page_number - 1 else b"" for i in range(page_count)]

PyPDFForm/wrapper.py

@@ -293,15 +293,13 @@ def draw_image(
     def schema(self) -> dict:
         """Generates a json schema for the PDF form template."""
 
-        result = {
+        return {
             "type": "object",
             "properties": {
                 key: value.schema_definition for key, value in self.widgets.items()
             },
         }
 
-        return result
-
     @classmethod
     def register_font(
         cls, font_name: str, ttf_file: Union[bytes, str, BinaryIO]

scripts/bump_version.py

@@ -15,27 +15,16 @@
     with open("PyPDFForm/__init__.py", encoding="utf8") as f:
         version = re.search(r'__version__ = "(.*?)"', f.read())
         if version:
-            v = v.group(1)
+            v = version.group(1)
 
     new_version = ".".join(v.split(".")[:-1] + [str(int(v.split(".")[-1]) + 1)])
 
-    with open("PyPDFForm/__init__.py", encoding="utf8") as f:
-        content = f.read().replace(version, new_version)
-
-    os.remove("PyPDFForm/__init__.py")
-    with open("PyPDFForm/__init__.py", mode="w", encoding="utf8") as f:
-        f.write(content)
-
-    with open("mkdocs.yml", encoding="utf8") as f:
-        content = f.read().replace(version, new_version)
-
-    os.remove("mkdocs.yml")
-    with open("mkdocs.yml", mode="w", encoding="utf8") as f:
-        f.write(content)
+    files_to_update = ["PyPDFForm/__init__.py", "mkdocs.yml", "SECURITY.md"]
 
-    with open("SECURITY.md", encoding="utf8") as f:
-        content = f.read().replace(version, new_version)
+    for each in files_to_update:
+        with open(each, encoding="utf8") as f:
+            content = f.read().replace(v, new_version)
 
-    os.remove("SECURITY.md")
-    with open("SECURITY.md", mode="w", encoding="utf8") as f:
-        f.write(content)
+        os.remove(each)
+        with open(each, mode="w", encoding="utf8") as f:
+            f.write(content)

tests/conftest.py

@@ -14,13 +14,12 @@ def pytest_addoption(parser):
 
 
 @pytest.fixture(autouse=True)
-def generate_new_pdf_samples(request):
+def _generate_new_pdf_samples(request):
     request.config.results = {}
     yield
-    if request.config.getoption("--regenerate") == "1":
-        if request.config.results:
-            with open(request.config.results["expected_path"], "wb+") as f:
-                f.write(request.config.results["stream"])
+    if request.config.getoption("--regenerate") == "1" and request.config.results:
+        with open(request.config.results["expected_path"], "wb+") as f:
+            f.write(request.config.results["stream"])
 
 
 @pytest.fixture

tests/scenario/test_issues_simple.py

@@ -55,7 +55,7 @@ def test_pdf_form_with_paragraph_fields_new_line_symbol_text(issue_pdf_directory
         {"Address": "Mr John Smith\n132, My Street\nKingston, New York 12401"}
     )
 
-    for _, widgets in get_widgets_by_page(obj.read()).items():
+    for widgets in get_widgets_by_page(obj.read()).values():
         for widget in widgets:
             if get_widget_key(widget) == "Address":
                 assert (
@@ -136,7 +136,7 @@ def test_pdf_form_with_paragraph_fields_new_line_symbol_short_text(issue_pdf_dir
         {"Address": "J Smith\n132 A St\nNYC, NY 12401"}
     )
 
-    for _, widgets in get_widgets_by_page(obj.read()).items():
+    for widgets in get_widgets_by_page(obj.read()).values():
         for widget in widgets:
             if get_widget_key(widget) == "Address":
                 assert widget[V] == "J Smith\n132 A St\nNYC, NY 12401"

tests/test_functional.py

@@ -12,7 +12,7 @@
 def test_base_schema_definition():
     try:
         assert Widget("foo").schema_definition
-        assert False
+        raise AssertionError
     except NotImplementedError:
         pass
 
@@ -34,7 +34,7 @@ def test_fill(template_stream, pdf_samples, data_dict, request):
         assert len(obj.stream) == len(expected)
         assert obj.stream == expected
 
-        for _, widgets in template.get_widgets_by_page(obj.read()).items():
+        for widgets in template.get_widgets_by_page(obj.read()).values():
             assert not widgets
 
 
@@ -375,7 +375,7 @@ def test_schema(sample_template_with_comb_text_field):
     data["LastName"] = "XXXXXXXX"
     try:
         validate(instance=data, schema=schema)
-        assert False
+        raise AssertionError
     except ValidationError:
         pass
 
@@ -386,7 +386,7 @@ def test_schema(sample_template_with_comb_text_field):
     data["Gender"] = 2
     try:
         validate(instance=data, schema=schema)
-        assert False
+        raise AssertionError
     except ValidationError:
         pass
 
@@ -396,12 +396,12 @@ def test_sample_data(sejda_template_complex):
     try:
         validate(instance=obj.sample_data, schema=obj.schema)
     except ValidationError:
-        assert False
+        raise AssertionError from ValidationError
 
     widget = Widget("foo")
     try:
         widget.sample_value()
-        assert False
+        raise AssertionError
     except NotImplementedError:
         pass
 
@@ -429,7 +429,7 @@ def test_fill_right_aligned(
         assert len(obj.stream) == len(expected)
         assert obj.stream == expected
 
-        for _, widgets in template.get_widgets_by_page(obj.read()).items():
+        for widgets in template.get_widgets_by_page(obj.read()).values():
             assert not widgets