Merge branch with 'master'

Author: NateScarlet

Makefile

@@ -1,11 +1,29 @@
+.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
 tests:
 	py.test graphene_django --cov=graphene_django -vv
 
+.PHONY: test
+test: tests  # Alias test -> tests
+
+.PHONY: format
 format:
-	black --exclude "/migrations/" graphene_django examples
+	black --exclude "/migrations/" graphene_django examples setup.py
 
+.PHONY: lint
 lint:
 	flake8 graphene_django examples
+
+.PHONY: docs ## Generate docs
+docs: dev-setup
+	cd docs && make install && make html
+
+.PHONY: docs-live ## Generate docs with live reloading
+docs-live: dev-setup
+	cd docs && make install && make livehtml

README.md

@@ -38,12 +38,12 @@ GRAPHENE = {
 We need to set up a `GraphQL` endpoint in our Django app, so we can serve the queries.
 
 ```python
-from django.conf.urls import url
+from django.urls import path
 from graphene_django.views import GraphQLView
 
 urlpatterns = [
     # ...
-    url(r'^graphql$', GraphQLView.as_view(graphiql=True)),
+    path('graphql', GraphQLView.as_view(graphiql=True)),
 ]
 ```
 
@@ -100,4 +100,4 @@ To learn more check out the following [examples](examples/):
 
 ## Contributing
 
-See [CONTRIBUTING.md](CONTRIBUTING.md)
+See [CONTRIBUTING.md](CONTRIBUTING.md)

docs/Makefile

@@ -48,12 +48,20 @@ help:
 clean:
 	rm -rf $(BUILDDIR)/*
 
+.PHONY: install ## to install all documentation related requirements
+install:
+	pip install -r requirements.txt
+
 .PHONY: html
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
+.PHONY: livehtml ## to build and serve live-reloading documentation
+livehtml:
+	sphinx-autobuild -b html --watch ../graphene_django $(ALLSPHINXOPTS) $(BUILDDIR)/html
+
 .PHONY: dirhtml
 dirhtml:
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml

docs/_static/.gitkeep

@@ -154,7 +154,8 @@ Adding Login Required
 To restrict users from accessing the GraphQL API page the standard Django LoginRequiredMixin_ can be used to create your own standard Django Class Based View, which includes the ``LoginRequiredMixin`` and subclasses the ``GraphQLView``.:
 
 .. code:: python
-    #views.py
+
+    # views.py
 
     from django.contrib.auth.mixins import LoginRequiredMixin
     from graphene_django.views import GraphQLView

docs/authorization.rst

@@ -151,7 +151,7 @@ customize the look up with the ``lookup_field`` attribute on the ``SerializerMut
 .. code:: python
 
     from graphene_django.rest_framework.mutation import SerializerMutation
-    from .serializers imoprt MyModelSerializer
+    from .serializers import MyModelSerializer
 
 
     class AwesomeModelMutation(SerializerMutation):
@@ -168,7 +168,7 @@ Use the method ``get_serializer_kwargs`` to override how updates are applied.
 .. code:: python
 
     from graphene_django.rest_framework.mutation import SerializerMutation
-    from .serializers imoprt MyModelSerializer
+    from .serializers import MyModelSerializer
 
 
     class AwesomeModelMutation(SerializerMutation):
@@ -199,7 +199,7 @@ You can use relay with mutations. A Relay mutation must inherit from
 
 .. code:: python
 
-    import graphene 
+    import graphene
     from graphene import relay
     from graphene_django import DjangoObjectType
     from graphql_relay import from_global_id

docs/mutations.rst

@@ -41,14 +41,18 @@ Full example
             return Question.objects.get(pk=question_id)
 
 
-Fields
-------
+Specifying which fields to include
+----------------------------------
 
 By default, ``DjangoObjectType`` will present all fields on a Model through GraphQL.
-If you don't want to do this you can change this by setting either ``only_fields`` and ``exclude_fields``.
+If you only want a subset of fields to be present, you can do so using
+``fields`` or ``exclude``. It is strongly recommended that you explicitly set
+all fields that should be exposed using the fields attribute.
+This will make it less likely to result in unintentionally exposing data when
+your models change.
 
-only_fields
-~~~~~~~~~~~
+``fields``
+~~~~~~~~~~
 
 Show **only** these fields on the model:
 
@@ -57,24 +61,35 @@ Show **only** these fields on the model:
     class QuestionType(DjangoObjectType):
         class Meta:
             model = Question
-            only_fields = ('question_text')
+            fields = ('id', 'question_text')
+
+You can also set the ``fields`` attribute to the special value ``'__all__'`` to indicate that all fields in the model should be used.
 
+For example:
 
-exclude_fields
-~~~~~~~~~~~~~~
+.. code:: python
 
-Show all fields **except** those in ``exclude_fields``:
+    class QuestionType(DjangoObjectType):
+        class Meta:
+            model = Question
+            fields = '__all__'
+
+
+``exclude``
+~~~~~~~~~~~
+
+Show all fields **except** those in ``exclude``:
 
 .. code:: python
 
     class QuestionType(DjangoObjectType):
         class Meta:
             model = Question
-            exclude_fields = ('question_text')
+            exclude = ('question_text',)
 
 
-Customised fields
-~~~~~~~~~~~~~~~~~
+Customising fields
+------------------
 
 You can completely overwrite a field, or add new fields, to a ``DjangoObjectType`` using a Resolver:
 
@@ -84,14 +99,79 @@ You can completely overwrite a field, or add new fields, to a ``DjangoObjectType
 
         class Meta:
             model = Question
-            exclude_fields = ('question_text')
+            fields = ('id', 'question_text')
 
         extra_field = graphene.String()
 
         def resolve_extra_field(self, info):
             return 'hello!'
 
 
+Choices to Enum conversion
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+By default Graphene-Django will convert any Django fields that have `choices`_
+defined into a GraphQL enum type.
+
+.. _choices: https://docs.djangoproject.com/en/2.2/ref/models/fields/#choices
+
+For example the following ``Model`` and ``DjangoObjectType``:
+
+.. code:: python
+
+   class PetModel(models.Model):
+      kind = models.CharField(max_length=100, choices=(('cat', 'Cat'), ('dog', 'Dog')))
+
+   class Pet(DjangoObjectType):
+      class Meta:
+         model = PetModel
+
+Results in the following GraphQL schema definition:
+
+.. code::
+
+   type Pet {
+     id: ID!
+     kind: PetModelKind!
+   }
+
+   enum PetModelKind {
+     CAT
+     DOG
+   }
+
+You can disable this automatic conversion by setting
+``convert_choices_to_enum`` attribute to ``False`` on the ``DjangoObjectType``
+``Meta`` class.
+
+.. code:: python
+
+   class Pet(DjangoObjectType):
+      class Meta:
+         model = PetModel
+         convert_choices_to_enum = False
+
+.. code::
+
+   type Pet {
+     id: ID!
+     kind: String!
+   }
+
+You can also set ``convert_choices_to_enum`` to a list of fields that should be
+automatically converted into enums:
+
+.. code:: python
+
+   class Pet(DjangoObjectType):
+      class Meta:
+         model = PetModel
+         convert_choices_to_enum = ['kind']
+
+**Note:** Setting ``convert_choices_to_enum = []`` is the same as setting it to
+``False``.
+
+
 Related models
 --------------
 
@@ -113,7 +193,7 @@ When ``Question`` is published as a ``DjangoObjectType`` and you want to add ``C
     class QuestionType(DjangoObjectType):
         class Meta:
             model = Question
-            only_fields = ('category',)
+            fields = ('category',)
 
 Then all query-able related models must be defined as DjangoObjectType subclass,
 or they will fail to show if you are trying to query those relation fields. You only

docs/queries.rst

@@ -1,3 +1,4 @@
-sphinx
+Sphinx==1.5.3
+sphinx-autobuild==0.7.1
 # Docs template
 http://graphene-python.org/sphinx_graphene_theme.zip

docs/requirements.txt

@@ -30,7 +30,7 @@ Default: ``None``
 
 
 ``SCHEMA_OUTPUT``
-----------
+-----------------
 
 The name of the file where the GraphQL schema output will go.
 
@@ -44,7 +44,7 @@ Default: ``schema.json``
 
 
 ``SCHEMA_INDENT``
-----------
+-----------------
 
 The indentation level of the schema output.
 
@@ -58,7 +58,7 @@ Default: ``2``
 
 
 ``MIDDLEWARE``
-----------
+--------------
 
 A tuple of middleware that will be executed for each GraphQL query.
 
@@ -76,7 +76,7 @@ Default: ``()``
 
 
 ``RELAY_CONNECTION_ENFORCE_FIRST_OR_LAST``
-----------
+------------------------------------------
 
 Enforces relay queries to have the ``first`` or ``last`` argument.
 
@@ -90,7 +90,7 @@ Default: ``False``
 
 
 ``RELAY_CONNECTION_MAX_LIMIT``
-----------
+------------------------------
 
 The maximum size of objects that can be requested through a relay connection.
 
@@ -101,3 +101,42 @@ Default: ``100``
     GRAPHENE = {
         'RELAY_CONNECTION_MAX_LIMIT': 100,
     }
+
+
+``CAMELCASE_ERRORS``
+------------------------------------
+
+When set to ``True`` field names in the ``errors`` object will be camel case.
+By default they will be snake case.
+
+Default: ``False``
+
+.. code:: python
+
+   GRAPHENE = {
+      'CAMELCASE_ERRORS': False,
+   }
+
+   # result = schema.execute(...)
+   print(result.errors)
+   # [
+   #     {
+   #         'field': 'test_field',
+   #         'messages': ['This field is required.'],
+   #     }
+   # ]
+
+.. code:: python
+
+   GRAPHENE = {
+      'CAMELCASE_ERRORS': True,
+   }
+
+   # result = schema.execute(...)
+   print(result.errors)
+   # [
+   #     {
+   #         'field': 'testField',
+   #         'messages': ['This field is required.'],
+   #     }
+   # ]

docs/settings.rst

@@ -1,4 +1,4 @@
 graphene
 graphene-django
 graphql-core>=2.1rc1
-django==2.1.6
+django==2.2.4

examples/cookbook-plain/requirements.txt

@@ -11,7 +11,9 @@ def __str__(self):
 class Ingredient(models.Model):
     name = models.CharField(max_length=100)
     notes = models.TextField(null=True, blank=True)
-    category = models.ForeignKey(Category, related_name="ingredients")
+    category = models.ForeignKey(
+        Category, related_name="ingredients", on_delete=models.CASCADE
+    )
 
     def __str__(self):
         return self.name

examples/cookbook/cookbook/ingredients/models.py

@@ -10,8 +10,10 @@ class Recipe(models.Model):
 
 
 class RecipeIngredient(models.Model):
-    recipe = models.ForeignKey(Recipe, related_name="amounts")
-    ingredient = models.ForeignKey(Ingredient, related_name="used_by")
+    recipe = models.ForeignKey(Recipe, related_name="amounts", on_delete=models.CASCADE)
+    ingredient = models.ForeignKey(
+        Ingredient, related_name="used_by", on_delete=models.CASCADE
+    )
     amount = models.FloatField()
     unit = models.CharField(
         max_length=20,