add tests & fix miscellaneous naming issues

Author: sebastianMindee

docs/extras/code_samples/default_v2.txt

@@ -0,0 +1,25 @@
+#
+# Install the Python client library by running:
+# pip install mindee
+#
+
+from mindee import ClientV2, InferencePredictOptions
+from mindee.parsing.v2 import InferenceResponse, PollingResponse
+from tests.product import PRODUCT_DATA_DIR
+
+input_path = "/path/to/the/file.ext"
+api_key = "MY_API_KEY"
+model_id = "MY_MODEL_ID"
+
+# Init a new client
+mindee_client = ClientV2(api_key)
+
+# Load a file from disk
+input_doc = mindee_client.source_from_path(input_path)
+options = InferencePredictOptions(model_id=model_id)
+
+# Parse the file.
+response: InferenceResponse = mindee_client.enqueue_and_parse(input_doc, options)
+
+# Print a brief summary of the parsed data
+print(response.inference)

mindee/client_v2.py

@@ -93,7 +93,7 @@ def parse_queued(
         """
         logger.debug("Fetching from queue '%s'.", queue_id)
 
-        response = self.mindee_api.document_queue_req_get(queue_id)
+        response = self.mindee_api.get_inference_from_queue(queue_id)
         if not is_valid_get_response(response):
             handle_error_v2(response.json())
 

mindee/mindee_http/mindee_api_v2.py

@@ -104,7 +104,7 @@ def predict_async_req_post(
 
         return response
 
-    def document_queue_req_get(self, queue_id: str) -> requests.Response:
+    def get_inference_from_queue(self, queue_id: str) -> requests.Response:
         """
         Sends a request matching a given queue_id. Returns either a Job or a Document.
 

mindee/parsing/v2/base_field.py

@@ -41,10 +41,16 @@ def __init__(self, raw_response: StringDict, indent_level: int = 0):
         self.items = []
         for item in raw_response["items"]:
             if isinstance(item, dict):
-                self.items.append(BaseField.create_field(item, 1))
+                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."""
@@ -59,14 +65,26 @@ def __init__(self, raw_response: StringDict, indent_level: int = 0):
         self.fields: Dict[str, Union["ListField", "ObjectField", "SimpleField"]] = {}
         for field_key, field_value in inner_fields.items():
             if isinstance(field_value, dict):
-                self.fields[field_key] = BaseField.create_field(field_value, 1)
+                self.fields[field_key] = BaseField.create_field(
+                    field_value, self._indent_level + 1
+                )
             else:
                 raise MindeeApiV2Error(f"Unrecognized field format '{field_value}'.")
 
     def __str__(self) -> str:
         out_str = ""
         for field_key, field_value in self.fields.items():
-            out_str += f"{' ' * self._indent_level}:{field_key}: {field_value}\n"
+            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
 
 
@@ -80,4 +98,4 @@ def __init__(self, raw_response: StringDict, indent_level: int = 0):
         self.value = raw_response["value"] = raw_response.get("value", None)
 
     def __str__(self) -> str:
-        return f"{' ' * self._indent_level}{self.value}\n"
+        return f"{self.value}\n" if self.value else "\n"

mindee/parsing/v2/inference.py

@@ -30,9 +30,9 @@ def __str__(self) -> str:
             f"#########\n"
             f":Model: {self.model.id}\n"
             f":File: {self.file}\n"
-            f"  :Name: {self.file.name}\n\n"
+            f"  :Name: {self.file.name}\n"
             f"  :Alias: {self.file.alias}\n\n"
             f"Result\n"
             f"======\n"
-            f"\n{self.result}\n"
+            f"{self.result}\n"
         )

mindee/parsing/v2/inference_fields.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
-from typing import Union, Dict
+
+from typing import Dict, Union
 
 from mindee.parsing.common.string_dict import StringDict
 from mindee.parsing.v2.base_field import BaseField, ListField, ObjectField, SimpleField
@@ -19,3 +20,9 @@ def __getattr__(self, item):
             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

mindee/parsing/v2/inference_result.py

@@ -22,7 +22,7 @@ def __init__(self, raw_response: StringDict) -> None:
         )
 
     def __str__(self) -> str:
-        str_fields = ""
-        for field_key, field_value in self.fields.items():
-            str_fields += f"  :{field_key}: {field_value}\n"
-        return f":fields: {str_fields}\n" f"options: {self.options}\n"
+        out_str = f":fields: {self.fields}"
+        if self.options:
+            out_str += f"\n:options: {self.options}"
+        return out_str

tests/test_code_samples.sh

@@ -5,9 +5,19 @@ OUTPUT_FILE='./_test.py'
 ACCOUNT=$1
 ENDPOINT=$2
 API_KEY=$3
+API_KEY_V2=$4
+MODEL_ID=$5
 
 for f in $(find ./docs/extras/code_samples -maxdepth 1 -name "*.txt" -not -name "workflow_*.txt" | sort -h)
 do
+  if echo "${f}" | grep -q "default_v2.txt"; then
+    if [ -z "${API_KEY_V2}" ] || [ -z "${MODEL_ID}" ]; then
+      echo "Skipping ${f} (API_KEY_V2 or MODEL_ID not supplied)"
+      echo
+      continue
+    fi
+  fi
+
   echo
   echo "###############################################"
   echo "${f}"
@@ -17,6 +27,15 @@ do
   sed "s/my-api-key/${API_KEY}/" "${f}" > $OUTPUT_FILE
   sed -i 's/\/path\/to\/the\/file.ext/.\/tests\/data\/file_types\/pdf\/blank_1.pdf/' $OUTPUT_FILE
 
+
+  if echo "${f}" | grep -q "default_v2.txt"
+  then
+    sed -i "s/MY_API_KEY/$API_KEY_V2/" $OUTPUT_FILE
+    sed -i "s/MY_MODEL_ID/$MODEL_ID/" $OUTPUT_FILE
+  else
+    sed -i "s/my-api-key/$API_KEY/" $OUTPUT_FILE
+  fi
+
   if echo "$f" | grep -q "custom_v1.txt"
   then
     sed -i "s/my-account/$ACCOUNT/g" $OUTPUT_FILE