Add SQLAlchemyList and SQLAlchemyMutation types

This brings default support for fields filtering and ordering on queries and mutations.

Author: Toilal

graphene_sqlalchemy/mutations.py

@@ -0,0 +1,208 @@
+from graphene import Mutation, Argument, Field
+from sqlalchemy.inspection import inspect as sqlalchemyinspect
+
+from graphene.types.objecttype import ObjectTypeOptions
+from graphene.types.utils import yank_fields_from_attrs
+from sqlalchemy.inspection import inspect as sqlalchemyinspect
+
+from graphene_sqlalchemy.types import construct_fields
+from .registry import get_global_registry
+from .utils import get_session
+
+
+class SQLAlchemyMutationOptions(ObjectTypeOptions):
+    model = None  # type: Model
+
+
+class SQLAlchemyCreate(Mutation):
+    @classmethod
+    def __init_subclass_with_meta__(cls, model=None, registry=None, only_fields=(), exclude_fields=None, **options):
+        meta = SQLAlchemyMutationOptions(cls)
+        meta.model = model
+
+        model_inspect = sqlalchemyinspect(model)
+        cls._model_inspect = model_inspect
+
+        if not isinstance(exclude_fields, list):
+            if exclude_fields:
+                exclude_fields = list(exclude_fields)
+            else:
+                exclude_fields = []
+
+        for primary_key_column in model_inspect.primary_key:
+            if primary_key_column.autoincrement:
+                exclude_fields.append(primary_key_column.name)
+
+        for relationship in model_inspect.relationships:
+            exclude_fields.append(relationship.key)
+
+        if not registry:
+            registry = get_global_registry()
+
+        arguments = yank_fields_from_attrs(
+            construct_fields(model, registry, only_fields, exclude_fields),
+            _as=Argument,
+        )
+
+        super(SQLAlchemyCreate, cls).__init_subclass_with_meta__(_meta=meta, arguments=arguments, **options)
+
+    @classmethod
+    def mutate(cls, self, info, **kwargs):
+        session = get_session(info.context)
+
+        meta = cls._meta
+
+        model = meta.model()
+        session.add(model)
+
+        for key, value in kwargs.items():
+            setattr(model, key, value)
+
+        session.commit()
+
+        return model
+
+    @classmethod
+    def Field(cls, *args, **kwargs):
+        return Field(
+            cls._meta.output, args=cls._meta.arguments, resolver=cls._meta.resolver
+        )
+
+
+class SQLAlchemyUpdate(Mutation):
+    @classmethod
+    def __init_subclass_with_meta__(cls, model=None, registry=None, only_fields=(), exclude_fields=None, **options):
+        meta = SQLAlchemyMutationOptions(cls)
+        meta.model = model
+
+        model_inspect = sqlalchemyinspect(model)
+        cls._model_inspect = model_inspect
+
+        if not registry:
+            registry = get_global_registry()
+
+        if not isinstance(exclude_fields, list):
+            if exclude_fields:
+                exclude_fields = list(exclude_fields)
+            else:
+                exclude_fields = []
+
+        for relationship in model_inspect.relationships:
+            exclude_fields.append(relationship.key)
+
+        arguments = yank_fields_from_attrs(
+            construct_fields(model, registry, only_fields, exclude_fields),
+            _as=Argument
+        )
+
+        super(SQLAlchemyUpdate, cls).__init_subclass_with_meta__(_meta=meta, arguments=arguments, **options)
+
+    @classmethod
+    def mutate(cls, self, info, **kwargs):
+        session = get_session(info.context)
+
+        meta = cls._meta
+
+        query = session.query(meta.model)
+        for primary_key_column in cls._model_inspect.primary_key:
+            query = query.filter(getattr(meta.model, primary_key_column.key) == kwargs[primary_key_column.name])
+        model = query.one()
+
+        for key, value in kwargs.items():
+            setattr(model, key, value)
+
+        session.commit()
+
+        return model
+
+    @classmethod
+    def Field(cls, *args, **kwargs):
+        return Field(
+            cls._meta.output, args=cls._meta.arguments, resolver=cls._meta.resolver
+        )
+
+
+class SQLAlchemyDeleteOptions(SQLAlchemyMutationOptions):
+    from_primary_key = True
+
+
+class SQLAlchemyDelete(Mutation):
+    @classmethod
+    def __init_subclass_with_meta__(cls, model=None, from_primary_key=True, registry=None, only_fields=(),
+                                    exclude_fields=None, **options):
+        meta = SQLAlchemyMutationOptions(cls)
+        meta.model = model
+        meta.from_primary_key = from_primary_key
+
+        model_inspect = sqlalchemyinspect(model)
+        cls._model_inspect = model_inspect
+
+        only_fields = []
+        exclude_fields = ()
+        if from_primary_key:
+            for primary_key_column in model_inspect.primary_key:
+                only_fields.append(primary_key_column.name)
+
+        if not registry:
+            registry = get_global_registry()
+
+        arguments = yank_fields_from_attrs(
+            construct_fields(model, registry, only_fields, exclude_fields),
+            _as=Argument
+        )
+
+        super(SQLAlchemyDelete, cls).__init_subclass_with_meta__(_meta=meta, arguments=arguments, **options)
+
+    @classmethod
+    def mutate(cls, self, info, **kwargs):
+        session = get_session(info.context)
+
+        meta = cls._meta
+
+        query = session.query(meta.model)
+        for primary_key_column in cls._model_inspect.primary_key:
+            query = query.filter(getattr(meta.model, primary_key_column.key) == kwargs[primary_key_column.name])
+        model = query.one()
+        session.delete(model)
+
+        session.commit()
+
+        return model
+
+    @classmethod
+    def Field(cls, *args, **kwargs):
+        return Field(
+            cls._meta.output, args=cls._meta.arguments, resolver=cls._meta.resolver
+        )
+
+
+def create(of_type):
+    class CreateModel(SQLAlchemyCreate):
+        class Meta:
+            model = of_type._meta.model
+
+        Output = of_type
+
+    return CreateModel.Field()
+
+
+def update(of_type):
+    class UpdateModel(SQLAlchemyUpdate):
+        class Meta:
+            model = of_type._meta.model
+
+        Output = of_type
+
+    return UpdateModel.Field()
+
+
+def delete(of_type, from_primary_key=True):
+    class DeleteModel(SQLAlchemyDelete):
+        class Meta:
+            nonlocal from_primary_key
+            model = of_type._meta.model
+            from_primary_key = from_primary_key
+
+        Output = of_type
+
+    return DeleteModel.Field()

graphene_sqlalchemy/tests/conftest.py

@@ -0,0 +1,7 @@
+import pytest
+from sqlalchemy import create_engine
+
+
+@pytest.fixture(scope='session')
+def db():
+    return create_engine('sqlite:///test_sqlalchemy.sqlite3')