regula-documentreader-webclient 8.1.355rc0__tar.gz → 8.1.357.dev0__tar.gz

{regula_documentreader_webclient-8.1.355rc0 → regula_documentreader_webclient-8.1.357.dev0}/PKG-INFO

@@ -1,22 +1,33 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: regula_documentreader_webclient
-Version: 8.1.355rc0
+Version: 8.1.357.dev0
 Summary: Regula's Document Reader python client
 Home-page: https://regulaforensics.com
 Author: Regula Forensics, Inc.
 Author-email: support@regulaforensics.com
 Keywords: document-reader-client,document reader,document recognition,regulaforensics,regula
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 Requires-Dist: certifi>=2024.07.04
 Requires-Dist: six>=1.10
-Requires-Dist: python-dateutil>=2.5.3
-Requires-Dist: urllib3>=1.26.19
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: urllib3<3.0.0,>=1.25.3
 Requires-Dist: vistir<=0.6.1,>=0.4.0
 Requires-Dist: idna==3.7
 Requires-Dist: requests>=2.32.3
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
-# Regula Document Reader web API Python 3.8+ client
+# Regula Document Reader web API Python 3.9+ client
 
 [![pypi](https://img.shields.io/pypi/v/regula.documentreader.webclient?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)
 [![OpenAPI](https://img.shields.io/badge/OpenAPI-defs-8c0a56?style=flat-square)](https://github.com/regulaforensics/DocumentReader-web-openapi)

{regula_documentreader_webclient-8.1.355rc0 → regula_documentreader_webclient-8.1.357.dev0}/README.md

@@ -1,4 +1,4 @@
-# Regula Document Reader web API Python 3.8+ client
+# Regula Document Reader web API Python 3.9+ client
 
 [![pypi](https://img.shields.io/pypi/v/regula.documentreader.webclient?style=flat-square)](https://support.regulaforensics.com/hc/en-us/articles/115000916306-Documentation)
 [![OpenAPI](https://img.shields.io/badge/OpenAPI-defs-8c0a56?style=flat-square)](https://github.com/regulaforensics/DocumentReader-web-openapi)

{regula_documentreader_webclient-8.1.355rc0 → regula_documentreader_webclient-8.1.357.dev0}/regula/documentreader/webclient/ext/__init__.py

@@ -6,7 +6,6 @@ from regula.documentreader.webclient.ext.models.authenticity.image_ident import
 from regula.documentreader.webclient.ext.models.authenticity.ocr_security_text import OCRSecurityTextChecks
 from regula.documentreader.webclient.ext.models.authenticity.security_feature import SecurityFeatureChecks
 from regula.documentreader.webclient.ext.models.images import Images, ImagesField
-from regula.documentreader.webclient.ext.models.raw_result_item import RawResultItem
 from regula.documentreader.webclient.ext.models.recognition_request import RecognitionRequest, RecognitionImage
 from regula.documentreader.webclient.ext.models.recognition_response import RecognitionResponse
 from regula.documentreader.webclient.ext.models.text import Text

{regula_documentreader_webclient-8.1.355rc0 → regula_documentreader_webclient-8.1.357.dev0}/regula/documentreader/webclient/ext/api/document_reader_api.py

@@ -25,8 +25,8 @@ class DocumentReaderApi(HealthcheckApi, ProcessApi):
     def __enter__(self):
         return self
 
-    def __exit__(self, exc_type, exc_val, exc_tb):
-        self.api_client.close()
+    def __exit__(self, exc_type, exc_value, traceback):
+        pass
 
     def set_configuration(self, configuration) -> None:
         self.api_client.configuration = configuration

{regula_documentreader_webclient-8.1.355rc0 → regula_documentreader_webclient-8.1.357.dev0}/regula/documentreader/webclient/ext/models/__init__.py

@@ -5,8 +5,6 @@ from regula.documentreader.webclient.ext.models.authenticity.image_ident import
 from regula.documentreader.webclient.ext.models.authenticity.ocr_security_text import OCRSecurityTextChecks
 from regula.documentreader.webclient.ext.models.authenticity.security_feature import SecurityFeatureChecks
 from regula.documentreader.webclient.ext.models.images import Images, ImagesField
-from regula.documentreader.webclient.ext.models.raw_authenticity_result_item import RawAuthenticityCheckResultItem
-from regula.documentreader.webclient.ext.models.raw_result_item import RawResultItem
 from regula.documentreader.webclient.ext.models.recognition_request import RecognitionImage
 from regula.documentreader.webclient.ext.models.recognition_request import RecognitionRequest
 from regula.documentreader.webclient.ext.models.recognition_response import RecognitionResponse

regula_documentreader_webclient-8.1.357.dev0/regula/documentreader/webclient/ext/models/authenticity/authenticity_check_list.py

@@ -0,0 +1,123 @@
+from typing import Optional
+
+from regula.documentreader.webclient.gen.models import AuthenticityCheckList as GenAuthenticityCheckList
+from regula.documentreader.webclient.gen.models import AuthenticityResultType, AuthenticityCheckResult
+from regula.documentreader.webclient.ext.models.authenticity.fiber import FiberChecks
+from regula.documentreader.webclient.ext.models.authenticity.ident import IdentChecks
+from regula.documentreader.webclient.ext.models.authenticity.image_ident import ImageIdentChecks
+from regula.documentreader.webclient.ext.models.authenticity.ocr_security_text import OCRSecurityTextChecks
+from regula.documentreader.webclient.ext.models.authenticity.security_feature import SecurityFeatureChecks
+
+
+class AuthenticityCheckList(GenAuthenticityCheckList):
+
+    @property
+    def uv_luminescence_checks(self) -> Optional[SecurityFeatureChecks]:
+        result = self.__result_by_type(AuthenticityResultType.UV_LUMINESCENCE)
+        if result:
+            return SecurityFeatureChecks.from_json(result.to_json())
+        return None
+
+    @property
+    def ir_b900_checks(self) -> Optional[SecurityFeatureChecks]:
+        result = self.__result_by_type(AuthenticityResultType.IR_B900)
+        if result:
+            return SecurityFeatureChecks.from_json(result.to_json())
+        return None
+
+    @property
+    def image_pattern_checks(self) -> Optional[IdentChecks]:
+        result = self.__result_by_type(AuthenticityResultType.IMAGE_PATTERN)
+        if result:
+            return IdentChecks.from_json(result.to_json())
+        return None
+
+    @property
+    def axial_protection_checks(self) -> Optional[SecurityFeatureChecks]:
+        result = self.__result_by_type(AuthenticityResultType.AXIAL_PROTECTION)
+        if result:
+            return SecurityFeatureChecks.from_json(result.to_json())
+        return None
+
+    @property
+    def uv_fiber_checks(self) -> Optional[FiberChecks]:
+        result = self.__result_by_type(AuthenticityResultType.UV_FIBERS)
+        if result:
+            return FiberChecks.from_json(result.to_json())
+        return None
+
+    @property
+    def ir_visibility_checks(self) -> Optional[IdentChecks]:
+        result = self.__result_by_type(AuthenticityResultType.IR_VISIBILITY)
+        if result:
+            return IdentChecks.from_json(result.to_json())
+        return None
+
+    @property
+    def ocr_security_text_checks(self) -> Optional[OCRSecurityTextChecks]:
+        result = self.__result_by_type(AuthenticityResultType.OCR_SECURITY_TEXT)
+        if result:
+            return OCRSecurityTextChecks.from_json(result.to_json())
+        return None
+
+    @property
+    def ipi_checks(self) -> Optional[ImageIdentChecks]:
+        result = self.__result_by_type(AuthenticityResultType.IPI)
+        if result:
+            return ImageIdentChecks.from_json(result.to_json())
+        return None
+
+    @property
+    def embed_image_checks(self) -> Optional[SecurityFeatureChecks]:
+        result = self.__result_by_type(AuthenticityResultType.PHOTO_EMBED_TYPE)
+        if result:
+            return SecurityFeatureChecks.from_json(result.to_json())
+        return None
+
+    @property
+    def holograms_checks(self) -> Optional[SecurityFeatureChecks]:
+        result = self.__result_by_type(AuthenticityResultType.HOLOGRAMS)
+        if result:
+            return SecurityFeatureChecks.from_json(result.to_json())
+        return None
+
+    @property
+    def photo_area_checks(self) -> Optional[SecurityFeatureChecks]:
+        result = self.__result_by_type(AuthenticityResultType.PHOTO_AREA)
+        if result:
+            return SecurityFeatureChecks.from_json(result.to_json())
+        return None
+
+    @property
+    def portrait_comparison_checks(self) -> Optional[IdentChecks]:
+        result = self.__result_by_type(AuthenticityResultType.PORTRAIT_COMPARISON)
+        if result:
+            return IdentChecks.from_json(result.to_json())
+        return None
+
+    @property
+    def barcode_format_checks(self) -> Optional[SecurityFeatureChecks]:
+        result = self.__result_by_type(AuthenticityResultType.BARCODE_FORMAT_CHECK)
+        if result:
+            return SecurityFeatureChecks.from_json(result.to_json())
+        return None
+
+    @property
+    def kinegram_checks(self) -> Optional[IdentChecks]:
+        result = self.__result_by_type(AuthenticityResultType.KINEGRAM)
+        if result:
+            return IdentChecks.from_json(result.to_json())
+        return None
+
+    @property
+    def letter_screen_checks(self) -> Optional[IdentChecks]:
+        result = self.__result_by_type(AuthenticityResultType.LETTER_SCREEN)
+        if result:
+            return IdentChecks.from_json(result.to_json())
+        return None
+
+    def __result_by_type(self, authenticity_type: int) -> Optional[AuthenticityCheckResult]:
+        for result in self.list:
+            if result.type == authenticity_type:
+                return result
+        return None

regula_documentreader_webclient-8.1.357.dev0/regula/documentreader/webclient/ext/models/authenticity/fiber.py

@@ -0,0 +1,11 @@
+from typing import List, cast
+
+from regula.documentreader.webclient.gen.models import FiberResult, AuthenticityCheckResult
+
+
+class FiberChecks(AuthenticityCheckResult):
+
+    @property
+    def checks_list(self) -> List[FiberResult]:
+        fiber_list: List[FiberResult] = cast(List[FiberResult], self.list)
+        return fiber_list

regula_documentreader_webclient-8.1.357.dev0/regula/documentreader/webclient/ext/models/authenticity/ident.py

@@ -0,0 +1,15 @@
+from typing import List, cast
+
+from regula.documentreader.webclient.gen.models import AuthenticityCheckResult, IdentResult
+
+
+class IdentChecks(AuthenticityCheckResult):
+
+    @property
+    def checks_list(self) -> List[IdentResult]:
+        ident_list: List[IdentResult] = cast(List[IdentResult], self.list)
+        return ident_list
+
+    # element_type is SecurityFeatureType
+    def checks_by_element(self, element_type: int) -> List[IdentResult]:
+        return [check for check in self.checks_list if check.element_type == element_type]

regula_documentreader_webclient-8.1.357.dev0/regula/documentreader/webclient/ext/models/authenticity/image_ident.py

@@ -0,0 +1,11 @@
+from typing import List, cast
+
+from regula.documentreader.webclient.gen.models import AuthenticityCheckResult, PhotoIdentResult
+
+
+class ImageIdentChecks(AuthenticityCheckResult):
+
+    @property
+    def checks_list(self) -> List[PhotoIdentResult]:
+        image_ident_list: List[PhotoIdentResult] = cast(List[PhotoIdentResult], self.list)
+        return image_ident_list

regula_documentreader_webclient-8.1.357.dev0/regula/documentreader/webclient/ext/models/authenticity/ocr_security_text.py

@@ -0,0 +1,11 @@
+from typing import List, cast
+
+from regula.documentreader.webclient.gen.models import AuthenticityCheckResult, OCRSecurityTextResult
+
+
+class OCRSecurityTextChecks(AuthenticityCheckResult):
+
+    @property
+    def checks_list(self) -> List[OCRSecurityTextResult]:
+        ocr_security_text_list: List[OCRSecurityTextResult] = cast(List[OCRSecurityTextResult], self.list)
+        return ocr_security_text_list

regula_documentreader_webclient-8.1.357.dev0/regula/documentreader/webclient/ext/models/authenticity/security_feature.py

@@ -0,0 +1,15 @@
+from typing import List, cast
+
+from regula.documentreader.webclient.gen.models import AuthenticityCheckResult, SecurityFeatureResult
+
+
+class SecurityFeatureChecks(AuthenticityCheckResult):
+
+    @property
+    def checks_list(self) -> List[SecurityFeatureResult]:
+        security_feature_list: List[SecurityFeatureResult] = cast(List[SecurityFeatureResult], self.list)
+        return security_feature_list
+
+    # element_type is SecurityFeatureType
+    def checks_by_element(self, element_type: int) -> List[SecurityFeatureResult]:
+        return [check for check in self.checks_list if check.element_type == element_type]

{regula_documentreader_webclient-8.1.355rc0 → regula_documentreader_webclient-8.1.357.dev0}/regula/documentreader/webclient/ext/models/images.py

@@ -1,10 +1,10 @@
 import base64
 from typing import Optional, List
 
-from regula.documentreader.webclient.gen.models import Images as GenImages, ImagesField as GetImagesField, Source
+from regula.documentreader.webclient.gen.models import Images as GenImages, ImagesField as GenImagesField, Source
 
 
-class ImagesField(GetImagesField):
+class ImagesField(GenImagesField):
 
     def get_value(self, source: str = None, original=False) -> Optional[bytes]:
 
@@ -33,8 +33,8 @@ class Images(GenImages):
     def get_field(self, field_type: int) -> Optional[ImagesField]:
         for field in self.field_list:
             if field.field_type == field_type:
-                return field
+                return ImagesField.from_json(field.to_json())
         return None
 
     def get_fields(self, field_type: int) -> List[ImagesField]:
-        return [field for field in self.field_list if field.field_type == field_type]
+        return [ImagesField.from_json(field.to_json()) for field in self.field_list if field.field_type == field_type]

{regula_documentreader_webclient-8.1.355rc0 → regula_documentreader_webclient-8.1.357.dev0}/regula/documentreader/webclient/ext/models/recognition_request.py

@@ -1,4 +1,3 @@
-import json
 import base64
 from typing import List, Union
 
@@ -15,7 +14,11 @@ class RecognitionImage(ProcessRequestImage):
     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)
+        super().__init__(
+            ImageData = ImageData(image = image),
+            light = light_index,
+            page_index = page_index,
+        )
 
 
 class LicenseRequest(LicenseResult):
@@ -29,12 +32,12 @@ class LicenseRequest(LicenseResult):
         _buf_length = len(_license)
         _result_type = Result.LICENSE
         super().__init__(
-            __license,
-            _buf_length,
-            _light,
-            _list_idx,
-            _page_idx,
-            _result_type
+            License = __license,
+            buf_length = _buf_length,
+            light = _light,
+            list_idx = _list_idx,
+            page_idx = _page_idx,
+            result_type = _result_type
         )
 
 
@@ -50,12 +53,12 @@ class EncryptedRCLRequest(EncryptedRCLResult):
         _buf_length = len(_encrypted_rcl)
         _result_type = Result.ENCRYPTED_RCL
         super().__init__(
-            __encrypted_rcl,
-            _buf_length,
-            _light,
-            _list_idx,
-            _page_idx,
-            _result_type
+            EncryptedRCL = __encrypted_rcl,
+            buf_length = _buf_length,
+            light = _light,
+            list_idx = _list_idx,
+            page_idx = _page_idx,
+            result_type = _result_type
         )
 
 
@@ -75,19 +78,15 @@ class RecognitionRequest(ProcessRequest):
                 else:
                     input_images.append(image)
             super().__init__(
-                process_param=process_params,
-                list=input_images,
-                system_info=system_info,
+                processParam=process_params,
+                List=input_images,
+                systemInfo=system_info,
                 tag=tag
             )
         if container_list:
             super().__init__(
-                process_param=process_params,
-                container_list=container_list,
-                system_info=system_info,
+                processParam=process_params,
+                ContainerList=container_list,
+                systemInfo=system_info,
                 tag=tag
             )
-
-    @property
-    def json(self) -> str:
-        return json.dumps(self.to_dict())

{regula_documentreader_webclient-8.1.355rc0 → regula_documentreader_webclient-8.1.357.dev0}/regula/documentreader/webclient/ext/models/recognition_response.py

@@ -1,5 +1,4 @@
 import base64
-import json
 import zlib
 from typing import Optional, List
 from regula.documentreader.webclient import ImageQualityCheckList, OneCandidate
@@ -21,13 +20,9 @@ class RecognitionResponse:
     def text(self) -> Optional[Text]:
         result = self.result_by_type(Result.TEXT)
         if result:
-            return result.text
+            return Text.from_json(result.text.to_json())
         return None
 
-    @property
-    def json(self) -> str:
-        return json.dumps(self.low_lvl_response.to_dict())
-
     @property
     def status(self) -> Optional[Status]:
         result = self.result_by_type(Result.STATUS)
@@ -39,13 +34,13 @@ class RecognitionResponse:
     def images(self) -> Optional[Images]:
         result = self.result_by_type(Result.IMAGES)
         if result:
-            return result.images
+            return Images.from_json(result.images.to_json())
         return None
 
     def authenticity(self, page_idx=0) -> Optional[AuthenticityCheckList]:
         result = self.pageable_result_by_type(Result.AUTHENTICITY, page_idx)
         if result:
-            return result.authenticity_check_list
+            return AuthenticityCheckList.from_json(result.authenticity_check_list.to_json())
         return None
 
     def image_quality_checks(self, page_idx=0) -> Optional[ImageQualityCheckList]:
@@ -85,3 +80,6 @@ class RecognitionResponse:
         if not isinstance(other, RecognitionResponse):
             return False
         return self.low_lvl_response == other.low_lvl_response
+
+    def to_json(self) -> str:
+        return self.low_lvl_response.to_json()

{regula_documentreader_webclient-8.1.355rc0 → regula_documentreader_webclient-8.1.357.dev0}/regula/documentreader/webclient/ext/models/text.py

@@ -1,4 +1,4 @@
-from typing import Optional, List
+from typing import Optional
 
 from regula.documentreader.webclient.ext.models.text_field import TextField
 from regula.documentreader.webclient.gen.models import LCID, Text as GenText
@@ -11,12 +11,12 @@ class Text(GenText):
         for field in self.field_list:
             if field.field_type == field_type:
                 if lcid is not None and field.lcid == lcid:
-                    return field
+                    return TextField.from_json(field.to_json())
                 elif lcid is None and field.lcid == LCID.LATIN:
-                    return field
+                    return TextField.from_json(field.to_json())
                 elif lcid is None and result is None:
                     result = field
-        return result
+        return TextField.from_json(result.to_json())
 
     def get_field_value(self, field_type: int, lcid: int = None) -> Optional[str]:
         field = self.get_field(field_type, lcid)
@@ -27,18 +27,13 @@ class Text(GenText):
         for field in self.field_list:
             if field.field_name == field_name:
                 if lcid is not None and field.lcid == lcid:
-                    return field
+                    return TextField.from_json(field.to_json())
                 elif lcid is None and field.lcid == LCID.LATIN:
-                    return field
+                    return TextField.from_json(field.to_json())
                 elif lcid is None and result is None:
                     result = field
-        return result
+        return TextField.from_json(result.to_json())
 
     def get_field_value_by_name(self, field_name: str, lcid: int = None) -> Optional[str]:
         field = self.get_field_by_name(field_name, lcid)
         return field.value if field else None
-
-    @GenText.field_list.getter
-    def field_list(self) -> List[TextField]:
-        # fix type hinting
-        return super().field_list