chg: ✨ add mypy and pylint to CI; 🚨 basic lint fixes (#40)

Author: ianardee

.github/workflows/linting.yml

@@ -23,3 +23,9 @@ jobs:
     - name: Analysing the code with Black
       run: |
         black --check .
+    - name: Analysing the code with mypy
+      run: |
+        mypy --install-types --non-interactive ./mindee
+    - name: Analysing the code with pylint
+      run: |
+        pylint ./mindee

mindee/__init__.py

@@ -19,7 +19,7 @@
 }
 
 
-class Client(object):
+class Client:
     def __init__(
         self,
         expense_receipt_token=None,
@@ -231,7 +231,7 @@ def parse_financial_document(
         return self._wrap_response(input_file, response, "financial_document")
 
 
-class Response(object):
+class Response:
     def __init__(
         self, http_response=None, pages=None, document=None, document_type=None
     ):
@@ -311,7 +311,7 @@ def format_response(json_response, document_type, input_file):
             raise Exception("Document type not supported.")
 
         # Create page level objects
-        for page_n, page_prediction in enumerate(
+        for _, page_prediction in enumerate(
             json_response["document"]["inference"]["pages"]
         ):
             pages.append(

mindee/documents/__init__.py

@@ -1,4 +1,4 @@
-class Document(object):
+class Document:
     def __init__(self, input_file=None):
         self.filepath = None
         self.filename = None
@@ -11,6 +11,7 @@ def __init__(self, input_file=None):
         self.checklist = {}
 
     def request(self, *args):
+        """Make request to the product endpoint"""
         raise NotImplementedError()
 
     def _checklist(self, *args):
@@ -20,4 +21,5 @@ def _reconstruct(self, *args):
         pass
 
     def all_checks(self):
+        """Return all checks"""
         return all(self.checklist)

mindee/documents/car_plate.py

@@ -1,7 +1,6 @@
 from mindee.documents import Document
 from mindee.fields import Field
 from mindee.http import make_api_request, make_predict_url
-import os
 
 
 class CarPlate(Document):
@@ -46,7 +45,7 @@ def build_from_api_prediction(self, api_prediction, page_n=0):
             for license_plate in api_prediction["license_plates"]
         ]
 
-    def __str__(self):
+    def __str__(self) -> str:
         return (
             "-----Car plate data-----\n"
             "Filename: %s\n"

mindee/documents/financial_document.py

@@ -8,7 +8,6 @@
 from mindee.http import make_api_request, make_predict_url
 from mindee.documents.invoice import Invoice
 from mindee.documents.receipt import Receipt
-import os
 
 
 class FinancialDocument(Document):
@@ -159,7 +158,7 @@ def build_from_api_prediction(self, api_prediction, input_file, page_n=0):
             self.payment_details = []
             self.company_number = []
 
-    def __str__(self):
+    def __str__(self) -> str:
         return (
             "-----Financial Document data-----\n"
             "Filename: %s \n"

mindee/documents/invoice.py

@@ -7,7 +7,6 @@
 from mindee.fields.payment_details import PaymentDetails
 from mindee.fields.tax import Tax
 from mindee.http import make_api_request, make_predict_url
-import os
 
 
 class Invoice(Document):
@@ -153,7 +152,7 @@ def build_from_api_prediction(self, api_prediction, page_n=0):
             {"value": None, "probability": 0.0}, value_key="value", page_n=page_n
         )
 
-    def __str__(self):
+    def __str__(self) -> str:
         return (
             "-----Invoice data-----\n"
             "Filename: %s \n"

mindee/documents/passport.py

@@ -1,9 +1,8 @@
+from datetime import datetime
 from mindee.documents import Document
 from mindee.fields import Field
 from mindee.fields.date import Date
-from datetime import datetime
 from mindee.http import make_api_request, make_predict_url
-import os
 
 
 class Passport(Document):
@@ -127,7 +126,7 @@ def build_from_api_prediction(self, api_prediction, page_n=0):
         self.mrz = Field({"value": None, "probability": 0.0}, page_n=page_n)
         self.full_name = Field({"value": None, "probability": 0.0}, page_n=page_n)
 
-    def __str__(self):
+    def __str__(self) -> str:
         return (
             "-----Passport data-----\n"
             "Filename: %s \n"

mindee/documents/receipt.py

@@ -6,7 +6,6 @@
 from mindee.fields.orientation import Orientation
 from mindee.fields.tax import Tax
 from mindee.http import make_api_request, make_predict_url
-import os
 
 
 class Receipt(Document):
@@ -95,7 +94,7 @@ def __init__(
         # Reconstruct extra fields
         self._reconstruct()
 
-    def __str__(self):
+    def __str__(self) -> str:
         return (
             "-----Receipt data-----\n"
             "Filename: %s\n"

mindee/fields/__init__.py

@@ -1,4 +1,4 @@
-class Field(object):
+class Field:
     def __init__(
         self,
         abstract_prediction,

mindee/http.py

@@ -3,7 +3,7 @@
 
 MINDEE_API_URL = "https://api.mindee.net/v1"
 
-platform = get_platform()
+PLATFORM = get_platform()
 
 
 def make_predict_url(product: str, version: str, owner: str = "mindee") -> str:
@@ -30,7 +30,7 @@ def make_api_request(url: str, input_file, token: str, include_words: bool = Fal
     files = {"document": (input_file.filename, input_file.file_object.read())}
     headers = {
         "Authorization": f"Token {token}",
-        "User-Agent": f"mindee-api-python@v{__version__} python-v{python_version} {platform}",
+        "User-Agent": f"mindee-api-python@v{__version__} python-v{python_version} {PLATFORM}",
     }
 
     params = {}