add_example_of_subject.py

"""
    Copyright(c) 2021 the original author or authors

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        https: // www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
    or implied. See the License for the specific language governing
    permissions and limitations under the License.
 """

import requests

from compreface.common.multipart_constructor import multipart_constructor
from compreface.common.typed_dict import (
    DetProbOptionsDict,
    SavedObjectOptions,
    check_fields_by_name,
)
from compreface.config.api_list import RECOGNIZE_CRUD_API
from ..common import ClientRequest


class AddExampleOfSubjectClient(ClientRequest):
    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

    """
        GET request for get all subjects. 
        
        :return: json with subjects from server.
    """

    def get(self, options: SavedObjectOptions = {}) -> dict:
        url: str = self.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])
        result = requests.get(url, headers={"x-api-key": self.api_key})
        return result.json()

    """
        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: str = "" or bytes,
        subject: str = "",
        options: DetProbOptionsDict = {},
    ) -> dict:
        url: str = self.url + "?subject=" + subject
        # 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])
        m = multipart_constructor(image)
        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})
        return result.json()