✨ update to Invoices v3

Author: ianardee

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Mindee Python API Helper Changelog
 
+## v2.1.0 (2022-03-02)
+
+### Changes
+
+* :sparkles: update to Invoices v3
+* :recycle: refactor `Endpoint` classes and document building
+* :arrow_up: Update PikePDF to 5.0.1
+* :sparkles: add a basic logger
+
 ## v2.0.2 (2022-02-21)
 
 ### Fixes

mindee/documents/financial_document.py

@@ -1,13 +1,19 @@
-from typing import List
+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
 
 
 class FinancialDocument(Document):
+    locale: Locale
+    # orientation is only present on page-level, not document-level
+    orientation: Optional[Orientation] = None
+
     def __init__(
         self,
         api_prediction=None,
@@ -20,7 +26,6 @@ def __init__(
         :param input_file: Input object
         :param page_n: Page number for multi pages pdf input
         """
-        self.locale = None
         self.total_incl = None
         self.total_excl = None
         self.date = None
@@ -31,7 +36,6 @@ def __init__(
         self.payment_details = None
         self.company_number = None
         self.vat_number = None
-        self.orientation = None
         self.total_tax = None
         self.time = None
 

mindee/documents/invoice.py

@@ -20,6 +20,10 @@ class Invoice(Document):
     due_date: Date
     taxes: List[Tax] = []
     supplier: Field
+    supplier_address: Field
+    customer_name: Field
+    customer_company_registration: Field
+    customer_address: Field
     payment_details: List[PaymentDetails] = []
     company_number: List[Field] = []
     total_tax: Amount
@@ -51,6 +55,9 @@ def build_from_api_prediction(self, api_prediction: dict, page_n=0):
         :param page_n: Page number for multi pages pdf input
         :return: (void) set the object attributes with api prediction values
         """
+        if page_n is not None:
+            self.orientation = Orientation(api_prediction["orientation"], page_n=page_n)
+
         self.company_number = [
             Field(company_reg, extra_fields={"type"}, page_n=page_n)
             for company_reg in api_prediction["company_registration"]
@@ -65,9 +72,14 @@ def build_from_api_prediction(self, api_prediction: dict, page_n=0):
         self.locale = Locale(
             api_prediction["locale"], value_key="language", page_n=page_n
         )
-        if page_n is not None:
-            self.orientation = Orientation(api_prediction["orientation"], page_n=page_n)
         self.supplier = Field(api_prediction["supplier"], page_n=page_n)
+        self.supplier_address = Field(api_prediction["supplier_address"], page_n=page_n)
+        self.customer_name = Field(api_prediction["customer"], page_n=page_n)
+        self.customer_company_registration = Field(
+            api_prediction["customer_company_registration"], page_n=page_n
+        )
+        self.customer_address = Field(api_prediction["customer_address"], page_n=page_n)
+
         self.taxes = [
             Tax(tax_prediction, page_n=page_n, value_key="value")
             for tax_prediction in api_prediction["taxes"]
@@ -93,16 +105,20 @@ def __str__(self) -> str:
         return (
             "-----Invoice data-----\n"
             f"Filename: {self.filename}\n"
-            f"Invoice number: {self.invoice_number.value}\n"
-            f"Total amount including taxes: {self.total_incl.value}\n"
-            f"Total amount excluding taxes: {self.total_excl.value}\n"
-            f"Invoice date: {self.invoice_date.value}\n"
-            f"Invoice due date: {self.due_date.value}\n"
-            f"Supplier name: {self.supplier.value}\n"
+            f"Invoice number: {self.invoice_number}\n"
+            f"Total amount including taxes: {self.total_incl}\n"
+            f"Total amount excluding taxes: {self.total_excl}\n"
+            f"Invoice date: {self.invoice_date}\n"
+            f"Invoice due date: {self.due_date}\n"
+            f"Supplier name: {self.supplier}\n"
+            f"Supplier address: {self.supplier_address}\n"
+            f"Customer name: {self.customer_name}\n"
+            f"Customer company registration: {self.customer_company_registration}\n"
+            f"Customer address: {self.customer_address}\n"
             f"Payment details: {payments}\n"
             f"Company numbers: {company_numbers}\n"
             f"Taxes: {taxes}\n"
-            f"Total taxes: {self.total_tax.value}\n"
+            f"Total taxes: {self.total_tax}\n"
             f"Locale: {self.locale}\n"
             "----------------------"
         )

mindee/documents/receipt.py

@@ -65,6 +65,9 @@ def build_from_api_prediction(self, api_prediction, page_n=0):
         :param page_n: Page number for multi pages pdf input
         :return: (void) set the object attributes with api prediction values
         """
+        if page_n is not None:
+            self.orientation = Orientation(api_prediction["orientation"], page_n=page_n)
+
         self.locale = Locale(api_prediction["locale"], page_n=page_n)
         self.total_incl = Amount(
             api_prediction["total_incl"], value_key="value", page_n=page_n
@@ -85,8 +88,6 @@ def build_from_api_prediction(self, api_prediction, page_n=0):
             )
             for tax_prediction in api_prediction["taxes"]
         ]
-        if page_n is not None:
-            self.orientation = Orientation(api_prediction["orientation"], page_n=page_n)
         self.total_tax = Amount(
             {"value": None, "confidence": 0.0}, value_key="value", page_n=page_n
         )

mindee/fields/base.py

@@ -18,7 +18,7 @@ def __init__(
         :param abstract_prediction: Prediction object from HTTP response
         :param value_key: Key to use in the abstract_prediction dict
         :param reconstructed: Bool for reconstructed object (not extracted in the API)
-        :param page_n: Page number for multi pages pdf
+        :param page_n: Page number for multi pages PDF
         :param extra_fields: extra field to get from the abstract_prediction and to set as attribute of the Field
         """
         self.page_n = page_n

mindee/http.py

@@ -10,7 +10,7 @@
 PLATFORM = get_platform()
 USER_AGENT = f"mindee-api-python@v{__version__} python-v{python_version} {PLATFORM}"
 
-INVOICE_VERSION = "2"
+INVOICE_VERSION = "3"
 INVOICE_URL_NAME = "invoices"
 
 RECEIPT_VERSION = "3"
@@ -146,8 +146,8 @@ def annotation_request(
 class InvoiceEndpoint(Endpoint):
     def __init__(self, api_key: Optional[str] = None):
         owner = "mindee"
-        url_name = os.getenv("MINDEE_INVOICE_URL_NAME", INVOICE_URL_NAME)
-        version = os.getenv("MINDEE_INVOICE_VERSION", INVOICE_VERSION)
+        url_name = INVOICE_URL_NAME
+        version = INVOICE_VERSION
         key_name = "invoice"
         super().__init__(
             owner=owner,
@@ -161,8 +161,8 @@ def __init__(self, api_key: Optional[str] = None):
 class ReceiptEndpoint(Endpoint):
     def __init__(self, api_key: Optional[str] = None):
         owner = "mindee"
-        url_name = os.getenv("MINDEE_RECEIPT_URL_NAME", RECEIPT_URL_NAME)
-        version = os.getenv("MINDEE_RECEIPT_VERSION", RECEIPT_VERSION)
+        url_name = RECEIPT_URL_NAME
+        version = RECEIPT_VERSION
         key_name = "receipt"
         super().__init__(
             owner=owner,
@@ -176,8 +176,8 @@ def __init__(self, api_key: Optional[str] = None):
 class PassportEndpoint(Endpoint):
     def __init__(self, api_key: Optional[str] = None):
         owner = "mindee"
-        url_name = os.getenv("MINDEE_PASSPORT_URL_NAME", PASSPORT_URL_NAME)
-        version = os.getenv("MINDEE_PASSPORT_VERSION", PASSPORT_VERSION)
+        url_name = PASSPORT_URL_NAME
+        version = PASSPORT_VERSION
         super().__init__(
             owner=owner,
             url_name=url_name,

mindee/response.py

@@ -1,7 +1,8 @@
-from typing import Dict, Any
+from typing import Dict, Any, List
 
 from mindee.logger import logger
 from mindee.document_config import DocumentConfig
+from mindee.documents.base import TypeDocument, Document
 
 
 def format_response(
@@ -57,9 +58,9 @@ def __init__(
         self,
         doc_config: DocumentConfig,
         http_response: dict,
-        pages: list,
+        pages: List[Document],
         document_type: str,
-        document=None,
+        document=TypeDocument,
     ):
         """
         :param http_response: HTTP response object

tests/data/expense_receipts/v3/receipt_all_na.json

@@ -74,10 +74,10 @@
         },
         "locale": {
           "confidence": 0.15,
-          "country": "FR",
-          "currency": "EUR",
-          "language": "fr",
-          "value": "fr-FR"
+          "country": null,
+          "currency": null,
+          "language": null,
+          "value": null
         },
         "supplier": {
           "confidence": 0.0,