✨ add support for shipping container v1

ianardee · ianardee · commit 5c4dcfd9782e · 2023-02-17T12:16:32.000+01:00
diff --git a/docs/code_samples/shipping_container_v1.py b/docs/code_samples/shipping_container_v1.py
@@ -0,0 +1,13 @@
+from mindee import Client, documents
+
+# Init a new client
+mindee_client = Client(api_key="my-api-key")
+
+# Load a file from disk
+input_doc = mindee_client.doc_from_path("/path/to/the/file.ext")
+
+# Parse the Shipping Container by passing the appropriate type
+result = input_doc.parse(documents.TypeShippingContainerV1)
+
+# Print a brief summary of the parsed data
+print(result.document)
diff --git a/docs/conf.py b/docs/conf.py
@@ -62,7 +62,7 @@
 autodoc_member_order = "groupwise"
 autodoc_class_signature = "separated"
 autodoc_typehints = "description"
-autodoc_default_options = {"undoc-members": True, "exclude-members": "__init__"}
+autodoc_default_options = {"exclude-members": "__init__"}
 
 # -- autodoc-typehints -------------------------------------------------------
 
diff --git a/docs/predictions/standard/documents/fr/carte_vitale_v1.rst b/docs/predictions/standard/documents/fr/carte_vitale_v1.rst
@@ -8,4 +8,3 @@ Carte Vitale V1
 
 .. autoclass:: mindee.documents.fr.CarteVitaleV1
     :members:
-    :undoc-members:
diff --git a/docs/predictions/standard/documents/fr/id_card_v1.rst b/docs/predictions/standard/documents/fr/id_card_v1.rst
@@ -8,4 +8,3 @@ Carte Nationale d'Identité V1
 
 .. autoclass:: mindee.documents.fr.IdCardV1
     :members:
-    :undoc-members:
diff --git a/docs/predictions/standard/documents/shipping_container_v1.rst b/docs/predictions/standard/documents/shipping_container_v1.rst
@@ -0,0 +1,10 @@
+Shipping Container V1
+---------------------
+
+**Sample Code:**
+
+.. literalinclude:: /code_samples/shipping_container_v1.py
+    :language: Python
+
+.. autoclass:: mindee.documents.ShippingContainerV1
+    :members:
diff --git a/docs/predictions/standard/fr/carte_vitale_v1.rst b/docs/predictions/standard/fr/carte_vitale_v1.rst
diff --git a/docs/predictions/standard/fr/id_card_v1.rst b/docs/predictions/standard/fr/id_card_v1.rst
diff --git a/docs/predictions/standard/international.rst b/docs/predictions/standard/international.rst
@@ -3,6 +3,7 @@ International
 
 .. include:: ./documents/financial_document_v1.rst
 .. include:: ./documents/passport_v1.rst
+.. include:: ./documents/shipping_container_v1.rst
 .. include:: ./documents/invoice_v3.rst
 .. include:: ./documents/invoice_v4.rst
 .. include:: ./documents/receipt_v3.rst
diff --git a/mindee/cli.py b/mindee/cli.py
@@ -42,20 +42,24 @@ class CommandConfig(Generic[TypeDoc]):
         help="Proof of Address",
         doc_class=documents.TypeProofOfAddressV1,
     ),
+    "shipping-container": CommandConfig(
+        help="Shipping Container",
+        doc_class=documents.fr.TypeIdCardV1,
+    ),
     "us-check": CommandConfig(
         help="US Bank Check",
         doc_class=documents.us.TypeBankCheckV1,
     ),
     "fr-carte-grise": CommandConfig(
-        help="French Carte Grise",
+        help="FR Carte Grise",
         doc_class=documents.fr.TypeCarteGriseV1,
     ),
     "fr-carte-vitale": CommandConfig(
-        help="French Carte Vitale",
+        help="FR Carte Vitale",
         doc_class=documents.fr.TypeCarteVitaleV1,
     ),
     "fr-id-card": CommandConfig(
-        help="French ID Card",
+        help="FR ID Card",
         doc_class=documents.fr.TypeIdCardV1,
     ),
 }
diff --git a/mindee/client.py b/mindee/client.py
@@ -1,20 +1,7 @@
 import json
 from typing import BinaryIO, Dict, List, NamedTuple, Optional, Type
 
-from mindee.documents import (
-    CropperV1,
-    CustomV1,
-    FinancialDocumentV1,
-    FinancialV1,
-    InvoiceV3,
-    InvoiceV4,
-    PassportV1,
-    ProofOfAddressV1,
-    ReceiptV3,
-    ReceiptV4,
-    fr,
-    us,
-)
+from mindee import documents
 from mindee.documents.base import Document, TypeDocument
 from mindee.documents.config import DocumentConfig, DocumentConfigDict
 from mindee.endpoints import OTS_OWNER, CustomEndpoint, HTTPException, StandardEndpoint
@@ -87,7 +74,7 @@ def parse(
             This performs a cropping operation on the server and will increase response time.
         """
         bound_classname = get_bound_classname(document_class)
-        if bound_classname != CustomV1.__name__:
+        if bound_classname != documents.CustomV1.__name__:
             endpoint_name = get_bound_classname(document_class)
         elif endpoint_name is None:
             raise RuntimeError(
@@ -169,7 +156,7 @@ def close(self) -> None:
 
 
 class ConfigSpec(NamedTuple):
-    klass: Type[Document]
+    doc_class: Type[Document]
     url_name: str
     version: str
 
@@ -212,73 +199,78 @@ def _standard_doc_config(
     def _init_default_endpoints(self) -> None:
         configs: List[ConfigSpec] = [
             ConfigSpec(
-                klass=InvoiceV3,
+                doc_class=documents.InvoiceV3,
                 url_name="invoices",
                 version="3",
             ),
             ConfigSpec(
-                klass=InvoiceV4,
+                doc_class=documents.InvoiceV4,
                 url_name="invoices",
                 version="4",
             ),
             ConfigSpec(
-                klass=ReceiptV3,
+                doc_class=documents.ReceiptV3,
                 url_name="expense_receipts",
                 version="3",
             ),
             ConfigSpec(
-                klass=ReceiptV4,
+                doc_class=documents.ReceiptV4,
                 url_name="expense_receipts",
                 version="4",
             ),
             ConfigSpec(
-                klass=FinancialDocumentV1,
+                doc_class=documents.FinancialDocumentV1,
                 url_name="financial_document",
                 version="1",
             ),
             ConfigSpec(
-                klass=PassportV1,
+                doc_class=documents.PassportV1,
                 url_name="passport",
                 version="1",
             ),
             ConfigSpec(
-                klass=ProofOfAddressV1,
+                doc_class=documents.ProofOfAddressV1,
                 url_name="proof_of_address",
                 version="1",
             ),
             ConfigSpec(
-                klass=CropperV1,
+                doc_class=documents.CropperV1,
                 url_name="cropper",
                 version="1",
             ),
             ConfigSpec(
-                klass=us.BankCheckV1,
+                doc_class=documents.us.BankCheckV1,
                 url_name="bank_check",
                 version="1",
             ),
             ConfigSpec(
-                klass=fr.CarteGriseV1,
+                doc_class=documents.fr.CarteGriseV1,
                 url_name="carte_grise",
                 version="1",
             ),
             ConfigSpec(
-                klass=fr.IdCardV1,
+                doc_class=documents.fr.IdCardV1,
                 url_name="idcard_fr",
                 version="1",
             ),
             ConfigSpec(
-                klass=fr.CarteVitaleV1,
+                doc_class=documents.fr.CarteVitaleV1,
                 url_name="carte_vitale",
                 version="1",
             ),
+            ConfigSpec(
+                doc_class=documents.ShippingContainerV1,
+                url_name="shipping_containers",
+                version="1",
+            ),
         ]
         for config in configs:
-            config_key = (OTS_OWNER, config.klass.__name__)
+            config_key = (OTS_OWNER, config.doc_class.__name__)
             self._doc_configs[config_key] = self._standard_doc_config(
-                config.klass, config.url_name, config.version
+                config.doc_class, config.url_name, config.version
             )
-        self._doc_configs[OTS_OWNER, FinancialV1.__name__] = DocumentConfig(
-            document_class=FinancialV1,
+        self._doc_configs[OTS_OWNER, documents.FinancialV1.__name__] = DocumentConfig(
+            document_class=documents.FinancialV1,
             endpoints=[
                 StandardEndpoint(
                     url_name="invoices", version="3", api_key=self.api_key
@@ -294,7 +286,7 @@ def add_endpoint(
         account_name: str,
         endpoint_name: str,
         version: str = "1",
-        document_class: Type[Document] = CustomV1,
+        document_class: Type[Document] = documents.CustomV1,
     ) -> "Client":
         """
         Add a custom endpoint, created using the Mindee API Builder.
diff --git a/mindee/documents/__init__.py b/mindee/documents/__init__.py
@@ -11,3 +11,7 @@
 from mindee.documents.passport import PassportV1, TypePassportV1
 from mindee.documents.proof_of_address import ProofOfAddressV1, TypeProofOfAddressV1
 from mindee.documents.receipt import ReceiptV3, ReceiptV4, TypeReceiptV3, TypeReceiptV4
+from mindee.documents.shipping_container import (
+    ShippingContainerV1,
+    TypeShippingContainerV1,
+)
diff --git a/mindee/documents/shipping_container/__init__.py b/mindee/documents/shipping_container/__init__.py
@@ -0,0 +1 @@
+from .shipping_container_v1 import ShippingContainerV1, TypeShippingContainerV1
diff --git a/mindee/documents/shipping_container/shipping_container_v1.py b/mindee/documents/shipping_container/shipping_container_v1.py
@@ -0,0 +1,71 @@
+from typing import Optional, TypeVar
+
+from mindee.documents.base import Document, TypeApiPrediction, clean_out_string
+from mindee.fields.text import TextField
+
+
+class ShippingContainerV1(Document):
+    """Shipping Container v1 prediction results."""
+
+    owner: TextField
+    """The ISO-6346 code for container owner and equipment identifier."""
+    serial_number: TextField
+    """ISO-6346 code for container serial number."""
+    size_type: TextField
+    """ISO 6346 code for container length, height and type."""
+
+    def __init__(
+        self,
+        api_prediction=None,
+        input_source=None,
+        page_n: Optional[int] = None,
+    ):
+        """
+        Shipping Container v1 prediction results.
+
+        :param api_prediction: Raw prediction from HTTP response
+        :param input_source: Input object
+        :param page_n: Page number for multi pages pdf input
+        """
+        super().__init__(
+            input_source=input_source,
+            document_type="shipping_container",
+            api_prediction=api_prediction,
+            page_n=page_n,
+        )
+        self._build_from_api_prediction(api_prediction["prediction"], page_n=page_n)
+
+    def _build_from_api_prediction(
+        self, api_prediction: TypeApiPrediction, page_n: Optional[int] = None
+    ) -> None:
+        """
+        Build the object from the prediction API JSON.
+
+        :param api_prediction: Raw prediction from HTTP response
+        :param page_n: Page number
+        """
+        self.owner = TextField(
+            api_prediction["owner"],
+            page_n=page_n,
+        )
+        self.serial_number = TextField(
+            api_prediction["serial_number"],
+            page_n=page_n,
+        )
+        self.size_type = TextField(
+            api_prediction["size_type"],
+            page_n=page_n,
+        )
+
+    def __str__(self) -> str:
+        return clean_out_string(
+            "----- Shipping Container V1 -----\n"
+            f"Filename: {self.filename or ''}\n"
+            f"Owner: { self.owner }\n"
+            f"Serial Number: { self.serial_number }\n"
+            f"Size and Type: { self.size_type }\n"
+            "----------------------"
+        )
+
+
+TypeShippingContainerV1 = TypeVar("TypeShippingContainerV1", bound=ShippingContainerV1)
diff --git a/tests/data b/tests/data
@@ -1 +1 @@
-Subproject commit d936a513e7fe9fad8c37648a21b838aabd949b2b
+Subproject commit 4d7ee8f7dd93381d4d64b48eb4fe01c65bfa2af5
diff --git a/tests/documents/test_shipping_container_v1.py b/tests/documents/test_shipping_container_v1.py
@@ -0,0 +1,46 @@
+import json
+
+import pytest
+
+from mindee.documents.shipping_container.shipping_container_v1 import (
+    ShippingContainerV1,
+)
+
+SHIPPING_CONTAINER_DATA_DIR = "./tests/data/shipping_container"
+
+FILE_PATH_SHIPPING_CONTAINER_V1_COMPLETE = (
+    f"{ SHIPPING_CONTAINER_DATA_DIR }/response_v1/complete.json"
+)
+FILE_PATH_SHIPPING_CONTAINER_V1_EMPTY = (
+    f"{ SHIPPING_CONTAINER_DATA_DIR }/response_v1/empty.json"
+)
+
+
+@pytest.fixture
+def shipping_container_v1_doc() -> ShippingContainerV1:
+    json_data = json.load(open(FILE_PATH_SHIPPING_CONTAINER_V1_COMPLETE))
+    return ShippingContainerV1(json_data["document"]["inference"], page_n=None)
+
+
+@pytest.fixture
+def shipping_container_v1_doc_empty() -> ShippingContainerV1:
+    json_data = json.load(open(FILE_PATH_SHIPPING_CONTAINER_V1_EMPTY))
+    return ShippingContainerV1(json_data["document"]["inference"], page_n=None)
+
+
+@pytest.fixture
+def shipping_container_v1_page0():
+    json_data = json.load(open(FILE_PATH_SHIPPING_CONTAINER_V1_COMPLETE))
+    return ShippingContainerV1(json_data["document"]["inference"]["pages"][0], page_n=0)
+
+
+def test_doc_constructor(shipping_container_v1_doc):
+    file_path = f"{ SHIPPING_CONTAINER_DATA_DIR }/response_v1/doc_to_string.txt"
+    reference_str = open(file_path, "r", encoding="utf-8").read().strip()
+    assert str(shipping_container_v1_doc) == reference_str
+
+
+def test_page0_constructor(shipping_container_v1_page0):
+    file_path = f"{ SHIPPING_CONTAINER_DATA_DIR }/response_v1/page0_to_string.txt"
+    reference_str = open(file_path, "r", encoding="utf-8").read().strip()
+    assert str(shipping_container_v1_page0) == reference_str

Original file line number	Diff line number	Diff line change
`@@ -8,4 +8,3 @@ Carte Vitale V1`
`8`	`8`
`9`	`9`	`.. autoclass:: mindee.documents.fr.CarteVitaleV1`
`10`	`10`	`:members:`
`11`		`- :undoc-members:`
Original file line number	Diff line number	Diff line change
`@@ -8,4 +8,3 @@ Carte Nationale d'Identité V1`
`8`	`8`
`9`	`9`	`.. autoclass:: mindee.documents.fr.IdCardV1`
`10`	`10`	`:members:`
`11`		`- :undoc-members:`