Merge pull request #9 from RSS-Engineering/alias_fields_fix

fix for pydantic fields with alias

Author: explorigin

pydanticrud/backends/dynamodb.py

@@ -333,7 +333,7 @@ def get(self, key):
         return self._deserialize_record(resp["Item"])
 
     def save(self, item, condition: Optional[Rule] = None) -> bool:
-        data = self._serialize_record(item.dict())
+        data = self._serialize_record(item.dict(by_alias=True))
 
         try:
             if condition:

pydanticrud/main.py

@@ -36,7 +36,7 @@ def get(cls, *args, **kwargs):
 
     def save(self) -> bool:
         # Parse the new obj to trigger validation
-        self.__class__.parse_obj(self.dict())
+        self.__class__.parse_obj(self.dict(by_alias=True))
 
         # Maybe we should pass a conditional to the backend but for now the only place that uses it doesn't need it.
         return self.__class__.__backend__.save(self)

pyproject.toml

@@ -10,7 +10,6 @@ python = ">=3.6"
 boto3 = "^1.17.112"
 rule-engine = "^3.2.0"
 pydantic = "^1.8.2"
-boto3 = {version = "^1.17.112", optional = true}
 dataclasses = {version = "^0.8", python = "3.6"}
 
 [tool.poetry.dev-dependencies]

tests/test_dynamodb.py

@@ -5,7 +5,7 @@
 import random
 
 import docker
-from pydantic import BaseModel as PydanticBaseModel
+from pydantic import BaseModel as PydanticBaseModel, Field
 from pydanticrud import BaseModel, DynamoDbBackend, ConditionCheckFailed
 import pytest
 from pydanticrud.exceptions import DoesNotExist
@@ -39,6 +39,19 @@ class Config:
         global_indexes = {"by-id": ("id",)}
 
 
+class AliasKeyModel(BaseModel):
+    id: int
+    value: int
+    name: str
+    type_: str = Field(alias="type")
+
+    class Config:
+        title = "AliasTitle123"
+        hash_key = "name"
+        backend = DynamoDbBackend
+        endpoint = "http://localhost:18002"
+
+
 class ComplexKeyModel(BaseModel):
     account: str
     sort_date_key: str
@@ -79,6 +92,17 @@ class Config:
         endpoint = "http://localhost:18002"
 
 
+def alias_model_data_generator(**kwargs):
+    data = dict(
+        id=random.randint(0, 100000),
+        value=random.randint(0, 100000),
+        name=random_unique_name(),
+        type="aliasType"
+    )
+    data.update(kwargs)
+    return data
+
+
 def simple_model_data_generator(**kwargs):
     data = dict(
         id=random.randint(0, 100000),
@@ -163,6 +187,14 @@ def nested_table(dynamo):
     return NestedModel
 
 
+@pytest.fixture(scope="module")
+def alias_table(dynamo):
+    if not AliasKeyModel.exists():
+        AliasKeyModel.initialize()
+        assert AliasKeyModel.exists()
+    return AliasKeyModel
+
+
 @pytest.fixture(scope="module")
 def simple_query_data(simple_table):
     presets = [dict(name="Jerry"), dict(name="Hermione"), dict(), dict(), dict()]
@@ -190,6 +222,18 @@ def complex_query_data(complex_table):
             ComplexKeyModel.delete((datum[ComplexKeyModel.Config.hash_key], datum[ComplexKeyModel.Config.range_key]))
 
 
+@pytest.fixture(scope="module")
+def alias_query_data(alias_table):
+    presets = [dict(name="Jerry"), dict(name="Hermione"), dict(), dict(), dict()]
+    data = [datum for datum in [alias_model_data_generator(**i) for i in presets]]
+    for datum in data:
+        AliasKeyModel.parse_obj(datum).save()
+    try:
+        yield data
+    finally:
+        for datum in data:
+            AliasKeyModel.delete(datum["name"])
+
 @pytest.fixture(scope="module")
 def nested_query_data(nested_table):
     presets = [dict()] * 5
@@ -348,3 +392,21 @@ def test_query_with_nested_model_optional(dynamo, nested_query_data_optional):
     res = NestedModel.query(filter_expr=Rule(f"expires <= '{data_by_expires['expires']}'"))
     res_data = [m.ticket for m in res]
     assert any(elem is None for elem in res_data)
+
+
+def test_query_alias_save(dynamo):
+    presets = [dict(name="Jerry"), dict(name="Hermione"), dict(), dict(), dict()]
+    data = [datum for datum in [alias_model_data_generator(**i) for i in presets]]
+    AliasKeyModel.initialize()
+    try:
+        for datum in data:
+            AliasKeyModel.parse_obj(datum).save()
+    except Exception as e:
+        raise pytest.fail("Failed to save Alias model!")
+
+def test_get_alias_model_data(dynamo, alias_query_data):
+    data = alias_model_data_generator()
+    res = AliasKeyModel.get(alias_query_data[0]['name'])
+    assert res.dict(by_alias=True) == alias_query_data[0]
+
+