✨ add list field typed accessors

Author: ianardee

mindee/parsing/v2/field/list_field.py

@@ -7,6 +7,8 @@
     FieldType,
     get_field_type,
 )
+from mindee.parsing.v2.field.object_field import ObjectField
+from mindee.parsing.v2.field.simple_field import SimpleField
 
 
 class ListField(BaseField):
@@ -22,6 +24,28 @@ def __init__(self, raw_response: StringDict, indent_level: int = 0):
         for item in raw_response["items"]:
             self.items.append(get_field_type(item))
 
+    @property
+    def simple_items(self) -> List[SimpleField]:
+        """List of items as ``SimpleField``."""
+        simple_items = []
+        for item in self.items:
+            if isinstance(item, SimpleField):
+                simple_items.append(item)
+            else:
+                raise ValueError("List item is not a simple field.")
+        return simple_items
+
+    @property
+    def object_items(self) -> List[ObjectField]:
+        """List of items as ``ObjectField``."""
+        object_items = []
+        for item in self.items:
+            if isinstance(item, ObjectField):
+                object_items.append(item)
+            else:
+                raise ValueError("List item is not an object field.")
+        return object_items
+
     def __str__(self) -> str:
         out_str = ""
         indent = " " * self._indent_level

tests/v2/test_inference_response.py

@@ -129,15 +129,35 @@ def test_standard_field_types():
     assert isinstance(
         inference_result.inference.result.fields["field_object"], ObjectField
     )
-    assert isinstance(
-        inference_result.inference.result.fields["field_simple_list"], ListField
-    )
-    assert isinstance(
-        inference_result.inference.result.fields["field_object_list"], ListField
-    )
     assert rst_sample == str(inference_result)
 
 
+@pytest.mark.v2
+def test_standard_field_object_list():
+    json_sample, _ = _get_inference_samples("standard_field_types")
+    inference_result = InferenceResponse(json_sample)
+    assert isinstance(inference_result.inference, Inference)
+
+    field_object_list = inference_result.inference.result.fields["field_object_list"]
+    assert isinstance(field_object_list, ListField)
+    assert len(field_object_list.items) == 2
+    for object_field in field_object_list.object_items:
+        assert isinstance(object_field, ObjectField)
+
+
+@pytest.mark.v2
+def test_standard_field_simple_list():
+    json_sample, _ = _get_inference_samples("standard_field_types")
+    inference_result = InferenceResponse(json_sample)
+    assert isinstance(inference_result.inference, Inference)
+
+    field_simple_list = inference_result.inference.result.fields["field_simple_list"]
+    assert isinstance(field_simple_list, ListField)
+    assert len(field_simple_list.simple_items) == 2
+    for object_field in field_simple_list.simple_items:
+        assert isinstance(object_field, SimpleField)
+
+
 @pytest.mark.v2
 def test_raw_texts():
     json_sample, rst_sample = _get_inference_samples("raw_texts")
@@ -159,18 +179,20 @@ def test_full_inference_response():
 
     assert isinstance(inference_result.inference, Inference)
     assert inference_result.inference.id == "12345678-1234-1234-1234-123456789abc"
-    assert isinstance(inference_result.inference.result.fields.date, SimpleField)
+    assert isinstance(inference_result.inference.result.fields["date"], SimpleField)
     assert inference_result.inference.result.fields["date"].value == "2019-11-02"
-    assert isinstance(inference_result.inference.result.fields.taxes, ListField)
+    assert isinstance(inference_result.inference.result.fields["taxes"], ListField)
     assert isinstance(
         inference_result.inference.result.fields["taxes"].items[0], ObjectField
     )
     assert (
-        inference_result.inference.result.fields["customer_address"].fields.city.value
+        inference_result.inference.result.fields["customer_address"]
+        .fields["city"]
+        .value
         == "New York"
     )
     assert (
-        inference_result.inference.result.fields.taxes.items[0].fields["base"].value
+        inference_result.inference.result.fields["taxes"].items[0].fields["base"].value
         == 31.5
     )