Merge pull request #408 from wwwjfy/json-prop-check

refs #406, define exception on unknown json prop

Author: wwwjfy

gino/exceptions.py

@@ -8,3 +8,7 @@ class NoSuchRowError(GinoException):
 
 class UninitializedError(GinoException):
     pass
+
+
+class UnknownJSONPropertyError(GinoException):
+    pass

gino/json_support.py

@@ -2,6 +2,8 @@
 
 import sqlalchemy as sa
 
+from .exceptions import UnknownJSONPropertyError
+
 DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%S.%f'
 NONE = object()
 
@@ -54,8 +56,15 @@ def get_profile(self, instance):
         if instance.__profile__ is None:
             props = type(instance).__dict__
             instance.__profile__ = {}
-            for key, value in (getattr(instance, self.prop_name, None)
-                               or {}).items():
+            for key, value in (
+                getattr(instance, self.prop_name, None) or {}
+            ).items():
+                if key not in props:
+                    raise UnknownJSONPropertyError(
+                        '`{}` is found in `{}` of instance {}, '
+                        'but it is not defined'.format(
+                            key, self.prop_name, instance
+                        ))
                 instance.__profile__[key] = props[key].decode(value)
         return instance.__profile__
 

tests/test_json.py

@@ -1,6 +1,8 @@
 import pytest
 from datetime import datetime, timedelta
 
+from gino.exceptions import UnknownJSONPropertyError
+
 from .models import db, User, UserType
 
 pytestmark = pytest.mark.asyncio
@@ -167,6 +169,25 @@ class PropsTest(db.Model):
         await PropsTest.gino.drop()
 
 
+# noinspection PyUnusedLocal
+async def test_unknown_properties(bind):
+    from gino.dialects.asyncpg import JSONB
+
+    class PropsTest1(db.Model):
+        __tablename__ = 'props_test1'
+        profile = db.Column(JSONB(), nullable=False, server_default='{}')
+        bool = db.BooleanProperty()
+
+    await PropsTest1.gino.create()
+    try:
+        # bool1 is not defined in the model
+        t = await PropsTest1.create(profile=dict(bool1=True))
+        with pytest.raises(UnknownJSONPropertyError, match=r'bool1.*profile'):
+            t.to_dict()
+    finally:
+        await PropsTest1.gino.drop()
+
+
 async def test_no_profile():
     with pytest.raises(AttributeError, match=r'JSON\[B\] column'):
         # noinspection PyUnusedLocal