SQLAlchemy JSON support (#40)

Author: Ckk3

.pre-commit-config.yaml

@@ -1,12 +1,12 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: 23.7.0
+    rev: 23.9.1
     hooks:
       - id: black
         exclude: ^tests/\w+/snapshots/
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.0.280
+    rev: v0.0.289
     hooks:
       - id: ruff
         exclude: ^tests/\w+/snapshots/
@@ -18,7 +18,7 @@ repos:
         exclude: (CHANGELOG|TWEET).md
 
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v3.0.0
+    rev: v3.0.3
     hooks:
       - id: prettier
         files: '^docs/.*\.mdx?$'
@@ -33,7 +33,7 @@ repos:
       - id: check-toml
 
   - repo: https://github.com/adamchainz/blacken-docs
-    rev: 1.15.0
+    rev: 1.16.0
     hooks:
       - id: blacken-docs
         args: [--skip-errors]

README.md

@@ -32,19 +32,21 @@ from sqlalchemy.ext.declarative import declarative_base
 
 Base = declarative_base()
 
+
 class Employee(Base):
-    __tablename__ = 'employee'
+    __tablename__ = "employee"
     id = Column(UUID, primary_key=True)
     name = Column(String, nullable=False)
     password_hash = Column(String, nullable=False)
-    department_id = Column(UUID, ForeignKey('department.id'))
-    department = relationship('Department', back_populates='employees')
+    department_id = Column(UUID, ForeignKey("department.id"))
+    department = relationship("Department", back_populates="employees")
+
 
 class Department(Base):
     __tablename__ = "department"
     id = Column(UUID, primary_key=True)
     name = Column(String, nullable=False)
-    employees = relationship('Employee', back_populates='department')
+    employees = relationship("Employee", back_populates="department")
 ```
 
 Next, decorate a type with `strawberry_sqlalchemy_mapper.type()`
@@ -58,6 +60,8 @@ and hybrid properties. For example:
 from strawberry_sqlalchemy_mapper import StrawberrySQLAlchemyMapper
 
 strawberry_sqlalchemy_mapper = StrawberrySQLAlchemyMapper()
+
+
 @strawberry_sqlalchemy_mapper.type(models.Employee)
 class Employee:
     __exclude__ = ["password_hash"]
@@ -67,6 +71,7 @@ class Employee:
 class Department:
     pass
 
+
 @strawberry.type
 class Query:
     @strawberry.field
@@ -81,6 +86,7 @@ class CustomGraphQLView(GraphQLView):
             "sqlalchemy_loader": StrawberrySQLAlchemyLoader(bind=YOUR_SESSION),
         }
 
+
 # call finalize() before using the schema:
 # (note that models that are related to models that are in the schema
 # are automatically mapped at this stage -- e.g., Department is mapped
@@ -144,6 +150,7 @@ SmallInteger: int,
 SQLAlchemyUUID: uuid.UUID,
 VARCHAR: str,
 ARRAY[T]: List[T] # PostgreSQL array
+JSON: JSON # SQLAlchemy JSON
 Enum: (the Python enum it is mapped to, which should be @strawberry.enum-decorated)
 ```
 
@@ -161,28 +168,34 @@ its descendants are expected to inherit from the interface:
 class Book(Model):
     id = Column(UUID, primary_key=True)
 
+
 class Novel(Book):
     pass
 
+
 class ShortStory(Book):
     pass
 
 
 # in another file
 strawberry_sqlalchemy_mapper = StrawberrySQLAlchemyMapper()
 
+
 @strawberry_sqlalchemy_mapper.interface(models.Book)
 class BookInterface:
     pass
 
+
 @strawberry_sqlalchemy_mapper.type(models.Book)
 class Book:
     pass
 
+
 @strawberry_sqlalchemy_mapper.type(models.Novel)
 class Novel:
     pass
 
+
 @strawberry_sqlalchemy_mapper.type(models.ShortStory)
 class ShortStory:
     pass

RELEASE.md

@@ -0,0 +1,3 @@
+Release type: minor
+
+Native SQLAlchemy JSON Conversion Support. Added native support for SQLAlchemy JSON conversions. Now, you'll find that `sqlalchemy.JSON` is converted to `strawberry.scalars.JSON` for enhanced compatibility.

src/strawberry_sqlalchemy_mapper/mapper.py

@@ -32,6 +32,7 @@
 import strawberry
 from sqlalchemy import (
     ARRAY,
+    JSON,
     VARCHAR,
     BigInteger,
     Boolean,
@@ -65,6 +66,7 @@
 from sqlalchemy.sql.type_api import TypeEngine
 from strawberry.annotation import StrawberryAnnotation
 from strawberry.field import StrawberryField
+from strawberry.scalars import JSON as StrawberryJSON
 from strawberry.types import Info
 
 from strawberry_sqlalchemy_mapper.exc import (
@@ -131,6 +133,7 @@ class StrawberrySQLAlchemyMapper(Generic[BaseModelType]):
         SmallInteger: int,
         SQLAlchemyUUID: uuid.UUID,
         VARCHAR: str,
+        JSON: StrawberryJSON,
     }
     #: Mapping from sqlalchemy types to strawberry types
     sqlalchemy_type_to_strawberry_type_map: MutableMapping[

tests/test_mapper.py

@@ -2,9 +2,10 @@
 from typing import List, Optional
 
 import pytest
-from sqlalchemy import Column, Enum, ForeignKey, Integer, String
+from sqlalchemy import JSON, Column, Enum, ForeignKey, Integer, String
 from sqlalchemy.dialects.postgresql.array import ARRAY
 from sqlalchemy.orm import relationship
+from strawberry.scalars import JSON as StrawberryJSON
 from strawberry.type import StrawberryOptional
 from strawberry_sqlalchemy_mapper import StrawberrySQLAlchemyMapper
 
@@ -133,13 +134,31 @@ class ParaLegal(Lawyer):
     assert mapper._get_polymorphic_base_model(ParaLegal) == Employee
 
 
+def test_convert_all_columns_to_strawberry_type(mapper):
+    for (
+        sqlalchemy_type,
+        strawberry_type,
+    ) in mapper.sqlalchemy_type_to_strawberry_type_map.items():
+        assert (
+            mapper._convert_column_to_strawberry_type(
+                Column(sqlalchemy_type, nullable=False)
+            )
+            == strawberry_type
+        )
+
+
 def test_convert_column_to_strawberry_type(mapper):
     int_column = Column(Integer, nullable=False)
     assert mapper._convert_column_to_strawberry_type(int_column) == int
     string_column = Column(String, nullable=False)
     assert mapper._convert_column_to_strawberry_type(string_column) == str
 
 
+def test_convert_json_column_to_strawberry_type(mapper):
+    json_colum = Column(JSON, nullable=False)
+    assert mapper._convert_column_to_strawberry_type(json_colum) == StrawberryJSON
+
+
 def test_convert_array_column_to_strawberry_type(mapper):
     column = Column(ARRAY(String))
     assert mapper._convert_column_to_strawberry_type(column) == Optional[List[str]]