🎨 fixes to import order (isort) and documentation (pydocstyle).

Author: ianardee

.pre-commit-config.yaml

@@ -18,7 +18,7 @@ repos:
         additional_dependencies: [toml]
         exclude: .*(test|__init__|version).*\.py
         args: [
-            --ignore=D10
+            "--ignore=D10,D212,D203,D401"
         ]
 
   - repo: https://github.com/PyCQA/pylint

mindee/__main__.py

@@ -1,7 +1,7 @@
 import argparse
-from argparse import Namespace
 import json
-from typing import Dict, Any
+from argparse import Namespace
+from typing import Any, Dict
 
 from mindee import Client
 
@@ -97,7 +97,7 @@ def call_endpoint(args: Namespace):
 
 
 def _parse_args() -> Namespace:
-    """Parse command line arguments"""
+    """Parse command line arguments."""
     parser = argparse.ArgumentParser(description="Mindee API")
     parser.add_argument(
         "-E",

mindee/client.py

@@ -1,28 +1,28 @@
 import json
 from typing import Dict
 
+from mindee.document_config import DocumentConfig, DocumentConfigDict
+from mindee.documents.custom_document import CustomDocument
+from mindee.documents.financial_document import FinancialDocument
+from mindee.documents.invoice import Invoice
+from mindee.documents.passport import Passport
+from mindee.documents.receipt import Receipt
+from mindee.http import (
+    CustomEndpoint,
+    HTTPException,
+    InvoiceEndpoint,
+    PassportEndpoint,
+    ReceiptEndpoint,
+)
 from mindee.inputs import (
-    InputDocument,
     Base64Document,
     BytesDocument,
     FileDocument,
+    InputDocument,
     PathDocument,
 )
 from mindee.logger import logger
-from mindee.response import format_response, DocumentResponse
-from mindee.http import (
-    HTTPException,
-    CustomEndpoint,
-    InvoiceEndpoint,
-    ReceiptEndpoint,
-    PassportEndpoint,
-)
-from mindee.document_config import DocumentConfig, DocumentConfigDict
-from mindee.documents.receipt import Receipt
-from mindee.documents.financial_document import FinancialDocument
-from mindee.documents.invoice import Invoice
-from mindee.documents.passport import Passport
-from mindee.documents.custom_document import CustomDocument
+from mindee.response import DocumentResponse, format_response
 
 
 class DocumentClient:
@@ -44,6 +44,8 @@ def parse(
         self, document_type: str, username: str = None, include_words: bool = False
     ):
         """
+        Call prediction API on the document and parse the results.
+
         :param document_type: Document type to parse
         :param username:
         :param include_words: Bool, extract all words into http_response
@@ -118,6 +120,8 @@ class Client:
 
     def __init__(self, raise_on_error: bool = True):
         """
+        Mindee API Client.
+
         :param raise_on_error: Raise an Exception on HTTP errors
         """
         self._doc_configs: Dict[tuple, DocumentConfig] = {}

mindee/document_config.py

@@ -1,7 +1,7 @@
 from typing import Dict, List
 
-from mindee.http import Endpoint
 from mindee.documents.base import TypeDocument
+from mindee.http import Endpoint
 
 
 class DocumentConfig:

mindee/documents/base.py

@@ -1,4 +1,4 @@
-from typing import List, Type, Optional
+from typing import List, Optional, Type
 
 # from mindee.inputs import InputDocument
 from mindee.http import Endpoint
@@ -31,11 +31,11 @@ def __init__(
 
     @staticmethod
     def request(endpoints: List[Endpoint], input_file, include_words: bool = False):
-        """Make request to the product endpoint"""
+        """Make request to the product endpoint."""
         raise NotImplementedError()
 
     def build_from_api_prediction(self, api_prediction: dict, page_n):
-        """Build the document from an API response JSON"""
+        """Build the document from an API response JSON."""
         raise NotImplementedError()
 
     def _checklist(self) -> None:
@@ -45,7 +45,7 @@ def _reconstruct(self) -> None:
         pass
 
     def all_checks(self) -> bool:
-        """Return all checks"""
+        """Return all checks."""
         return all(self.checklist)
 
 

mindee/documents/financial_document.py

@@ -1,12 +1,12 @@
 from typing import List, Optional
 
-from mindee.fields import Field
-from mindee.fields.orientation import Orientation
-from mindee.fields.locale import Locale
-from mindee.http import Endpoint
 from mindee.documents.base import Document
 from mindee.documents.invoice import Invoice
 from mindee.documents.receipt import Receipt
+from mindee.fields import Field
+from mindee.fields.locale import Locale
+from mindee.fields.orientation import Orientation
+from mindee.http import Endpoint
 
 
 class FinancialDocument(Document):
@@ -22,6 +22,8 @@ def __init__(
         document_type="financial_doc",
     ):
         """
+        Union of `Invoice` and `Receipt`.
+
         :param api_prediction: Raw prediction from HTTP response
         :param input_file: Input object
         :param page_n: Page number for multi pages pdf input
@@ -55,6 +57,8 @@ def __init__(
 
     def build_from_api_prediction(self, api_prediction, page_n=0):
         """
+        Build the document from an API response JSON.
+
         :param api_prediction: Raw prediction from HTTP response
         :param page_n: Page number for multi pages pdf input
         :return: (void) set the object attributes with api prediction values
@@ -133,7 +137,8 @@ def __str__(self) -> str:
     @staticmethod
     def request(endpoints: List[Endpoint], input_file, include_words=False):
         """
-        Make request to expense_receipts endpoint
+        Make request to prediction endpoint.
+
         :param input_file: Input object
         :param endpoints: Endpoints config
         :param include_words: Include Mindee vision words in http_response
@@ -146,15 +151,14 @@ def request(endpoints: List[Endpoint], input_file, include_words=False):
         return endpoints[index].predict_request(input_file, include_words)
 
     def _checklist(self) -> None:
-        """
-        :return: Set of validation rules
-        """
+        """Set the validation rules."""
         self.checklist = {"taxes_match_total_incl": self.__taxes_match_total_incl()}
 
     # Checks
     def __taxes_match_total_incl(self) -> bool:
         """
-        Check invoice rule of matching between taxes and total_incl
+        Check invoice rule of matching between taxes and total_incl.
+
         :return: True if rule matches, False otherwise
         """
         # Check taxes and total_incl exist

mindee/documents/invoice.py

@@ -2,8 +2,8 @@
 
 from mindee.documents.base import Document
 from mindee.fields import Field
-from mindee.fields.date import Date
 from mindee.fields.amount import Amount
+from mindee.fields.date import Date
 from mindee.fields.locale import Locale
 from mindee.fields.orientation import Orientation
 from mindee.fields.payment_details import PaymentDetails
@@ -38,6 +38,8 @@ def __init__(
         document_type="invoice",
     ):
         """
+        Invoice document.
+
         :param api_prediction: Raw prediction from HTTP response
         :param input_file: Input object
         :param page_n: Page number for multi pages pdf input
@@ -51,6 +53,8 @@ def __init__(
 
     def build_from_api_prediction(self, api_prediction: dict, page_n=0):
         """
+        Build the object from the prediction API JSON.
+
         :param api_prediction: Raw prediction from HTTP response
         :param page_n: Page number for multi pages pdf input
         :return: (void) set the object attributes with api prediction values
@@ -126,26 +130,23 @@ def __str__(self) -> str:
     @staticmethod
     def request(endpoints: List[Endpoint], input_file, include_words=False):
         """
-        Make request to expense_receipts endpoint
+        Make request to prediction endpoint.
+
         :param input_file: Input object
         :param endpoints: Endpoints config
         :param include_words: Include Mindee vision words in http_response
         """
         return endpoints[0].predict_request(input_file, include_words)
 
     def _reconstruct(self) -> None:
-        """
-        Call fields reconstruction methods
-        """
+        """Call fields reconstruction methods."""
         self.__reconstruct_total_tax_from_tax_lines()
         self.__reconstruct_total_excl_from_tcc_and_taxes()
         self.__reconstruct_total_incl_from_taxes_plus_excl()
         self.__reconstruct_total_tax_from_incl_and_excl()
 
     def _checklist(self) -> None:
-        """
-        Call check methods
-        """
+        """Call check methods."""
         self.checklist = {
             "taxes_match_total_incl": self.__taxes_match_total_incl(),
             "taxes_match_total_excl": self.__taxes_match_total_excl(),
@@ -155,7 +156,8 @@ def _checklist(self) -> None:
     # Checks
     def __taxes_match_total_incl(self) -> bool:
         """
-        Check invoice rule of matching between taxes and total_incl
+        Check invoice matching rule between taxes and total_incl.
+
         :return: True if rule matches, False otherwise
         """
         # Ensure taxes and total_incl exist
@@ -191,7 +193,8 @@ def __taxes_match_total_incl(self) -> bool:
 
     def __taxes_match_total_excl(self) -> bool:
         """
-        Check invoice rule of matching between taxes and total_excl
+        Check invoice matching rule between taxes and total_excl.
+
         :return: True if rule matches, False otherwise
         """
         # Check taxes and total excl exist
@@ -228,7 +231,9 @@ def __taxes_match_total_excl(self) -> bool:
 
     def __taxes_plus_total_excl_match_total_incl(self) -> bool:
         """
-        Check invoice rule of matching : sum(taxes) + total_excluding_taxes = total_including_taxes
+        Check invoice matching rule.
+
+        Rule is: sum(taxes) + total_excluding_taxes = total_including_taxes
         :return: True if rule matches, False otherwise
         """
         # Check total_tax, total excl and total incl exist
@@ -267,7 +272,8 @@ def __taxes_plus_total_excl_match_total_incl(self) -> bool:
     # Reconstruct
     def __reconstruct_total_incl_from_taxes_plus_excl(self) -> None:
         """
-        Set self.total_incl with Amount object
+        Set self.total_incl with Amount object.
+
         The total_incl Amount value is the sum of total_excl and sum of taxes
         The total_incl Amount confidence is the product of self.taxes probabilities
             multiplied by total_excl confidence
@@ -292,7 +298,8 @@ def __reconstruct_total_incl_from_taxes_plus_excl(self) -> None:
 
     def __reconstruct_total_excl_from_tcc_and_taxes(self) -> None:
         """
-        Set self.total_excl with Amount object
+        Set self.total_excl with Amount object.
+
         The total_excl Amount value is the difference between total_incl and sum of taxes
         The total_excl Amount confidence is the product of self.taxes probabilities
             multiplied by total_incl confidence
@@ -317,7 +324,8 @@ def __reconstruct_total_excl_from_tcc_and_taxes(self) -> None:
 
     def __reconstruct_total_tax_from_tax_lines(self) -> None:
         """
-        Set self.total_tax with Amount object
+        Set self.total_tax with Amount object.
+
         The total_tax Amount value is the sum of all self.taxes value
         The total_tax Amount confidence is the product of self.taxes probabilities
         """
@@ -335,7 +343,8 @@ def __reconstruct_total_tax_from_tax_lines(self) -> None:
 
     def __reconstruct_total_tax_from_incl_and_excl(self) -> None:
         """
-        Set self.total_tax with Amount object
+        Set self.total_tax with Amount object.
+
         Check if the total tax was already set
         If not, set thta total tax amount to the diff of incl and excl
         """