preemptively upgrade split syntax to account for future server evolutions

Author: sebastianMindee

mindee/v2/product/split/__init__.py

@@ -2,12 +2,12 @@
 from mindee.v2.product.split.split_parameters import SplitParameters
 from mindee.v2.product.split.split_response import SplitResponse
 from mindee.v2.product.split.split_result import SplitResult
-from mindee.v2.product.split.split_split import SplitSplit
+from mindee.v2.product.split.split_range import SplitRange
 
 __all__ = [
     "SplitInference",
     "SplitParameters",
     "SplitResponse",
     "SplitResult",
-    "SplitSplit",
+    "SplitRange",
 ]

mindee/v2/product/split/split_split.py mindee/v2/product/split/split_range.pymindee/v2/product/split/split_split.py renamed to mindee/v2/product/split/split_range.py

@@ -3,7 +3,7 @@
 from mindee.parsing.common.string_dict import StringDict
 
 
-class SplitSplit:
+class SplitRange:
     """Split inference result."""
 
     page_range: List[int]

mindee/v2/product/split/split_result.py

@@ -1,20 +1,20 @@
 from typing import List
 
 from mindee.parsing.common.string_dict import StringDict
-from mindee.v2.product.split.split_split import SplitSplit
+from mindee.v2.product.split.split_range import SplitRange
 
 
 class SplitResult:
     """Split result info."""
 
-    split: List[SplitSplit]
+    splits: List[SplitRange]
 
     def __init__(self, raw_response: StringDict) -> None:
-        self.split = [SplitSplit(split) for split in raw_response["split"]]
+        self.splits = [SplitRange(split) for split in raw_response["split"]]
 
     def __str__(self) -> str:
         splits = "\n"
-        if len(self.split) > 0:
-            splits += "\n\n".join([str(split) for split in self.split])
+        if len(self.splits) > 0:
+            splits += "\n\n".join([str(split) for split in self.splits])
         out_str = f"Splits\n======{splits}"
         return out_str

tests/v2/parsing/test_split_integration.py

@@ -35,5 +35,5 @@ def test_split_blank(v2_client: ClientV2, split_model_id: str):
     )  # Note: do not use blank_1.pdf for this.
     assert response.inference is not None
     assert response.inference.file.name == "default_sample.pdf"
-    assert response.inference.result.split
-    assert len(response.inference.result.split) == 2
+    assert response.inference.result.splits
+    assert len(response.inference.result.splits) == 2

tests/v2/parsing/test_split_response.py

@@ -1,7 +1,7 @@
 import pytest
 
 from mindee import LocalResponse
-from mindee.v2.product.split.split_split import SplitSplit
+from mindee.v2.product.split.split_range import SplitRange
 from mindee.v2.product.split import SplitInference
 from mindee.v2.product.split.split_response import SplitResponse
 from mindee.v2.product.split.split_result import SplitResult
@@ -13,11 +13,11 @@ def test_split_single():
     input_inference = LocalResponse(V2_UTILITIES_DATA_DIR / "split_single.json")
     split_response = input_inference.deserialize_response(SplitResponse)
     assert isinstance(split_response.inference, SplitInference)
-    assert split_response.inference.result.split
-    assert len(split_response.inference.result.split[0].page_range) == 2
-    assert split_response.inference.result.split[0].page_range[0] == 0
-    assert split_response.inference.result.split[0].page_range[1] == 0
-    assert split_response.inference.result.split[0].document_type == "receipt"
+    assert split_response.inference.result.splits
+    assert len(split_response.inference.result.splits[0].page_range) == 2
+    assert split_response.inference.result.splits[0].page_range[0] == 0
+    assert split_response.inference.result.splits[0].page_range[1] == 0
+    assert split_response.inference.result.splits[0].document_type == "receipt"
 
 
 @pytest.mark.v2
@@ -26,20 +26,20 @@ def test_split_multiple():
     split_response = input_inference.deserialize_response(SplitResponse)
     assert isinstance(split_response.inference, SplitInference)
     assert isinstance(split_response.inference.result, SplitResult)
-    assert isinstance(split_response.inference.result.split[0], SplitSplit)
-    assert len(split_response.inference.result.split) == 3
-
-    assert len(split_response.inference.result.split[0].page_range) == 2
-    assert split_response.inference.result.split[0].page_range[0] == 0
-    assert split_response.inference.result.split[0].page_range[1] == 0
-    assert split_response.inference.result.split[0].document_type == "invoice"
-
-    assert len(split_response.inference.result.split[1].page_range) == 2
-    assert split_response.inference.result.split[1].page_range[0] == 1
-    assert split_response.inference.result.split[1].page_range[1] == 3
-    assert split_response.inference.result.split[1].document_type == "invoice"
-
-    assert len(split_response.inference.result.split[2].page_range) == 2
-    assert split_response.inference.result.split[2].page_range[0] == 4
-    assert split_response.inference.result.split[2].page_range[1] == 4
-    assert split_response.inference.result.split[2].document_type == "invoice"
+    assert isinstance(split_response.inference.result.splits[0], SplitRange)
+    assert len(split_response.inference.result.splits) == 3
+
+    assert len(split_response.inference.result.splits[0].page_range) == 2
+    assert split_response.inference.result.splits[0].page_range[0] == 0
+    assert split_response.inference.result.splits[0].page_range[1] == 0
+    assert split_response.inference.result.splits[0].document_type == "invoice"
+
+    assert len(split_response.inference.result.splits[1].page_range) == 2
+    assert split_response.inference.result.splits[1].page_range[0] == 1
+    assert split_response.inference.result.splits[1].page_range[1] == 3
+    assert split_response.inference.result.splits[1].document_type == "invoice"
+
+    assert len(split_response.inference.result.splits[2].page_range) == 2
+    assert split_response.inference.result.splits[2].page_range[0] == 4
+    assert split_response.inference.result.splits[2].page_range[1] == 4
+    assert split_response.inference.result.splits[2].document_type == "invoice"