Merge pull request #2 from colelin26/support_sqlalchemy1.4

Support sqlalchemy1.4

Author: richin13

.github/workflows/tests.yml

@@ -8,31 +8,31 @@ jobs:
     strategy:
       max-parallel: 10
       matrix:
-        sql-alchemy: ["1.2", "1.3"]
+        sql-alchemy: ["1.2", "1.3", "1.4"]
         python-version: ["3.6", "3.7", "3.8", "3.9"]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install tox tox-gh-actions
-    - name: Test with tox
-      run: tox
-      env:
-        SQLALCHEMY: ${{ matrix.sql-alchemy }}
-        TOXENV: ${{ matrix.toxenv }}
-    - name: Upload coverage.xml
-      if: ${{ matrix.sql-alchemy == '1.3' && matrix.python-version == '3.9' }}
-      uses: actions/upload-artifact@v2
-      with:
-        name: graphene-sqlalchemy-coverage
-        path: coverage.xml
-        if-no-files-found: error
-    - name: Upload coverage.xml to codecov
-      if: ${{ matrix.sql-alchemy == '1.3' && matrix.python-version == '3.9' }}
-      uses: codecov/codecov-action@v1
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox tox-gh-actions
+      - name: Test with tox
+        run: tox
+        env:
+          SQLALCHEMY: ${{ matrix.sql-alchemy }}
+          TOXENV: ${{ matrix.toxenv }}
+      - name: Upload coverage.xml
+        if: ${{ matrix.sql-alchemy == '1.4' && matrix.python-version == '3.9' }}
+        uses: actions/upload-artifact@v2
+        with:
+          name: graphene-sqlalchemy-coverage
+          path: coverage.xml
+          if-no-files-found: error
+      - name: Upload coverage.xml to codecov
+        if: ${{ matrix.sql-alchemy == '1.4' && matrix.python-version == '3.9' }}
+        uses: codecov/codecov-action@v1

graphene_sqlalchemy/batching.py

@@ -3,6 +3,8 @@
 from sqlalchemy.orm import Session, strategies
 from sqlalchemy.orm.query import QueryContext
 
+from .utils import is_sqlalchemy_version_less_than
+
 
 def get_batch_resolver(relationship_prop):
 
@@ -52,15 +54,30 @@ async def batch_load_fn(self, parents):
             states = [(sqlalchemy.inspect(parent), True) for parent in parents]
 
             # For our purposes, the query_context will only used to get the session
-            query_context = QueryContext(session.query(parent_mapper.entity))
-
-            selectin_loader._load_for_path(
-                query_context,
-                parent_mapper._path_registry,
-                states,
-                None,
-                child_mapper,
-            )
+            query_context = None
+            if is_sqlalchemy_version_less_than('1.4'):
+                query_context = QueryContext(session.query(parent_mapper.entity))
+            else:
+                parent_mapper_query = session.query(parent_mapper.entity)
+                query_context = parent_mapper_query._compile_context()
+
+            if is_sqlalchemy_version_less_than('1.4'):
+                selectin_loader._load_for_path(
+                    query_context,
+                    parent_mapper._path_registry,
+                    states,
+                    None,
+                    child_mapper
+                )
+            else:
+                selectin_loader._load_for_path(
+                    query_context,
+                    parent_mapper._path_registry,
+                    states,
+                    None,
+                    child_mapper,
+                    None
+                )
 
             return [getattr(parent, relationship_prop.key) for parent in parents]
 

graphene_sqlalchemy/tests/test_batching.py

@@ -1,3 +1,4 @@
+import ast
 import contextlib
 import logging
 
@@ -9,8 +10,9 @@
 from ..fields import (BatchSQLAlchemyConnectionField,
                       default_connection_field_factory)
 from ..types import ORMField, SQLAlchemyObjectType
+from ..utils import is_sqlalchemy_version_less_than
 from .models import Article, HairKind, Pet, Reporter
-from .utils import is_sqlalchemy_version_less_than, to_std_dicts
+from .utils import remove_cache_miss_stat, to_std_dicts
 
 
 class MockLoggingHandler(logging.Handler):
@@ -126,26 +128,12 @@ async def test_many_to_one(session_factory):
         assert len(sql_statements) == 1
         return
 
-    assert messages == [
-      'BEGIN (implicit)',
-
-      'SELECT articles.id AS articles_id, '
-      'articles.headline AS articles_headline, '
-      'articles.pub_date AS articles_pub_date, '
-      'articles.reporter_id AS articles_reporter_id \n'
-      'FROM articles',
-      '()',
-
-      'SELECT reporters.id AS reporters_id, '
-      '(SELECT CAST(count(reporters.id) AS INTEGER) AS anon_2 \nFROM reporters) AS anon_1, '
-      'reporters.first_name AS reporters_first_name, '
-      'reporters.last_name AS reporters_last_name, '
-      'reporters.email AS reporters_email, '
-      'reporters.favorite_pet_kind AS reporters_favorite_pet_kind \n'
-      'FROM reporters \n'
-      'WHERE reporters.id IN (?, ?)',
-      '(1, 2)',
-    ]
+    if not is_sqlalchemy_version_less_than('1.4'):
+        messages[2] = remove_cache_miss_stat(messages[2])
+        messages[4] = remove_cache_miss_stat(messages[4])
+
+    assert ast.literal_eval(messages[2]) == ()
+    assert sorted(ast.literal_eval(messages[4])) == [1, 2]
 
     assert not result.errors
     result = to_std_dicts(result.data)
@@ -218,26 +206,12 @@ async def test_one_to_one(session_factory):
         assert len(sql_statements) == 1
         return
 
-    assert messages == [
-      'BEGIN (implicit)',
-
-      'SELECT (SELECT CAST(count(reporters.id) AS INTEGER) AS anon_2 \nFROM reporters) AS anon_1, '
-      'reporters.id AS reporters_id, '
-      'reporters.first_name AS reporters_first_name, '
-      'reporters.last_name AS reporters_last_name, '
-      'reporters.email AS reporters_email, '
-      'reporters.favorite_pet_kind AS reporters_favorite_pet_kind \n'
-      'FROM reporters',
-      '()',
-
-      'SELECT articles.reporter_id AS articles_reporter_id, '
-      'articles.id AS articles_id, '
-      'articles.headline AS articles_headline, '
-      'articles.pub_date AS articles_pub_date \n'
-      'FROM articles \n'
-      'WHERE articles.reporter_id IN (?, ?)',
-      '(1, 2)'
-    ]
+    if not is_sqlalchemy_version_less_than('1.4'):
+        messages[2] = remove_cache_miss_stat(messages[2])
+        messages[4] = remove_cache_miss_stat(messages[4])
+
+    assert ast.literal_eval(messages[2]) == ()
+    assert sorted(ast.literal_eval(messages[4])) == [1, 2]
 
     assert not result.errors
     result = to_std_dicts(result.data)
@@ -322,26 +296,12 @@ async def test_one_to_many(session_factory):
         assert len(sql_statements) == 1
         return
 
-    assert messages == [
-      'BEGIN (implicit)',
-
-      'SELECT (SELECT CAST(count(reporters.id) AS INTEGER) AS anon_2 \nFROM reporters) AS anon_1, '
-      'reporters.id AS reporters_id, '
-      'reporters.first_name AS reporters_first_name, '
-      'reporters.last_name AS reporters_last_name, '
-      'reporters.email AS reporters_email, '
-      'reporters.favorite_pet_kind AS reporters_favorite_pet_kind \n'
-      'FROM reporters',
-      '()',
-
-      'SELECT articles.reporter_id AS articles_reporter_id, '
-      'articles.id AS articles_id, '
-      'articles.headline AS articles_headline, '
-      'articles.pub_date AS articles_pub_date \n'
-      'FROM articles \n'
-      'WHERE articles.reporter_id IN (?, ?)',
-      '(1, 2)'
-    ]
+    if not is_sqlalchemy_version_less_than('1.4'):
+        messages[2] = remove_cache_miss_stat(messages[2])
+        messages[4] = remove_cache_miss_stat(messages[4])
+
+    assert ast.literal_eval(messages[2]) == ()
+    assert sorted(ast.literal_eval(messages[4])) == [1, 2]
 
     assert not result.errors
     result = to_std_dicts(result.data)
@@ -450,31 +410,12 @@ async def test_many_to_many(session_factory):
         assert len(sql_statements) == 1
         return
 
-    assert messages == [
-      'BEGIN (implicit)',
-
-      'SELECT (SELECT CAST(count(reporters.id) AS INTEGER) AS anon_2 \nFROM reporters) AS anon_1, '
-      'reporters.id AS reporters_id, '
-      'reporters.first_name AS reporters_first_name, '
-      'reporters.last_name AS reporters_last_name, '
-      'reporters.email AS reporters_email, '
-      'reporters.favorite_pet_kind AS reporters_favorite_pet_kind \n'
-      'FROM reporters',
-      '()',
-
-      'SELECT reporters_1.id AS reporters_1_id, '
-      'pets.id AS pets_id, '
-      'pets.name AS pets_name, '
-      'pets.pet_kind AS pets_pet_kind, '
-      'pets.hair_kind AS pets_hair_kind, '
-      'pets.reporter_id AS pets_reporter_id \n'
-      'FROM reporters AS reporters_1 '
-      'JOIN association AS association_1 ON reporters_1.id = association_1.reporter_id '
-      'JOIN pets ON pets.id = association_1.pet_id \n'
-      'WHERE reporters_1.id IN (?, ?) '
-      'ORDER BY pets.id',
-      '(1, 2)'
-    ]
+    if not is_sqlalchemy_version_less_than('1.4'):
+        messages[2] = remove_cache_miss_stat(messages[2])
+        messages[4] = remove_cache_miss_stat(messages[4])
+
+    assert ast.literal_eval(messages[2]) == ()
+    assert sorted(ast.literal_eval(messages[4])) == [1, 2]
 
     assert not result.errors
     result = to_std_dicts(result.data)

graphene_sqlalchemy/tests/test_benchmark.py

@@ -4,8 +4,8 @@
 from graphene import relay
 
 from ..types import SQLAlchemyObjectType
+from ..utils import is_sqlalchemy_version_less_than
 from .models import Article, HairKind, Pet, Reporter
-from .utils import is_sqlalchemy_version_less_than
 
 if is_sqlalchemy_version_less_than('1.2'):
     pytest.skip('SQL batching only works for SQLAlchemy 1.2+', allow_module_level=True)

graphene_sqlalchemy/tests/test_converter.py

@@ -47,12 +47,11 @@ class Model(declarative_base()):
     return convert_sqlalchemy_column(column_prop, get_global_registry(), mock_resolver)
 
 
-def _test_should_unknown_sqlalchemy_field_raise_exception():
-    # TODO: SQLALchemy does not export types.Binary, remove or update this test
+def test_should_unknown_sqlalchemy_field_raise_exception():
     re_err = "Don't know how to convert the SQLAlchemy field"
     with pytest.raises(Exception, match=re_err):
         # support legacy Binary type and subsequent LargeBinary
-        get_field(getattr(types, 'LargeBinary', types.Binary)())
+        get_field(getattr(types, 'LargeBinary', types.BINARY)())
 
 
 def test_should_date_convert_string():

graphene_sqlalchemy/tests/utils.py

@@ -1,4 +1,4 @@
-import pkg_resources
+import re
 
 
 def to_std_dicts(value):
@@ -11,6 +11,7 @@ def to_std_dicts(value):
         return value
 
 
-def is_sqlalchemy_version_less_than(version_string):
-    """Check the installed SQLAlchemy version"""
-    return pkg_resources.get_distribution('SQLAlchemy').parsed_version < pkg_resources.parse_version(version_string)
+def remove_cache_miss_stat(message):
+    """Remove the stat from the echoed query message when the cache is missed for sqlalchemy version >= 1.4"""
+    # https://github.com/sqlalchemy/sqlalchemy/blob/990eb3d8813369d3b8a7776ae85fb33627443d30/lib/sqlalchemy/engine/default.py#L1177
+    return re.sub(r"\[generated in \d+.?\d*s\]\s", "", message)

graphene_sqlalchemy/utils.py

@@ -1,6 +1,7 @@
 import re
 import warnings
 
+import pkg_resources
 from sqlalchemy.exc import ArgumentError
 from sqlalchemy.orm import class_mapper, object_mapper
 from sqlalchemy.orm.exc import UnmappedClassError, UnmappedInstanceError
@@ -140,3 +141,8 @@ def sort_argument_for_model(cls, has_default=True):
         enum.default = None
 
     return Argument(List(enum), default_value=enum.default)
+
+
+def is_sqlalchemy_version_less_than(version_string):
+    """Check the installed SQLAlchemy version"""
+    return pkg_resources.get_distribution('SQLAlchemy').parsed_version < pkg_resources.parse_version(version_string)

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,<1.4",
+    "SQLAlchemy>=1.1,<2",
     "aiodataloader>=0.2.0,<1.0",
 ]
 

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = pre-commit,py{36,37,38}-sql{11,12,13,14}
+envlist = pre-commit,py{36,37,38,39}-sql{11,12,13,14}
 skipsdist = true
 minversion = 3.7.0
 
@@ -16,6 +16,7 @@ python =
 SQLALCHEMY =
     1.2: sql12
     1.3: sql13
+    1.4: sql14
 
 [testenv]
 passenv = GITHUB_*