Redo add text module

Author: hleb-albau

example/example.py

@@ -1,41 +1,38 @@
 import os
 
 from regula.documentreader.webclient.ext.api import DocumentReaderApi
-from regula.documentreader.webclient.ext.models import RecognitionImage, RecognitionRequest
-from regula.documentreader.webclient.gen import ProcessParams, Scenario, Result, Light, TextFieldType, Source, \
+from regula.documentreader.webclient.ext.models import RecognitionRequest
+from regula.documentreader.webclient.gen import ProcessParams, Scenario, Result, TextFieldType, Source, \
     CheckResult
 
 host = os.getenv("API_BASE_PATH", "http://localhost:8080")
-license = os.getenv("TEST_LICENSE", None)
+license = os.getenv("TEST_LICENSE", None)  # optional, used here only for smoke test purposes
 
 with open("australia_passport.jpg", "rb") as f:
-    image_payload = f.read()
+    input_image = f.read()
 
 with DocumentReaderApi(host) as api:
-    api.license = license
-
-    process_params = ProcessParams(Scenario.FULL_PROCESS, [Result.STATUS, Result.TEXT, Result.IMAGES, 6])
-    process_images = [RecognitionImage(image_payload, Light.WHITE)]
-    request = RecognitionRequest(process_params, process_images)
+    api.license = license  # used here only for smoke test purposes, most of clients will attach license on server side
 
+    params = ProcessParams(
+        scenario=Scenario.FULL_PROCESS,
+        result_type_output=[Result.STATUS, Result.TEXT, Result.IMAGES]
+    )
+    request = RecognitionRequest(process_params=params, images=[input_image])
     response = api.process(request)
-    response.result_by_type(Result.IMAGES)
-
-    response_text = response.text
-
-    doc_number_field = response_text.get_field(TextFieldType.DOCUMENT_NUMBER)
-
-    doc_number_visual = doc_number_field.get_value(Source.VISUAL)
-    doc_number_mrz = doc_number_field.get_value(Source.MRZ)
-
-    doc_number_visual_validity = doc_number_field.get_validity(Source.VISUAL)
-    doc_number_mrz_validity = doc_number_field.get_validity(Source.MRZ)
-
-    doc_number_mrz_visual_matching = doc_number_field.get_comparison(Source.MRZ, Source.VISUAL)
 
+    # status examples
     response_status = response.status
     doc_overall_status = "valid" if response_status.overall_status == CheckResult.OK else "not valid"
 
+    # text fields example
+    doc_number_field = response.text.get_field(TextFieldType.DOCUMENT_NUMBER)
+    doc_number_visual = doc_number_field.get_value()
+    doc_number_mrz = doc_number_field.get_value(Source.MRZ)
+    doc_number_visual_validity = doc_number_field.source_validity(Source.VISUAL)
+    doc_number_mrz_validity = doc_number_field.source_validity(Source.MRZ)
+    doc_number_mrz_visual_matching = doc_number_field.cross_source_comparison(Source.MRZ, Source.VISUAL)
+
     response_images = response.images
 
     print("""

regula/documentreader/webclient/ext/models/recognition_request.py

@@ -1,17 +1,27 @@
 import base64
+from typing import List, Union
 
-from regula.documentreader.webclient.gen.models.image_data import ImageData
+from regula.documentreader.webclient.gen.models import ImageData, ProcessParams
 from regula.documentreader.webclient.gen.models.process_request import ProcessRequest
 from regula.documentreader.webclient.gen.models.process_request_image import ProcessRequestImage
 from regula.documentreader.webclient.gen.models.process_system_info import ProcessSystemInfo
 
-
-class RecognitionRequest(ProcessRequest):
-    def __init__(self, process_params, images):
-        super().__init__(process_params, images, ProcessSystemInfo())
+Base64String = str
 
 
 class RecognitionImage(ProcessRequestImage):
-    def __init__(self, image: bytes, light_index=None, page_index=0):
-        image_base64 = base64.b64encode(image).decode("utf-8")
-        super().__init__(ImageData(image_base64), light_index, page_index)
+    def __init__(self, image: Union[bytes, Base64String], light_index=None, page_index=None):
+        if isinstance(image, bytes):
+            image = base64.b64encode(image).decode("utf-8")
+        super().__init__(ImageData(image), light_index, page_index)
+
+
+class RecognitionRequest(ProcessRequest):
+    def __init__(self, process_params: ProcessParams, images: List[Union[RecognitionImage, bytes, Base64String]]):
+        input_images = []
+        for image in images:
+            if isinstance(image, (bytes, str)):
+                input_images.append(RecognitionImage(image))
+            else:
+                input_images.append(image)
+        super().__init__(process_params, input_images, ProcessSystemInfo())

regula/documentreader/webclient/ext/models/text.py

@@ -6,25 +6,13 @@
 
 class Text(GenText):
 
-    def get_field(self, field_type: int, lcid=0) -> Optional[TextField]:
+    def get_field(self, field_type: int, lcid: int = None) -> Optional[TextField]:
         for field in self.field_list:
-            if field.field_type == field_type and field.lcid == lcid:
+            if field.field_type == field_type and (not lcid or field.lcid == lcid):
                 return field
         return None
 
-    def get_field_value(self, field_type: int, lcid=0) -> Optional[str]:
-        field = self.get_field(field_type, lcid)
-        if field:
-            return "todo"
-        return None
-
-    @property
+    @GenText.field_list.getter
     def field_list(self) -> List[TextField]:
         # fix type hinting
         return super().field_list
-
-    @field_list.setter
-    def field_list(self, field_list: List[TextField]):
-        if self.local_vars_configuration.client_side_validation and field_list is None:
-            raise ValueError("Invalid value for `field_list`, must not be `None`")
-        self._field_list = field_list

regula/documentreader/webclient/ext/models/text_field.py

@@ -6,7 +6,9 @@
 
 class TextField(GenTextField):
 
-    def get_value(self, source: str, original=False) -> Optional[str]:
+    def get_value(self, source: str = None, original=False) -> Optional[str]:
+        if not source:
+            return self.value
         for i in self.value_list:
             if i.source == source:
                 if original:
@@ -15,13 +17,13 @@ def get_value(self, source: str, original=False) -> Optional[str]:
                     return i.value
         return None
 
-    def get_validity(self, source) -> CheckResult:
+    def source_validity(self, source: str) -> CheckResult:
         for i in self.validity_list:
             if i.source == source:
                 return i.status
         return CheckResult.WAS_NOT_DONE
 
-    def get_comparison(self, one, other) -> CheckResult:
+    def cross_source_comparison(self, one: str, other: str) -> CheckResult:
         for i in self.comparison_list:
             a = i.source_left == one and i.source_right == other
             b = i.source_right == one and i.source_left == other