Merge pull request #76 from passren/0.7.6

0.7.6

Author: passren

.github/workflows/run-test.yaml

@@ -5,6 +5,9 @@ on:
     branches:
       - "*"
 
+  schedule:
+    - cron: '0 3 * * 1'
+
 jobs:
   pytest:
     runs-on: ubuntu-latest
@@ -56,7 +59,7 @@ jobs:
         run: |
           pip install pytest
           pip install pytest-cov
-          pip install moto[sts]==4.2.0
+          pip install moto[sts]
           pytest --cov=pydynamodb --cov-report=xml tests/
       - name: Install sqlalchemy 2.x
         run: |

pydynamodb/__init__.py

@@ -6,7 +6,7 @@
 if TYPE_CHECKING:
     from .connection import Connection
 
-__version__: str = "0.7.5"
+__version__: str = "0.7.6"
 
 # Globals https://www.python.org/dev/peps/pep-0249/#globals
 apilevel: str = "2.0"

pydynamodb/sqlalchemy_dynamodb/pydynamodb.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 import re
+import json
 from ..util import strtobool
 from typing import TYPE_CHECKING, cast, Optional, Sequence, List
 
@@ -36,6 +37,30 @@ def _check_sqla_major_ver():  # pragma: no cover
     from sqlalchemy.sql.compiler import InsertmanyvaluesSentinelOpts, _InsertManyValues
 
 
+class DynamoDBJSON(types.JSON):
+    """Custom JSON type for DynamoDB that handles SQLAlchemy 1.x compatibility."""
+
+    def result_processor(self, dialect, coltype):
+        string_process = self._str_impl.result_processor(dialect, coltype)
+        json_deserializer = dialect._json_deserializer or json.loads
+
+        def process(value):
+            if value is None:
+                return None
+
+            if isinstance(value, dict):
+                return value
+
+            if isinstance(value, str) and _SQLALCHEMY_MAJOR_VERSION < 2:
+                value = value.encode("utf-8")
+
+            if string_process:
+                value = string_process(value)
+            return json_deserializer(value)
+
+        return process
+
+
 class DynamoDBIdentifierPreparer(IdentifierPreparer):
     reserved_words = RESERVED_WORDS
 
@@ -621,8 +646,29 @@ class DynamoDBDialect(DefaultDialect):
     description_encoding = None
     postfetch_lastrowid = False
 
+    # Custom type mapping for SQLAlchemy compatibility
+    colspecs = {
+        types.JSON: DynamoDBJSON,
+    }
+
     _connect_options = dict()  # type: ignore
 
+    def __init__(
+        self,
+        json_serializer=None,
+        json_deserializer=None,
+        _json_serializer=None,
+        _json_deserializer=None,
+        **kwargs,
+    ):
+        DefaultDialect.__init__(self, **kwargs)
+        if _json_serializer:
+            json_serializer = _json_serializer
+        if _json_deserializer:
+            json_deserializer = _json_deserializer
+        self._json_serializer = json_serializer
+        self._json_deserializer = json_deserializer
+
     @classmethod
     def dbapi(cls):
         return pydynamodb

tests/test_connection.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 import contextlib
-from moto import mock_sts
+from moto import mock_aws
 
 TESTCASE01_TABLE = "pydynamodb_test_case01"
 
@@ -192,7 +192,7 @@ class TestConnectionWithSTS:
     TEST_WEB_IDENTITY_TOKEN = "Atza%7CIQEBLjAsAhRFiXuWpUXuRvQ9PZL3GMFcYevydwIUFAHZwXZXXXXXXXXJnrulxKDHwy87oGKPznh0D6bEQZTSCzyoCtL_8S07pLpr0zMbn6w1lfVZKNTBdDansFBmtGnIsIapjI6xKR02Yc_2bQ8LZbUXSGm6Ry6_BG7PrtLZtj_dfCTj92xNGed-CrKqjG7nPBjNIL016GGvuS5gSvPRUxWES3VYfm1wl7WTI7jn-Pcb6M-buCgHhFOzTQxod27L9CqnOLio7N3gZAGpsp6n1-AJBOCJckcyXe2c6uD0srOJeZlKUm2eTDVMf8IehDVI0r1QOnTV6KzzAI3OY87Vd_cVMQ"
     TEST_PROVIDER_ID = "www.amazon.com"
 
-    @mock_sts
+    @mock_aws
     def test_conn_with_credentials(self):
         from pydynamodb import connect
 
@@ -258,7 +258,7 @@ def test_conn_with_credentials(self):
         assert conn._session_kwargs["aws_secret_access_key"] is not None
         assert conn._session_kwargs["aws_session_token"] is not None
 
-    @mock_sts
+    @mock_aws
     def test_conn_with_sqlalchemy(self):
         from pydynamodb import sqlalchemy_dynamodb  # noqa
         import sqlalchemy  # noqa

tests/test_sqlalchemy_dynamodb.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 from sqlalchemy.sql import text, select
 from sqlalchemy.sql.schema import Column, MetaData, Table
-from sqlalchemy import Integer, String, Numeric
+from sqlalchemy import Integer, String, Numeric, JSON
 from sqlalchemy.orm import declarative_base, Session
 
 Base = declarative_base()
@@ -19,6 +19,7 @@ class _TestCase02(Base):
     col_str = Column(String)
     col_num = Column(Numeric)
     col_nested = Column()
+    col_json = Column(JSON)
 
 class _User(Base):
     __tablename__ = USER_TABLE
@@ -109,7 +110,7 @@ def test_nested_data_insert(self, engine):
             """
         INSERT INTO "%s" VALUE {
             'key_partition': :pk, 'key_sort': :sk,
-            'col_str': :col1, 'col_nested': :col2
+            'col_str': :col1, 'col_nested': :col2, 'col_json': :col3
         }
         """
             % TESTCASE02_TABLE
@@ -124,13 +125,14 @@ def test_nested_data_insert(self, engine):
             "sk": 0,
             "col1": "test case nested 0",
             "col2": nested_data,
+            "col3": nested_data,
         }
         conn.execute(text(sql_one_row_2_0_), params_2_0_)
 
         rows = conn.execute(
             text(
                 """
-            SELECT col_nested FROM %s WHERE key_partition = :pk
+            SELECT col_nested, col_json FROM %s WHERE key_partition = :pk
             AND key_sort = :sk
             """
                 % TESTCASE02_TABLE
@@ -139,6 +141,7 @@ def test_nested_data_insert(self, engine):
         ).fetchall()
         assert len(rows) == 1
         assert rows[0][0] == nested_data
+        assert rows[0][1] == nested_data
 
     def test_declarative_table_insert(self, engine):
         engine, conn = engine
@@ -150,6 +153,7 @@ def test_declarative_table_insert(self, engine):
                 test_case02.key_sort = i
                 test_case02.col_str = "test case declarative table " + str(i)
                 test_case02.col_num = i
+                test_case02.col_json = {"key": "value"}
                 session.add(test_case02)
             session.commit()
 
@@ -176,6 +180,7 @@ def test_declarative_table_update(self, engine):
             ).one()
             test_case.col_str = "test case declarative table 99"
             test_case.col_num = 99
+            test_case.col_json = {"key": "value updated"}
             session.commit()
 
         rows = conn.execute(
@@ -192,6 +197,24 @@ def test_declarative_table_update(self, engine):
         assert len(rows) == 1
         assert rows[0][2] == "test case declarative table 99"
         assert rows[0][3] == 99
+        assert rows[0][5] == '{"key": "value updated"}'
+
+    def test_declarative_table_select(self, engine):
+        engine, _ = engine
+
+        with Session(engine) as session:
+            test_case = session.scalars(
+                select(_TestCase02).where(
+                    _TestCase02.key_partition == "test_one_row_3",
+                    _TestCase02.key_sort == 4,
+                )
+            ).one()
+        assert test_case.key_partition == "test_one_row_3"
+        assert test_case.key_sort == 4
+        assert test_case.col_str == "test case declarative table 4"
+        assert test_case.col_num == 4
+        assert test_case.col_nested is None
+        assert test_case.col_json == {"key": "value"}
 
     def test_declarative_table_delete(self, engine):
         engine, _ = engine
@@ -260,11 +283,13 @@ def test_reflect_table(self, engine):
             Column("key_sort", Integer),
             Column("col_str", String),
             Column("col_num", Numeric),
+            Column("col_json", JSON)
         )
-        assert len(table.c) == 4
+        assert len(table.c) == 5
 
         rows = conn.execute(table.select()).fetchall()
         assert len(rows) == 10
+        assert rows[7][4] == {"key": "value updated"}
 
         rows = conn.execute(
             table.select().where(