Merge pull request #31 from hostnfly/feat/deserializer-union-types

feat: allow Union typed schemas

Author: batistadasilva

jsonapi_client/client.py

@@ -1,4 +1,5 @@
-from typing import Any, Generic, TypeVar, cast
+from types import UnionType
+from typing import Any, Generic, TypeVar, cast, get_args
 
 import jsonpickle  # type: ignore[import-untyped]
 from requests import request  # type: ignore[import-untyped]
@@ -38,7 +39,7 @@ def __init__(self, status_code: int, jsonapi_errors: list[JsonAPIError]) -> None
 
 
 class JsonAPIClient(Generic[T]):
-    def __init__(self, url: str, schema: type[JsonAPIResourceSchema], auth: AuthBase | None = None) -> None:
+    def __init__(self, url: str, schema: type[JsonAPIResourceSchema] | UnionType, auth: AuthBase | None = None) -> None:
         self.url = url
         self.schema = schema
         self.auth = auth
@@ -79,8 +80,19 @@ def __deserialize_payload(self, response: Response) -> tuple[T | list[T], dict[s
         parsed = JsonAPIParser().parse(**json)
         meta = cast("dict[str, Any]", json["meta"])
         if isinstance(parsed, list):
-            results = [cast("T", cast("Any", self.schema).from_dict(r)) for r in parsed]
+            results = [self.__deserializer_resource(r) for r in parsed]
             return results, meta
 
-        result = cast("T", cast("Any", self.schema).from_dict(parsed))
-        return result, meta
+        return self.__deserializer_resource(parsed), meta
+
+    def __deserializer_resource(self, jsonapi_resource: dict[str, Any]) -> T:
+        if isinstance(self.schema, UnionType):
+            for schema_type in get_args(self.schema):
+                try:
+                    return cast("T", cast("Any", schema_type).from_dict(jsonapi_resource))
+                except KeyError as e:
+                    last_error = e
+                    pass
+            raise last_error
+
+        return cast("T", cast("Any", self.schema).from_dict(jsonapi_resource))

tests/fixtures/media.json

@@ -0,0 +1,40 @@
+{
+  "meta": {
+    "total": 2
+  },
+  "data": [
+    {
+      "id": "1",
+      "type": "media",
+      "attributes": {
+        "title": "Das weiße Band - Eine deutsche Kindergeschichte",
+        "year": 2009
+      },
+      "relationships": {
+        "director": {
+          "data": {
+            "id": "1",
+            "type": "person"
+          }
+        }
+      }
+    },
+    {
+      "id": "2",
+      "type": "media",
+      "attributes": {
+        "title": "Good Morning, Veronica",
+        "seasons": 3
+      }
+    }
+  ],
+  "included": [
+    {
+      "id": "1",
+      "type": "person",
+      "attributes": {
+        "full_name": "Michael Haneke"
+      }
+    }
+  ]
+}

tests/test_client.py

@@ -25,6 +25,12 @@ class Movie(JsonAPIResourceSchema):
     director: Person
 
 
+@dataclass
+class Series(JsonAPIResourceSchema):
+    title: str
+    seasons: int
+
+
 class TestClient(TestCase):
     @patch("jsonapi_client.client.request")
     def test_get(self, test_request: MagicMock) -> None:
@@ -46,3 +52,19 @@ def test_get(self, test_request: MagicMock) -> None:
         self.assertEqual(result[1].year, 1997)
         self.assertEqual(result[1].director.full_name, "Michael Haneke")
 
+    @patch("jsonapi_client.client.request")
+    def test_get_polymorphic(self, test_request: MagicMock) -> None:
+        client: JsonAPIClient = JsonAPIClient(url="http://example.com/api", schema=Movie | Series, auth=None)
+        fixture = Path("tests/fixtures/media.json")
+        response = Response()
+        response.status_code = 200
+        response._content = fixture.read_bytes()
+        test_request.return_value = response
+
+        result, meta = client.get()
+
+        self.assertEqual(len(result), 2)
+        self.assertEqual(meta["total"], 2)
+        self.assertIsInstance(result[0], Movie)
+        self.assertIsInstance(result[1], Series)
+