Fix examples

Author: ArtsiomTsybulko

Pipfile

@@ -7,7 +7,7 @@ name = "pypi"
 certifi = ">=2024.07.04"
 six = ">=1.10"
 python-dateutil = ">=2.8.2"
-urllib3 = ">= 1.25.3, < 3.0.0"
+urllib3 = ">=1.25.3, <3.0.0"
 vistir = ">=0.4.0, <=0.6.1"
 idna = "==3.7"
 requests = ">=2.32.3"

Pipfile.lock

@@ -22,8 +22,8 @@
     api.license = regula_license
 
     params = ProcessParams(
-        scenario=Scenario.FULL_PROCESS,
-        result_type_output=[
+        scenario=Scenario.FULLPROCESS,
+        resultTypeOutput=[
             # actual results
             Result.STATUS, Result.AUTHENTICITY, Result.TEXT, Result.IMAGES,
             Result.DOCUMENT_TYPE, Result.DOCUMENT_TYPE_CANDIDATES, Result.IMAGE_QUALITY,
@@ -36,10 +36,7 @@
     )
     request = RecognitionRequest(
         process_params=params,
-        container_list=ContainerList([
-            LicenseRequest(license_),
-            EncryptedRCLRequest(encrypted_rcl)
-        ])
+        container_list=ContainerList(List = [LicenseRequest(license_), EncryptedRCLRequest(encrypted_rcl)])
     )
     response = api.process(request)
 

example/example-rcl.py

@@ -38,8 +38,8 @@
     ])
     response = api.process(request)
 
-    request_json = request.json   # example for request & response raw json
-    response_json = response.json
+    request_json = request.to_json()   # example for request & response raw json
+    response_json = response.to_json()
 
     # status examples
     response_status = response.status

example/example.py

@@ -1,78 +1,93 @@
 from typing import Optional
 
-from regula.documentreader.webclient import gen, AuthenticityResultType
+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(gen.AuthenticityCheckList):
+class AuthenticityCheckList(GenAuthenticityCheckList):
 
     @property
     def uv_luminescence_checks(self) -> Optional[SecurityFeatureChecks]:
-        return self.__result_by_type(AuthenticityResultType.UV_LUMINESCENCE, SecurityFeatureChecks)
+        result = self.__result_by_type(AuthenticityResultType.UV_LUMINESCENCE)
+        return SecurityFeatureChecks.from_dict(result.to_dict())
 
     @property
     def ir_b900_checks(self) -> Optional[SecurityFeatureChecks]:
-        return self.__result_by_type(AuthenticityResultType.IR_B900, SecurityFeatureChecks)
+        result = self.__result_by_type(AuthenticityResultType.IR_B900)
+        return SecurityFeatureChecks.from_dict(result.to_dict())
 
     @property
     def image_pattern_checks(self) -> Optional[IdentChecks]:
-        return self.__result_by_type(AuthenticityResultType.IMAGE_PATTERN, IdentChecks)
+        result = self.__result_by_type(AuthenticityResultType.IMAGE_PATTERN)
+        return IdentChecks.from_dict(result.to_dict())
 
     @property
     def axial_protection_checks(self) -> Optional[SecurityFeatureChecks]:
-        return self.__result_by_type(AuthenticityResultType.AXIAL_PROTECTION, SecurityFeatureChecks)
+        result = self.__result_by_type(AuthenticityResultType.AXIAL_PROTECTION)
+        return SecurityFeatureChecks.from_dict(result.to_dict())
 
     @property
     def uv_fiber_checks(self) -> Optional[FiberChecks]:
-        return self.__result_by_type(AuthenticityResultType.UV_FIBERS, FiberChecks)
+        result = self.__result_by_type(AuthenticityResultType.UV_FIBERS)
+        return FiberChecks.from_dict(result.to_dict())
 
     @property
     def ir_visibility_checks(self) -> Optional[IdentChecks]:
-        return self.__result_by_type(AuthenticityResultType.IR_VISIBILITY, IdentChecks)
+        result = self.__result_by_type(AuthenticityResultType.IR_VISIBILITY)
+        return IdentChecks.from_dict(result.to_dict())
 
     @property
     def ocr_security_text_checks(self) -> Optional[OCRSecurityTextChecks]:
-        return self.__result_by_type(AuthenticityResultType.OCR_SECURITY_TEXT, OCRSecurityTextChecks)
+        result = self.__result_by_type(AuthenticityResultType.OCR_SECURITY_TEXT)
+        return OCRSecurityTextChecks.from_dict(result.to_dict())
 
     @property
     def ipi_checks(self) -> Optional[ImageIdentChecks]:
-        return self.__result_by_type(AuthenticityResultType.IPI, ImageIdentChecks)
+        result = self.__result_by_type(AuthenticityResultType.IPI)
+        return ImageIdentChecks.from_dict(result.to_dict())
 
     @property
     def embed_image_checks(self) -> Optional[SecurityFeatureChecks]:
-        return self.__result_by_type(AuthenticityResultType.PHOTO_EMBED_TYPE, SecurityFeatureChecks)
+        result = self.__result_by_type(AuthenticityResultType.PHOTO_EMBED_TYPE)
+        return SecurityFeatureChecks.from_dict(result.to_dict())
 
     @property
     def holograms_checks(self) -> Optional[SecurityFeatureChecks]:
-        return self.__result_by_type(AuthenticityResultType.HOLOGRAMS, SecurityFeatureChecks)
+        result = self.__result_by_type(AuthenticityResultType.HOLOGRAMS)
+        return SecurityFeatureChecks.from_dict(result.to_dict())
 
     @property
     def photo_area_checks(self) -> Optional[SecurityFeatureChecks]:
-        return self.__result_by_type(AuthenticityResultType.PHOTO_AREA, SecurityFeatureChecks)
+        result = self.__result_by_type(AuthenticityResultType.PHOTO_AREA)
+        return SecurityFeatureChecks.from_dict(result.to_dict())
 
     @property
     def portrait_comparison_checks(self) -> Optional[IdentChecks]:
-        return self.__result_by_type(AuthenticityResultType.PORTRAIT_COMPARISON, IdentChecks)
+        result = self.__result_by_type(AuthenticityResultType.PORTRAIT_COMPARISON)
+        return IdentChecks.from_dict(result.to_dict())
 
     @property
     def barcode_format_checks(self) -> Optional[SecurityFeatureChecks]:
-        return self.__result_by_type(AuthenticityResultType.BARCODE_FORMAT_CHECK, SecurityFeatureChecks)
+        result = self.__result_by_type(AuthenticityResultType.BARCODE_FORMAT_CHECK)
+        return SecurityFeatureChecks.from_dict(result.to_dict())
 
     @property
     def kinegram_checks(self) -> Optional[IdentChecks]:
-        return self.__result_by_type(AuthenticityResultType.KINEGRAM, IdentChecks)
+        result = self.__result_by_type(AuthenticityResultType.KINEGRAM)
+        return IdentChecks.from_dict(result.to_dict())
 
     @property
     def letter_screen_checks(self) -> Optional[IdentChecks]:
-        return self.__result_by_type(AuthenticityResultType.LETTER_SCREEN, IdentChecks)
+        result = self.__result_by_type(AuthenticityResultType.LETTER_SCREEN)
+        return IdentChecks.from_dict(result.to_dict())
 
-    def __result_by_type(self, authenticity_type: int, parent_class: type) -> Optional[gen.AuthenticityCheckResult]:
+    def __result_by_type(self, authenticity_type: int) -> Optional[AuthenticityCheckResult]:
         for result in self.list:
             if result.type == authenticity_type:
-                result.__class__ = parent_class
                 return result
         return None

regula/documentreader/webclient/ext/models/authenticity/authenticity_check_list.py

@@ -1,11 +1,11 @@
 from typing import List
 
-from regula.documentreader.webclient import gen
+from regula.documentreader.webclient.gen.models import FiberResult, AuthenticityCheckResult
 
 
-class FiberChecks(gen.AuthenticityCheckResult):
+class FiberChecks(AuthenticityCheckResult):
 
     @property
-    def list(self) -> List[gen.FiberResult]:
+    def list(self) -> List[FiberResult]:
         # noinspection PyTypeChecker
         return super().list

regula/documentreader/webclient/ext/models/authenticity/fiber.py

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

regula/documentreader/webclient/ext/models/authenticity/ident.py

@@ -1,10 +1,11 @@
 from typing import List
 
-from regula.documentreader.webclient import gen
+from regula.documentreader.webclient.gen.models import AuthenticityCheckResult, PhotoIdentResult
 
 
-class ImageIdentChecks(gen.AuthenticityCheckResult):
+class ImageIdentChecks(AuthenticityCheckResult):
+
     @property
-    def list(self) -> List[gen.PhotoIdentResult]:
+    def list(self) -> List[PhotoIdentResult]:
         # noinspection PyTypeChecker
-        return super().list
+        return self.list

regula/documentreader/webclient/ext/models/authenticity/image_ident.py

@@ -1,11 +1,11 @@
 from typing import List
 
-from regula.documentreader.webclient import gen
+from regula.documentreader.webclient.gen.models import AuthenticityCheckResult, OCRSecurityTextResult
 
 
-class OCRSecurityTextChecks(gen.AuthenticityCheckResult):
+class OCRSecurityTextChecks(AuthenticityCheckResult):
 
     @property
-    def list(self) -> List[gen.OCRSecurityTextResult]:
+    def list(self) -> List[OCRSecurityTextResult]:
         # noinspection PyTypeChecker
-        return super().list
+        return self.list

regula/documentreader/webclient/ext/models/authenticity/ocr_security_text.py

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