Added options in Global Compreface

Author: Artsiom Khadzkou

.gitignore

@@ -92,5 +92,9 @@ Thumbs.db
 .history
 .ionide
 
-
+# Vscode
 .vscode
+
+#Idea
+.idea
+.idea/*

.idea/.gitignore

@@ -17,9 +17,6 @@
 from compreface.common.multipart_constructor import multipart_constructor_with_two_images
 import requests
 from compreface.config.api_list import VERIFICATION_API
-import os
-
-from requests_toolbelt.multipart.encoder import MultipartEncoder
 from compreface.common.typed_dict import ExpandedOptionsDict, check_fields_by_name
 from compreface.common.client import ClientRequest
 
@@ -42,8 +39,8 @@ def get(self):
     """
         POST request for verify face in image using source and target images. 
         
-        :param source_image_path: Path to source image in file system.
-        :param target_image_path: Path to target image in file system.
+        :param source_image: Path to source image in file system.
+        :param target_image: Path to target image in file system.
         :param image_id: subject id from previously added image. 
         :param options: dictionary with options for server.
         

.idea/compreface-python-sdk.iml

@@ -14,7 +14,7 @@
     permissions and limitations under the License.
  """
 
-from compreface.common.typed_dict import ExpandedOptionsDict, DetProbOptionsDict
+from compreface.common.typed_dict import AllOptionsDict, ExpandedOptionsDict, DetProbOptionsDict, pass_dict
 from ..use_cases import (
     AddExampleOfSubject,
     ListOfAllSavedSubjects,
@@ -25,10 +25,11 @@
 
 
 class FaceCollection:
-    def __init__(self, api_key: str, domain: str, port: str):
+    def __init__(self, api_key: str, domain: str, port: str, options: AllOptionsDict = {}):
         """Init service with define API Key"""
         self.available_services = []
         self.api_key = api_key
+        self.options = options
         self.add_example: AddExampleOfSubject = AddExampleOfSubject(
             domain=domain,
             port=port,
@@ -67,7 +68,7 @@ def add(self, image_path: str, subject: str, options: DetProbOptionsDict = {}) -
             image_path=image_path,
             subject=subject
         )
-        return self.add_example.execute(request, options)
+        return self.add_example.execute(request, pass_dict(options, DetProbOptionsDict) if options == {} else options)
 
     def list(self) -> dict:
         """
@@ -112,4 +113,4 @@ def verify(self, image_path: str, image_id: str, options: ExpandedOptionsDict =
             image_path=image_path,
             image_id=image_id
         )
-        return self.verify_face_from_image.execute(request, options)
+        return self.verify_face_from_image.execute(request, pass_dict(options, ExpandedOptionsDict) if options == {} else options)

.idea/inspectionProfiles/Project_Default.xml

@@ -15,19 +15,25 @@
  """
 
 from abc import ABC, abstractmethod
+from compreface.common.typed_dict import AllOptionsDict
 
 
 class Service(ABC):
     """The best class of all services"""
 
     @abstractmethod
-    def __init__(self, api_key: str):
+    def __init__(self, api_key: str, options: AllOptionsDict):
         self._api_key = api_key
+        self._options = options
 
     @property
     def api_key(self):
         return self._api_key
 
+    @property
+    def options(self):
+        return self._options
+
     @abstractmethod
     def get_available_functions(self):
         pass

.idea/inspectionProfiles/profiles_settings.xml

@@ -58,3 +58,12 @@ def check_fields_by_name(name: str, value: Any):
             if row.find('age') == -1 and row.find('calculator') == -1 and row.find('gender') == -1 and row.find('landmarks') == -1:
                 raise IncorrectFieldException(
                     "face_plugins must be only contains calculator,age,gender,landmarks. Incorrect value {}".format(row))
+
+
+def pass_dict(options: AllOptionsDict, type: DetProbOptionsDict or ExpandedOptionsDict):
+    converted_options: ExpandedOptionsDict or DetProbOptionsDict = {}
+    for key in type.__annotations__.keys():
+        value = options.get(key)
+        if value != None:
+            converted_options[key] = value
+    return converted_options

.idea/misc.xml

@@ -14,6 +14,7 @@
     permissions and limitations under the License.
  """
 
+from compreface.common.typed_dict import AllOptionsDict
 from typing import Optional
 from ..service import (
     RecognitionService,
@@ -27,9 +28,10 @@ class CompreFace(object):
     Main class
     """
 
-    def __init__(self, domain: str, port: str):
+    def __init__(self, domain: str, port: str, options: AllOptionsDict = {}):
         self._domain: str = domain
         self._port: str = port
+        self._options: AllOptionsDict = options
         self.recognition: Optional[RecognitionService] = None
         self.verification: Optional[VerificationService] = None
         self.detection: Optional[DetectionService] = None
@@ -50,6 +52,14 @@ def port(self):
     def port(self, port: str):
         self._port = port
 
+    @property
+    def options(self):
+        return self._options
+
+    @options.setter
+    def options(self, options: AllOptionsDict):
+        self._options = options
+
     def init_face_recognition(self, api_key: str) -> RecognitionService:
         """
         Init Face Recognition Service
@@ -58,7 +68,8 @@ def init_face_recognition(self, api_key: str) -> RecognitionService:
         """
         self.recognition = RecognitionService(api_key=api_key,
                                               domain=self.domain,
-                                              port=self.port)
+                                              port=self.port,
+                                              options=self.options)
         return self.recognition
 
     def init_face_verification(self, api_key: str) -> VerificationService:
@@ -69,7 +80,8 @@ def init_face_verification(self, api_key: str) -> VerificationService:
         """
         self.verification = VerificationService(api_key=api_key,
                                                 domain=self.domain,
-                                                port=self.port)
+                                                port=self.port,
+                                                options=self.options)
         return self.verification
 
     def init_face_detection(self, api_key: str) -> DetectionService:
@@ -78,6 +90,8 @@ def init_face_detection(self, api_key: str) -> DetectionService:
         :param api_key:
         :return:
         """
-        self.detection = DetectionService(api_key=api_key, domain=self.domain,
-                                          port=self.port)
+        self.detection = DetectionService(api_key=api_key,
+                                          domain=self.domain,
+                                          port=self.port,
+                                          options=self.options)
         return self.detection

.idea/modules.xml

@@ -14,7 +14,7 @@
     permissions and limitations under the License.
  """
 
-from compreface.common.typed_dict import ExpandedOptionsDict
+from compreface.common.typed_dict import AllOptionsDict, ExpandedOptionsDict, pass_dict
 from compreface.use_cases.detect_face_from_image import DetectFaceFromImage
 from typing import List
 
@@ -24,9 +24,9 @@
 class DetectionService(Service):
     """Detection service"""
 
-    def __init__(self, api_key: str, domain: str, port: str):
+    def __init__(self, api_key: str, domain: str, port: str, options: AllOptionsDict = {}):
         """Init service with define API Key"""
-        super().__init__(api_key)
+        super().__init__(api_key, options)
         self.available_services = []
         self.detect_face_from_image: DetectFaceFromImage = DetectFaceFromImage(
             domain=domain,
@@ -52,4 +52,5 @@ def detect(self, image_path: str, options: ExpandedOptionsDict = {}) -> dict:
             api_key=self.api_key,
             image_path=image_path
         )
-        return self.detect_face_from_image.execute(request, options)
+        return self.detect_face_from_image.execute(request, pass_dict(
+            self.options, ExpandedOptionsDict) if options == {} else options)

.idea/vcs.xml

@@ -27,9 +27,9 @@
 class RecognitionService(Service):
     """Recognition service"""
 
-    def __init__(self, api_key: str, domain: str, port: str):
+    def __init__(self, api_key: str, domain: str, port: str, options: AllOptionsDict = {}):
         """Init service with define API Key"""
-        super().__init__(api_key)
+        super().__init__(api_key, options)
         self.available_services = []
         self.recognize_face_from_images: RecognizeFaceFromImage = RecognizeFaceFromImage(
             domain=domain,
@@ -39,7 +39,8 @@ def __init__(self, api_key: str, domain: str, port: str):
         self.face_collection: FaceCollection = FaceCollection(
             domain=domain,
             port=port,
-            api_key=api_key
+            api_key=api_key,
+            options=options
         )
 
     def get_available_functions(self) -> List[str]:
@@ -60,7 +61,7 @@ def recognize(self, image_path: str, options: AllOptionsDict = {}) -> dict:
             api_key=self.api_key,
             image_path=image_path
         )
-        return self.recognize_face_from_images.execute(request, options)
+        return self.recognize_face_from_images.execute(request, self.options if options == {} else options)
 
     def get_face_collection(self) -> FaceCollection:
         """

compreface/client/verify_face_from_image.py

@@ -15,7 +15,7 @@
  """
 
 from compreface.use_cases.verifiy_face_from_images import VerifyFaceFromImage
-from compreface.common.typed_dict import ExpandedOptionsDict
+from compreface.common.typed_dict import AllOptionsDict, ExpandedOptionsDict, pass_dict
 from compreface.client.verify_face_from_image import VerifyFaceFromImageClient
 from typing import List
 
@@ -25,9 +25,9 @@
 class VerificationService(Service):
     """Verification service"""
 
-    def __init__(self, api_key: str, domain: str, port: str):
+    def __init__(self, api_key: str, domain: str, port: str, options: AllOptionsDict = {}):
         """Init service with define API Key"""
-        super().__init__(api_key)
+        super().__init__(api_key, options)
         self.available_services = []
         self.verify_face_from_image: VerifyFaceFromImageClient = VerifyFaceFromImageClient(
             domain=domain,
@@ -42,7 +42,7 @@ def get_available_functions(self) -> List[str]:
         """
         return self.available_services
 
-    def verify(self, source_image_path: str, target_image_path: str, options: ExpandedOptionsDict) -> dict:
+    def verify(self, source_image_path: str, target_image_path: str, options: ExpandedOptionsDict = {}) -> dict:
         """
         Verify face in images
         :param source_image_path:
@@ -54,7 +54,8 @@ def verify(self, source_image_path: str, target_image_path: str, options: Expand
                                               source_image_path=source_image_path,
                                               target_image_path=target_image_path)
         return self.verify_face_from_image.post(
-            source_image_path=request.source_image_path,
-            target_image_path=request.target_image_path,
-            options=options
+            source_image=request.source_image_path,
+            target_image=request.target_image_path,
+            options=pass_dict(
+                self.options, ExpandedOptionsDict) if options == {} else options
         )

compreface/collections/face_collections.py

@@ -14,6 +14,7 @@
     permissions and limitations under the License.
  """
 
+from compreface.common.typed_dict import ExpandedOptionsDict
 from compreface import CompreFace
 from compreface.service import RecognitionService
 from compreface.collections import FaceCollection
@@ -22,7 +23,9 @@
 PORT: str = '8000'
 RECOGNITION_API_KEY: str = 'b97fbc0a-518a-4b1d-a93a-581b1d3814cc'
 
-compre_face: CompreFace = CompreFace(DOMAIN, PORT)
+compre_face: CompreFace = CompreFace(DOMAIN, PORT, {
+    "det_prob_threshold": 0.8
+})
 
 recognition: RecognitionService = compre_face.init_face_recognition(
     RECOGNITION_API_KEY)
@@ -33,6 +36,4 @@
 image: str = 'examples/common/jonathan-petit-unsplash.jpg'
 subject: str = 'Jonathan Petit'
 
-print(face_collection.add(image, subject, {
-    "det_prob_threshold": 0.8
-}))
+print(face_collection.add(image, subject))

compreface/common/service.py

@@ -20,7 +20,7 @@
 
 DOMAIN: str = 'http://localhost'
 PORT: str = '8000'
-RECOGNITION_API_KEY: str = '9916f5d1-216f-4049-9e06-51c140bfa898'
+RECOGNITION_API_KEY: str = 'b97fbc0a-518a-4b1d-a93a-581b1d3814cc'
 
 
 compre_face: CompreFace = CompreFace(DOMAIN, PORT)

compreface/common/typed_dict.py

@@ -20,7 +20,7 @@
 
 DOMAIN: str = 'http://localhost'
 PORT: str = '8000'
-RECOGNITION_API_KEY: str = '9916f5d1-216f-4049-9e06-51c140bfa898'
+RECOGNITION_API_KEY: str = 'b97fbc0a-518a-4b1d-a93a-581b1d3814cc'
 
 
 compre_face: CompreFace = CompreFace(DOMAIN, PORT)