Merge branch 'main' into feature/django-forms-inputobjecttype

Author: firaskafri

.github/ISSUE_TEMPLATE/bug_report.md

@@ -27,8 +27,8 @@ a github repo, https://repl.it or similar (you can use this template as a starti
 
 
 * **Please tell us about your environment:**
-  
-  - Version: 
-  - Platform: 
+
+  - Version:
+  - Platform:
 
 * **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow)

.github/workflows/lint.yml

@@ -16,7 +16,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install tox
-    - name: Run lint 💅
+    - name: Run pre-commit 💅
       run: tox
       env:
-        TOXENV: flake8
+        TOXENV: pre-commit

.github/workflows/tests.yml

@@ -8,15 +8,11 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        django: ["2.2", "3.0", "3.1", "3.2"]
-        python-version: ["3.6", "3.7", "3.8", "3.9"]
+        django: ["3.2", "4.0", "4.1"]
+        python-version: ["3.8", "3.9", "3.10"]
         include:
           - django: "3.2"
-            python-version: "3.10"
-          - django: "4.0"
-            python-version: "3.10"
-          - django: "main"
-            python-version: "3.10"
+            python-version: "3.7"
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}

.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+default_language_version:
+  python: python3.9
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+    -   id: check-merge-conflict
+    -   id: check-json
+    -   id: check-yaml
+    -   id: debug-statements
+    -   id: end-of-file-fixer
+        exclude: ^docs/.*$
+    -   id: pretty-format-json
+        args:
+        - --autofix
+    -   id: trailing-whitespace
+        exclude: README.md
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v3.2.0
+    hooks:
+    -   id: pyupgrade
+        args: [--py37-plus]
+-   repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+    -   id: black
+-   repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
+    hooks:
+    -   id: flake8

CONTRIBUTING.md

@@ -59,4 +59,4 @@ Then to produce a HTML version of the documentation:
 
 ```sh
 make html
-```
+```

MANIFEST.in

@@ -3,4 +3,4 @@ recursive-include graphene_django/templates *
 recursive-include graphene_django/static *
 
 include examples/cookbook/cookbook/ingredients/fixtures/ingredients.json
-include examples/cookbook-plain/cookbook/ingredients/fixtures/ingredients.json
+include examples/cookbook-plain/cookbook/ingredients/fixtures/ingredients.json

Makefile

@@ -1,22 +1,21 @@
+.PHONY: help
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@grep -E '^\.PHONY: [a-zA-Z_-]+ .*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = "(: |##)"}; {printf "\033[36m%-30s\033[0m %s\n", $$2, $$3}'
+
 .PHONY: dev-setup ## Install development dependencies
 dev-setup:
 	pip install -e ".[dev]"
 
-.PHONY: install-dev
-install-dev: dev-setup  # Alias install-dev -> dev-setup
-
-.PHONY: tests
+.PHONY: tests ## Run unit tests
 tests:
 	py.test graphene_django --cov=graphene_django -vv
 
-.PHONY: test
-test: tests  # Alias test -> tests
-
-.PHONY: format
+.PHONY: format ## Format code
 format:
-	black --exclude "/migrations/" graphene_django examples setup.py
+	black graphene_django examples setup.py
 
-.PHONY: lint
+.PHONY: lint ## Lint code
 lint:
 	flake8 graphene_django examples
 

docs/queries.rst

@@ -151,7 +151,7 @@ For example the following ``Model`` and ``DjangoObjectType``:
 
 Results in the following GraphQL schema definition:
 
-.. code::
+.. code:: graphql
 
    type Pet {
      id: ID!
@@ -178,7 +178,7 @@ You can disable this automatic conversion by setting
             fields = ("id", "kind",)
             convert_choices_to_enum = False
 
-.. code::
+.. code:: graphql
 
   type Pet {
     id: ID!
@@ -313,7 +313,7 @@ Additionally, Resolvers will receive **any arguments declared in the field defin
             bar=graphene.Int()
         )
 
-        def resolve_question(root, info, foo, bar):
+        def resolve_question(root, info, foo=None, bar=None):
             # If `foo` or `bar` are declared in the GraphQL query they will be here, else None.
             return Question.objects.filter(foo=foo, bar=bar).first()
 
@@ -336,12 +336,12 @@ of Django's ``HTTPRequest`` in your resolve methods, such as checking for authen
     class Query(graphene.ObjectType):
         questions = graphene.List(QuestionType)
 
-    def resolve_questions(root, info):
-        # See if a user is authenticated
-        if info.context.user.is_authenticated():
-            return Question.objects.all()
-        else:
-            return Question.objects.none()
+        def resolve_questions(root, info):
+            # See if a user is authenticated
+            if info.context.user.is_authenticated():
+                return Question.objects.all()
+            else:
+                return Question.objects.none()
 
 
 DjangoObjectTypes
@@ -418,29 +418,29 @@ the core graphene pages for more information on customizing the Relay experience
 You can now execute queries like:
 
 
-.. code:: python
+.. code:: graphql
 
     {
         questions (first: 2, after: "YXJyYXljb25uZWN0aW9uOjEwNQ==") {
             pageInfo {
-            startCursor
-            endCursor
-            hasNextPage
-            hasPreviousPage
+                startCursor
+                endCursor
+                hasNextPage
+                hasPreviousPage
             }
             edges {
-            cursor
-            node {
-                id
-                question_text
-            }
+                cursor
+                node {
+                    id
+                    question_text
+                }
             }
         }
     }
 
 Which returns:
 
-.. code:: python
+.. code:: json
 
     {
         "data": {

docs/schema.py

@@ -1,60 +1,57 @@
-  import graphene
+import graphene
 
-  from graphene_django.types import DjangoObjectType
+from graphene_django.types import DjangoObjectType
 
-  from cookbook.ingredients.models import Category, Ingredient
+from cookbook.ingredients.models import Category, Ingredient
 
 
-  class CategoryType(DjangoObjectType):
-      class Meta:
-          model = Category
-          fields = '__all__'
+class CategoryType(DjangoObjectType):
+    class Meta:
+        model = Category
+        fields = "__all__"
 
 
-  class IngredientType(DjangoObjectType):
-      class Meta:
-          model = Ingredient
-          fields = '__all__'
+class IngredientType(DjangoObjectType):
+    class Meta:
+        model = Ingredient
+        fields = "__all__"
 
 
-  class Query(object):
-      category = graphene.Field(CategoryType,
-                                id=graphene.Int(),
-                                name=graphene.String())
-      all_categories = graphene.List(CategoryType)
+class Query:
+    category = graphene.Field(CategoryType, id=graphene.Int(), name=graphene.String())
+    all_categories = graphene.List(CategoryType)
 
+    ingredient = graphene.Field(
+        IngredientType, id=graphene.Int(), name=graphene.String()
+    )
+    all_ingredients = graphene.List(IngredientType)
 
-      ingredient = graphene.Field(IngredientType,
-                                  id=graphene.Int(),
-                                  name=graphene.String())
-      all_ingredients = graphene.List(IngredientType)
+    def resolve_all_categories(self, info, **kwargs):
+        return Category.objects.all()
 
-      def resolve_all_categories(self, info, **kwargs):
-          return Category.objects.all()
+    def resolve_all_ingredients(self, info, **kwargs):
+        return Ingredient.objects.all()
 
-      def resolve_all_ingredients(self, info, **kwargs):
-          return Ingredient.objects.all()
+    def resolve_category(self, info, **kwargs):
+        id = kwargs.get("id")
+        name = kwargs.get("name")
 
-      def resolve_category(self, info, **kwargs):
-          id = kwargs.get('id')
-          name = kwargs.get('name')
+        if id is not None:
+            return Category.objects.get(pk=id)
 
-          if id is not None:
-              return Category.objects.get(pk=id)
+        if name is not None:
+            return Category.objects.get(name=name)
 
-          if name is not None:
-              return Category.objects.get(name=name)
+        return None
 
-          return None
+    def resolve_ingredient(self, info, **kwargs):
+        id = kwargs.get("id")
+        name = kwargs.get("name")
 
-      def resolve_ingredient(self, info, **kwargs):
-          id = kwargs.get('id')
-          name = kwargs.get('name')
+        if id is not None:
+            return Ingredient.objects.get(pk=id)
 
-          if id is not None:
-              return Ingredient.objects.get(pk=id)
+        if name is not None:
+            return Ingredient.objects.get(name=name)
 
-          if name is not None:
-              return Ingredient.objects.get(name=name)
-
-          return None
+        return None

docs/settings.rst

@@ -189,7 +189,7 @@ Default: ``None``
 
 
 ``GRAPHIQL_HEADER_EDITOR_ENABLED``
----------------------
+----------------------------------
 
 GraphiQL starting from version 1.0.0 allows setting custom headers in similar fashion to query variables.
 
@@ -207,3 +207,36 @@ Default: ``True``
    GRAPHENE = {
       'GRAPHIQL_HEADER_EDITOR_ENABLED': True,
    }
+
+
+``TESTING_ENDPOINT``
+--------------------
+
+Define the graphql endpoint url used for the `GraphQLTestCase` class.
+
+Default: ``/graphql``
+
+.. code:: python
+
+   GRAPHENE = {
+      'TESTING_ENDPOINT': '/customEndpoint'
+   }
+
+
+``GRAPHIQL_SHOULD_PERSIST_HEADERS``
+---------------------
+
+Set to ``True`` if you want to persist GraphiQL headers after refreshing the page.
+
+This setting is passed to ``shouldPersistHeaders`` GraphiQL options, for details refer to GraphiQLDocs_.
+
+.. _GraphiQLDocs: https://github.com/graphql/graphiql/tree/main/packages/graphiql#options
+
+
+Default: ``False``
+
+.. code:: python
+
+   GRAPHENE = {
+      'GRAPHIQL_SHOULD_PERSIST_HEADERS': False,
+   }

docs/testing.rst

@@ -6,7 +6,8 @@ Using unittest
 
 If you want to unittest your API calls derive your test case from the class `GraphQLTestCase`.
 
-Your endpoint is set through the `GRAPHQL_URL` attribute on `GraphQLTestCase`. The default endpoint is `GRAPHQL_URL = "/graphql/"`.
+The default endpoint for testing is `/graphql`. You can override this in the `settings <https://docs.graphene-python.org/projects/django/en/latest/settings/#testing-endpoint>`__.
+
 
 Usage:
 

docs/tutorial-plain.rst

@@ -35,6 +35,7 @@ Now sync your database for the first time:
 
 .. code:: bash
 
+    cd ..
     python manage.py migrate
 
 Let's create a few simple models...
@@ -77,6 +78,18 @@ Add ingredients as INSTALLED_APPS:
         "cookbook.ingredients",
     ]
 
+Make sure the app name in ``cookbook.ingredients.apps.IngredientsConfig`` is set to ``cookbook.ingredients``.
+
+.. code:: python
+
+    # cookbook/ingredients/apps.py
+
+    from django.apps import AppConfig
+
+
+    class IngredientsConfig(AppConfig):
+        default_auto_field = 'django.db.models.BigAutoField'
+        name = 'cookbook.ingredients'
 
 Don't forget to create & run migrations:
 

docs/tutorial-relay.rst

@@ -151,7 +151,7 @@ Create ``cookbook/ingredients/schema.py`` and type the following:
             interfaces = (relay.Node, )
 
 
-    class Query(graphene.ObjectType):
+    class Query(ObjectType):
         category = relay.Node.Field(CategoryNode)
         all_categories = DjangoFilterConnectionField(CategoryNode)