🚧 rework classes to use dynamic fields (#337)

Author: ianardee

docs/extras/code_samples/default_v2.txt

@@ -1,5 +1,4 @@
 from mindee import ClientV2, InferencePredictOptions
-from mindee.parsing.v2 import InferenceResponse
 
 input_path = "/path/to/the/file.ext"
 api_key = "MY_API_KEY"
@@ -20,9 +19,9 @@ options = InferencePredictOptions(
 input_doc = mindee_client.source_from_path(input_path)
 
 # Upload the file
-response: InferenceResponse = mindee_client.enqueue_and_parse(
+response = mindee_client.enqueue_and_parse(
     input_doc, options
 )
 
 # Print a brief summary of the parsed data
-print(response.inference)
+print(response.inference)

mindee/parsing/v2/__init__.py

@@ -1,16 +0,0 @@
-from mindee.parsing.v2.base_field import (
-    InferenceFields,
-    ListField,
-    ObjectField,
-    SimpleField,
-)
-from mindee.parsing.v2.common_response import CommonResponse
-from mindee.parsing.v2.error_response import ErrorResponse
-from mindee.parsing.v2.inference import Inference
-from mindee.parsing.v2.inference_file import InferenceFile
-from mindee.parsing.v2.inference_model import InferenceModel
-from mindee.parsing.v2.inference_options import InferenceOptions
-from mindee.parsing.v2.inference_response import InferenceResponse
-from mindee.parsing.v2.inference_result import InferenceResult
-from mindee.parsing.v2.job import Job
-from mindee.parsing.v2.job_response import JobResponse

mindee/parsing/v2/base_field.py

@@ -1,116 +1,10 @@
-from typing import Dict, List, Union
+from typing import List, Optional
 
-from mindee.error.mindee_error import MindeeApiV2Error
-from mindee.parsing.common.string_dict import StringDict
+from mindee.parsing.v2.dynamic_field import DynamicField
 
 
-class BaseField:
-    """Base field class for V2."""
+class BaseField(DynamicField):
+    """Field with base information."""
 
-    _indent_level: int
-    """Indentation level for rst display."""
-
-    def __init__(self, indent_level=0) -> None:
-        self._indent_level = indent_level
-
-    @staticmethod
-    def create_field(
-        raw_response: StringDict, indent_level: int = 0
-    ) -> Union["ListField", "ObjectField", "SimpleField"]:
-        """Factory function to create appropriate field instances."""
-        if isinstance(raw_response, dict):
-            if "items" in raw_response:
-                return ListField(raw_response, indent_level)
-            if "fields" in raw_response:
-                return ObjectField(raw_response, indent_level)
-            if "value" in raw_response:
-                return SimpleField(raw_response, indent_level)
-            raise MindeeApiV2Error(f"Unrecognized field format in {raw_response}.")
-        raise MindeeApiV2Error(f"Unrecognized field format {raw_response}.")
-
-
-class InferenceFields(Dict[str, Union["SimpleField", "ObjectField", "ListField"]]):
-    """Inference fields dict."""
-
-    def __init__(self, raw_response: StringDict, indent_level: int = 0) -> None:
-        super().__init__()
-        for key, value in raw_response.items():
-            field_obj = BaseField.create_field(value, indent_level)
-            self[key] = field_obj
-
-    def __getattr__(self, item):
-        try:
-            return self[item]
-        except KeyError:
-            raise AttributeError(item) from None
-
-    def __str__(self) -> str:
-        str_fields = ""
-        for field_key, field_value in self.items():
-            str_fields += f":{field_key}: {field_value}"
-        return str_fields
-
-
-class ListField(BaseField):
-    """List field containing multiple fields."""
-
-    items: List[Union["ListField", "ObjectField", "SimpleField"]]
-    """Items contained in the list."""
-
-    def __init__(self, raw_response: StringDict, indent_level: int = 0):
-        super().__init__(indent_level)
-
-        self.items = []
-        for item in raw_response["items"]:
-            if isinstance(item, dict):
-                self.items.append(BaseField.create_field(item, self._indent_level + 2))
-            else:
-                raise MindeeApiV2Error(f"Unrecognized field format '{item}'.")
-
-    def __str__(self) -> str:
-        out_str = ""
-        for item in self.items:
-            out_str += f"* {str(item)[2:] if item else ''}"
-        return "\n" + out_str if out_str else ""
-
-
-class ObjectField(BaseField):
-    """Object field containing multiple fields."""
-
-    fields: InferenceFields
-    """Fields contained in the object."""
-
-    def __init__(self, raw_response: StringDict, indent_level: int = 0):
-        super().__init__(indent_level)
-        inner_fields = raw_response.get("fields", raw_response)
-
-        self.fields = InferenceFields(inner_fields, self._indent_level + 1)
-
-    def __str__(self) -> str:
-        out_str = ""
-        for field_key, field_value in self.fields.items():
-            if isinstance(field_value, ListField):
-                value_str = ""
-                if len(field_value.items) > 0:
-                    value_str = (
-                        " " * self._indent_level + str(field_value)
-                        if field_value
-                        else ""
-                    )
-                out_str += f"{' ' * self._indent_level}:{field_key}: {value_str}"
-            else:
-                out_str += f"{' ' * self._indent_level}:{field_key}: {field_value if field_value else ''}"
-        return out_str
-
-
-class SimpleField(BaseField):
-    """Simple field containing a single value."""
-
-    value: Union[str, float, bool, None]
-
-    def __init__(self, raw_response: StringDict, indent_level: int = 0):
-        super().__init__(indent_level)
-        self.value = raw_response["value"] = raw_response.get("value", None)
-
-    def __str__(self) -> str:
-        return f"{self.value}\n" if self.value else "\n"
+    locations: List
+    confidence: Optional[str]

mindee/parsing/v2/dynamic_field.py

@@ -0,0 +1,49 @@
+from enum import Enum
+from importlib import import_module
+
+from mindee.error import MindeeApiV2Error
+from mindee.parsing.common.string_dict import StringDict
+
+
+class FieldType(str, Enum):
+    """Field types."""
+
+    OBJECT = "ObjectField"
+    LIST = "ListField"
+    SIMPLE = "SimpleField"
+
+
+class DynamicField:
+    """Field that can be displayed in rst format."""
+
+    _indent_level: int
+    """Indentation level for rst display."""
+    field_type: FieldType
+    """Field type."""
+
+    def __init__(self, field_type: FieldType, indent_level=0) -> None:
+        self.field_type = field_type
+        self._indent_level = indent_level
+
+    def multi_str(self) -> str:
+        """String representation of the field in a list."""
+        return str(self)
+
+
+def get_field_type(raw_response: StringDict, indent_level: int = 0) -> DynamicField:
+    """Get appropriate field types."""
+    if isinstance(raw_response, dict):
+        if "value" in raw_response:
+            field_file = import_module("mindee.parsing.v2.simple_field")
+            field_class = getattr(field_file, FieldType.SIMPLE.value)
+        elif "items" in raw_response:
+            field_file = import_module("mindee.parsing.v2.list_field")
+            field_class = getattr(field_file, FieldType.LIST.value)
+        elif "fields" in raw_response:
+            field_file = import_module("mindee.parsing.v2.object_field")
+            field_class = getattr(field_file, FieldType.OBJECT.value)
+        else:
+            raise MindeeApiV2Error(f"Unrecognized field format in {raw_response}.")
+        return field_class(raw_response, indent_level)
+
+    raise MindeeApiV2Error(f"Unrecognized field format {raw_response}.")

mindee/parsing/v2/inference.py

@@ -25,14 +25,14 @@ def __init__(self, raw_response: StringDict):
         self.id = raw_response["id"] if "id" in raw_response else None
 
     def __str__(self) -> str:
+        alias = f" {self.file.alias}" if self.file.alias else ""
         return (
-            f"Inference\n"
-            f"#########\n"
-            f":Model: {self.model.id}\n"
-            f":File:\n"
-            f"  :Name: {self.file.name}\n"
-            f"  :Alias: {self.file.alias}\n\n"
-            f"Result\n"
-            f"======\n"
-            f"{self.result}\n"
+            f"Inference\n#########"
+            f"\nModel\n====="
+            f"\n:ID: {self.model.id}"
+            f"\n\nFile\n===="
+            f"\n:Name: {self.file.name}"
+            f"\n:Alias:{alias}"
+            f"{self.result}"
+            "\n"
         )

mindee/parsing/v2/inference_response.py

@@ -12,3 +12,6 @@ class InferenceResponse(CommonResponse):
     def __init__(self, raw_response: StringDict) -> None:
         super().__init__(raw_response)
         self.inference = Inference(raw_response["inference"])
+
+    def __str__(self) -> str:
+        return str(self.inference)

mindee/parsing/v2/inference_result.py

@@ -1,28 +1,28 @@
 from typing import Optional
 
 from mindee.parsing.common.string_dict import StringDict
-from mindee.parsing.v2.base_field import InferenceFields
-from mindee.parsing.v2.inference_options import InferenceOptions
+from mindee.parsing.v2.inference_result_fields import InferenceResultFields
+from mindee.parsing.v2.inference_result_options import InferenceResultOptions
 
 
 class InferenceResult:
     """Inference result info."""
 
-    fields: InferenceFields
+    fields: InferenceResultFields
     """Fields contained in the inference."""
-    options: Optional[InferenceOptions]
+    options: Optional[InferenceResultOptions]
     """Potential options retrieved alongside the inference."""
 
     def __init__(self, raw_response: StringDict) -> None:
-        self.fields = InferenceFields(raw_response["fields"])
+        self.fields = InferenceResultFields(raw_response["fields"])
         self.options = (
-            InferenceOptions(raw_response["options"])
+            InferenceResultOptions(raw_response["options"])
             if raw_response.get("options")
             else None
         )
 
     def __str__(self) -> str:
-        out_str = f":fields: {self.fields}"
+        out_str = f"\n\nFields\n======{self.fields}"
         if self.options:
-            out_str += f"\n:options: {self.options}"
+            out_str += f"\n\nOptions\n====={self.options}"
         return out_str

mindee/parsing/v2/inference_result_fields.py

@@ -0,0 +1,29 @@
+from typing import Dict
+
+from mindee.parsing.common.string_dict import StringDict
+from mindee.parsing.v2.dynamic_field import DynamicField, FieldType, get_field_type
+
+
+class InferenceResultFields(Dict[str, DynamicField]):
+    """Inference fields dict."""
+
+    def __init__(self, raw_response: StringDict, indent_level: int = 0) -> None:
+        super().__init__()
+        for key, value in raw_response.items():
+            field_obj = get_field_type(value, indent_level)
+            self[key] = field_obj
+
+    def __getattr__(self, item):
+        try:
+            return self[item]
+        except KeyError:
+            raise AttributeError(item) from None
+
+    def __str__(self) -> str:
+        str_fields = ""
+        for field_key, field_value in self.items():
+            if field_value.field_type == FieldType.SIMPLE:
+                str_fields += f"\n:{field_key}: {field_value}"
+            else:
+                str_fields += f"\n:{field_key}:{field_value}"
+        return str_fields

mindee/parsing/v2/inference_options.py renamed to mindee/parsing/v2/inference_result_options.py

@@ -4,7 +4,7 @@
 from mindee.parsing.v2.raw_text import RawText
 
 
-class InferenceOptions:
+class InferenceResultOptions:
     """Optional information about the document."""
 
     raw_texts: List[RawText]

mindee/parsing/v2/list_field.py

@@ -0,0 +1,29 @@
+from typing import List
+
+from mindee.parsing.common.string_dict import StringDict
+from mindee.parsing.v2.dynamic_field import DynamicField, FieldType, get_field_type
+
+
+class ListField(DynamicField):
+    """List field containing multiple fields."""
+
+    items: List[DynamicField]
+    """Items contained in the list."""
+
+    def __init__(self, raw_response: StringDict, indent_level: int = 0):
+        super().__init__(FieldType.LIST, indent_level)
+
+        self.items = []
+        for item in raw_response["items"]:
+            self.items.append(get_field_type(item))
+
+    def __str__(self) -> str:
+        out_str = ""
+        indent = " " * self._indent_level
+        for item in self.items:
+            if item.field_type == FieldType.SIMPLE:
+                out_str += f"\n{indent}  * {item}"
+            elif item.field_type == FieldType.OBJECT:
+                out_str += f"\n{indent}  * {item.multi_str()}"
+
+        return out_str