v0.4.0 - Async BugFixes & Optimisations

.github/workflows/ci.yml

@@ -17,17 +17,17 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python: ["3.8", "3.9", "3.10", "3.11","3.12"]
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python }}
       uses: actions/setup-python@v3
       with:
         python-version: ${{ matrix.python }}
-    - name: Lint with flake8
+    - name: Lint with ruff
       run: |
-        python -m pip install flake8
+        python -m pip install ruff
         make lint
     - name: Install dependencies
       run: |

.github/workflows/lint.yml

@@ -11,17 +11,15 @@ jobs:
   build:
     strategy:
       matrix:
-        python: ["3.11"]
+        python: ["3.12"]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python
       uses: actions/setup-python@v3
       with:
         python-version: ${{ matrix.python }}
-    - name: Install dependencies
+    - name: Lint with ruff
       run: |
-        python -m pip install --upgrade pip
-        pip install flake8
-    - name: Lint with flake8
-      run: make lint
+        python -m pip install ruff
+        make lint

Makefile

@@ -11,7 +11,8 @@ clean:
 	@find . -name "__pycache__" -delete
 
 lint:
-	@flake8 graphene_mongo --count --show-source --statistics
+	@ruff check graphene_mongo
+	@ruff format . --check
 
 test: clean
 	pytest graphene_mongo/tests --cov=graphene_mongo --cov-report=html --cov-report=term

README.md

@@ -6,7 +6,6 @@
 
 A [Mongoengine](https://mongoengine-odm.readthedocs.io/) integration for [Graphene](http://graphene-python.org/).
 
-
 ## Installation
 
 For installing graphene-mongo, just run this command in your shell
@@ -23,13 +22,14 @@ Here is a simple Mongoengine model as `models.py`:
 from mongoengine import Document
 from mongoengine.fields import StringField
 
+
 class User(Document):
     meta = {'collection': 'user'}
     first_name = StringField(required=True)
     last_name = StringField(required=True)
 ```
 
-To create a GraphQL schema for it you simply have to write the following:
+To create a GraphQL schema and sync executor; for it you simply have to write the following:
 
 ```python
 import graphene
@@ -38,15 +38,60 @@ from graphene_mongo import MongoengineObjectType
 
 from .models import User as UserModel
 
+
 class User(MongoengineObjectType):
     class Meta:
         model = UserModel
 
+
 class Query(graphene.ObjectType):
     users = graphene.List(User)
-    
+
     def resolve_users(self, info):
-    	return list(UserModel.objects.all())
+        return list(UserModel.objects.all())
+
+
+schema = graphene.Schema(query=Query)
+```
+
+Then you can simply query the schema:
+
+```python
+query = '''
+    query {
+        users {
+            firstName,
+            lastName
+        }
+    }
+'''
+result = await schema.execute(query)
+```
+
+To create a GraphQL schema and async executor; for it you simply have to write the following:
+
+```python
+import graphene
+
+from graphene_mongo import AsyncMongoengineObjectType
+from asgiref.sync import sync_to_async
+from concurrent.futures import ThreadPoolExecutor
+
+from .models import User as UserModel
+
+
+class User(AsyncMongoengineObjectType):
+    class Meta:
+        model = UserModel
+
+
+class Query(graphene.ObjectType):
+    users = graphene.List(User)
+
+    async def resolve_users(self, info):
+        return await sync_to_async(list, thread_sensitive=False,
+                             executor=ThreadPoolExecutor())(UserModel.objects.all())
+
 
 schema = graphene.Schema(query=Query)
 ```
@@ -71,7 +116,6 @@ To learn more check out the following [examples](examples/):
 * [Django MongoEngine example](examples/django_mongoengine)
 * [Falcon MongoEngine example](examples/falcon_mongoengine)
 
-
 ## Contributing
 
 After cloning this repo, ensure dependencies are installed by running:

docs/conf.py

@@ -60,18 +60,18 @@
 master_doc = "index"
 
 # General information about the project.
-project = u"Graphene Mongo"
-copyright = u"Graphene 2018"
-author = u"Abaw Chen"
+project = "Graphene Mongo"
+copyright = "Graphene 2018"
+author = "Abaw Chen"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u"0.1"
+version = "0.1"
 # The full version, including alpha/beta/rc tags.
-release = u"0.1.2"
+release = "0.1.2"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -275,9 +275,7 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    (master_doc, "Graphene.tex", u"Graphene Documentation", u"Syrus Akbary", "manual")
-]
+latex_documents = [(master_doc, "Graphene.tex", "Graphene Documentation", "Syrus Akbary", "manual")]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
@@ -316,9 +314,7 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, "graphene_django", u"Graphene Django Documentation", [author], 1)
-]
+man_pages = [(master_doc, "graphene_django", "Graphene Django Documentation", [author], 1)]
 
 # If true, show URL addresses after external links.
 #
@@ -334,7 +330,7 @@
     (
         master_doc,
         "Graphene-Django",
-        u"Graphene Django Documentation",
+        "Graphene Django Documentation",
         author,
         "Graphene Django",
         "One line description of project.",

examples/django_mongoengine/bike/urls.py

@@ -3,7 +3,5 @@
 from graphene_django.views import GraphQLView
 
 urlpatterns = [
-    path(
-        "graphql", csrf_exempt(GraphQLView.as_view(graphiql=True)), name="graphql-query"
-    )
+    path("graphql", csrf_exempt(GraphQLView.as_view(graphiql=True)), name="graphql-query")
 ]

examples/django_mongoengine/bike_catalog/settings.py

@@ -85,9 +85,7 @@
 # https://docs.djangoproject.com/en/2.2/ref/settings/#auth-password-validators
 
 AUTH_PASSWORD_VALIDATORS = [
-    {
-        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"
-    },
+    {"NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"},
     {"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator"},
     {"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator"},
     {"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator"},

examples/django_mongoengine/bike_catalog/settings_test.py

@@ -1,5 +1,3 @@
 from .settings import *  # flake8: noqa
 
-mongoengine.connect(
-    "graphene-mongo-test", host="mongomock://localhost", alias="default"
-)
+mongoengine.connect("graphene-mongo-test", host="mongomock://localhost", alias="default")

examples/falcon_mongoengine/api.py

@@ -3,9 +3,7 @@
 from .schema import schema
 
 
-def set_graphql_allow_header(
-    req: falcon.Request, resp: falcon.Response, resource: object
-):
+def set_graphql_allow_header(req: falcon.Request, resp: falcon.Response, resource: object):
     resp.set_header("Allow", "GET, POST, OPTIONS")
 
 

examples/falcon_mongoengine/tests/tests.py

@@ -1,11 +1,10 @@
 import mongoengine
 from graphene.test import Client
+
 from examples.falcon_mongoengine.schema import schema
 from .fixtures import fixtures_data
 
-mongoengine.connect(
-    "graphene-mongo-test", host="mongomock://localhost", alias="default"
-)
+mongoengine.connect("graphene-mongo-test", host="mongomock://localhost", alias="default")
 
 
 def test_category_last_1_item_query(fixtures_data):
@@ -23,7 +22,16 @@ def test_category_last_1_item_query(fixtures_data):
 
     expected = {
         "data": {
-            "categories": {"edges": [{"node": {"name": "Work", "color": "#1769ff"}}]}
+            "categories": {
+                "edges": [
+                    {
+                        "node": {
+                            "name": "Work",
+                            "color": "#1769ff",
+                        }
+                    }
+                ]
+            }
         }
     }
 
@@ -45,11 +53,7 @@ def test_category_filter_item_query(fixtures_data):
                }
            }"""
 
-    expected = {
-        "data": {
-            "categories": {"edges": [{"node": {"name": "Work", "color": "#1769ff"}}]}
-        }
-    }
+    expected = {"data": {"categories": {"edges": [{"node": {"name": "Work", "color": "#1769ff"}}]}}}
 
     client = Client(schema)
     result = client.execute(query)

examples/falcon_mongoengine/types.py

@@ -1,8 +1,7 @@
-import graphene
 from graphene import relay
-from graphene_mongo import MongoengineObjectType
 
-from .models import Category, Bookmark
+from graphene_mongo import MongoengineObjectType
+from .models import Bookmark, Category
 
 
 class CategoryType(MongoengineObjectType):

examples/flask_mongoengine/app.py

@@ -42,9 +42,7 @@
   }
 }""".strip()
 
-app.add_url_rule(
-    "/graphql", view_func=GraphQLView.as_view("graphql", schema=schema, graphiql=True)
-)
+app.add_url_rule("/graphql", view_func=GraphQLView.as_view("graphql", schema=schema, graphiql=True))
 
 if __name__ == "__main__":
     init_db()

examples/flask_mongoengine/models.py

@@ -10,25 +10,21 @@
 
 
 class Department(Document):
-
     meta = {"collection": "department"}
     name = StringField()
 
 
 class Role(Document):
-
     meta = {"collection": "role"}
     name = StringField()
 
 
 class Task(EmbeddedDocument):
-
     name = StringField()
     deadline = DateTimeField(default=datetime.now)
 
 
 class Employee(Document):
-
     meta = {"collection": "employee"}
     name = StringField()
     hired_on = DateTimeField(default=datetime.now)

examples/flask_mongoengine/schema.py

@@ -1,6 +1,5 @@
 import graphene
 from graphene.relay import Node
-from graphene_mongo.tests.nodes import PlayerNode, ReporterNode
 
 from graphene_mongo import MongoengineConnectionField, MongoengineObjectType
 from .models import Department as DepartmentModel
@@ -20,7 +19,11 @@ class Meta:
         model = RoleModel
         interfaces = (Node,)
         filter_fields = {
-            'name': ['exact', 'icontains', 'istartswith']
+            "name": [
+                "exact",
+                "icontains",
+                "istartswith",
+            ]
         }
 
 
@@ -35,7 +38,11 @@ class Meta:
         model = EmployeeModel
         interfaces = (Node,)
         filter_fields = {
-            'name': ['exact', 'icontains', 'istartswith']
+            "name": [
+                "exact",
+                "icontains",
+                "istartswith",
+            ]
         }
 
 

graphene_mongo/__init__.py

@@ -1,13 +1,17 @@
 from .fields import MongoengineConnectionField
+from .fields_async import AsyncMongoengineConnectionField
 
 from .types import MongoengineObjectType, MongoengineInputType, MongoengineInterfaceType
+from .types_async import AsyncMongoengineObjectType
 
 __version__ = "0.1.1"
 
 __all__ = [
     "__version__",
     "MongoengineObjectType",
+    "AsyncMongoengineObjectType",
     "MongoengineInputType",
     "MongoengineInterfaceType",
-    "MongoengineConnectionField"
-    ]
+    "MongoengineConnectionField",
+    "AsyncMongoengineConnectionField",
+]