feat: SQLAlchemy 2.0 support

.github/workflows/tests.yml

@@ -1,20 +1,15 @@
 name: Tests
 
-on:
-  push:
-    branches:
-      - 'master'
-  pull_request:
-    branches:
-      - '*'
+on: [ push, pull_request ]
+
 jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 10
       matrix:
-        sql-alchemy: ["1.2", "1.3", "1.4"]
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        sql-alchemy: [ "1.2", "1.3", "1.4","2.0" ]
+        python-version: [ "3.7", "3.8", "3.9", "3.10" ]
 
     steps:
       - uses: actions/checkout@v3

graphene_sqlalchemy/batching.py

@@ -5,8 +5,13 @@
 import sqlalchemy
 from sqlalchemy.orm import Session, strategies
 from sqlalchemy.orm.query import QueryContext
+from sqlalchemy.util import immutabledict
 
-from .utils import SQL_VERSION_HIGHER_EQUAL_THAN_1_4, is_graphene_version_less_than
+from .utils import (
+    SQL_VERSION_HIGHER_EQUAL_THAN_1_4,
+    SQL_VERSION_HIGHER_EQUAL_THAN_2,
+    is_graphene_version_less_than,
+)
 
 
 def get_data_loader_impl() -> Any:  # pragma: no cover
@@ -76,7 +81,18 @@ async def batch_load_fn(self, parents):
             query_context = parent_mapper_query._compile_context()
         else:
             query_context = QueryContext(session.query(parent_mapper.entity))
-        if SQL_VERSION_HIGHER_EQUAL_THAN_1_4:
+        if SQL_VERSION_HIGHER_EQUAL_THAN_2:  # pragma: no cover
+            self.selectin_loader._load_for_path(
+                query_context,
+                parent_mapper._path_registry,
+                states,
+                None,
+                child_mapper,
+                None,
+                None,  # recursion depth can be none
+                immutabledict(),  # default value for selectinload->lazyload
+            )
+        elif SQL_VERSION_HIGHER_EQUAL_THAN_1_4:
             self.selectin_loader._load_for_path(
                 query_context,
                 parent_mapper._path_registry,

graphene_sqlalchemy/tests/conftest.py

@@ -3,6 +3,13 @@
 from sqlalchemy import create_engine
 from sqlalchemy.orm import sessionmaker
 
+# fmt: off
+# Fixme remove when https://github.com/kvesteri/sqlalchemy-utils/pull/644 is released #noqa
+import sqlalchemy # noqa  # isort:skip
+if sqlalchemy.__version__ == "2.0.0b3": # noqa  # isort:skip
+    sqlalchemy.__version__ = "2.0.0"    # noqa  # isort:skip
+# fmt: on
+
 import graphene
 from graphene_sqlalchemy.utils import SQL_VERSION_HIGHER_EQUAL_THAN_1_4
 

graphene_sqlalchemy/tests/models.py

@@ -22,6 +22,8 @@
 from sqlalchemy.ext.hybrid import hybrid_property
 from sqlalchemy.orm import backref, column_property, composite, mapper, relationship
 
+from graphene_sqlalchemy.utils import SQL_VERSION_HIGHER_EQUAL_THAN_1_4
+
 PetKind = Enum("cat", "dog", name="pet_kind")
 
 
@@ -116,9 +118,15 @@ def hybrid_prop_bool(self) -> bool:
     def hybrid_prop_list(self) -> List[int]:
         return [1, 2, 3]
 
-    column_prop = column_property(
-        select([func.cast(func.count(id), Integer)]), doc="Column property"
-    )
+    # TODO Remove when switching min sqlalchemy version to SQLAlchemy 1.4
+    if SQL_VERSION_HIGHER_EQUAL_THAN_1_4:
+        column_prop = column_property(
+            select(func.cast(func.count(id), Integer)), doc="Column property"
+        )
+    else:
+        column_prop = column_property(
+            select([func.cast(func.count(id), Integer)]), doc="Column property"
+        )
 
     composite_prop = composite(
         CompositeFullName, first_name, last_name, doc="Composite"
@@ -161,7 +169,11 @@ def __subclasses__(cls):
 
 editor_table = Table("editors", Base.metadata, autoload=True)
 
-mapper(ReflectedEditor, editor_table)
+# TODO Remove when switching min sqlalchemy version to SQLAlchemy 1.4
+if SQL_VERSION_HIGHER_EQUAL_THAN_1_4:
+    Base.registry.map_imperatively(ReflectedEditor, editor_table)
+else:
+    mapper(ReflectedEditor, editor_table)
 
 
 ############################################

graphene_sqlalchemy/tests/models_batching.py

@@ -16,6 +16,8 @@
 from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.orm import column_property, relationship
 
+from graphene_sqlalchemy.utils import SQL_VERSION_HIGHER_EQUAL_THAN_1_4
+
 PetKind = Enum("cat", "dog", name="pet_kind")
 
 
@@ -60,9 +62,14 @@ class Reporter(Base):
     articles = relationship("Article", backref="reporter")
     favorite_article = relationship("Article", uselist=False)
 
-    column_prop = column_property(
-        select([func.cast(func.count(id), Integer)]), doc="Column property"
-    )
+    if SQL_VERSION_HIGHER_EQUAL_THAN_1_4:
+        column_prop = column_property(
+            select(func.cast(func.count(id), Integer)), doc="Column property"
+        )
+    else:
+        column_prop = column_property(
+            select([func.cast(func.count(id), Integer)]), doc="Column property"
+        )
 
 
 class Article(Base):

graphene_sqlalchemy/tests/test_converter.py

@@ -24,6 +24,7 @@
 from ..fields import UnsortedSQLAlchemyConnectionField, default_connection_field_factory
 from ..registry import Registry, get_global_registry
 from ..types import ORMField, SQLAlchemyObjectType
+from ..utils import SQL_VERSION_HIGHER_EQUAL_THAN_1_4, is_sqlalchemy_version_less_than
 from .models import (
     Article,
     CompositeFullName,
@@ -336,6 +337,22 @@ class TestEnum(enum.IntEnum):
     assert graphene_type._meta.enum.__members__["two"].value == 2
 
 
+@pytest.mark.skipif(
+    not SQL_VERSION_HIGHER_EQUAL_THAN_1_4,
+    reason="SQLAlchemy <1.4 does not support this",
+)
+def test_should_columproperty_convert_sqa_20():
+    field = get_field_from_column(
+        column_property(select(func.sum(func.cast(id, types.Integer))).where(id == 1))
+    )
+
+    assert field.type == graphene.Int
+
+
+@pytest.mark.skipif(
+    not is_sqlalchemy_version_less_than("2.0.0b1"),
+    reason="SQLAlchemy >=2.0 does not support this syntax, see convert_sqa_20",
+)
 def test_should_columproperty_convert():
     field = get_field_from_column(
         column_property(select([func.sum(func.cast(id, types.Integer))]).where(id == 1))
@@ -355,10 +372,18 @@ def test_should_jsontype_convert_jsonstring():
     assert get_field(types.JSON).type == graphene.JSONString
 
 
+@pytest.mark.skipif(
+    (not is_sqlalchemy_version_less_than("2.0.0b1")),
+    reason="SQLAlchemy >=2.0 does not support this: Variant is no longer used in SQLAlchemy",
+)
 def test_should_variant_int_convert_int():
     assert get_field(types.Variant(types.Integer(), {})).type == graphene.Int
 
 
+@pytest.mark.skipif(
+    (not is_sqlalchemy_version_less_than("2.0.0b1")),
+    reason="SQLAlchemy >=2.0 does not support this: Variant is no longer used in SQLAlchemy",
+)
 def test_should_variant_string_convert_string():
     assert get_field(types.Variant(types.String(), {})).type == graphene.String
 

graphene_sqlalchemy/utils.py

@@ -26,12 +26,18 @@ def is_graphene_version_less_than(version_string):  # pragma: no cover
 
 SQL_VERSION_HIGHER_EQUAL_THAN_1_4 = False
 
-if not is_sqlalchemy_version_less_than("1.4"):
+if not is_sqlalchemy_version_less_than("1.4"):  # pragma: no cover
     from sqlalchemy.ext.asyncio import AsyncSession
 
     SQL_VERSION_HIGHER_EQUAL_THAN_1_4 = True
 
 
+SQL_VERSION_HIGHER_EQUAL_THAN_2 = False
+
+if not is_sqlalchemy_version_less_than("2.0.0b1"):  # pragma: no cover
+    SQL_VERSION_HIGHER_EQUAL_THAN_2 = True
+
+
 def get_session(context):
     return context.get("session")
 

setup.py

@@ -15,7 +15,7 @@
     # To keep things simple, we only support newer versions of Graphene
     "graphene>=3.0.0b7",
     "promise>=2.3",
-    "SQLAlchemy>=1.1,<2",
+    "SQLAlchemy>=1.1,<2.1",
     "aiodataloader>=0.2.0,<1.0",
 ]
 

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = pre-commit,py{37,38,39,310}-sql{12,13,14}
+envlist = pre-commit,py{37,38,39,310}-sql{12,13,14,20}
 skipsdist = true
 minversion = 3.7.0
 
@@ -15,6 +15,7 @@ SQLALCHEMY =
     1.2: sql12
     1.3: sql13
     1.4: sql14
+    2.0: sql20
 
 [testenv]
 passenv = GITHUB_*
@@ -23,8 +24,11 @@ deps =
     sql12: sqlalchemy>=1.2,<1.3
     sql13: sqlalchemy>=1.3,<1.4
     sql14: sqlalchemy>=1.4,<1.5
+    sql20: sqlalchemy>=2.0.0b3,<2.1
+setenv =
+    SQLALCHEMY_WARN_20 = 1
 commands =
-    pytest graphene_sqlalchemy --cov=graphene_sqlalchemy --cov-report=term --cov-report=xml {posargs}
+    python -W always -m pytest graphene_sqlalchemy --cov=graphene_sqlalchemy --cov-report=term --cov-report=xml {posargs}
 
 [testenv:pre-commit]
 basepython=python3.10