roundtrip for simple JSON prototypes

Author: isabelizimm

vetiver/__init__.py

@@ -2,7 +2,11 @@
 # Change to import.metadata when minimum python>=3.8
 from importlib_metadata import version as _version
 
-from .prototype import vetiver_create_prototype, vetiver_create_ptype  # noqa
+from .prototype import (  # noqa
+    vetiver_create_prototype,  # noqa
+    vetiver_create_ptype,  # noqa
+    InvalidPTypeError,  # noqa
+)  # noqa
 from .vetiver_model import VetiverModel  # noqa
 from .server import VetiverAPI, vetiver_endpoint, predict  # noqa
 from .mock import get_mock_data, get_mock_model  # noqa

vetiver/prototype.py

@@ -175,6 +175,22 @@ def _(data: dict):
     data : dict
         Dictionary
     """
+
+    # if it comes from vetiver's /prototype endpoint
+    dict_data = {}
+    if data.keys() >= {"properties", "title", "type"}:
+        # automatically create for simple prototypes
+        try:
+            for key, value in data["properties"].items():
+                dict_data.update({key: (value["type"], value["default"])})
+        # error for complex objects
+        except KeyError:
+            raise InvalidPTypeError(
+                "Failed to create dict prototype for this data. "
+                "Please use pandas DataFrame or pydantic BaseModel."
+            )
+        return create_prototype(**dict_data)
+
     return create_prototype(**_to_field(data))
 
 

vetiver/tests/test_server.py

@@ -1,4 +1,10 @@
-from vetiver import mock, VetiverModel, VetiverAPI
+from vetiver import (
+    mock,
+    VetiverModel,
+    VetiverAPI,
+    vetiver_create_prototype,
+    InvalidPTypeError,
+)
 from pydantic import BaseModel, conint
 from fastapi.testclient import TestClient
 import numpy as np
@@ -76,7 +82,7 @@ def test_get_metadata(client):
     }
 
 
-def test_get_prototype(client):
+def test_get_prototype(client, vetiver_model):
     response = client.get("/prototype")
     assert response.status_code == 200, response.text
     assert response.json() == {
@@ -89,6 +95,11 @@ def test_get_prototype(client):
         "type": "object",
     }
 
+    assert (
+        vetiver_model.prototype.construct()
+        == vetiver_create_prototype(response.json()).construct()
+    )
+
 
 def test_complex_prototype(complex_prototype_model):
     response = complex_prototype_model.get("/prototype")
@@ -103,3 +114,6 @@ def test_complex_prototype(complex_prototype_model):
         "title": "CustomPrototype",
         "type": "object",
     }
+
+    with pytest.raises(InvalidPTypeError):
+        vetiver_create_prototype(response.json())