add Numpy + PIL IMAGE return type, ability to specify response mime-type

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
       - name: install poetry
         run: |
           curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python;
-          echo "::add-path::$HOME/.poetry/bin/"
+          echo "$HOME/.poetry/bin/" >> $GITHUB_PATH
       - name: install deps
         run: poetry install -v
       - name: flake8

dploy_kickstart/annotations.py

@@ -20,9 +20,7 @@ def __init__(self, callble: typing.Callable) -> None:
         self.request_method = "post"
         self.accepts_json = True
         self.returns_json = True
-        self.response_mime_type = (
-            "application/json"  # functionality deprecated, to be removed `
-        )
+        self.response_mime_type = None
         self.request_content_type = (
             "application/json"  # functionality deprecated, to be removed `
         )
@@ -69,7 +67,6 @@ def evaluate_comment_args(self) -> None:
                 self.endpoint = True
                 self.endpoint_path = p
 
-            # functionality deprecated, to be removed
             if c[0] == "response_mime_type":
                 self.response_mime_type = c[1].lower()
 

dploy_kickstart/errors.py

@@ -16,7 +16,6 @@ class ScriptImportError(ServerException):
     status_code = 500
 
     def __init__(self, message: str):
-        super().__init__(self)
         self.message = message
 
     def to_dict(self) -> dict:
@@ -27,7 +26,6 @@ class UnsupportedEntrypoint(ServerException):
     status_code = 500
 
     def __init__(self, entrypoint: str):
-        super().__init__(self)
         self.message = f"entrypoint '{entrypoint}' not supported"
 
     def to_dict(self) -> dict:

dploy_kickstart/server.py

@@ -40,10 +40,7 @@ def append_entrypoint(app: Flask, entrypoint: str, location: str) -> Flask:
             po.path_spec(openapi_spec, f)
 
     app.add_url_rule(
-        "/openapi.yaml",
-        "/openapi.yaml",
-        openapi_spec.to_yaml,
-        methods=["GET"],
+        "/openapi.yaml", "/openapi.yaml", openapi_spec.to_yaml, methods=["GET"],
     )
 
     return app

dploy_kickstart/transformers.py

@@ -1,25 +1,73 @@
 """Utilities to transform requests and responses."""
-
+import io
 import typing
 from flask import jsonify, Response, Request
 import dploy_kickstart.annotations as da
 
 
-def bytes_resp(func_result: typing.Any) -> Response:
-    return Response(func_result, mimetype="application/octet-stream")
+def bytes_resp(func_result: typing.Any, mimetype=None) -> Response:
+    if mimetype is None:
+        return Response(func_result, mimetype="application/octet-stream")
+    else:
+        return Response(func_result, mimetype=mimetype)
 
 
-def bytes_io_resp(func_result: typing.Any) -> Response:
-    return Response(func_result.getvalue(), mimetype="application/octet-stream")
+def bytes_io_resp(func_result: typing.Any, mimetype=None) -> Response:
+    if mimetype is None:
+        return Response(func_result.getvalue(), mimetype="application/octet-stream")
+    else:
+        return Response(func_result.getvalue(), mimetype=mimetype)
 
 
-def default_req(f: da.AnnotatedCallable, req: Request) -> typing.Any:
-    return f(req.data)
+def pil_image_resp(func_result: typing.Any, mimetype=None) -> Response:
+    # create file-object in memory
+    file_object = io.BytesIO()
+    img_format = func_result.format
+
+    # write image to a file-object
+    # Don't change quality and subsampling since save decrease the quality by default
+    func_result.save(file_object, img_format, quality=100, subsampling=0)
+    auto_mimetype = f"image/{img_format.lower()}"
+
+    # move to beginning of file so `send_file()` it will read from start
+    file_object.seek(0)
+
+    if mimetype is None:
+        return Response(file_object, mimetype=auto_mimetype)
+    else:
+        return Response(file_object, mimetype=mimetype)
+
+
+def np_tolist_resp(func_result: typing.Any, mimetype=None) -> Response:
+    response = jsonify(func_result.tolist())
+    if mimetype is None:
+        return response
+    else:
+        response.mimetype = mimetype
+        return response
+
+
+def np_item_resp(func_result: typing.Any, mimetype=None) -> Response:
+    response = jsonify(func_result.item())
+    if mimetype is None:
+        return response
+    else:
+        response.mimetype = mimetype
+        return response
 
 
-def json_resp(func_result: typing.Any) -> Response:
+def json_resp(func_result: typing.Any, mimetype=None) -> Response:
     """Transform json response."""
-    return jsonify(func_result)
+    response = jsonify(func_result)
+    if mimetype is None:
+        return response
+    else:
+        response.mimetype = mimetype
+        return response
+
+
+def default_req(f: da.AnnotatedCallable, req: Request) -> typing.Any:
+    return f(req.data)
 
 
 def json_req(f: da.AnnotatedCallable, req: Request) -> typing.Any:
@@ -39,5 +87,22 @@ def json_req(f: da.AnnotatedCallable, req: Request) -> typing.Any:
     "list": json_resp,
     "dict": json_resp,
     "bytes": bytes_resp,
+    # io.BytesIO return type
     "BytesIO": bytes_io_resp,
+    # Pillow Image Return dtype
+    "Image": pil_image_resp,
+    # Numpy Return dtypes
+    "ndarray": np_tolist_resp,
+    "matrix": np_tolist_resp,
+    "int8": np_item_resp,
+    "uint8": np_item_resp,
+    "int16": np_item_resp,
+    "uint16": np_item_resp,
+    "int32": np_item_resp,
+    "uint32": np_item_resp,
+    "int64": np_item_resp,
+    "uint64": np_item_resp,
+    "float16": np_item_resp,
+    "float32": np_item_resp,
+    "float64": np_item_resp,
 }

dploy_kickstart/wrapper.py

@@ -114,7 +114,9 @@ def exposed_func() -> typing.Callable:
 
         # determine whether or not to process response before sending it back to caller
         try:
-            return pt.MIME_TYPE_RES_MAPPER[res.__class__.__name__](res)
+            return pt.MIME_TYPE_RES_MAPPER[res.__class__.__name__](
+                res, f.response_mime_type
+            )
         except Exception:
             raise pe.UserApplicationError(
                 message=f"error in executing '{f.__name__()}' method, the return type "

pyproject.toml

@@ -28,6 +28,7 @@ pytest-cov = "^2.8.1"
 requests = "^2.23.0"
 flynt = "^0.46.1"
 pillow = "^8.0.1"
+numpy = "^1.19.4"
 
 [tool.black]
 line-length = 88

tests/assets/deps_tests/fake_requirements.txt

@@ -0,0 +1 @@
+some_random_package_kickstart==4.0.0

tests/assets/deps_tests/my_pkg/setup.py

@@ -3,10 +3,5 @@
 from distutils.core import setup
 
 setup(
-    name="dummy",
-    version="1.0",
-    packages=[],
-    install_requires=[
-        "dummy_test==0.1.3",
-    ],
+    name="dummy", version="1.0", packages=[], install_requires=["dummy_test==0.1.3",],
 )

tests/assets/deps_tests/my_pkg/stp.py

@@ -0,0 +1,7 @@
+#!/usr/bin/env python
+
+from distutils.core import setup
+
+setup(
+    name="dummy", version="1.0", packages=[], install_requires=["dummy_test==0.1.3",],
+)

tests/assets/server_default.py

@@ -1,3 +1,4 @@
+import numpy as np
 from PIL import Image
 import io
 
@@ -97,3 +98,34 @@ def f7(some_string):
 def f8(raw_image):
     image = Image.open(io.BytesIO(raw_image))
     return image
+
+
+# @dploy endpoint f9
+def f9(raw_image):
+    image = Image.open(io.BytesIO(raw_image))
+
+    # Size of the image in pixels (size of original image)
+    # (This is not mandatory)
+    width, height = image.size
+
+    # Setting the points for cropped image
+    left = 5
+    top = height / 4
+    right = 164
+    bottom = 3 * height / 4
+
+    # Cropped image of above dimension
+    # (It will not change orginal image)
+    im1 = image.crop((left, top, right, bottom))
+    im1.format = image.format  # original image extension
+    return im1
+
+
+# @dploy endpoint f10
+def f10(input):
+    return np.uint(input)
+
+
+# @dploy endpoint f11
+def f11(input):
+    return np.array(input)

tests/test_callable_annotation.py

@@ -73,6 +73,12 @@ def t11():
     return img1
 
 
+# @dploy endpoint get_model_name
+# @dploy response_method get
+def t12():
+    return "kickstart"
+
+
 @pytest.mark.parametrize(
     "callable,endpoint,endpoint_path,has_args,output, error",
     [
@@ -87,6 +93,7 @@ def t11():
         (t9, True, "/get_image2/", True, img1, True),
         (t10, True, "/get_image3/", True, img1, True),
         (t11, True, "/get_image4/", True, img1, True),
+        (t12, True, "/get_model_name/", True, "kickstart", False),
     ],
 )
 def test_callable_annotation(
@@ -111,17 +118,10 @@ def test_callable_annotation(
 @pytest.mark.parametrize(
     "py_file,expected",
     [
-        (
-            "c1.py",
-            [["endpoint", "predict"], ["endpoint", "train2"]],
-        ),
+        ("c1.py", [["endpoint", "predict"], ["endpoint", "train2"]],),
         (
             "nb_with_comments.ipynb",
-            [
-                ["endpoint", "predict"],
-                ["endpoint", "train"],
-                ["trigger", "train"],
-            ],
+            [["endpoint", "predict"], ["endpoint", "train"], ["trigger", "train"],],
         ),
     ],
 )
@@ -180,9 +180,7 @@ def test_annotated_scripts(py_file, expected):
         #
         # irrelevant other stuff
         """,
-            [
-                ["arg", "foo bar", "arg2", "bar the foos"],
-            ],
+            [["arg", "foo bar", "arg2", "bar the foos"],],
         ],
         [
             """

tests/test_dep_install.py

@@ -10,6 +10,7 @@
 @pytest.mark.parametrize(
     "req_file, error_expected",
     [
+        ("fake_requirements.txt", True),
         ("req1.txt", True),
         ("non_existing.txt", True),
         ("requirements.txt", False),
@@ -28,6 +29,7 @@ def test_req_install(req_file, error_expected):
     "setup_py, error_expected",
     [
         ("my_pkg/setup.py", False),
+        ("my_pkg/stp.py", True),
         ("non_existing_pkg/setup.py", True),
     ],
 )