cleanup existing products

Author: sebastianMindee

docs/extras/code_samples/invoice_splitter_v1_async.txt

@@ -2,8 +2,6 @@ from mindee import Client, product
 from time import sleep
 from mindee.parsing.common import AsyncPredictResponse
 
-from mindee.product import InvoiceSplitterV1
-
 # Init a new client
 mindee_client = Client(api_key="my-api-key")
 
@@ -12,7 +10,7 @@ input_doc = mindee_client.source_from_path("/path/to/the/file.ext")
 
 # Load a file from disk and enqueue it.
 result: AsyncPredictResponse = mindee_client.enqueue_and_parse(
-    InvoiceSplitterV1,
+    product.InvoiceSplitterV1,
     input_doc,
 )
 

examples/display_cropping.py

@@ -63,10 +63,10 @@ def show_image_crops(file_path: str, cropping: list):
     mindee_client = Client()
 
     # Load a file from disk
-    input_doc = mindee_client.doc_from_path(image_path)
+    input_doc = mindee_client.source_from_path(image_path)
 
     # Parse the document by passing the appropriate type
-    # api_response = input_doc.parse(product.TypeCropperV1)
+    # api_response = mindee_client.parse(input_doc, product.CropperV1)
 
     # Display
     # show_image_crops(image_path, api_response.pages[0].cropping)

mindee/product/__init__.py

@@ -1,22 +1,19 @@
 from mindee.product import eu, fr, us
 
-# from mindee.product.cropper import CropperV1, TypeCropperV1
-from mindee.product.custom import CustomV1, TypeCustomV1
+# from mindee.product.cropper import CropperV1
+from mindee.product.custom import CustomV1
 
 # from mindee.product.financial_document import (
 #     FinancialDocumentV1,
 #     FinancialDocumentV1LineItem,
-#     TypeFinancialDocumentV1,
 # )
-# from mindee.product.invoice import InvoiceV4, TypeInvoiceV4
-from mindee.product.invoice_splitter import InvoiceSplitterV1, TypeInvoiceSplitterV1
+# from mindee.product.invoice import InvoiceV4
+from mindee.product.invoice_splitter import InvoiceSplitterV1
 
 # from mindee.product.material_certificate import (
 #     MaterialCertificateV1,
-#     TypeMaterialCertificateV1,
 # )
-from mindee.product.receipt import (  # ReceiptV5,; ReceiptV5LineItem,; TypeReceiptV5,
+from mindee.product.receipt import (  # ReceiptV5,; ReceiptV5LineItem,
     ReceiptV4,
     ReceiptV4Document,
-    TypeReceiptV4Document,
 )

mindee/product/custom/__init__.py

@@ -1 +1 @@
-from mindee.product.custom.custom_v1 import CustomV1, TypeCustomV1
+from mindee.product.custom.custom_v1 import CustomV1

mindee/product/custom/custom_v1.py

@@ -1,4 +1,4 @@
-from typing import List, TypeVar
+from typing import List
 
 from mindee.parsing.common import Inference, Page, StringDict
 from mindee.product.custom.custom_v1_document import CustomV1Document
@@ -28,6 +28,3 @@ def __init__(self, raw_prediction: StringDict) -> None:
         self.pages = []
         for page in raw_prediction["pages"]:
             self.pages.append(Page(CustomV1Page, page))
-
-
-TypeCustomV1 = TypeVar("TypeCustomV1", bound=CustomV1)

mindee/product/custom/custom_v1_document.py

@@ -1,4 +1,4 @@
-from typing import Dict, Optional
+from typing import Dict
 
 from mindee.parsing.common import Prediction, StringDict, clean_out_string
 from mindee.parsing.custom import ClassificationFieldV1, ListFieldV1
@@ -12,11 +12,9 @@ class CustomV1Document(Prediction):
     classifications: Dict[str, ClassificationFieldV1]
     """Dictionary of all classifications in the document"""
 
-    def __init__(
-        self, raw_prediction: StringDict, page_id: Optional[int] = None
-    ) -> None:
+    def __init__(self, raw_prediction: StringDict) -> None:
         """
-        Custom document object.
+        Custom document.
 
         :param raw_prediction: Dictionary containing the JSON document response
         """
@@ -27,7 +25,7 @@ def __init__(
                 self.classifications[field_name] = ClassificationFieldV1(field_contents)
             # Only value lists have the 'values' attribute.
             elif "values" in field_contents:
-                self.fields[field_name] = ListFieldV1(field_contents, page_id=page_id)
+                self.fields[field_name] = ListFieldV1(field_contents)
 
     def __str__(self) -> str:
         out_str = ""

mindee/product/invoice_splitter/__init__.py

@@ -1,4 +1 @@
-from mindee.product.invoice_splitter.invoice_splitter_v1 import (
-    InvoiceSplitterV1,
-    TypeInvoiceSplitterV1,
-)
+from mindee.product.invoice_splitter.invoice_splitter_v1 import InvoiceSplitterV1

mindee/product/invoice_splitter/invoice_splitter_v1.py

@@ -1,4 +1,4 @@
-from typing import List, TypeVar
+from typing import List
 
 from mindee.parsing.common import Inference, Page, StringDict
 from mindee.product.invoice_splitter.invoice_splitter_v1_document import (
@@ -29,6 +29,3 @@ def __init__(self, raw_prediction: StringDict) -> None:
         self.pages = []
         for page in raw_prediction["pages"]:
             self.pages.append(Page(InvoiceSplitterV1Document, page))
-
-
-TypeInvoiceSplitterV1 = TypeVar("TypeInvoiceSplitterV1", bound=InvoiceSplitterV1)

mindee/product/invoice_splitter/invoice_splitter_v1_document.py

@@ -14,7 +14,7 @@ class InvoiceSplitterV1Document(Prediction):
 
     def __init__(self, raw_prediction: StringDict) -> None:
         """
-        Invoice Splitter document Object.
+        Invoice Splitter document.
 
         :param raw_prediction: Raw prediction from HTTP response
         """

mindee/product/receipt/__init__.py

@@ -1,8 +1,5 @@
 from mindee.product.receipt.receipt_v4 import ReceiptV4
-from mindee.product.receipt.receipt_v4_document import (
-    ReceiptV4Document,
-    TypeReceiptV4Document,
-)
+from mindee.product.receipt.receipt_v4_document import ReceiptV4Document
 
-# from mindee.product.receipt.receipt_v5 import ReceiptV5, TypeReceiptV5
+# from mindee.product.receipt.receipt_v5 import ReceiptV5
 # from mindee.product.receipt.receipt_v5_line_item import ReceiptV5LineItem

mindee/product/receipt/receipt_v4.py

@@ -1,8 +1,6 @@
 from typing import List
 
-from mindee.parsing.common import Inference
-from mindee.parsing.common.page import Page
-from mindee.parsing.common.string_dict import StringDict
+from mindee.parsing.common import Inference, Page, StringDict
 from mindee.product.receipt.receipt_v4_document import ReceiptV4Document
 
 

mindee/product/receipt/receipt_v4_document.py

@@ -1,4 +1,4 @@
-from typing import Optional, TypeVar
+from typing import Optional
 
 from mindee.parsing.common import Prediction, StringDict, clean_out_string
 from mindee.parsing.standard import (
@@ -12,7 +12,7 @@
 
 
 class ReceiptV4Document(Prediction):
-    """Receipt v4 prediction results."""
+    """Document data for Receipt, API version 4."""
 
     locale: LocaleField
     """locale information"""
@@ -86,6 +86,3 @@ def __str__(self) -> str:
             f":Tip: {self.tip}\n"
             f":Total amount: {self.total_amount}"
         )
-
-
-TypeReceiptV4Document = TypeVar("TypeReceiptV4Document", bound=ReceiptV4Document)

tests/test_client.py

@@ -66,7 +66,7 @@ def test_interface_version(dummy_client: Client):
     )
     with pytest.raises(HTTPException):
         input_doc = dummy_client.source_from_path(FILE_TYPES_DIR / "receipt.jpg")
-        dummy_client.parse(product.TypeCustomV1, input_doc, endpoint=dummy_endpoint)
+        dummy_client.parse(product.CustomV1, input_doc, endpoint=dummy_endpoint)
 
 
 def test_keep_file_open(dummy_client: Client):