Merge pull request #689 from chinapandaman/PPF-688

PPF-688: add new linters

.github/workflows/python-linting.yml

@@ -24,3 +24,9 @@ jobs:
     - name: Analyze code with pylint
       run: |
         pylint PyPDFForm
+    - name: Analyze code with pyright
+      run: |
+        pyright .
+    - name: Analyze code with ruff
+      run: |
+        ruff check .

Makefile

@@ -7,8 +7,8 @@ test-all:
 coverage-all:
 	bash ./scripts/coverage.sh
 
-check-imports:
-	bash ./scripts/check_imports.sh
+linting:
+	bash ./scripts/linting.sh
 
 generate-new-pdf-samples:
 	bash ./scripts/new_pdf_samples.sh

PyPDFForm/__init__.py

@@ -4,3 +4,5 @@
 __version__ = "1.4.30"
 
 from .wrapper import FormWrapper, PdfWrapper
+
+__all__ = ["FormWrapper", "PdfWrapper"]

PyPDFForm/middleware/base.py

@@ -14,6 +14,7 @@ def __init__(
     ) -> None:
         """Constructs basic attributes for the object."""
 
+        super().__init__()
         self._name = name
         self.value = value
 

PyPDFForm/middleware/checkbox.py

@@ -34,7 +34,7 @@ def schema_definition(self) -> dict:
         return {"type": "boolean"}
 
     @property
-    def sample_value(self) -> bool:
+    def sample_value(self) -> Union[bool, int]:
         """Sample value of the checkbox."""
 
         return True

PyPDFForm/widgets/base.py

@@ -29,6 +29,7 @@ def __init__(
     ) -> None:
         """Sets acro form parameters."""
 
+        super().__init__()
         self.page_number = page_number
         self.acro_form_params = {
             "name": name,

PyPDFForm/wrapper.py

@@ -36,6 +36,7 @@ def __init__(
     ) -> None:
         """Constructs all attributes for the object."""
 
+        super().__init__()
         self.stream = fp_or_f_obj_or_stream_to_stream(template)
 
     def read(self) -> bytes:

pyrightconfig.json

@@ -0,0 +1,17 @@
+{
+    "typeCheckingMode": "basic",
+    "reportArgumentType": "none",
+    "reportAssignmentType": "none",
+    "reportAttributeAccessIssue": "none",
+    "reportReturnType": "none",
+    "reportOptionalSubscript": "none",
+    "reportIndexIssue": "none",
+    "reportOperatorIssue": "none",
+    "reportGeneralTypeIssues": "none",
+    "reportOptionalMemberAccess": "none",
+    // custom configs
+    "reportPossiblyUnboundVariable": "error",
+    "reportUnusedImport": "error",
+    "reportIncompatibleMethodOverride": "error",
+    "reportMissingSuperCall": "error"
+}

requirements.txt

@@ -6,6 +6,8 @@ pillow
 pudb
 pylint
 pypdf
+pyright
 pytest
 reportlab
 requests
+ruff

ruff.toml

@@ -0,0 +1,2 @@
+[lint]
+select = ["E4", "E7", "E9", "F", "N802"]

scripts/linting.sh

@@ -0,0 +1,7 @@
+if [[ "$VIRTUAL_ENV" == "" ]]; then
+  source "./venv/bin/activate"
+fi
+
+pylint PyPDFForm/
+pyright .
+ruff check .