Merge pull request #13 from dev-yoonik/fix/process-configuration-default-value

Fixed configurations default value.

Author: mlourencob

CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v0.3.4
+
+### Added
+
+- Extra face process request argument 'processings' validations.
+
+### Fixed
+
+- Process default configurations value to empty array instead of None.
+
 ## v0.3.3
 
 ### Fixed

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name="yk_face",
-    version="0.3.3",
+    version="0.3.4",
     description="Python SDK for the YouFace API.",
     long_description=long_description,
     long_description_content_type="text/markdown",

tests/test_face.py

@@ -43,12 +43,14 @@ def loop():
 
 @pytest.mark.parametrize('use_async', [(True,), (False,)])
 @pytest.mark.parametrize('configurations', [
+    None,
+    [],
     [
         ProcessRequestConfig(name="config1", value="12490812.523"),
         ProcessRequestConfig(name="config1.1", value="stringvalue"),
         ProcessRequestConfig(name="config2", bvalue=True),
         ProcessRequestConfig(name="config3", bvalue=False),
-     ]
+    ],
 ])
 def test_face_process_with_valid_image(
         use_async: bool,
@@ -84,6 +86,91 @@ def test_face_process_with_valid_image(
     __template = detected_face.get("template")
 
 
+@pytest.mark.parametrize('use_async', [(True,), (False,)])
+@pytest.mark.parametrize('processings', [
+    None,
+    ["detect", "analyze"],
+    ["detect", "templify"],
+    ["detect", "analyze", "templify"],
+])
+def test_face_process_processings(
+        use_async: bool,
+        processings,
+        loop: asyncio.AbstractEventLoop
+):
+    """
+    Test sync and async process request method when passed valid processings values.
+    :param use_async: flag to use the async function
+    :param loop: event loop for the current test
+    :return:
+    """
+    try:
+        if use_async:
+            loop.run_until_complete(
+                YKF.face.process_async(
+                    __image_file,
+                    configurations=[],
+                    processings=processings,
+                )
+            )
+        else:
+            YKF.face.process(__image_file)
+    except YoonikApiException as exc:
+        raise exc
+
+
+@pytest.mark.parametrize('use_async', [(True,), (False,)])
+@pytest.mark.parametrize('processings', [[]])
+def test_face_process_with_invalid_empty_processings(
+        use_async: bool,
+        processings,
+        loop: asyncio.AbstractEventLoop
+):
+    """
+    Test sync and async process request method when passed processings with empty values.
+    :param use_async: flag to use the async function
+    :param loop: event loop for the current test
+    :return:
+    """
+    with pytest.raises(ValueError):
+        if use_async:
+            loop.run_until_complete(
+                YKF.face.process_async(
+                    __image_file,
+                    configurations=[],
+                    processings=processings,
+                )
+            )
+        else:
+            YKF.face.process(__image_file)
+
+
+@pytest.mark.parametrize('use_async', [(True,), (False,)])
+@pytest.mark.parametrize('processings', [1, "2", b"4", dict(), set()])
+def test_face_process_with_invalid_processings(
+        use_async: bool,
+        processings,
+        loop: asyncio.AbstractEventLoop
+):
+    """
+    Test sync and async process request method when passed processing of incorrect type.
+    :param use_async: flag to use the async function
+    :param loop: event loop for the current test
+    :return:
+    """
+    with pytest.raises(TypeError):
+        if use_async:
+            loop.run_until_complete(
+                YKF.face.process_async(
+                    __image_file,
+                    configurations=[],
+                    processings=processings,
+                )
+            )
+        else:
+            YKF.face.process(__image_file)
+
+
 @pytest.mark.parametrize('use_async', [(True,), (False,)])
 @pytest.mark.parametrize('configurations', [
     [

yk_face/face.py

@@ -40,8 +40,14 @@ def __process_request_validation(
         raise ValueError("image must be provided")
 
     image_b64 = parse_image(image)
+    configurations = configurations or []
     if processings is None:
         processings = ['detect', 'analyze', 'templify']
+    elif type(processings) is not list:
+        raise TypeError("The provided processings are not of expected type.")
+    elif len(processings) == 0:
+        raise ValueError("The processings were not provided.")
+
     process_request = ProcessRequest(
         image=image_b64,
         processings=processings,