Merge pull request #4 from exadel-inc/detect_service_and_testing

Detect service and testing

Author: aliubymov

Diff for: .gitignore

@@ -92,3 +92,5 @@ Thumbs.db
 .history
 .ionide
 
+
+.vscode

Diff for: README.md

@@ -1,6 +1,8 @@
 # -*- coding: utf-8 -*-
 
-from .verify_face_from_image import VerifyFaceFromImageClient
+from .compare_face_from_image import CompareFaceFromImageClient
 from .add_example_of_subject import AddExampleOfSubjectClient
 from .delete_example_by_id import DeleteExampleByIdClient
 from .recognize_face_from_image import RecognizeFaceFromImageClient
+from .detect_face_from_image import DetectFaceFromImageClient
+from .verify_face_from_image import VerifyFaceFromImageClient

Diff for: compreface/__pycache__/__init__.cpython-38.pyc

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 
+from compreface.common.typed_dict import DetProbOptionsDict, check_fields_by_name
 from compreface.config.api_list import RECOGNIZE_CRUD_API
 import os
 import requests
@@ -16,24 +17,59 @@ def __init__(self, api_key: str, domain: str, port: str):
         self.api_key: str = api_key
         self.url: str = domain + ':' + port + self.client_url
 
+    """
+        GET request for get all subjects. 
+        
+        :return: json with subjects from server.
+    """
+
     def get(self) -> dict:
         url: str = self.url
         result = requests.get(url, headers={'x-api-key': self.api_key})
         return result.json()
 
-    def post(self, image_path: str = '', subject: str = '') -> dict:
+    """
+        POST request for add subject from his face in image. 
+        
+        :param image_path: path to image in file system.
+        :param subject: fullname
+        :param options: dictionary with options for server.
+        
+        :return: json with this subject from server.
+    """
+
+    def post(self, image_path: str = '', subject: str = '', options: DetProbOptionsDict = {}) -> dict:
         url: str = self.url + '?subject=' + subject
         name_img: str = os.path.basename(image_path)
+
+        # Validation loop and adding fields to the url.
+        for key in options.keys():
+            # Checks fields with necessary rules.
+            # key - key field by options.
+            check_fields_by_name(key, options[key])
+            url += '&' + key + "=" + str(options[key])
+
+        # Encoding image from path and encode in multipart for sending to the server.
         m = MultipartEncoder(
             fields={'file': (name_img, open(image_path, 'rb'))}
         )
+
+        # Sending encode image for add subject.
         result = requests.post(url, data=m, headers={'Content-Type': m.content_type,
                                                      'x-api-key': self.api_key})
         return result.json()
 
     def put(self):
         pass
 
+    """ 
+        Delete request to CompreFace server. 
+        
+        :param subject: fullname
+        
+        :return: json from server.
+    """
+
     def delete(self, subject: str = ''):
         url: str = self.url + '?subject=' + subject
         result = requests.delete(url, headers={'x-api-key': self.api_key})

Diff for: compreface/client/__init__.py

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+import os
+import requests
+from compreface.common.typed_dict import ExpandedOptionsDict, check_fields_by_name
+from compreface.config.api_list import RECOGNIZE_CRUD_API
+from requests_toolbelt.multipart.encoder import MultipartEncoder
+from ..common import ClientRequest
+
+
+class CompareFaceFromImageClient(ClientRequest):
+    """
+        Compare face in image. It uses image path for encode and send to CompreFace 
+        server with validation by image id.
+    """
+
+    def __init__(self, api_key: str, domain: str, port: str):
+        super().__init__()
+        self.client_url: str = RECOGNIZE_CRUD_API
+        self.api_key: str = api_key
+        self.url: str = domain + ':' + port + self.client_url
+
+    def get(self):
+        pass
+
+    """
+        POST request for compare face in image using image id. 
+        
+        :param image_path: Path to image in file system.
+        :param image_id: subject id from previously added image.
+        :param options: dictionary with options for server.
+        
+        :return: json from server.
+    """
+
+    def post(self,
+             image_path: str = '',
+             image_id: str = '',
+             options: ExpandedOptionsDict = {}) -> dict:
+
+        url: str = self.url + '/' + image_id + '/verify?'
+        name_img: str = os.path.basename(image_path)
+        # Validation loop and adding fields to the url.
+        for key in options.keys():
+            # Checks fields with necessary rules.
+            # key - key field by options.
+            check_fields_by_name(key, options[key])
+            url += '&' + key + "=" + str(options[key])
+
+        # Encoding image from path and encode in multipart for sending to the server.
+        m = MultipartEncoder(
+            fields={'file': (name_img, open(image_path, 'rb'))}
+        )
+
+        # Sending encode image for verify face.
+        result = requests.post(url, data=m, headers={'Content-Type': m.content_type,
+                                                     'x-api-key': self.api_key})
+        return result.json()
+
+    def put(self):
+        pass
+
+    def delete(self):
+        pass

Diff for: compreface/client/__pycache__/__init__.cpython-38.pyc

@@ -8,6 +8,10 @@
 
 class DeleteExampleByIdClient(ClientRequest):
 
+    """
+        Delete example by id from image_id.
+    """
+
     def __init__(self, api_key: str, domain: str, port: str):
         super().__init__()
         self.client_url: str = RECOGNIZE_CRUD_API
@@ -23,6 +27,14 @@ def post(self):
     def put(self):
         pass
 
+    """ 
+        DELETE request to CompreFace server. Delete example by id from image_id.
+        
+        :param image_id:
+        
+        :return: json from server.
+    """
+
     def delete(self, image_id: str = ''):
         url: str = self.url + '/' + image_id
         result = requests.delete(url, headers={'x-api-key': self.api_key})

Diff for: compreface/client/__pycache__/add_example_of_subject.cpython-38.pyc

@@ -0,0 +1,57 @@
+import os
+import requests
+from compreface.common.typed_dict import AllOptionsDict, check_fields_by_name
+from ..common import ClientRequest
+from compreface.config.api_list import DETECTION_API
+from requests_toolbelt.multipart.encoder import MultipartEncoder
+
+
+class DetectFaceFromImageClient(ClientRequest):
+    """
+        Detection faces in image. It uses image path for encode and send to CompreFace server.
+    """
+
+    def __init__(self, api_key: str, domain: str, port: str):
+        super().__init__()
+        self.client_url: str = DETECTION_API
+        self.api_key: str = api_key
+        self.url: str = domain + ':' + port + self.client_url
+
+    def get(self):
+        pass
+
+    """
+        POST request for detection faces in image. 
+        
+        :param image_path: Path to image in file system.
+        :param options: dictionary with options for server.
+        
+        :return: json from server.
+    """
+
+    def post(self, image_path: str = '', options: AllOptionsDict = {}):
+        url: str = self.url + '?'
+        name_img: str = os.path.basename(image_path)
+
+        # Validation loop and adding fields to the url.
+        for key in options.keys():
+            # Checks fields with necessary rules.
+            # key - key field by options.
+            check_fields_by_name(key, options[key])
+            url += '&' + key + "=" + str(options[key])
+
+        # Encoding image from path and encode in multipart for sending to the server.
+        m = MultipartEncoder(
+            fields={'file': (name_img, open(image_path, 'rb'))}
+        )
+
+        # Sending encode image for detection faces.
+        result = requests.post(url, data=m, headers={'Content-Type': m.content_type,
+                                                     'x-api-key': self.api_key})
+        return result.json()
+
+    def put(self):
+        pass
+
+    def delete(self):
+        pass

Diff for: compreface/client/__pycache__/delete_example_by_id.cpython-38.pyc

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 
+from compreface.common.typed_dict import ExpandedOptionsDict, check_fields_by_name
 from compreface.config.api_list import RECOGNIZE_API
 import os
 import requests
@@ -9,6 +10,9 @@
 
 
 class RecognizeFaceFromImageClient(ClientRequest):
+    """
+        Recognize faces in image. It uses image path for encode and send to CompreFace server.
+    """
 
     def __init__(self, api_key: str, domain: str, port: str):
         super().__init__()
@@ -19,12 +23,32 @@ def __init__(self, api_key: str, domain: str, port: str):
     def get(self):
         pass
 
-    def post(self, image_path: str = ''):
-        url: str = self.url
+    """
+        POST request for recognize faces in image. 
+        
+        :param image_path: Path to image in file system.
+        :param options: dictionary with options for server.
+        
+        :return: json from server.
+    """
+
+    def post(self, image_path: str = '', options: ExpandedOptionsDict = {}):
+        url: str = self.url + "?"
         name_img: str = os.path.basename(image_path)
+
+        # Validation loop and adding fields to the url.
+        for key in options.keys():
+            # Checks fields with necessary rules.
+            # key - key field by options.
+            check_fields_by_name(key, options[key])
+            url += '&' + key + "=" + str(options[key])
+
+        # Encoding image from path and encode in multipart for sending to the server.
         m = MultipartEncoder(
             fields={'file': (name_img, open(image_path, 'rb'))}
         )
+
+        # Sending encode image for recognize faces.
         result = requests.post(url, data=m, headers={'Content-Type': m.content_type,
                                                      'x-api-key': self.api_key})
         return result.json()

Diff for: compreface/client/__pycache__/recognize_face_from_image.cpython-38.pyc

@@ -1,31 +1,62 @@
-# -*- coding: utf-8 -*-
-
-from compreface.config.api_list import RECOGNIZE_CRUD_API
-import os
 import requests
-from requests_toolbelt.multipart.encoder import MultipartEncoder
+from compreface.config.api_list import VERIFICATION_API
+import os
 
-from ..common import ClientRequest
+from requests_toolbelt.multipart.encoder import MultipartEncoder
+from compreface.common.typed_dict import AllOptionsDict, check_fields_by_name
+from compreface.common.client import ClientRequest
 
 
 class VerifyFaceFromImageClient(ClientRequest):
+    """
+        Verify face in image. It uses source and target images for encode and send to CompreFace 
+        server with validation by image id.
+    """
+
     def __init__(self, api_key: str, domain: str, port: str):
         super().__init__()
-        self.client_url: str = RECOGNIZE_CRUD_API
+        self.client_url: str = VERIFICATION_API
         self.api_key: str = api_key
         self.url: str = domain + ':' + port + self.client_url
 
     def get(self):
         pass
 
+    """
+        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 image_id: subject id from previously added image. 
+        :param options: dictionary with options for server.
+        
+        :return: json from server.
+    """
+
     def post(self,
-             image_path: str = '',
-             image_id: str = ''):
-        url: str = self.url + '/' + image_id + '/verify'
-        name_img: str = os.path.basename(image_path)
+             source_image_path: str = '',
+             target_image_path: str = '',
+             options: AllOptionsDict = {}) -> dict:
+
+        url: str = self.url + '/verify?'
+        source_name_img: str = os.path.basename(source_image_path)
+        target_name_img: str = os.path.basename(target_image_path)
+        # Validation loop and adding fields to the url.
+        for key in options.keys():
+            # Checks fields with necessary rules.
+            # key - key field by options.
+            check_fields_by_name(key, options[key])
+            url += '&' + key + "=" + str(options[key])
+
+        # Encoding image from path and encode in multipart for sending to the server.
         m = MultipartEncoder(
-            fields={'file': (name_img, open(image_path, 'rb'))}
+            fields={'source_image': (source_name_img, open(
+                source_image_path, 'rb')), 'target_image': (target_name_img, open(
+                    target_image_path, 'rb'))}
+
         )
+
+        # Sending encode image for verify face.
         result = requests.post(url, data=m, headers={'Content-Type': m.content_type,
                                                      'x-api-key': self.api_key})
         return result.json()