♻️ 🐛 fix circular imports and refactor internals

.github/workflows/_smoke-test.yml

@@ -56,7 +56,7 @@ jobs:
           ./tests/test_v1_code_samples.sh ${{ secrets.MINDEE_ACCOUNT_SE_TESTS }} ${{ secrets.MINDEE_ENDPOINT_SE_TESTS }}
 
       - name: Notify Slack Action on Failure
-        uses: ravsamhq/notify-slack-action@2.3.0
+        uses: ravsamhq/notify-slack-action@2.5.0
         if: ${{ always() && github.ref_name == 'main' }}
         with:
           status: ${{ job.status }}

.github/workflows/_static-analysis.yml

@@ -52,5 +52,7 @@ jobs:
           ${{ runner.os }}-prec-
 
     - name: Run all static analysis
+      env:
+        SKIP: sphinx-html,sphinx-linkcheck
       run: |
         pre-commit run --all-files

.pre-commit-config.yaml

@@ -41,3 +41,18 @@ repos:
           - types-setuptools
           - importlib-metadata
           - types-Pillow
+  - repo: local
+    hooks:
+      - id: sphinx-html
+        name: Sphinx HTML build
+        entry: make -C docs html
+        language: system
+        pass_filenames: false
+        files: ^docs/.*$|^mindee/.*\.py$
+
+      - id: sphinx-linkcheck
+        name: Sphinx Linkcheck
+        entry: make -C docs linkcheck
+        language: system
+        pass_filenames: false
+        files: ^docs/.*$|^mindee/.*\.py$

docs/conf.py

@@ -73,3 +73,4 @@
 # -- autodoc-typehints -------------------------------------------------------
 
 typehints_defaults = "comma"
+suppress_warnings = ["ref.python"]

docs/input.rst

@@ -3,7 +3,6 @@ Mindee Input
 ------------
 
 .. automodule:: mindee.input
-    :imported-members:
     :inherited-members:
     :members:
     :undoc-members:

docs/v2/parsing/error.rst

@@ -0,0 +1,15 @@
+V2 Parsing Error
+################
+
+
+Error Item
+----------
+.. autoclass:: mindee.v2.parsing.error.error_item.ErrorItem
+    :members:
+    :inherited-members:
+
+Error Response
+--------------
+.. autoclass:: mindee.v2.parsing.error.error_response.ErrorResponse
+    :members:
+    :inherited-members:

docs/v2/parsing/index.rst

@@ -5,4 +5,6 @@ V2 Parsing
 .. toctree::
     :maxdepth: 3
 
-    ./inference/index
+    ./inference/index
+    ./error
+    ./job

docs/v2/parsing/inference/field.rst

@@ -7,12 +7,6 @@ Base Field
     :members:
     :inherited-members:
 
-Dynamic Field
--------------
-.. autoclass:: mindee.v2.parsing.inference.field.base_field.DynamicField
-    :members:
-    :inherited-members:
-
 Field Confidence
 ----------------
 .. autoclass:: mindee.v2.parsing.inference.field.field_confidence.FieldConfidence

docs/v2/parsing/inference/index.rst

@@ -20,19 +20,6 @@ Base Response
     :members:
     :inherited-members:
 
-
-Error Item
-==========
-.. autoclass:: mindee.v2.parsing.inference.error_item.ErrorItem
-    :members:
-    :inherited-members:
-
-Error Response
-==============
-.. autoclass:: mindee.v2.parsing.inference.error_response.ErrorResponse
-    :members:
-    :inherited-members:
-
 Inference Active Options
 ========================
 .. autoclass:: mindee.v2.parsing.inference.inference_active_options.InferenceActiveOptions
@@ -45,36 +32,12 @@ Inference File
     :members:
     :inherited-members:
 
-Inference Job
-=============
-.. autoclass:: mindee.v2.parsing.inference.inference_job.InferenceJob
-    :members:
-    :inherited-members:
-
 Inference Model
 =================
 .. autoclass:: mindee.v2.parsing.inference.inference_model.InferenceModel
     :members:
     :inherited-members:
 
-Job
-===
-.. autoclass:: mindee.v2.parsing.inference.job.Job
-    :members:
-    :inherited-members:
-
-Job Response
-============
-.. autoclass:: mindee.v2.parsing.inference.job_response.JobResponse
-    :members:
-    :inherited-members:
-
-Job Webhook
-===========
-.. autoclass:: mindee.v2.parsing.inference.job_webhook.JobWebhook
-    :members:
-    :inherited-members:
-
 RAG Metadata
 ============
 .. autoclass:: mindee.v2.parsing.inference.rag_metadata.RAGMetadata

docs/v2/parsing/job.rst

@@ -0,0 +1,21 @@
+V2 Parsing Job
+##############
+
+
+Job
+---
+.. autoclass:: mindee.v2.parsing.job.job.Job
+    :members:
+    :inherited-members:
+
+Job Response
+------------
+.. autoclass:: mindee.v2.parsing.job.job_response.JobResponse
+    :members:
+    :inherited-members:
+
+Job Webook
+----------
+.. autoclass:: mindee.v2.parsing.job.job_webhook.JobWebhook
+    :members:
+    :inherited-members:

docs/v2/product/crop/index.rst

@@ -8,12 +8,6 @@ Crop
 
     ./params
 
-Crop Box
-========
-.. autoclass:: mindee.v2.product.crop.crop_box.CropBox
-    :members:
-    :inherited-members:
-
 Crop Item
 =========
 .. autoclass:: mindee.v2.product.crop.crop_item.CropItem

mindee/__init__.py

@@ -8,7 +8,7 @@
 from mindee.input.path_input import PathInput
 from mindee.input.url_input_source import URLInputSource
 from mindee.v1 import product
-from mindee.v2.parsing.inference.job_response import JobResponse
+from mindee.v2.parsing.job.job_response import JobResponse
 from mindee.v2.product.classification.classification_response import (
     ClassificationResponse,
 )

mindee/input/__init__.py

@@ -1,4 +1,3 @@
-from mindee.client_options.polling_options import PollingOptions
 from mindee.input.base_64_input import Base64Input
 from mindee.input.bytes_input import BytesInput
 from mindee.input.file_input import FileInput
@@ -16,6 +15,5 @@
     "LocalResponse",
     "PageOptions",
     "PathInput",
-    "PollingOptions",
     "URLInputSource",
 ]

mindee/v2/__init__.py

@@ -1,9 +1,9 @@
 from mindee.v2.client import Client
 from mindee.v2.file_operations.crop import (
-    extract_crops,
+    extract_multiple_crops,
     extract_single_crop,
 )
-from mindee.v2.file_operations.split import extract_splits
+from mindee.v2.file_operations.split import extract_multiple_splits
 from mindee.v2.product.classification.classification_response import (
     ClassificationResponse,
 )
@@ -33,8 +33,8 @@
     "OCRResponse",
     "SplitParameters",
     "SplitResponse",
-    "extract_crops",
-    "extract_crops",
+    "extract_multiple_crops",
+    "extract_multiple_crops",
+    "extract_multiple_splits",
     "extract_single_crop",
-    "extract_splits",
 ]

mindee/v2/client.py

@@ -22,7 +22,7 @@
     is_valid_post_response,
 )
 from mindee.v2.parsing.inference.base_response import BaseResponse
-from mindee.v2.parsing.inference.job_response import JobResponse
+from mindee.v2.parsing.job.job_response import JobResponse
 from mindee.v2.product.extraction.extraction_response import ExtractionResponse
 
 TypeBaseResponse = TypeVar("TypeBaseResponse", bound=BaseResponse)

mindee/v2/file_operations/__init__.py

@@ -1,7 +1,12 @@
 from mindee.v2.file_operations.crop import (
-    extract_crops,
+    extract_multiple_crops,
     extract_single_crop,
 )
-from mindee.v2.file_operations.split import extract_splits
+from mindee.v2.file_operations.split import extract_multiple_splits
 
-__all__ = ["extract_crops", "extract_crops", "extract_single_crop", "extract_splits"]
+__all__ = [
+    "extract_multiple_crops",
+    "extract_multiple_crops",
+    "extract_multiple_splits",
+    "extract_single_crop",
+]

mindee/v2/file_operations/crop.py

@@ -5,7 +5,7 @@
 from mindee.input.local_input_source import LocalInputSource
 from mindee.v2.file_operations.crop_files import CropFiles
 from mindee.v2.parsing.inference.field import FieldLocation
-from mindee.v2.product.crop.crop_box import CropBox
+from mindee.v2.product.crop.crop_item import CropItem
 
 
 def extract_single_crop(
@@ -23,7 +23,9 @@ def extract_single_crop(
     return extract_multiple_images_from_source(input_source, crop.page, polygons)[0]
 
 
-def extract_crops(input_source: LocalInputSource, crops: list[CropBox]) -> CropFiles:
+def extract_multiple_crops(
+    input_source: LocalInputSource, crops: list[CropItem]
+) -> CropFiles:
     """
     Extracts individual receipts from multi-receipts documents.
 

mindee/v2/file_operations/split.py

@@ -15,10 +15,10 @@ def extract_single_split(
     :param split: List of pages to keep.
     :return: Extracted PDF
     """
-    return extract_splits(input_source, [split])[0]
+    return extract_multiple_splits(input_source, [split])[0]
 
 
-def extract_splits(
+def extract_multiple_splits(
     input_source: LocalInputSource,
     splits: list[list[int]],
 ) -> SplitFiles:

mindee/v2/parsing/__init__.py

@@ -1,11 +1,11 @@
+from mindee.v2.parsing.error.error_item import ErrorItem
+from mindee.v2.parsing.error.error_response import ErrorResponse
 from mindee.v2.parsing.inference.base_inference import BaseInference
 from mindee.v2.parsing.inference.base_response import BaseResponse
-from mindee.v2.parsing.inference.error_item import ErrorItem
-from mindee.v2.parsing.inference.error_response import ErrorResponse
 from mindee.v2.parsing.inference.inference_active_options import InferenceActiveOptions
 from mindee.v2.parsing.inference.inference_file import InferenceFile
 from mindee.v2.parsing.inference.inference_model import InferenceModel
-from mindee.v2.parsing.inference.job_response import JobResponse
+from mindee.v2.parsing.job.job_response import JobResponse
 from mindee.v2.product.extraction.extraction_inference import ExtractionInference
 from mindee.v2.product.extraction.extraction_response import ExtractionResponse
 from mindee.v2.product.extraction.extraction_result import ExtractionResult

mindee/v2/parsing/error/__init__.py

@@ -0,0 +1,4 @@
+from mindee.v2.parsing.error.error_item import ErrorItem
+from mindee.v2.parsing.error.error_response import ErrorResponse
+
+__all__ = ["ErrorItem", "ErrorResponse"]

mindee/v2/parsing/inference/error_response.py → mindee/v2/parsing/error/error_response.py

@@ -1,5 +1,5 @@
 from mindee.parsing.common import StringDict
-from mindee.v2.parsing.inference.error_item import ErrorItem
+from mindee.v2.parsing.error.error_item import ErrorItem
 
 
 class ErrorResponse:

mindee/v2/parsing/inference/field/base_field.py

@@ -1,19 +1,30 @@
+from enum import Enum
+
 from mindee.parsing.common import StringDict
-from mindee.v2.parsing.inference.field.dynamic_field import DynamicField, FieldType
 from mindee.v2.parsing.inference.field.field_confidence import FieldConfidence
 from mindee.v2.parsing.inference.field.field_location import FieldLocation
 
 
-class BaseField(DynamicField):
+class FieldType(str, Enum):
+    """Field types."""
+
+    OBJECT = "ObjectField"
+    LIST = "ListField"
+    SIMPLE = "SimpleField"
+
+
+class BaseField:
     """Field with base information."""
 
+    field_type: FieldType
+    _indent_level: int
     locations: list[FieldLocation]
     confidence: FieldConfidence | None
 
     def __init__(
         self, field_type: FieldType, raw_response: StringDict, indent_level: int = 0
     ) -> None:
-        super().__init__(field_type, indent_level)
+        self.field_type = field_type
         self._indent_level = indent_level
 
         self.confidence = None
@@ -29,3 +40,7 @@ def __init__(
             self.locations = []
             for location in raw_response["locations"]:
                 self.locations.append(FieldLocation(location))
+
+    def multi_str(self) -> str:
+        """String representation of the field in a list."""
+        return str(self)