Merge remote-tracking branch 'up/master' into drf-choices

Author: zbyte64

README.md

@@ -20,6 +20,7 @@ pip install "graphene-django>=2.0"
 ```python
 INSTALLED_APPS = (
     # ...
+    'django.contrib.staticfiles', # Required for GraphiQL
     'graphene_django',
 )
 

docs/authorization.rst

@@ -96,6 +96,29 @@ schema is simple.
 
     result = schema.execute(query, context_value=request)
 
+
+Global Filtering
+----------------
+
+If you are using ``DjangoObjectType`` you can define a custom `get_queryset`.
+
+.. code:: python
+
+    from graphene import relay
+    from graphene_django.types import DjangoObjectType
+    from .models import Post
+
+    class PostNode(DjangoObjectType):
+        class Meta:
+            model = Post
+
+        @classmethod
+        def get_queryset(cls, queryset, info):
+            if info.context.user.is_anonymous:
+                return queryset.filter(published=True)
+            return queryset
+
+
 Filtering ID-based Node Access
 ------------------------------
 
@@ -114,7 +137,7 @@ method to your ``DjangoObjectType``.
             interfaces = (relay.Node, )
 
         @classmethod
-        def get_node(cls, id, info):
+        def get_node(cls, info, id):
             try:
                 post = cls._meta.model.objects.get(id=id)
             except cls._meta.model.DoesNotExist:

docs/form-mutations.rst

@@ -4,27 +4,31 @@ Integration with Django forms
 Graphene-Django comes with mutation classes that will convert the fields on Django forms into inputs on a mutation.
 *Note: the API is experimental and will likely change in the future.*
 
-FormMutation
-------------
+DjangoFormMutation
+------------------
 
 .. code:: python
 
+    from graphene_django.forms.mutation import DjangoFormMutation
+
     class MyForm(forms.Form):
         name = forms.CharField()
 
-    class MyMutation(FormMutation):
+    class MyMutation(DjangoFormMutation):
         class Meta:
             form_class = MyForm
 
 ``MyMutation`` will automatically receive an ``input`` argument. This argument should be a ``dict`` where the key is ``name`` and the value is a string.
 
-ModelFormMutation
------------------
+DjangoModelFormMutation
+-----------------------
 
-``ModelFormMutation`` will pull the fields from a ``ModelForm``.
+``DjangoModelFormMutation`` will pull the fields from a ``ModelForm``.
 
 .. code:: python
 
+    from graphene_django.forms.mutation import DjangoModelFormMutation
+
     class Pet(models.Model):
         name = models.CharField()
 
@@ -61,8 +65,8 @@ Form validation
 
 Form mutations will call ``is_valid()`` on your forms.
 
-If the form is valid then ``form_valid(form, info)`` is called on the mutation. Override this method to change how
-the form is saved or to return a different Graphene object type.
+If the form is valid then the class method ``perform_mutate(form, info)`` is called on the mutation. Override this method
+to change how the form is saved or to return a different Graphene object type.
 
 If the form is *not* valid then a list of errors will be returned. These errors have two fields: ``field``, a string
 containing the name of the invalid form field, and ``messages``, a list of strings with the validation messages.

docs/introspection.rst

@@ -11,7 +11,7 @@ data to ``schema.json`` that is compatible with babel-relay-plugin.
 Usage
 -----
 
-Include ``graphene_django`` to ``INSTALLED_APPS`` in you project
+Include ``graphene_django`` to ``INSTALLED_APPS`` in your project
 settings:
 
 .. code:: python
@@ -29,6 +29,8 @@ It dumps your full introspection schema to ``schema.json`` inside your
 project root directory. Point ``babel-relay-plugin`` to this file and
 you're ready to use Relay with Graphene GraphQL implementation.
 
+The schema file is sorted to create a reproducible canonical representation.
+
 Advanced Usage
 --------------
 

docs/tutorial-relay.rst

@@ -147,7 +147,7 @@ Create ``cookbook/ingredients/schema.py`` and type the following:
             interfaces = (relay.Node, )
 
 
-    class Query(object):
+    class Query(graphene.ObjectType):
         category = relay.Node.Field(CategoryNode)
         all_categories = DjangoFilterConnectionField(CategoryNode)
 
@@ -158,7 +158,7 @@ Create ``cookbook/ingredients/schema.py`` and type the following:
 The filtering functionality is provided by
 `django-filter <https://django-filter.readthedocs.org>`__. See the
 `usage
-documentation <https://django-filter.readthedocs.org/en/latest/usage.html#the-filter>`__
+documentation <https://django-filter.readthedocs.org/en/latest/guide/usage.html#the-filter>`__
 for details on the format for ``filter_fields``. While optional, this
 tutorial makes use of this functionality so you will need to install
 ``django-filter`` for this tutorial to work:
@@ -345,3 +345,10 @@ Or you can get only 'meat' ingredients containing the letter 'e':
         }
       }
     }
+
+
+
+Final Steps
+^^^^^^^^^^^
+
+We have created a GraphQL endpoint that will work with Relay, but for Relay to work it needs access to a (non python) schema. Instructions to export the schema can be found on the `Introspection Schema <http://docs.graphene-python.org/projects/django/en/latest/introspection/>`__ part of this guide.

examples/cookbook-plain/cookbook/ingredients/migrations/0003_auto_20181018_1746.py

@@ -0,0 +1,17 @@
+# Generated by Django 2.0 on 2018-10-18 17:46
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('ingredients', '0002_auto_20161104_0050'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='category',
+            options={'verbose_name_plural': 'Categories'},
+        ),
+    ]

examples/cookbook-plain/cookbook/ingredients/models.py

@@ -2,6 +2,8 @@
 
 
 class Category(models.Model):
+    class Meta:
+        verbose_name_plural = 'Categories'
     name = models.CharField(max_length=100)
 
     def __str__(self):
@@ -11,7 +13,7 @@ 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-plain/cookbook/ingredients/schema.py

@@ -1,7 +1,7 @@
 import graphene
 from graphene_django.types import DjangoObjectType
 
-from cookbook.ingredients.models import Category, Ingredient
+from .models import Category, Ingredient
 
 
 class CategoryType(DjangoObjectType):
@@ -25,17 +25,14 @@ class Query(object):
                                 name=graphene.String())
     all_ingredients = graphene.List(IngredientType)
 
-    def resolve_all_categories(self, args, context, info):
+    def resolve_all_categories(self, context):
         return Category.objects.all()
 
-    def resolve_all_ingredients(self, args, context, info):
+    def resolve_all_ingredients(self, context):
         # We can easily optimize query count in the resolve method
         return Ingredient.objects.select_related('category').all()
 
-    def resolve_category(self, args, context, info):
-        id = args.get('id')
-        name = args.get('name')
-
+    def resolve_category(self, context, id=None, name=None):
         if id is not None:
             return Category.objects.get(pk=id)
 
@@ -44,10 +41,7 @@ def resolve_category(self, args, context, info):
 
         return None
 
-    def resolve_ingredient(self, args, context, info):
-        id = args.get('id')
-        name = args.get('name')
-
+    def resolve_ingredient(self, context, id=None, name=None):
         if id is not None:
             return Ingredient.objects.get(pk=id)
 

examples/cookbook-plain/cookbook/recipes/migrations/0003_auto_20181018_1728.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.0 on 2018-10-18 17:28
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('recipes', '0002_auto_20161104_0106'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='recipeingredient',
+            name='unit',
+            field=models.CharField(choices=[('unit', 'Units'), ('kg', 'Kilograms'), ('l', 'Litres'), ('st', 'Shots')], max_length=20),
+        ),
+    ]

examples/cookbook-plain/cookbook/recipes/models.py

@@ -1,17 +1,18 @@
 from django.db import models
 
-from cookbook.ingredients.models import Ingredient
+from ..ingredients.models import Ingredient
 
 
 class Recipe(models.Model):
     title = models.CharField(max_length=100)
     instructions = models.TextField()
-    __unicode__ = lambda self: self.title
+    def __str__(self):
+        return self.title
 
 
 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, choices=(
         ('unit', 'Units'),

examples/cookbook-plain/cookbook/recipes/schema.py

@@ -1,7 +1,7 @@
 import graphene
 from graphene_django.types import DjangoObjectType
 
-from cookbook.recipes.models import Recipe, RecipeIngredient
+from .models import Recipe, RecipeIngredient
 
 
 class RecipeType(DjangoObjectType):
@@ -24,10 +24,7 @@ class Query(object):
                                       id=graphene.Int())
     all_recipeingredients = graphene.List(RecipeIngredientType)
 
-    def resolve_recipe(self, args, context, info):
-        id = args.get('id')
-        title = args.get('title')
-
+    def resolve_recipe(self, context, id=None, title=None):
         if id is not None:
             return Recipe.objects.get(pk=id)
 
@@ -36,17 +33,15 @@ def resolve_recipe(self, args, context, info):
 
         return None
 
-    def resolve_recipeingredient(self, args, context, info):
-        id = args.get('id')
-
+    def resolve_recipeingredient(self, context, id=None):
         if id is not None:
             return RecipeIngredient.objects.get(pk=id)
 
         return None
 
-    def resolve_all_recipes(self, args, context, info):
+    def resolve_all_recipes(self, context):
         return Recipe.objects.all()
 
-    def resolve_all_recipeingredients(self, args, context, info):
+    def resolve_all_recipeingredients(self, context):
         related = ['recipe', 'ingredient']
         return RecipeIngredient.objects.select_related(*related).all()

examples/cookbook-plain/cookbook/settings.py

@@ -44,13 +44,12 @@
     'cookbook.recipes.apps.RecipesConfig',
 ]
 
-MIDDLEWARE_CLASSES = [
+MIDDLEWARE = [
     'django.middleware.security.SecurityMiddleware',
     'django.contrib.sessions.middleware.SessionMiddleware',
     'django.middleware.common.CommonMiddleware',
     'django.middleware.csrf.CsrfViewMiddleware',
     'django.contrib.auth.middleware.AuthenticationMiddleware',
-    'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
     'django.contrib.messages.middleware.MessageMiddleware',
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
 ]

examples/cookbook-plain/cookbook/urls.py

@@ -1,10 +1,10 @@
-from django.conf.urls import url
+from django.urls import path
 from django.contrib import admin
 
 from graphene_django.views import GraphQLView
 
 
 urlpatterns = [
-    url(r'^admin/', admin.site.urls),
-    url(r'^graphql', GraphQLView.as_view(graphiql=True)),
+    path('admin/', admin.site.urls),
+    path('graphql/', GraphQLView.as_view(graphiql=True)),
 ]

examples/cookbook-plain/requirements.txt

@@ -1,4 +1,4 @@
 graphene
 graphene-django
 graphql-core>=2.1rc1
-django==1.9
+django==2.1.2

graphene_django/fields.py

@@ -67,6 +67,10 @@ def get_manager(self):
         else:
             return self.model._default_manager
 
+    @classmethod
+    def resolve_queryset(cls, connection, queryset, info, args):
+        return connection._meta.node.get_queryset(queryset, info)
+
     @classmethod
     def merge_querysets(cls, default_queryset, queryset):
         if default_queryset.query.distinct and not queryset.query.distinct:
@@ -135,7 +139,8 @@ def connection_resolver(
                 args["last"] = min(last, max_limit)
 
         iterable = resolver(root, info, **args)
-        on_resolve = partial(cls.resolve_connection, connection, default_manager, args)
+        queryset = cls.resolve_queryset(connection, default_manager, info, args)
+        on_resolve = partial(cls.resolve_connection, connection, queryset, args)
 
         if Promise.is_thenable(iterable):
             return Promise.resolve(iterable).then(on_resolve)

graphene_django/forms/mutation.py

@@ -14,7 +14,7 @@
 from graphene_django.registry import get_global_registry
 
 from .converter import convert_form_field
-from .types import ErrorType
+from ..types import ErrorType
 
 
 def fields_for_form(form, only_fields, exclude_fields):

graphene_django/management/commands/graphql_schema.py

@@ -39,7 +39,7 @@ class Command(CommandArguments):
 
     def save_file(self, out, schema_dict, indent):
         with open(out, "w") as outfile:
-            json.dump(schema_dict, outfile, indent=indent)
+            json.dump(schema_dict, outfile, indent=indent, sort_keys=True)
 
     def handle(self, *args, **options):
         options_schema = options.get("schema")
@@ -65,7 +65,7 @@ def handle(self, *args, **options):
         indent = options.get("indent")
         schema_dict = {"data": schema.introspect()}
         if out == '-':
-            self.stdout.write(json.dumps(schema_dict, indent=indent))
+            self.stdout.write(json.dumps(schema_dict, indent=indent, sort_keys=True))
         else:
             self.save_file(out, schema_dict, indent)
 

graphene_django/rest_framework/mutation.py

@@ -9,7 +9,7 @@
 from graphene.types.objecttype import yank_fields_from_attrs
 
 from .serializer_converter import convert_serializer_field
-from .types import ErrorType
+from ..types import ErrorType
 
 
 class SerializerMutationOptions(MutationOptions):