✨ add support for Barcode Reader V1

Author: sebastianMindee

docs/extras/code_samples/barcode_reader_v1.txt

@@ -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 Barcode Reader by passing the appropriate type
+result = input_doc.parse(documents.TypeBarcodeReaderV1)
+
+# Print a brief summary of the parsed data
+print(result.document)

docs/predictions/standard/documents/barcode_reader_v1.rst

@@ -0,0 +1,10 @@
+Barcode Reader V1
+-----------------
+
+**Sample Code:**
+
+.. literalinclude:: /extras/code_samples/barcode_reader_v1.txt
+    :language: Python
+
+.. autoclass:: mindee.documents.BarcodeReaderV1
+    :members:

mindee/cli.py

@@ -27,6 +27,10 @@ class CommandConfig(Generic[TypeDoc]):
         help="Custom document type from API builder",
         doc_class=documents.TypeCustomV1,
     ),
+    "barcode-reader": CommandConfig(
+        help="Barcode Reader",
+        doc_class=documents.TypeBarcodeReaderV1,
+    ),
     "invoice": CommandConfig(
         help="Invoice",
         doc_class=documents.TypeInvoiceV4,

mindee/client.py

@@ -374,6 +374,11 @@ def _standard_doc_config(
 
     def _init_default_endpoints(self) -> None:
         configs: List[ConfigSpec] = [
+            ConfigSpec(
+                doc_class=documents.BarcodeReaderV1,
+                url_name="barcode_reader",
+                version="1",
+            ),
             ConfigSpec(
                 doc_class=documents.InvoiceV3,
                 url_name="invoices",

mindee/documents/__init__.py

@@ -1,4 +1,5 @@
 from mindee.documents import eu, fr, us
+from mindee.documents.barcode_reader import BarcodeReaderV1, TypeBarcodeReaderV1
 from mindee.documents.cropper import CropperV1, TypeCropperV1
 from mindee.documents.custom import CustomV1, TypeCustomV1
 from mindee.documents.financial_document import (

mindee/documents/barcode_reader/__init__.py

@@ -0,0 +1 @@
+from .barcode_reader_v1 import BarcodeReaderV1, TypeBarcodeReaderV1

mindee/documents/barcode_reader/barcode_reader_v1.py

@@ -0,0 +1,73 @@
+from typing import List, Optional, TypeVar
+
+from mindee.documents.base import Document, TypeApiPrediction, clean_out_string
+from mindee.fields.text import TextField
+
+
+class BarcodeReaderV1(Document):
+    """Barcode Reader v1 prediction results."""
+
+    codes_1d: List[TextField]
+    """List of decoded 1D barcodes."""
+    codes_2d: List[TextField]
+    """List of decoded 2D barcodes."""
+
+    def __init__(
+        self,
+        api_prediction=None,
+        input_source=None,
+        page_n: Optional[int] = None,
+    ):
+        """
+        Barcode Reader 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="barcode_reader",
+            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.codes_1d = [
+            TextField(prediction, page_id=page_n)
+            for prediction in api_prediction["codes_1d"]
+        ]
+        self.codes_2d = [
+            TextField(prediction, page_id=page_n)
+            for prediction in api_prediction["codes_2d"]
+        ]
+
+    def __str__(self) -> str:
+        codes_1d = f"\n { ' ' * 13 }".join(
+            [str(item) for item in self.codes_1d],
+        )
+        codes_2d = f"\n { ' ' * 13 }".join(
+            [str(item) for item in self.codes_2d],
+        )
+        return clean_out_string(
+            "Barcode Reader V1 Prediction\n"
+            "============================\n"
+            f":Filename: {self.filename or ''}\n"
+            f":Barcodes 1D: {codes_1d}\n"
+            f":Barcodes 2D: {codes_2d}\n"
+        )
+
+
+TypeBarcodeReaderV1 = TypeVar(
+    "TypeBarcodeReaderV1",
+    bound=BarcodeReaderV1,
+)

tests/documents/test_barcode_reader_v1.py

@@ -0,0 +1,32 @@
+import json
+
+import pytest
+
+from mindee.documents import BarcodeReaderV1
+
+BARCODE_READER_DATA_DIR = "./tests/data/products/barcode_reader"
+FILE_PATH_BARCODE_READER_V1_COMPLETE = f"{ BARCODE_READER_DATA_DIR }/response_v1/complete.json"
+FILE_PATH_BARCODE_READER_V1_EMPTY = f"{ BARCODE_READER_DATA_DIR }/response_v1/empty.json"
+
+
+@pytest.fixture
+def barcode_reader_v1_doc() -> BarcodeReaderV1:
+    json_data = json.load(open(FILE_PATH_BARCODE_READER_V1_COMPLETE, encoding="utf-8"))
+    return BarcodeReaderV1(json_data["document"]["inference"], page_n=None)
+
+
+@pytest.fixture
+def barcode_reader_v1_doc_empty() -> BarcodeReaderV1:
+    json_data = json.load(open(FILE_PATH_BARCODE_READER_V1_EMPTY, encoding="utf-8"))
+    return BarcodeReaderV1(json_data["document"]["inference"], page_n=None)
+
+
+@pytest.fixture
+def barcode_reader_v1_page0():
+    json_data = json.load(open(FILE_PATH_BARCODE_READER_V1_COMPLETE, encoding="utf-8"))
+    return BarcodeReaderV1(json_data["document"]["inference"]["pages"][0], page_n=0)
+
+
+def test_empty_doc_constructor(barcode_reader_v1_doc_empty):
+    assert len(barcode_reader_v1_doc_empty.codes_1d) == 0
+    assert len(barcode_reader_v1_doc_empty.codes_2d) == 0

tests/documents/us/test_w9_v1.py

@@ -40,4 +40,3 @@ def test_empty_doc_constructor(w9_v1_doc_empty):
     assert w9_v1_doc_empty.signature_position.value is None
     assert w9_v1_doc_empty.signature_date_position.value is None
     assert w9_v1_doc_empty.tax_classification_llc.value is None
-