From f034946cda62f5a0e2477c02684664a97a54b1bc Mon Sep 17 00:00:00 2001 From: Grant McConnaughey Date: Tue, 18 Jul 2017 10:15:25 -0500 Subject: [PATCH 001/111] Add Django form-based mutations --- graphene_django/forms/__init__.py | 1 + graphene_django/forms/converter.py | 90 +++++++++++ graphene_django/{ => forms}/forms.py | 0 graphene_django/forms/mutation.py | 157 +++++++++++++++++++ graphene_django/forms/tests/__init__.py | 0 graphene_django/forms/tests/test_coverter.py | 98 ++++++++++++ graphene_django/forms/tests/test_mutation.py | 49 ++++++ graphene_django/forms/types.py | 6 + 8 files changed, 401 insertions(+) create mode 100644 graphene_django/forms/__init__.py create mode 100644 graphene_django/forms/converter.py rename graphene_django/{ => forms}/forms.py (100%) create mode 100644 graphene_django/forms/mutation.py create mode 100644 graphene_django/forms/tests/__init__.py create mode 100644 graphene_django/forms/tests/test_coverter.py create mode 100644 graphene_django/forms/tests/test_mutation.py create mode 100644 graphene_django/forms/types.py diff --git a/graphene_django/forms/__init__.py b/graphene_django/forms/__init__.py new file mode 100644 index 0000000..9559be4 --- /dev/null +++ b/graphene_django/forms/__init__.py @@ -0,0 +1 @@ +from .forms import GlobalIDFormField, GlobalIDMultipleChoiceField diff --git a/graphene_django/forms/converter.py b/graphene_django/forms/converter.py new file mode 100644 index 0000000..9d7b242 --- /dev/null +++ b/graphene_django/forms/converter.py @@ -0,0 +1,90 @@ +from django import forms +from django.core.exceptions import ImproperlyConfigured +from graphene_django.utils import import_single_dispatch +import graphene + + +singledispatch = import_single_dispatch() + + +def convert_form_to_input_type(form_class): + form = form_class() + + items = { + name: convert_form_field(field) + for name, field in form.fields.items() + } + + return type( + '{}Input'.format(form.__class__.__name__), + (graphene.InputObjectType, ), + items + ) + + +@singledispatch +def get_graphene_type_from_form_field(field): + raise ImproperlyConfigured( + "Don't know how to convert the form field %s (%s) " + "to Graphene type" % (field, field.__class__) + ) + + +def convert_form_field(field, is_input=True): + """ + Converts a Django form field to a graphql field and marks the field as + required if we are creating an input type and the field itself is required + """ + + graphql_type = get_graphene_type_from_form_field(field) + + kwargs = { + 'description': field.help_text, + 'required': is_input and field.required, + } + + # if it is a tuple or a list it means that we are returning + # the graphql type and the child type + if isinstance(graphql_type, (list, tuple)): + kwargs['of_type'] = graphql_type[1] + graphql_type = graphql_type[0] + + return graphql_type(**kwargs) + + +@get_graphene_type_from_form_field.register(forms.CharField) +@get_graphene_type_from_form_field.register(forms.ChoiceField) +def convert_form_field_to_string(field): + return graphene.String + + +@get_graphene_type_from_form_field.register(forms.IntegerField) +def convert_form_field_to_int(field): + return graphene.Int + + +@get_graphene_type_from_form_field.register(forms.BooleanField) +def convert_form_field_to_bool(field): + return graphene.Boolean + + +@get_graphene_type_from_form_field.register(forms.FloatField) +@get_graphene_type_from_form_field.register(forms.DecimalField) +def convert_form_field_to_float(field): + return graphene.Float + + +@get_graphene_type_from_form_field.register(forms.DateField) +@get_graphene_type_from_form_field.register(forms.DateTimeField) +def convert_form_field_to_datetime(field): + return graphene.types.datetime.DateTime + + +@get_graphene_type_from_form_field.register(forms.TimeField) +def convert_form_field_to_time(field): + return graphene.types.datetime.Time + + +@get_graphene_type_from_form_field.register(forms.MultipleChoiceField) +def convert_form_field_to_list_of_string(field): + return (graphene.List, graphene.String) diff --git a/graphene_django/forms.py b/graphene_django/forms/forms.py similarity index 100% rename from graphene_django/forms.py rename to graphene_django/forms/forms.py diff --git a/graphene_django/forms/mutation.py b/graphene_django/forms/mutation.py new file mode 100644 index 0000000..d9e27aa --- /dev/null +++ b/graphene_django/forms/mutation.py @@ -0,0 +1,157 @@ +from functools import partial + +import six +import graphene +from graphene import Field, Argument +from graphene.types.mutation import MutationMeta +from graphene.types.objecttype import ObjectTypeMeta +from graphene.types.options import Options +from graphene.types.utils import get_field_as, merge +from graphene.utils.is_base_type import is_base_type +from graphene_django.registry import get_global_registry + +from .converter import convert_form_to_input_type +from .types import ErrorType + + +class FormMutationMeta(MutationMeta): + def __new__(cls, name, bases, attrs): + if not is_base_type(bases, FormMutationMeta): + return type.__new__(cls, name, bases, attrs) + + options = Options( + attrs.pop('Meta', None), + name=name, + description=attrs.pop('__doc__', None), + form_class=None, + input_field_name='input', + local_fields=None, + only_fields=(), + exclude_fields=(), + interfaces=(), + registry=None + ) + + if not options.form_class: + raise Exception('Missing form_class') + + cls = ObjectTypeMeta.__new__( + cls, name, bases, dict(attrs, _meta=options) + ) + + options.fields = merge( + options.interface_fields, options.base_fields, options.local_fields, + {'errors': get_field_as(cls.errors, Field)} + ) + + cls.Input = convert_form_to_input_type(options.form_class) + + field_kwargs = {cls.options.input_field_name: Argument(cls.Input, required=True)} + cls.Field = partial( + Field, + cls, + resolver=cls.mutate, + **field_kwargs + ) + + return cls + + +class BaseFormMutation(graphene.Mutation): + + @classmethod + def mutate(cls, root, args, context, info): + form = cls.get_form(root, args, context, info) + + if form.is_valid(): + return cls.perform_mutate(form, info) + else: + errors = [ + ErrorType(field=key, messages=value) + for key, value in form.errors.items() + ] + return cls(errors=errors) + + @classmethod + def perform_mutate(cls, form, info): + form.save() + return cls(errors=[]) + + @classmethod + def get_form(cls, root, args, context, info): + form_data = args.get(cls._meta.input_field_name) + kwargs = cls.get_form_kwargs(root, args, context, info) + return cls._meta.form_class(data=form_data, **kwargs) + + @classmethod + def get_form_kwargs(cls, root, args, context, info): + return {} + + +class FormMutation(six.with_metaclass(FormMutationMeta, BaseFormMutation)): + + errors = graphene.List(ErrorType) + + +class ModelFormMutationMeta(MutationMeta): + def __new__(cls, name, bases, attrs): + if not is_base_type(bases, ModelFormMutationMeta): + return type.__new__(cls, name, bases, attrs) + + options = Options( + attrs.pop('Meta', None), + name=name, + description=attrs.pop('__doc__', None), + form_class=None, + input_field_name='input', + return_field_name=None, + model=None, + local_fields=None, + only_fields=(), + exclude_fields=(), + interfaces=(), + registry=None + ) + + if not options.form_class: + raise Exception('Missing form_class') + + cls = ObjectTypeMeta.__new__( + cls, name, bases, dict(attrs, _meta=options) + ) + + options.fields = merge( + options.interface_fields, options.base_fields, options.local_fields, + {'errors': get_field_as(cls.errors, Field)} + ) + + cls.Input = convert_form_to_input_type(options.form_class) + + field_kwargs = {cls.options.input_field_name: Argument(cls.Input, required=True)} + cls.Field = partial( + Field, + cls, + resolver=cls.mutate, + **field_kwargs + ) + + cls.model = options.model or options.form_class.Meta.model + cls.return_field_name = cls._meta.return_field_name or cls.model._meta.model_name + + registry = get_global_registry() + model_type = registry.get_type_for_model(cls.model) + + options.fields[cls.return_field_name] = graphene.Field(model_type) + + return cls + + +class ModelFormMutation(six.with_metaclass(ModelFormMutationMeta, BaseFormMutation)): + + errors = graphene.List(ErrorType) + + @classmethod + def perform_mutate(cls, form, info): + obj = form.save() + kwargs = {cls.return_field_name: obj} + return cls(errors=[], **kwargs) diff --git a/graphene_django/forms/tests/__init__.py b/graphene_django/forms/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/graphene_django/forms/tests/test_coverter.py b/graphene_django/forms/tests/test_coverter.py new file mode 100644 index 0000000..e4a686b --- /dev/null +++ b/graphene_django/forms/tests/test_coverter.py @@ -0,0 +1,98 @@ +import copy + +from django import forms +from py.test import raises + +import graphene + +from ..converter import convert_form_field + + +def _get_type(form_field, **kwargs): + # prevents the following error: + # AssertionError: The `source` argument is not meaningful when applied to a `child=` field. + # Remove `source=` from the field declaration. + # since we are reusing the same child in when testing the required attribute + + if 'child' in kwargs: + kwargs['child'] = copy.deepcopy(kwargs['child']) + + field = form_field(**kwargs) + + return convert_form_field(field) + + +def assert_conversion(form_field, graphene_field, **kwargs): + graphene_type = _get_type(form_field, help_text='Custom Help Text', **kwargs) + assert isinstance(graphene_type, graphene_field) + + graphene_type_required = _get_type( + form_field, help_text='Custom Help Text', required=True, **kwargs + ) + assert isinstance(graphene_type_required, graphene_field) + + return graphene_type + + +def test_should_unknown_form_field_raise_exception(): + with raises(Exception) as excinfo: + convert_form_field(None) + assert 'Don\'t know how to convert the form field' in str(excinfo.value) + + +def test_should_charfield_convert_string(): + assert_conversion(forms.CharField, graphene.String) + + +def test_should_timefield_convert_time(): + assert_conversion(forms.TimeField, graphene.types.datetime.Time) + + +def test_should_email_convert_string(): + assert_conversion(forms.EmailField, graphene.String) + + +def test_should_slug_convert_string(): + assert_conversion(forms.SlugField, graphene.String) + + +def test_should_url_convert_string(): + assert_conversion(forms.URLField, graphene.String) + + +def test_should_choicefield_convert_string(): + assert_conversion(forms.ChoiceField, graphene.String, choices=[]) + + +def test_should_regexfield_convert_string(): + assert_conversion(forms.RegexField, graphene.String, regex='[0-9]+') + + +def test_should_uuidfield_convert_string(): + assert_conversion(forms.UUIDField, graphene.String) + + +def test_should_integer_convert_int(): + assert_conversion(forms.IntegerField, graphene.Int) + + +def test_should_boolean_convert_boolean(): + assert_conversion(forms.BooleanField, graphene.Boolean) + + +def test_should_float_convert_float(): + assert_conversion(forms.FloatField, graphene.Float) + + +def test_should_decimal_convert_float(): + assert_conversion(forms.DecimalField, graphene.Float, max_digits=4, decimal_places=2) + + +def test_should_filepath_convert_string(): + assert_conversion(forms.FilePathField, graphene.String, path='/') + + +def test_should_multiplechoicefield_convert_to_list_of_string(): + field = assert_conversion(forms.MultipleChoiceField, graphene.List, choices=[1, 2, 3]) + + assert field.of_type == graphene.String diff --git a/graphene_django/forms/tests/test_mutation.py b/graphene_django/forms/tests/test_mutation.py new file mode 100644 index 0000000..004f5d3 --- /dev/null +++ b/graphene_django/forms/tests/test_mutation.py @@ -0,0 +1,49 @@ +from django import forms +from py.test import raises + +from graphene_django.tests.models import Pet +from ..mutation import FormMutation, ModelFormMutation + + +class MyForm(forms.Form): + text = forms.CharField() + + +class PetForm(forms.ModelForm): + + class Meta: + model = Pet + fields = ('name',) + + +def test_needs_form_class(): + with raises(Exception) as exc: + class MyMutation(FormMutation): + pass + + assert exc.value.args[0] == 'Missing form_class' + + +def test_has_fields(): + class MyMutation(FormMutation): + class Meta: + form_class = MyForm + + assert 'errors' in MyMutation._meta.fields + + +def test_has_input_fields(): + class MyMutation(FormMutation): + class Meta: + form_class = MyForm + + assert 'text' in MyMutation.Input._meta.fields + + +def test_model_form(): + class PetMutation(ModelFormMutation): + class Meta: + form_class = PetForm + + assert PetMutation.model == Pet + assert PetMutation.return_field_name == 'pet' diff --git a/graphene_django/forms/types.py b/graphene_django/forms/types.py new file mode 100644 index 0000000..1fe33f3 --- /dev/null +++ b/graphene_django/forms/types.py @@ -0,0 +1,6 @@ +import graphene + + +class ErrorType(graphene.ObjectType): + field = graphene.String() + messages = graphene.List(graphene.String) From 26a4d315c5960fc3e04ab59dff735caac3d7b221 Mon Sep 17 00:00:00 2001 From: Grant McConnaughey Date: Tue, 18 Jul 2017 10:31:17 -0500 Subject: [PATCH 002/111] Use options correctly --- graphene_django/forms/mutation.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/graphene_django/forms/mutation.py b/graphene_django/forms/mutation.py index d9e27aa..291a7af 100644 --- a/graphene_django/forms/mutation.py +++ b/graphene_django/forms/mutation.py @@ -46,7 +46,7 @@ class FormMutationMeta(MutationMeta): cls.Input = convert_form_to_input_type(options.form_class) - field_kwargs = {cls.options.input_field_name: Argument(cls.Input, required=True)} + field_kwargs = {options.input_field_name: Argument(cls.Input, required=True)} cls.Field = partial( Field, cls, @@ -127,7 +127,7 @@ class ModelFormMutationMeta(MutationMeta): cls.Input = convert_form_to_input_type(options.form_class) - field_kwargs = {cls.options.input_field_name: Argument(cls.Input, required=True)} + field_kwargs = {options.input_field_name: Argument(cls.Input, required=True)} cls.Field = partial( Field, cls, From 80a06a035488b43f709373672aef5e53840f01d3 Mon Sep 17 00:00:00 2001 From: Grant McConnaughey Date: Tue, 18 Jul 2017 10:37:08 -0500 Subject: [PATCH 003/111] Fix flake8 issue --- graphene_django/forms/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/graphene_django/forms/__init__.py b/graphene_django/forms/__init__.py index 9559be4..066eec4 100644 --- a/graphene_django/forms/__init__.py +++ b/graphene_django/forms/__init__.py @@ -1 +1 @@ -from .forms import GlobalIDFormField, GlobalIDMultipleChoiceField +from .forms import GlobalIDFormField, GlobalIDMultipleChoiceField # noqa From 4f904f470088bbafbebe8d5158852a36d9111aa7 Mon Sep 17 00:00:00 2001 From: Grant McConnaughey Date: Tue, 18 Jul 2017 10:48:09 -0500 Subject: [PATCH 004/111] Test mutation --- graphene_django/forms/tests/test_mutation.py | 26 +++++++++++++++----- 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/graphene_django/forms/tests/test_mutation.py b/graphene_django/forms/tests/test_mutation.py index 004f5d3..9874ae6 100644 --- a/graphene_django/forms/tests/test_mutation.py +++ b/graphene_django/forms/tests/test_mutation.py @@ -1,4 +1,5 @@ from django import forms +from django.test import TestCase from py.test import raises from graphene_django.tests.models import Pet @@ -40,10 +41,23 @@ def test_has_input_fields(): assert 'text' in MyMutation.Input._meta.fields -def test_model_form(): - class PetMutation(ModelFormMutation): - class Meta: - form_class = PetForm +class ModelFormMutationTests(TestCase): - assert PetMutation.model == Pet - assert PetMutation.return_field_name == 'pet' + def test_model_form_mutation(self): + class PetMutation(ModelFormMutation): + class Meta: + form_class = PetForm + + self.assertEqual(PetMutation.model, Pet) + self.assertEqual(PetMutation.return_field_name, 'pet') + + def test_model_form_mutation_mutate(self): + class PetMutation(ModelFormMutation): + class Meta: + form_class = PetForm + + PetMutation.mutate(None, {'input': {'name': 'Fluffy'}}, None, None) + + self.assertEqual(Pet.objects.count(), 1) + pet = Pet.objects.get() + self.assertEqual(pet.name, 'Fluffy') From 507246468b07bddaaac63f4bf2f72013bdadbc23 Mon Sep 17 00:00:00 2001 From: Grant McConnaughey Date: Tue, 18 Jul 2017 11:18:58 -0500 Subject: [PATCH 005/111] Document form mutations --- docs/form-mutations.rst | 67 +++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 1 + 2 files changed, 68 insertions(+) create mode 100644 docs/form-mutations.rst diff --git a/docs/form-mutations.rst b/docs/form-mutations.rst new file mode 100644 index 0000000..f010d8a --- /dev/null +++ b/docs/form-mutations.rst @@ -0,0 +1,67 @@ +Integration with Django forms +============================= + +Graphene-Django comes with mutation classes that will convert the fields on Django forms into inputs on a mutation. + +FormMutation +------------ + +.. code:: python + + class MyForm(forms.Form): + name = forms.CharField() + + class MyMutation(FormMutation): + 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 +----------------- + +``ModelFormMutation`` will pull the fields from a ``ModelForm``. + +.. code:: python + + class Pet(models.Model): + name = models.CharField() + + class PetForm(forms.ModelForm): + class Meta: + model = Pet + fields = ('name',) + + # This will get returned when the mutation completes successfully + class PetType(DjangoObjectType): + class Meta: + model = Pet + + class PetMutation(ModelFormMutation): + class Meta: + form_class = PetForm + +``PetMutation`` will grab the fields from ``PetForm`` and turn them into inputs. If the form is valid then the mutation +will lookup the ``DjangoObjectType`` for the ``Pet`` model and return that under the key ``pet``. Otherwise it will +return a list of errors. + +You can change the input name (default is ``input``) and the return field name (default is the model name lowercase). + +.. code:: python + + class PetMutation(ModelFormMutation): + class Meta: + form_class = PetForm + input_field_name = 'data' + return_field_name = 'my_pet' + +Form validation +--------------- + +Form mutations will call ``is_valid()`` on your forms. + +If the form is valid then ``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. diff --git a/docs/index.rst b/docs/index.rst index 256da68..7c64ae7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,4 +12,5 @@ Contents: authorization debug rest-framework + form-mutations introspection From f5083cb1901596b4a41ab6484ec3c89013d6c245 Mon Sep 17 00:00:00 2001 From: Grant McConnaughey Date: Tue, 18 Jul 2017 11:20:59 -0500 Subject: [PATCH 006/111] Change form valid method names --- docs/form-mutations.rst | 2 +- graphene_django/forms/mutation.py | 20 ++++++++++++-------- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/form-mutations.rst b/docs/form-mutations.rst index f010d8a..a498b56 100644 --- a/docs/form-mutations.rst +++ b/docs/form-mutations.rst @@ -60,7 +60,7 @@ Form validation Form mutations will call ``is_valid()`` on your forms. -If the form is valid then ``perform_mutate(form, info)`` is called on the mutation. Override this method to change how +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 *not* valid then a list of errors will be returned. These errors have two fields: ``field``, a string diff --git a/graphene_django/forms/mutation.py b/graphene_django/forms/mutation.py index 291a7af..43726d4 100644 --- a/graphene_django/forms/mutation.py +++ b/graphene_django/forms/mutation.py @@ -64,19 +64,23 @@ class BaseFormMutation(graphene.Mutation): form = cls.get_form(root, args, context, info) if form.is_valid(): - return cls.perform_mutate(form, info) + return cls.form_valid(form, info) else: - errors = [ - ErrorType(field=key, messages=value) - for key, value in form.errors.items() - ] - return cls(errors=errors) + return cls.form_invalid(form, info) @classmethod - def perform_mutate(cls, form, info): + def form_valid(cls, form, info): form.save() return cls(errors=[]) + @classmethod + def form_invalid(cls, form, info): + errors = [ + ErrorType(field=key, messages=value) + for key, value in form.errors.items() + ] + return cls(errors=errors) + @classmethod def get_form(cls, root, args, context, info): form_data = args.get(cls._meta.input_field_name) @@ -151,7 +155,7 @@ class ModelFormMutation(six.with_metaclass(ModelFormMutationMeta, BaseFormMutati errors = graphene.List(ErrorType) @classmethod - def perform_mutate(cls, form, info): + def form_valid(cls, form, info): obj = form.save() kwargs = {cls.return_field_name: obj} return cls(errors=[], **kwargs) From 666ddb2ff38eae171ed20ef8b467cd2cb0eaa8e0 Mon Sep 17 00:00:00 2001 From: Grant McConnaughey Date: Mon, 2 Oct 2017 09:42:57 -0500 Subject: [PATCH 007/111] Merge form converter modules --- graphene_django/filter/utils.py | 2 +- graphene_django/form_converter.py | 75 ------------- graphene_django/forms/converter.py | 106 ++++++++++-------- .../tests/test_converter.py} | 2 +- 4 files changed, 61 insertions(+), 124 deletions(-) delete mode 100644 graphene_django/form_converter.py rename graphene_django/{tests/test_form_converter.py => forms/tests/test_converter.py} (98%) diff --git a/graphene_django/filter/utils.py b/graphene_django/filter/utils.py index 6b938ce..cfa5621 100644 --- a/graphene_django/filter/utils.py +++ b/graphene_django/filter/utils.py @@ -8,7 +8,7 @@ def get_filtering_args_from_filterset(filterset_class, type): a Graphene Field. These arguments will be available to filter against in the GraphQL """ - from ..form_converter import convert_form_field + from ..forms.converter import convert_form_field args = {} for name, filter_field in six.iteritems(filterset_class.base_filters): diff --git a/graphene_django/form_converter.py b/graphene_django/form_converter.py deleted file mode 100644 index 46a38b3..0000000 --- a/graphene_django/form_converter.py +++ /dev/null @@ -1,75 +0,0 @@ -from django import forms -from django.forms.fields import BaseTemporalField - -from graphene import ID, Boolean, Float, Int, List, String, UUID - -from .forms import GlobalIDFormField, GlobalIDMultipleChoiceField -from .utils import import_single_dispatch - -singledispatch = import_single_dispatch() - -try: - UUIDField = forms.UUIDField -except AttributeError: - class UUIDField(object): - pass - - -@singledispatch -def convert_form_field(field): - raise Exception( - "Don't know how to convert the Django form field %s (%s) " - "to Graphene type" % - (field, field.__class__) - ) - - -@convert_form_field.register(BaseTemporalField) -@convert_form_field.register(forms.CharField) -@convert_form_field.register(forms.EmailField) -@convert_form_field.register(forms.SlugField) -@convert_form_field.register(forms.URLField) -@convert_form_field.register(forms.ChoiceField) -@convert_form_field.register(forms.RegexField) -@convert_form_field.register(forms.Field) -def convert_form_field_to_string(field): - return String(description=field.help_text, required=field.required) - - -@convert_form_field.register(UUIDField) -def convert_form_field_to_uuid(field): - return UUID(description=field.help_text, required=field.required) - - -@convert_form_field.register(forms.IntegerField) -@convert_form_field.register(forms.NumberInput) -def convert_form_field_to_int(field): - return Int(description=field.help_text, required=field.required) - - -@convert_form_field.register(forms.BooleanField) -def convert_form_field_to_boolean(field): - return Boolean(description=field.help_text, required=True) - - -@convert_form_field.register(forms.NullBooleanField) -def convert_form_field_to_nullboolean(field): - return Boolean(description=field.help_text) - - -@convert_form_field.register(forms.DecimalField) -@convert_form_field.register(forms.FloatField) -def convert_form_field_to_float(field): - return Float(description=field.help_text, required=field.required) - - -@convert_form_field.register(forms.ModelMultipleChoiceField) -@convert_form_field.register(GlobalIDMultipleChoiceField) -def convert_form_field_to_list(field): - return List(ID, required=field.required) - - -@convert_form_field.register(forms.ModelChoiceField) -@convert_form_field.register(GlobalIDFormField) -def convert_form_field_to_id(field): - return ID(required=field.required) diff --git a/graphene_django/forms/converter.py b/graphene_django/forms/converter.py index 9d7b242..7e816d6 100644 --- a/graphene_django/forms/converter.py +++ b/graphene_django/forms/converter.py @@ -1,8 +1,17 @@ from django import forms from django.core.exceptions import ImproperlyConfigured -from graphene_django.utils import import_single_dispatch + import graphene +from .forms import GlobalIDFormField, GlobalIDMultipleChoiceField +from .utils import import_single_dispatch + +try: + UUIDField = forms.UUIDField +except AttributeError: + class UUIDField(object): + pass + singledispatch = import_single_dispatch() @@ -23,68 +32,71 @@ def convert_form_to_input_type(form_class): @singledispatch -def get_graphene_type_from_form_field(field): +def convert_form_field(field): raise ImproperlyConfigured( - "Don't know how to convert the form field %s (%s) " - "to Graphene type" % (field, field.__class__) + "Don't know how to convert the Django form field %s (%s) " + "to Graphene type" % + (field, field.__class__) ) -def convert_form_field(field, is_input=True): - """ - Converts a Django form field to a graphql field and marks the field as - required if we are creating an input type and the field itself is required - """ - - graphql_type = get_graphene_type_from_form_field(field) - - kwargs = { - 'description': field.help_text, - 'required': is_input and field.required, - } - - # if it is a tuple or a list it means that we are returning - # the graphql type and the child type - if isinstance(graphql_type, (list, tuple)): - kwargs['of_type'] = graphql_type[1] - graphql_type = graphql_type[0] - - return graphql_type(**kwargs) - - -@get_graphene_type_from_form_field.register(forms.CharField) -@get_graphene_type_from_form_field.register(forms.ChoiceField) +@convert_form_field.register(forms.BaseTemporalField) +@convert_form_field.register(forms.CharField) +@convert_form_field.register(forms.EmailField) +@convert_form_field.register(forms.SlugField) +@convert_form_field.register(forms.URLField) +@convert_form_field.register(forms.ChoiceField) +@convert_form_field.register(forms.RegexField) +@convert_form_field.register(forms.Field) def convert_form_field_to_string(field): - return graphene.String + return graphene.String(description=field.help_text, required=field.required) -@get_graphene_type_from_form_field.register(forms.IntegerField) +@convert_form_field.register(UUIDField) +def convert_form_field_to_uuid(field): + return graphene.UUID(description=field.help_text, required=field.required) + + +@convert_form_field.register(forms.IntegerField) +@convert_form_field.register(forms.NumberInput) def convert_form_field_to_int(field): - return graphene.Int + return graphene.Int(description=field.help_text, required=field.required) -@get_graphene_type_from_form_field.register(forms.BooleanField) -def convert_form_field_to_bool(field): - return graphene.Boolean +@convert_form_field.register(forms.BooleanField) +def convert_form_field_to_boolean(field): + return graphene.Boolean(description=field.help_text, required=True) -@get_graphene_type_from_form_field.register(forms.FloatField) -@get_graphene_type_from_form_field.register(forms.DecimalField) +@convert_form_field.register(forms.NullBooleanField) +def convert_form_field_to_nullboolean(field): + return graphene.Boolean(description=field.help_text) + + +@convert_form_field.register(forms.DecimalField) +@convert_form_field.register(forms.FloatField) def convert_form_field_to_float(field): - return graphene.Float + return graphene.Float(description=field.help_text, required=field.required) -@get_graphene_type_from_form_field.register(forms.DateField) -@get_graphene_type_from_form_field.register(forms.DateTimeField) +@convert_form_field.register(forms.ModelMultipleChoiceField) +@convert_form_field.register(GlobalIDMultipleChoiceField) +def convert_form_field_to_list(field): + return graphene.List(graphene.ID, required=field.required) + + +@convert_form_field.register(forms.ModelChoiceField) +@convert_form_field.register(GlobalIDFormField) +def convert_form_field_to_id(field): + return graphene.ID(required=field.required) + + +@convert_form_field.register(forms.DateField) +@convert_form_field.register(forms.DateTimeField) def convert_form_field_to_datetime(field): - return graphene.types.datetime.DateTime + return graphene.types.datetime.DateTime(description=field.help_text, required=field.required) -@get_graphene_type_from_form_field.register(forms.TimeField) +@convert_form_field.register(forms.TimeField) def convert_form_field_to_time(field): - return graphene.types.datetime.Time - - -@get_graphene_type_from_form_field.register(forms.MultipleChoiceField) -def convert_form_field_to_list_of_string(field): - return (graphene.List, graphene.String) + return graphene.types.datetime.Time(description=field.help_text, required=field.required) diff --git a/graphene_django/tests/test_form_converter.py b/graphene_django/forms/tests/test_converter.py similarity index 98% rename from graphene_django/tests/test_form_converter.py rename to graphene_django/forms/tests/test_converter.py index 5a13554..ec66f8f 100644 --- a/graphene_django/tests/test_form_converter.py +++ b/graphene_django/forms/tests/test_converter.py @@ -4,7 +4,7 @@ from py.test import raises import graphene from graphene import ID, List, NonNull -from ..form_converter import convert_form_field +from ..converter import convert_form_field from .models import Reporter From 463ce68b16b070c0a49637dc71755a33acdf9d49 Mon Sep 17 00:00:00 2001 From: Grant McConnaughey Date: Mon, 2 Oct 2017 13:03:20 -0500 Subject: [PATCH 008/111] Change mutations to new 2.0 format --- graphene_django/forms/converter.py | 4 +- graphene_django/forms/mutation.py | 224 ++++++++---------- graphene_django/forms/tests/test_converter.py | 11 +- graphene_django/forms/tests/test_coverter.py | 98 -------- graphene_django/forms/tests/test_mutation.py | 26 +- 5 files changed, 128 insertions(+), 235 deletions(-) delete mode 100644 graphene_django/forms/tests/test_coverter.py diff --git a/graphene_django/forms/converter.py b/graphene_django/forms/converter.py index 7e816d6..220edc4 100644 --- a/graphene_django/forms/converter.py +++ b/graphene_django/forms/converter.py @@ -4,7 +4,7 @@ from django.core.exceptions import ImproperlyConfigured import graphene from .forms import GlobalIDFormField, GlobalIDMultipleChoiceField -from .utils import import_single_dispatch +from ..utils import import_single_dispatch try: UUIDField = forms.UUIDField @@ -40,7 +40,7 @@ def convert_form_field(field): ) -@convert_form_field.register(forms.BaseTemporalField) +@convert_form_field.register(forms.fields.BaseTemporalField) @convert_form_field.register(forms.CharField) @convert_form_field.register(forms.EmailField) @convert_form_field.register(forms.SlugField) diff --git a/graphene_django/forms/mutation.py b/graphene_django/forms/mutation.py index 43726d4..bbe5f80 100644 --- a/graphene_django/forms/mutation.py +++ b/graphene_django/forms/mutation.py @@ -1,161 +1,141 @@ -from functools import partial +from collections import OrderedDict -import six import graphene -from graphene import Field, Argument -from graphene.types.mutation import MutationMeta -from graphene.types.objecttype import ObjectTypeMeta -from graphene.types.options import Options -from graphene.types.utils import get_field_as, merge -from graphene.utils.is_base_type import is_base_type +from graphene import Field, InputField +from graphene.relay.mutation import ClientIDMutation +from graphene.types.mutation import MutationOptions +from graphene.types.utils import yank_fields_from_attrs from graphene_django.registry import get_global_registry -from .converter import convert_form_to_input_type +from .converter import convert_form_field from .types import ErrorType -class FormMutationMeta(MutationMeta): - def __new__(cls, name, bases, attrs): - if not is_base_type(bases, FormMutationMeta): - return type.__new__(cls, name, bases, attrs) - - options = Options( - attrs.pop('Meta', None), - name=name, - description=attrs.pop('__doc__', None), - form_class=None, - input_field_name='input', - local_fields=None, - only_fields=(), - exclude_fields=(), - interfaces=(), - registry=None +def fields_for_form(form, only_fields, exclude_fields): + fields = OrderedDict() + for name, field in form.fields.items(): + is_not_in_only = only_fields and name not in only_fields + is_excluded = ( + name in exclude_fields # or + # name in already_created_fields ) - if not options.form_class: - raise Exception('Missing form_class') + if is_not_in_only or is_excluded: + continue - cls = ObjectTypeMeta.__new__( - cls, name, bases, dict(attrs, _meta=options) - ) - - options.fields = merge( - options.interface_fields, options.base_fields, options.local_fields, - {'errors': get_field_as(cls.errors, Field)} - ) - - cls.Input = convert_form_to_input_type(options.form_class) - - field_kwargs = {options.input_field_name: Argument(cls.Input, required=True)} - cls.Field = partial( - Field, - cls, - resolver=cls.mutate, - **field_kwargs - ) - - return cls + fields[name] = convert_form_field(field) + return fields -class BaseFormMutation(graphene.Mutation): +class BaseFormMutation(ClientIDMutation): + class Meta: + abstract = True @classmethod - def mutate(cls, root, args, context, info): - form = cls.get_form(root, args, context, info) + def mutate_and_get_payload(cls, root, info, **input): + form = cls._meta.form_class(data=input) if form.is_valid(): - return cls.form_valid(form, info) + return cls.perform_mutate(form, info) else: - return cls.form_invalid(form, info) + errors = [ + ErrorType(field=key, messages=value) + for key, value in form.errors.items() + ] - @classmethod - def form_valid(cls, form, info): - form.save() - return cls(errors=[]) - - @classmethod - def form_invalid(cls, form, info): - errors = [ - ErrorType(field=key, messages=value) - for key, value in form.errors.items() - ] - return cls(errors=errors) - - @classmethod - def get_form(cls, root, args, context, info): - form_data = args.get(cls._meta.input_field_name) - kwargs = cls.get_form_kwargs(root, args, context, info) - return cls._meta.form_class(data=form_data, **kwargs) - - @classmethod - def get_form_kwargs(cls, root, args, context, info): - return {} + return cls(errors=errors) -class FormMutation(six.with_metaclass(FormMutationMeta, BaseFormMutation)): +class FormMutationOptions(MutationOptions): + form_class = None + + +class FormMutation(BaseFormMutation): + class Meta: + abstract = True errors = graphene.List(ErrorType) + @classmethod + def __init_subclass_with_meta__(cls, form_class=None, + only_fields=(), exclude_fields=(), **options): -class ModelFormMutationMeta(MutationMeta): - def __new__(cls, name, bases, attrs): - if not is_base_type(bases, ModelFormMutationMeta): - return type.__new__(cls, name, bases, attrs) + if not form_class: + raise Exception('form_class is required for FormMutation') - options = Options( - attrs.pop('Meta', None), - name=name, - description=attrs.pop('__doc__', None), - form_class=None, - input_field_name='input', - return_field_name=None, - model=None, - local_fields=None, - only_fields=(), - exclude_fields=(), - interfaces=(), - registry=None + form = form_class() + input_fields = fields_for_form(form, only_fields, exclude_fields) + output_fields = fields_for_form(form, only_fields, exclude_fields) + + _meta = FormMutationOptions(cls) + _meta.form_class = form_class + _meta.fields = yank_fields_from_attrs( + output_fields, + _as=Field, ) - if not options.form_class: - raise Exception('Missing form_class') - - cls = ObjectTypeMeta.__new__( - cls, name, bases, dict(attrs, _meta=options) + input_fields = yank_fields_from_attrs( + input_fields, + _as=InputField, ) + super(FormMutation, cls).__init_subclass_with_meta__(_meta=_meta, input_fields=input_fields, **options) - options.fields = merge( - options.interface_fields, options.base_fields, options.local_fields, - {'errors': get_field_as(cls.errors, Field)} - ) + @classmethod + def perform_mutate(cls, form, info): + form.save() + return cls(errors=None) - cls.Input = convert_form_to_input_type(options.form_class) - field_kwargs = {options.input_field_name: Argument(cls.Input, required=True)} - cls.Field = partial( - Field, - cls, - resolver=cls.mutate, - **field_kwargs - ) +class ModelFormMutationOptions(FormMutationOptions): + model = None + return_field_name = None - cls.model = options.model or options.form_class.Meta.model - cls.return_field_name = cls._meta.return_field_name or cls.model._meta.model_name + +class ModelFormMutation(BaseFormMutation): + class Meta: + abstract = True + + errors = graphene.List(ErrorType) + + @classmethod + def __init_subclass_with_meta__(cls, form_class=None, model=None, return_field_name=None, + only_fields=(), exclude_fields=(), **options): + + if not form_class: + raise Exception('form_class is required for ModelFormMutation') + + if not model: + model = form_class._meta.model + + if not model: + raise Exception('model is required for ModelFormMutation') + + form = form_class() + input_fields = fields_for_form(form, only_fields, exclude_fields) registry = get_global_registry() - model_type = registry.get_type_for_model(cls.model) + model_type = registry.get_type_for_model(model) + return_field_name = return_field_name or model._meta.model_name + output_fields = OrderedDict() + output_fields[return_field_name] = graphene.Field(model_type) - options.fields[cls.return_field_name] = graphene.Field(model_type) + _meta = ModelFormMutationOptions(cls) + _meta.form_class = form_class + _meta.model = model + _meta.return_field_name = return_field_name + _meta.fields = yank_fields_from_attrs( + output_fields, + _as=Field, + ) - return cls - - -class ModelFormMutation(six.with_metaclass(ModelFormMutationMeta, BaseFormMutation)): - - errors = graphene.List(ErrorType) + input_fields = yank_fields_from_attrs( + input_fields, + _as=InputField, + ) + super(ModelFormMutation, cls).__init_subclass_with_meta__(_meta=_meta, input_fields=input_fields, **options) @classmethod - def form_valid(cls, form, info): + def perform_mutate(cls, form, info): obj = form.save() - kwargs = {cls.return_field_name: obj} - return cls(errors=[], **kwargs) + kwargs = {cls._meta.return_field_name: obj} + return cls(errors=None, **kwargs) diff --git a/graphene_django/forms/tests/test_converter.py b/graphene_django/forms/tests/test_converter.py index ec66f8f..f002031 100644 --- a/graphene_django/forms/tests/test_converter.py +++ b/graphene_django/forms/tests/test_converter.py @@ -5,7 +5,6 @@ import graphene from graphene import ID, List, NonNull from ..converter import convert_form_field -from .models import Reporter def assert_conversion(django_field, graphene_field, *args): @@ -24,15 +23,15 @@ def test_should_unknown_django_field_raise_exception(): def test_should_date_convert_string(): - assert_conversion(forms.DateField, graphene.String) + assert_conversion(forms.DateField, graphene.types.datetime.DateTime) def test_should_time_convert_string(): - assert_conversion(forms.TimeField, graphene.String) + assert_conversion(forms.TimeField, graphene.types.datetime.Time) def test_should_date_time_convert_string(): - assert_conversion(forms.DateTimeField, graphene.String) + assert_conversion(forms.DateTimeField, graphene.types.datetime.DateTime) def test_should_char_convert_string(): @@ -91,13 +90,13 @@ def test_should_decimal_convert_float(): def test_should_multiple_choice_convert_connectionorlist(): - field = forms.ModelMultipleChoiceField(Reporter.objects.all()) + field = forms.ModelMultipleChoiceField(queryset=None) graphene_type = convert_form_field(field) assert isinstance(graphene_type, List) assert graphene_type.of_type == ID def test_should_manytoone_convert_connectionorlist(): - field = forms.ModelChoiceField(Reporter.objects.all()) + field = forms.ModelChoiceField(queryset=None) graphene_type = convert_form_field(field) assert isinstance(graphene_type, graphene.ID) diff --git a/graphene_django/forms/tests/test_coverter.py b/graphene_django/forms/tests/test_coverter.py deleted file mode 100644 index e4a686b..0000000 --- a/graphene_django/forms/tests/test_coverter.py +++ /dev/null @@ -1,98 +0,0 @@ -import copy - -from django import forms -from py.test import raises - -import graphene - -from ..converter import convert_form_field - - -def _get_type(form_field, **kwargs): - # prevents the following error: - # AssertionError: The `source` argument is not meaningful when applied to a `child=` field. - # Remove `source=` from the field declaration. - # since we are reusing the same child in when testing the required attribute - - if 'child' in kwargs: - kwargs['child'] = copy.deepcopy(kwargs['child']) - - field = form_field(**kwargs) - - return convert_form_field(field) - - -def assert_conversion(form_field, graphene_field, **kwargs): - graphene_type = _get_type(form_field, help_text='Custom Help Text', **kwargs) - assert isinstance(graphene_type, graphene_field) - - graphene_type_required = _get_type( - form_field, help_text='Custom Help Text', required=True, **kwargs - ) - assert isinstance(graphene_type_required, graphene_field) - - return graphene_type - - -def test_should_unknown_form_field_raise_exception(): - with raises(Exception) as excinfo: - convert_form_field(None) - assert 'Don\'t know how to convert the form field' in str(excinfo.value) - - -def test_should_charfield_convert_string(): - assert_conversion(forms.CharField, graphene.String) - - -def test_should_timefield_convert_time(): - assert_conversion(forms.TimeField, graphene.types.datetime.Time) - - -def test_should_email_convert_string(): - assert_conversion(forms.EmailField, graphene.String) - - -def test_should_slug_convert_string(): - assert_conversion(forms.SlugField, graphene.String) - - -def test_should_url_convert_string(): - assert_conversion(forms.URLField, graphene.String) - - -def test_should_choicefield_convert_string(): - assert_conversion(forms.ChoiceField, graphene.String, choices=[]) - - -def test_should_regexfield_convert_string(): - assert_conversion(forms.RegexField, graphene.String, regex='[0-9]+') - - -def test_should_uuidfield_convert_string(): - assert_conversion(forms.UUIDField, graphene.String) - - -def test_should_integer_convert_int(): - assert_conversion(forms.IntegerField, graphene.Int) - - -def test_should_boolean_convert_boolean(): - assert_conversion(forms.BooleanField, graphene.Boolean) - - -def test_should_float_convert_float(): - assert_conversion(forms.FloatField, graphene.Float) - - -def test_should_decimal_convert_float(): - assert_conversion(forms.DecimalField, graphene.Float, max_digits=4, decimal_places=2) - - -def test_should_filepath_convert_string(): - assert_conversion(forms.FilePathField, graphene.String, path='/') - - -def test_should_multiplechoicefield_convert_to_list_of_string(): - field = assert_conversion(forms.MultipleChoiceField, graphene.List, choices=[1, 2, 3]) - - assert field.of_type == graphene.String diff --git a/graphene_django/forms/tests/test_mutation.py b/graphene_django/forms/tests/test_mutation.py index 9874ae6..5f1ef4a 100644 --- a/graphene_django/forms/tests/test_mutation.py +++ b/graphene_django/forms/tests/test_mutation.py @@ -2,7 +2,7 @@ from django import forms from django.test import TestCase from py.test import raises -from graphene_django.tests.models import Pet +from graphene_django.tests.models import Pet, Film from ..mutation import FormMutation, ModelFormMutation @@ -22,10 +22,10 @@ def test_needs_form_class(): class MyMutation(FormMutation): pass - assert exc.value.args[0] == 'Missing form_class' + assert exc.value.args[0] == 'form_class is required for FormMutation' -def test_has_fields(): +def test_has_output_fields(): class MyMutation(FormMutation): class Meta: form_class = MyForm @@ -43,20 +43,32 @@ def test_has_input_fields(): class ModelFormMutationTests(TestCase): - def test_model_form_mutation(self): + def test_default_meta_fields(self): class PetMutation(ModelFormMutation): class Meta: form_class = PetForm - self.assertEqual(PetMutation.model, Pet) - self.assertEqual(PetMutation.return_field_name, 'pet') + self.assertEqual(PetMutation._meta.model, Pet) + self.assertEqual(PetMutation._meta.return_field_name, 'pet') + self.assertIn('pet', PetMutation._meta.fields) + + def test_custom_return_field_name(self): + class PetMutation(ModelFormMutation): + class Meta: + form_class = PetForm + model = Film + return_field_name = 'animal' + + self.assertEqual(PetMutation._meta.model, Film) + self.assertEqual(PetMutation._meta.return_field_name, 'animal') + self.assertIn('animal', PetMutation._meta.fields) def test_model_form_mutation_mutate(self): class PetMutation(ModelFormMutation): class Meta: form_class = PetForm - PetMutation.mutate(None, {'input': {'name': 'Fluffy'}}, None, None) + PetMutation.mutate_and_get_payload(None, None, name='Fluffy') self.assertEqual(Pet.objects.count(), 1) pet = Pet.objects.get() From bf7ad7eeda4c493d2b5954ee69232ec052eeaea6 Mon Sep 17 00:00:00 2001 From: Grant McConnaughey Date: Mon, 2 Oct 2017 13:15:29 -0500 Subject: [PATCH 009/111] Test invalid forms --- graphene_django/forms/converter.py | 15 --------------- graphene_django/forms/mutation.py | 4 ++-- graphene_django/forms/tests/test_mutation.py | 17 ++++++++++++++++- 3 files changed, 18 insertions(+), 18 deletions(-) diff --git a/graphene_django/forms/converter.py b/graphene_django/forms/converter.py index 220edc4..9d87811 100644 --- a/graphene_django/forms/converter.py +++ b/graphene_django/forms/converter.py @@ -16,21 +16,6 @@ except AttributeError: singledispatch = import_single_dispatch() -def convert_form_to_input_type(form_class): - form = form_class() - - items = { - name: convert_form_field(field) - for name, field in form.fields.items() - } - - return type( - '{}Input'.format(form.__class__.__name__), - (graphene.InputObjectType, ), - items - ) - - @singledispatch def convert_form_field(field): raise ImproperlyConfigured( diff --git a/graphene_django/forms/mutation.py b/graphene_django/forms/mutation.py index bbe5f80..49fabb8 100644 --- a/graphene_django/forms/mutation.py +++ b/graphene_django/forms/mutation.py @@ -83,7 +83,7 @@ class FormMutation(BaseFormMutation): @classmethod def perform_mutate(cls, form, info): form.save() - return cls(errors=None) + return cls(errors=[]) class ModelFormMutationOptions(FormMutationOptions): @@ -138,4 +138,4 @@ class ModelFormMutation(BaseFormMutation): def perform_mutate(cls, form, info): obj = form.save() kwargs = {cls._meta.return_field_name: obj} - return cls(errors=None, **kwargs) + return cls(errors=[], **kwargs) diff --git a/graphene_django/forms/tests/test_mutation.py b/graphene_django/forms/tests/test_mutation.py index 5f1ef4a..084b8b0 100644 --- a/graphene_django/forms/tests/test_mutation.py +++ b/graphene_django/forms/tests/test_mutation.py @@ -68,8 +68,23 @@ class ModelFormMutationTests(TestCase): class Meta: form_class = PetForm - PetMutation.mutate_and_get_payload(None, None, name='Fluffy') + result = PetMutation.mutate_and_get_payload(None, None, name='Fluffy') self.assertEqual(Pet.objects.count(), 1) pet = Pet.objects.get() self.assertEqual(pet.name, 'Fluffy') + self.assertEqual(result.errors, []) + + def test_model_form_mutation_mutate_invalid_form(self): + class PetMutation(ModelFormMutation): + class Meta: + form_class = PetForm + + result = PetMutation.mutate_and_get_payload(None, None) + + # A pet was not created + self.assertEqual(Pet.objects.count(), 0) + + self.assertEqual(len(result.errors), 1) + self.assertEqual(result.errors[0].field, 'name') + self.assertEqual(result.errors[0].messages, ['This field is required.']) From 40610c64a3be003719d88db439e442085ed18072 Mon Sep 17 00:00:00 2001 From: Grant McConnaughey Date: Wed, 29 Nov 2017 14:12:02 -0600 Subject: [PATCH 010/111] Support instance kwarg --- graphene_django/forms/mutation.py | 40 ++++++++++++++------ graphene_django/forms/tests/test_mutation.py | 34 ++++++++++++----- 2 files changed, 52 insertions(+), 22 deletions(-) diff --git a/graphene_django/forms/mutation.py b/graphene_django/forms/mutation.py index 49fabb8..876e76a 100644 --- a/graphene_django/forms/mutation.py +++ b/graphene_django/forms/mutation.py @@ -27,13 +27,13 @@ def fields_for_form(form, only_fields, exclude_fields): return fields -class BaseFormMutation(ClientIDMutation): +class BaseDjangoFormMutation(ClientIDMutation): class Meta: abstract = True @classmethod def mutate_and_get_payload(cls, root, info, **input): - form = cls._meta.form_class(data=input) + form = cls.get_form(root, info, **input) if form.is_valid(): return cls.perform_mutate(form, info) @@ -45,12 +45,28 @@ class BaseFormMutation(ClientIDMutation): return cls(errors=errors) + @classmethod + def get_form(cls, root, info, **input): + form_kwargs = cls.get_form_kwargs(root, info, **input) + return cls._meta.form_class(**form_kwargs) -class FormMutationOptions(MutationOptions): + @classmethod + def get_form_kwargs(cls, root, info, **input): + kwargs = {'data': input} + + pk = input.pop('id', None) + if pk: + instance = cls._meta.model._default_manager.get(pk=pk) + kwargs['instance'] = instance + + return kwargs + + +class DjangoFormMutationOptions(MutationOptions): form_class = None -class FormMutation(BaseFormMutation): +class DjangoFormMutation(BaseDjangoFormMutation): class Meta: abstract = True @@ -67,7 +83,7 @@ class FormMutation(BaseFormMutation): input_fields = fields_for_form(form, only_fields, exclude_fields) output_fields = fields_for_form(form, only_fields, exclude_fields) - _meta = FormMutationOptions(cls) + _meta = DjangoFormMutationOptions(cls) _meta.form_class = form_class _meta.fields = yank_fields_from_attrs( output_fields, @@ -78,7 +94,7 @@ class FormMutation(BaseFormMutation): input_fields, _as=InputField, ) - super(FormMutation, cls).__init_subclass_with_meta__(_meta=_meta, input_fields=input_fields, **options) + super(DjangoFormMutation, cls).__init_subclass_with_meta__(_meta=_meta, input_fields=input_fields, **options) @classmethod def perform_mutate(cls, form, info): @@ -86,12 +102,12 @@ class FormMutation(BaseFormMutation): return cls(errors=[]) -class ModelFormMutationOptions(FormMutationOptions): +class DjangoModelDjangoFormMutationOptions(DjangoFormMutationOptions): model = None return_field_name = None -class ModelFormMutation(BaseFormMutation): +class DjangoModelFormMutation(BaseDjangoFormMutation): class Meta: abstract = True @@ -102,13 +118,13 @@ class ModelFormMutation(BaseFormMutation): only_fields=(), exclude_fields=(), **options): if not form_class: - raise Exception('form_class is required for ModelFormMutation') + raise Exception('form_class is required for DjangoModelFormMutation') if not model: model = form_class._meta.model if not model: - raise Exception('model is required for ModelFormMutation') + raise Exception('model is required for DjangoModelFormMutation') form = form_class() input_fields = fields_for_form(form, only_fields, exclude_fields) @@ -119,7 +135,7 @@ class ModelFormMutation(BaseFormMutation): output_fields = OrderedDict() output_fields[return_field_name] = graphene.Field(model_type) - _meta = ModelFormMutationOptions(cls) + _meta = DjangoModelDjangoFormMutationOptions(cls) _meta.form_class = form_class _meta.model = model _meta.return_field_name = return_field_name @@ -132,7 +148,7 @@ class ModelFormMutation(BaseFormMutation): input_fields, _as=InputField, ) - super(ModelFormMutation, cls).__init_subclass_with_meta__(_meta=_meta, input_fields=input_fields, **options) + super(DjangoModelFormMutation, cls).__init_subclass_with_meta__(_meta=_meta, input_fields=input_fields, **options) @classmethod def perform_mutate(cls, form, info): diff --git a/graphene_django/forms/tests/test_mutation.py b/graphene_django/forms/tests/test_mutation.py index 084b8b0..5876405 100644 --- a/graphene_django/forms/tests/test_mutation.py +++ b/graphene_django/forms/tests/test_mutation.py @@ -3,7 +3,7 @@ from django.test import TestCase from py.test import raises from graphene_django.tests.models import Pet, Film -from ..mutation import FormMutation, ModelFormMutation +from ..mutation import DjangoFormMutation, DjangoModelFormMutation class MyForm(forms.Form): @@ -19,14 +19,14 @@ class PetForm(forms.ModelForm): def test_needs_form_class(): with raises(Exception) as exc: - class MyMutation(FormMutation): + class MyMutation(DjangoFormMutation): pass assert exc.value.args[0] == 'form_class is required for FormMutation' def test_has_output_fields(): - class MyMutation(FormMutation): + class MyMutation(DjangoFormMutation): class Meta: form_class = MyForm @@ -34,7 +34,7 @@ def test_has_output_fields(): def test_has_input_fields(): - class MyMutation(FormMutation): + class MyMutation(DjangoFormMutation): class Meta: form_class = MyForm @@ -44,7 +44,7 @@ def test_has_input_fields(): class ModelFormMutationTests(TestCase): def test_default_meta_fields(self): - class PetMutation(ModelFormMutation): + class PetMutation(DjangoModelFormMutation): class Meta: form_class = PetForm @@ -53,7 +53,7 @@ class ModelFormMutationTests(TestCase): self.assertIn('pet', PetMutation._meta.fields) def test_custom_return_field_name(self): - class PetMutation(ModelFormMutation): + class PetMutation(DjangoModelFormMutation): class Meta: form_class = PetForm model = Film @@ -64,19 +64,33 @@ class ModelFormMutationTests(TestCase): self.assertIn('animal', PetMutation._meta.fields) def test_model_form_mutation_mutate(self): - class PetMutation(ModelFormMutation): + class PetMutation(DjangoModelFormMutation): class Meta: form_class = PetForm - result = PetMutation.mutate_and_get_payload(None, None, name='Fluffy') + pet = Pet.objects.create(name='Axel') + + result = PetMutation.mutate_and_get_payload(None, None, id=pet.pk, name='Mia') + + self.assertEqual(Pet.objects.count(), 1) + pet.refresh_from_db() + self.assertEqual(pet.name, 'Mia') + self.assertEqual(result.errors, []) + + def test_model_form_mutation_updates_existing_(self): + class PetMutation(DjangoModelFormMutation): + class Meta: + form_class = PetForm + + result = PetMutation.mutate_and_get_payload(None, None, name='Mia') self.assertEqual(Pet.objects.count(), 1) pet = Pet.objects.get() - self.assertEqual(pet.name, 'Fluffy') + self.assertEqual(pet.name, 'Mia') self.assertEqual(result.errors, []) def test_model_form_mutation_mutate_invalid_form(self): - class PetMutation(ModelFormMutation): + class PetMutation(DjangoModelFormMutation): class Meta: form_class = PetForm From d6dbe2a4a81dd069d12bfb75f8e997f8105d7335 Mon Sep 17 00:00:00 2001 From: Grant McConnaughey Date: Wed, 29 Nov 2017 14:20:56 -0600 Subject: [PATCH 011/111] Default return_field_name is camcelcased --- graphene_django/forms/mutation.py | 6 +++++- graphene_django/forms/tests/test_mutation.py | 11 ++++++++++- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/graphene_django/forms/mutation.py b/graphene_django/forms/mutation.py index 876e76a..58e0075 100644 --- a/graphene_django/forms/mutation.py +++ b/graphene_django/forms/mutation.py @@ -131,7 +131,11 @@ class DjangoModelFormMutation(BaseDjangoFormMutation): registry = get_global_registry() model_type = registry.get_type_for_model(model) - return_field_name = return_field_name or model._meta.model_name + return_field_name = return_field_name + if not return_field_name: + model_name = model.__name__ + return_field_name = model_name[:1].lower() + model_name[1:] + output_fields = OrderedDict() output_fields[return_field_name] = graphene.Field(model_type) diff --git a/graphene_django/forms/tests/test_mutation.py b/graphene_django/forms/tests/test_mutation.py index 5876405..3bfb883 100644 --- a/graphene_django/forms/tests/test_mutation.py +++ b/graphene_django/forms/tests/test_mutation.py @@ -2,7 +2,7 @@ from django import forms from django.test import TestCase from py.test import raises -from graphene_django.tests.models import Pet, Film +from graphene_django.tests.models import Pet, Film, FilmDetails from ..mutation import DjangoFormMutation, DjangoModelFormMutation @@ -52,6 +52,15 @@ class ModelFormMutationTests(TestCase): self.assertEqual(PetMutation._meta.return_field_name, 'pet') self.assertIn('pet', PetMutation._meta.fields) + def test_return_field_name_is_camelcased(self): + class PetMutation(DjangoModelFormMutation): + class Meta: + form_class = PetForm + model = FilmDetails + + self.assertEqual(PetMutation._meta.model, FilmDetails) + self.assertEqual(PetMutation._meta.return_field_name, 'filmDetails') + def test_custom_return_field_name(self): class PetMutation(DjangoModelFormMutation): class Meta: From 748dc4c50994c99301143aaff36035ac513309f6 Mon Sep 17 00:00:00 2001 From: Grant McConnaughey Date: Wed, 29 Nov 2017 15:15:16 -0600 Subject: [PATCH 012/111] Add id input field to model form mutation --- graphene_django/forms/mutation.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/graphene_django/forms/mutation.py b/graphene_django/forms/mutation.py index 58e0075..e8e76a2 100644 --- a/graphene_django/forms/mutation.py +++ b/graphene_django/forms/mutation.py @@ -77,7 +77,7 @@ class DjangoFormMutation(BaseDjangoFormMutation): only_fields=(), exclude_fields=(), **options): if not form_class: - raise Exception('form_class is required for FormMutation') + raise Exception('form_class is required for DjangoFormMutation') form = form_class() input_fields = fields_for_form(form, only_fields, exclude_fields) @@ -128,6 +128,7 @@ class DjangoModelFormMutation(BaseDjangoFormMutation): form = form_class() input_fields = fields_for_form(form, only_fields, exclude_fields) + input_fields['id'] = convert_form_field(model._meta.pk) registry = get_global_registry() model_type = registry.get_type_for_model(model) From 6d7a0d053dfff709dabef85d5509a648df594715 Mon Sep 17 00:00:00 2001 From: Grant McConnaughey Date: Wed, 29 Nov 2017 15:25:24 -0600 Subject: [PATCH 013/111] Make id field an ID type --- graphene_django/forms/mutation.py | 2 +- graphene_django/forms/tests/test_mutation.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/graphene_django/forms/mutation.py b/graphene_django/forms/mutation.py index e8e76a2..793aafe 100644 --- a/graphene_django/forms/mutation.py +++ b/graphene_django/forms/mutation.py @@ -128,7 +128,7 @@ class DjangoModelFormMutation(BaseDjangoFormMutation): form = form_class() input_fields = fields_for_form(form, only_fields, exclude_fields) - input_fields['id'] = convert_form_field(model._meta.pk) + input_fields['id'] = graphene.ID() registry = get_global_registry() model_type = registry.get_type_for_model(model) diff --git a/graphene_django/forms/tests/test_mutation.py b/graphene_django/forms/tests/test_mutation.py index 3bfb883..10a15ae 100644 --- a/graphene_django/forms/tests/test_mutation.py +++ b/graphene_django/forms/tests/test_mutation.py @@ -22,7 +22,7 @@ def test_needs_form_class(): class MyMutation(DjangoFormMutation): pass - assert exc.value.args[0] == 'form_class is required for FormMutation' + assert exc.value.args[0] == 'form_class is required for DjangoFormMutation' def test_has_output_fields(): From c3938d1e4f7679f61a939aa875ac4e37734b47a1 Mon Sep 17 00:00:00 2001 From: Grant McConnaughey Date: Wed, 29 Nov 2017 15:31:26 -0600 Subject: [PATCH 014/111] Fix line length --- graphene_django/forms/mutation.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/graphene_django/forms/mutation.py b/graphene_django/forms/mutation.py index 793aafe..4ce9a5d 100644 --- a/graphene_django/forms/mutation.py +++ b/graphene_django/forms/mutation.py @@ -153,7 +153,11 @@ class DjangoModelFormMutation(BaseDjangoFormMutation): input_fields, _as=InputField, ) - super(DjangoModelFormMutation, cls).__init_subclass_with_meta__(_meta=_meta, input_fields=input_fields, **options) + super(DjangoModelFormMutation, cls).__init_subclass_with_meta__( + _meta=_meta, + input_fields=input_fields, + **options + ) @classmethod def perform_mutate(cls, form, info): From 443b5eaafc22919d828b30a1d86cf8c117c0b8e6 Mon Sep 17 00:00:00 2001 From: Stefan Stammberger Date: Sat, 2 Dec 2017 19:35:17 +0100 Subject: [PATCH 015/111] Docs: Update Cookbook tutorial --- docs/tutorial-plain.rst | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/tutorial-plain.rst b/docs/tutorial-plain.rst index eca7904..966d973 100644 --- a/docs/tutorial-plain.rst +++ b/docs/tutorial-plain.rst @@ -68,7 +68,8 @@ Let's get started with these models: class Ingredient(models.Model): name = models.CharField(max_length=100) notes = models.TextField() - category = models.ForeignKey(Category, related_name='ingredients') + category = models.ForeignKey( + Category, related_name='ingredients', on_delete=models.CASCADE) def __str__(self): return self.name @@ -80,9 +81,21 @@ Add ingredients as INSTALLED_APPS: INSTALLED_APPS = [ ... # Install the ingredients app - 'ingredients', + 'cookbook.ingredients', ] +Register models with admin panel: + +.. code:: python + + # cookbook/ingredients/admin.py + from django.contrib import admin + from cookbook.ingredients.models import Category, Ingredient + + admin.site.register(Category) + admin.site.register(Ingredient) + + Don't forget to create & run migrations: .. code:: bash From 73706fa6bbe692642db28a622d28db7894506072 Mon Sep 17 00:00:00 2001 From: = <=> Date: Tue, 5 Dec 2017 15:01:52 -0500 Subject: [PATCH 016/111] Add on_delete atrributes to test models foreignkeys --- examples/starwars/models.py | 6 +++--- graphene_django/tests/models.py | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/examples/starwars/models.py b/examples/starwars/models.py index 2f80e27..45741da 100644 --- a/examples/starwars/models.py +++ b/examples/starwars/models.py @@ -5,7 +5,7 @@ from django.db import models class Character(models.Model): name = models.CharField(max_length=50) - ship = models.ForeignKey('Ship', blank=True, null=True, related_name='characters') + ship = models.ForeignKey('Ship', on_delete=models.CASCADE, blank=True, null=True, related_name='characters') def __str__(self): return self.name @@ -13,7 +13,7 @@ class Character(models.Model): class Faction(models.Model): name = models.CharField(max_length=50) - hero = models.ForeignKey(Character) + hero = models.ForeignKey(Character, on_delete=models.CASCADE) def __str__(self): return self.name @@ -21,7 +21,7 @@ class Faction(models.Model): class Ship(models.Model): name = models.CharField(max_length=50) - faction = models.ForeignKey(Faction, related_name='ships') + faction = models.ForeignKey(Faction, on_delete=models.CASCADE, related_name='ships') def __str__(self): return self.name diff --git a/graphene_django/tests/models.py b/graphene_django/tests/models.py index 0c62f28..db1fca4 100644 --- a/graphene_django/tests/models.py +++ b/graphene_django/tests/models.py @@ -15,7 +15,7 @@ class Pet(models.Model): class FilmDetails(models.Model): location = models.CharField(max_length=30) - film = models.OneToOneField('Film', related_name='details') + film = models.OneToOneField('Film', on_delete=models.CASCADE, related_name='details') class Film(models.Model): @@ -37,8 +37,8 @@ class Reporter(models.Model): class Article(models.Model): headline = models.CharField(max_length=100) pub_date = models.DateField() - reporter = models.ForeignKey(Reporter, related_name='articles') - editor = models.ForeignKey(Reporter, related_name='edited_articles_+') + reporter = models.ForeignKey(Reporter, on_delete=models.CASCADE, related_name='articles') + editor = models.ForeignKey(Reporter, on_delete=models.CASCADE, related_name='edited_articles_+') lang = models.CharField(max_length=2, help_text='Language', choices=[ ('es', 'Spanish'), ('en', 'English') From 62c0694901cb0e4f711750bebb2901d509088cc0 Mon Sep 17 00:00:00 2001 From: = <=> Date: Tue, 5 Dec 2017 15:04:29 -0500 Subject: [PATCH 017/111] models.DateField corresponds to graphene Date Scalar --- graphene_django/converter.py | 9 +++++++-- graphene_django/filter/tests/test_fields.py | 10 ++++++---- graphene_django/rest_framework/serializer_converter.py | 6 +++++- .../rest_framework/tests/test_field_converter.py | 4 ++-- graphene_django/tests/models.py | 1 + graphene_django/tests/test_converter.py | 7 +++++-- graphene_django/tests/test_form_converter.py | 2 ++ graphene_django/tests/test_query.py | 7 +++++++ graphene_django/tests/test_types.py | 7 +++++-- 9 files changed, 40 insertions(+), 13 deletions(-) diff --git a/graphene_django/converter.py b/graphene_django/converter.py index dff77a8..fa771e2 100644 --- a/graphene_django/converter.py +++ b/graphene_django/converter.py @@ -3,7 +3,7 @@ from django.utils.encoding import force_text from graphene import (ID, Boolean, Dynamic, Enum, Field, Float, Int, List, NonNull, String, UUID) -from graphene.types.datetime import DateTime, Time +from graphene.types.datetime import DateTime, Date, Time from graphene.types.json import JSONString from graphene.utils.str_converters import to_camel_case, to_const from graphql import assert_valid_name @@ -121,11 +121,16 @@ def convert_field_to_float(field, registry=None): return Float(description=field.help_text, required=not field.null) -@convert_django_field.register(models.DateField) +@convert_django_field.register(models.DateTimeField) def convert_date_to_string(field, registry=None): return DateTime(description=field.help_text, required=not field.null) +@convert_django_field.register(models.DateField) +def convert_date_to_string(field, registry=None): + return Date(description=field.help_text, required=not field.null) + + @convert_django_field.register(models.TimeField) def convert_time_to_string(field, registry=None): return Time(description=field.help_text, required=not field.null) diff --git a/graphene_django/filter/tests/test_fields.py b/graphene_django/filter/tests/test_fields.py index 258da3e..c730ef3 100644 --- a/graphene_django/filter/tests/test_fields.py +++ b/graphene_django/filter/tests/test_fields.py @@ -157,8 +157,8 @@ def test_filter_shortcut_filterset_context(): r1 = Reporter.objects.create(first_name='r1', last_name='r1', email='r1@test.com') r2 = Reporter.objects.create(first_name='r2', last_name='r2', email='r2@test.com') - Article.objects.create(headline='a1', pub_date=datetime.now(), reporter=r1, editor=r1) - Article.objects.create(headline='a2', pub_date=datetime.now(), reporter=r2, editor=r2) + Article.objects.create(headline='a1', pub_date=datetime.now(), pub_date_time=datetime.now(), reporter=r1, editor=r1) + Article.objects.create(headline='a2', pub_date=datetime.now(), pub_date_time=datetime.now(), reporter=r2, editor=r2) class context(object): reporter = r2 @@ -245,8 +245,8 @@ def test_filter_filterset_related_results(): r1 = Reporter.objects.create(first_name='r1', last_name='r1', email='r1@test.com') r2 = Reporter.objects.create(first_name='r2', last_name='r2', email='r2@test.com') - Article.objects.create(headline='a1', pub_date=datetime.now(), reporter=r1) - Article.objects.create(headline='a2', pub_date=datetime.now(), reporter=r2) + Article.objects.create(headline='a1', pub_date=datetime.now(), pub_date_time=datetime.now(), reporter=r1) + Article.objects.create(headline='a2', pub_date=datetime.now(), pub_date_time=datetime.now(), reporter=r2) query = ''' query { @@ -464,6 +464,7 @@ def test_should_query_filter_node_limit(): Article.objects.create( headline='Article Node 1', pub_date=datetime.now(), + pub_date_time=datetime.now(), reporter=r, editor=r, lang='es' @@ -471,6 +472,7 @@ def test_should_query_filter_node_limit(): Article.objects.create( headline='Article Node 2', pub_date=datetime.now(), + pub_date_time=datetime.now(), reporter=r, editor=r, lang='en' diff --git a/graphene_django/rest_framework/serializer_converter.py b/graphene_django/rest_framework/serializer_converter.py index 6a57f5f..0c10a65 100644 --- a/graphene_django/rest_framework/serializer_converter.py +++ b/graphene_django/rest_framework/serializer_converter.py @@ -92,11 +92,15 @@ def convert_serializer_field_to_float(field): @get_graphene_type_from_serializer_field.register(serializers.DateTimeField) -@get_graphene_type_from_serializer_field.register(serializers.DateField) def convert_serializer_field_to_date_time(field): return graphene.types.datetime.DateTime +@get_graphene_type_from_serializer_field.register(serializers.DateField) +def convert_serializer_field_to_date_time(field): + return graphene.types.datetime.Date + + @get_graphene_type_from_serializer_field.register(serializers.TimeField) def convert_serializer_field_to_time(field): return graphene.types.datetime.Time diff --git a/graphene_django/rest_framework/tests/test_field_converter.py b/graphene_django/rest_framework/tests/test_field_converter.py index 623cf58..ec851c2 100644 --- a/graphene_django/rest_framework/tests/test_field_converter.py +++ b/graphene_django/rest_framework/tests/test_field_converter.py @@ -87,8 +87,8 @@ def test_should_date_time_convert_datetime(): assert_conversion(serializers.DateTimeField, graphene.types.datetime.DateTime) -def test_should_date_convert_datetime(): - assert_conversion(serializers.DateField, graphene.types.datetime.DateTime) +def test_should_date_convert_date(): + assert_conversion(serializers.DateField, graphene.types.datetime.Date) def test_should_time_convert_time(): diff --git a/graphene_django/tests/models.py b/graphene_django/tests/models.py index db1fca4..56fcecf 100644 --- a/graphene_django/tests/models.py +++ b/graphene_django/tests/models.py @@ -37,6 +37,7 @@ class Reporter(models.Model): class Article(models.Model): headline = models.CharField(max_length=100) pub_date = models.DateField() + pub_date_time = models.DateTimeField() reporter = models.ForeignKey(Reporter, on_delete=models.CASCADE, related_name='articles') editor = models.ForeignKey(Reporter, on_delete=models.CASCADE, related_name='edited_articles_+') lang = models.CharField(max_length=2, help_text='Language', choices=[ diff --git a/graphene_django/tests/test_converter.py b/graphene_django/tests/test_converter.py index d616106..3dd2963 100644 --- a/graphene_django/tests/test_converter.py +++ b/graphene_django/tests/test_converter.py @@ -5,7 +5,7 @@ from py.test import raises import graphene from graphene.relay import ConnectionField, Node -from graphene.types.datetime import DateTime, Time +from graphene.types.datetime import DateTime, Date, Time from graphene.types.json import JSONString from ..compat import JSONField, ArrayField, HStoreField, RangeField, MissingType @@ -38,9 +38,12 @@ def test_should_unknown_django_field_raise_exception(): convert_django_field(None) assert 'Don\'t know how to convert the Django field' in str(excinfo.value) +def test_should_date_time_convert_string(): + assert_conversion(models.DateTimeField, DateTime) + def test_should_date_convert_string(): - assert_conversion(models.DateField, DateTime) + assert_conversion(models.DateField, Date) def test_should_time_convert_string(): diff --git a/graphene_django/tests/test_form_converter.py b/graphene_django/tests/test_form_converter.py index 5a13554..97932d8 100644 --- a/graphene_django/tests/test_form_converter.py +++ b/graphene_django/tests/test_form_converter.py @@ -30,6 +30,8 @@ def test_should_date_convert_string(): def test_should_time_convert_string(): assert_conversion(forms.TimeField, graphene.String) +def test_should_date_convert_string(): + assert_conversion(forms.DateField, graphene.String) def test_should_date_time_convert_string(): assert_conversion(forms.DateTimeField, graphene.String) diff --git a/graphene_django/tests/test_query.py b/graphene_django/tests/test_query.py index 0dece3f..96e0f32 100644 --- a/graphene_django/tests/test_query.py +++ b/graphene_django/tests/test_query.py @@ -371,6 +371,7 @@ def test_should_query_node_filtering(): Article.objects.create( headline='Article Node 1', pub_date=datetime.date.today(), + pub_date_time=datetime.datetime.now(), reporter=r, editor=r, lang='es' @@ -378,6 +379,7 @@ def test_should_query_node_filtering(): Article.objects.create( headline='Article Node 2', pub_date=datetime.date.today(), + pub_date_time=datetime.datetime.now(), reporter=r, editor=r, lang='en' @@ -453,6 +455,7 @@ def test_should_query_node_multiple_filtering(): Article.objects.create( headline='Article Node 1', pub_date=datetime.date.today(), + pub_date_time=datetime.datetime.now(), reporter=r, editor=r, lang='es' @@ -460,6 +463,7 @@ def test_should_query_node_multiple_filtering(): Article.objects.create( headline='Article Node 2', pub_date=datetime.date.today(), + pub_date_time=datetime.datetime.now(), reporter=r, editor=r, lang='es' @@ -467,6 +471,7 @@ def test_should_query_node_multiple_filtering(): Article.objects.create( headline='Article Node 3', pub_date=datetime.date.today(), + pub_date_time=datetime.datetime.now(), reporter=r, editor=r, lang='en' @@ -692,6 +697,7 @@ def test_should_query_dataloader_fields(): Article.objects.create( headline='Article Node 1', pub_date=datetime.date.today(), + pub_date_time=datetime.datetime.now(), reporter=r, editor=r, lang='es' @@ -699,6 +705,7 @@ def test_should_query_dataloader_fields(): Article.objects.create( headline='Article Node 2', pub_date=datetime.date.today(), + pub_date_time=datetime.datetime.now(), reporter=r, editor=r, lang='en' diff --git a/graphene_django/tests/test_types.py b/graphene_django/tests/test_types.py index 83d9b40..0e0679b 100644 --- a/graphene_django/tests/test_types.py +++ b/graphene_django/tests/test_types.py @@ -64,7 +64,7 @@ def test_django_objecttype_map_correct_fields(): def test_django_objecttype_with_node_have_correct_fields(): fields = Article._meta.fields - assert list(fields.keys()) == ['id', 'headline', 'pub_date', 'reporter', 'editor', 'lang', 'importance'] + assert list(fields.keys()) == ['id', 'headline', 'pub_date', 'pub_date_time', 'reporter', 'editor', 'lang', 'importance'] def test_schema_representation(): @@ -76,7 +76,8 @@ schema { type Article implements Node { id: ID! headline: String! - pubDate: DateTime! + pubDate: Date! + pubDateTime: DateTime! reporter: Reporter! editor: Reporter! lang: ArticleLang! @@ -104,6 +105,8 @@ enum ArticleLang { EN } +scalar Date + scalar DateTime interface Node { From d314d1041fc86bf08224bf0ddb8da7f7d279cd5b Mon Sep 17 00:00:00 2001 From: = <=> Date: Wed, 6 Dec 2017 12:45:03 -0500 Subject: [PATCH 018/111] rel -> remote_field: Update Django DeprecatedAttribute --- graphene_django/filter/filterset.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/graphene_django/filter/filterset.py b/graphene_django/filter/filterset.py index c716b05..4873f71 100644 --- a/graphene_django/filter/filterset.py +++ b/graphene_django/filter/filterset.py @@ -57,7 +57,7 @@ class GrapheneFilterSetMixin(BaseFilterSet): Global IDs (the default implementation expects database primary keys) """ - rel = f.field.rel + rel = f.field.remote_field default = { 'name': name, 'label': capfirst(rel.related_name) From 384bff08e8fa6fb61cf41be81d914ddb65d70a03 Mon Sep 17 00:00:00 2001 From: = <=> Date: Wed, 6 Dec 2017 13:10:03 -0500 Subject: [PATCH 019/111] Add fallback for depracated atrribute --- graphene_django/filter/filterset.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/graphene_django/filter/filterset.py b/graphene_django/filter/filterset.py index 4873f71..231a8e1 100644 --- a/graphene_django/filter/filterset.py +++ b/graphene_django/filter/filterset.py @@ -57,7 +57,10 @@ class GrapheneFilterSetMixin(BaseFilterSet): Global IDs (the default implementation expects database primary keys) """ - rel = f.field.remote_field + try: + rel = f.field.remote_field + except AttributeError: + rel = f.field.rel default = { 'name': name, 'label': capfirst(rel.related_name) From 489d2878da1d3563930c47329baffe08a8af5e38 Mon Sep 17 00:00:00 2001 From: = <=> Date: Wed, 6 Dec 2017 15:10:50 -0500 Subject: [PATCH 020/111] django version depends on python version --- setup.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/setup.py b/setup.py index beee83c..2e835d1 100644 --- a/setup.py +++ b/setup.py @@ -24,6 +24,7 @@ tests_require = [ 'pytest-django==2.9.1', ] + rest_framework_require +django_version = 'Django>=1.8.0,<2' if sys.version_info[0] < 3 else 'Django>=1.8.0' setup( name='graphene-django', version=version, @@ -58,7 +59,7 @@ setup( install_requires=[ 'six>=1.10.0', 'graphene>=2.0,<3', - 'Django>=1.8.0', + django_version, 'iso8601', 'singledispatch>=3.4.0.3', 'promise>=2.1', From f687406ac5f2b1b7ff55a0f1ae91dc1117f371c8 Mon Sep 17 00:00:00 2001 From: = <=> Date: Tue, 5 Dec 2017 15:01:52 -0500 Subject: [PATCH 021/111] Add on_delete atrributes to test models foreignkeys --- examples/starwars/models.py | 6 +++--- graphene_django/tests/models.py | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/examples/starwars/models.py b/examples/starwars/models.py index 2f80e27..45741da 100644 --- a/examples/starwars/models.py +++ b/examples/starwars/models.py @@ -5,7 +5,7 @@ from django.db import models class Character(models.Model): name = models.CharField(max_length=50) - ship = models.ForeignKey('Ship', blank=True, null=True, related_name='characters') + ship = models.ForeignKey('Ship', on_delete=models.CASCADE, blank=True, null=True, related_name='characters') def __str__(self): return self.name @@ -13,7 +13,7 @@ class Character(models.Model): class Faction(models.Model): name = models.CharField(max_length=50) - hero = models.ForeignKey(Character) + hero = models.ForeignKey(Character, on_delete=models.CASCADE) def __str__(self): return self.name @@ -21,7 +21,7 @@ class Faction(models.Model): class Ship(models.Model): name = models.CharField(max_length=50) - faction = models.ForeignKey(Faction, related_name='ships') + faction = models.ForeignKey(Faction, on_delete=models.CASCADE, related_name='ships') def __str__(self): return self.name diff --git a/graphene_django/tests/models.py b/graphene_django/tests/models.py index 0c62f28..db1fca4 100644 --- a/graphene_django/tests/models.py +++ b/graphene_django/tests/models.py @@ -15,7 +15,7 @@ class Pet(models.Model): class FilmDetails(models.Model): location = models.CharField(max_length=30) - film = models.OneToOneField('Film', related_name='details') + film = models.OneToOneField('Film', on_delete=models.CASCADE, related_name='details') class Film(models.Model): @@ -37,8 +37,8 @@ class Reporter(models.Model): class Article(models.Model): headline = models.CharField(max_length=100) pub_date = models.DateField() - reporter = models.ForeignKey(Reporter, related_name='articles') - editor = models.ForeignKey(Reporter, related_name='edited_articles_+') + reporter = models.ForeignKey(Reporter, on_delete=models.CASCADE, related_name='articles') + editor = models.ForeignKey(Reporter, on_delete=models.CASCADE, related_name='edited_articles_+') lang = models.CharField(max_length=2, help_text='Language', choices=[ ('es', 'Spanish'), ('en', 'English') From 61829abc8c7d15587cc63866e907a1462f8deab3 Mon Sep 17 00:00:00 2001 From: = <=> Date: Thu, 7 Dec 2017 13:06:31 -0500 Subject: [PATCH 022/111] Add testing to django 2 --- .travis.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.travis.yml b/.travis.yml index ef8a3d6..d2349ed 100644 --- a/.travis.yml +++ b/.travis.yml @@ -38,6 +38,12 @@ env: matrix: fast_finish: true include: + - python: '3.4' + env: TEST_TYPE=build DJANGO_VERSION=2.0 + - python: '3.5' + env: TEST_TYPE=build DJANGO_VERSION=2.0 + - python: '3.6' + env: TEST_TYPE=build DJANGO_VERSION=2.0 - python: '2.7' env: TEST_TYPE=build DJANGO_VERSION=1.8 - python: '2.7' From 6008cb6de44458f91a23359b60e8b5e78c7342a0 Mon Sep 17 00:00:00 2001 From: = <=> Date: Mon, 11 Dec 2017 21:08:42 -0500 Subject: [PATCH 023/111] Fix qfactor rankings for HTTP-ACCEPT --- graphene_django/tests/test_views.py | 14 ++++++++++++++ graphene_django/views.py | 11 +++++++---- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/graphene_django/tests/test_views.py b/graphene_django/tests/test_views.py index c31db8d..ae6cf6f 100644 --- a/graphene_django/tests/test_views.py +++ b/graphene_django/tests/test_views.py @@ -30,6 +30,20 @@ jl = lambda **kwargs: json.dumps([kwargs]) def test_graphiql_is_enabled(client): response = client.get(url_string(), HTTP_ACCEPT='text/html') assert response.status_code == 200 + assert response['Content-Type'].split(';')[0] == 'text/html' + +def test_qfactor_graphiql(client): + response = client.get(url_string(query='{test}'), HTTP_ACCEPT='application/json;q=0.8, text/html;q=0.9') + assert response.status_code == 200 + assert response['Content-Type'].split(';')[0] == 'text/html' + +def test_qfactor_json(client): + response = client.get(url_string(query='{test}'), HTTP_ACCEPT='text/html;q=0.8, application/json;q=0.9') + assert response.status_code == 200 + assert response['Content-Type'].split(';')[0] == 'application/json' + assert response_json(response) == { + 'data': {'test': "Hello World"} + } def test_allows_get_with_query_param(client): diff --git a/graphene_django/views.py b/graphene_django/views.py index cc9e8bb..8b413f2 100644 --- a/graphene_django/views.py +++ b/graphene_django/views.py @@ -35,8 +35,8 @@ def get_accepted_content_types(request): match = re.match(r'(^|;)q=(0(\.\d{,3})?|1(\.0{,3})?)(;|$)', parts[1]) if match: - return parts[0], float(match.group(2)) - return parts[0], 1 + return parts[0].strip(), float(match.group(2)) + return parts[0].strip(), 1 raw_content_types = request.META.get('HTTP_ACCEPT', '*/*').split(',') qualified_content_types = map(qualify, raw_content_types) @@ -280,8 +280,11 @@ class GraphQLView(View): @classmethod def request_wants_html(cls, request): accepted = get_accepted_content_types(request) - html_index = accepted.count('text/html') - json_index = accepted.count('application/json') + accepted_length = len(accepted) + #the list will be ordered in preferred first - so we have to make + #sure the most preferred gets the highest number + html_index = accepted_length - accepted.index('text/html') if 'text/html' in accepted else 0 + json_index = accepted_length - accepted.index('application/json') if 'application/json' in accepted else 0 return html_index > json_index From 6da95d72eabb71d53824b0000563d7f7219c6e5e Mon Sep 17 00:00:00 2001 From: = <=> Date: Sat, 16 Dec 2017 19:32:01 -0500 Subject: [PATCH 024/111] Rename [html/json]_index to _priority --- graphene_django/views.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/graphene_django/views.py b/graphene_django/views.py index 8b413f2..2ce2146 100644 --- a/graphene_django/views.py +++ b/graphene_django/views.py @@ -283,10 +283,10 @@ class GraphQLView(View): accepted_length = len(accepted) #the list will be ordered in preferred first - so we have to make #sure the most preferred gets the highest number - html_index = accepted_length - accepted.index('text/html') if 'text/html' in accepted else 0 - json_index = accepted_length - accepted.index('application/json') if 'application/json' in accepted else 0 + html_priority = accepted_length - accepted.index('text/html') if 'text/html' in accepted else 0 + json_priority = accepted_length - accepted.index('application/json') if 'application/json' in accepted else 0 - return html_index > json_index + return html_priority > json_priority @staticmethod def get_graphql_params(request, data): From 28cccb49f7772f785e6b6424e9e579ce0933717a Mon Sep 17 00:00:00 2001 From: = <=> Date: Mon, 18 Dec 2017 11:40:19 -0500 Subject: [PATCH 025/111] add saces for linter --- graphene_django/views.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/graphene_django/views.py b/graphene_django/views.py index 2ce2146..e27105d 100644 --- a/graphene_django/views.py +++ b/graphene_django/views.py @@ -281,8 +281,8 @@ class GraphQLView(View): def request_wants_html(cls, request): accepted = get_accepted_content_types(request) accepted_length = len(accepted) - #the list will be ordered in preferred first - so we have to make - #sure the most preferred gets the highest number + # the list will be ordered in preferred first - so we have to make + # sure the most preferred gets the highest number html_priority = accepted_length - accepted.index('text/html') if 'text/html' in accepted else 0 json_priority = accepted_length - accepted.index('application/json') if 'application/json' in accepted else 0 From c952ef1a880e271303bdcc7887b293fb5130eac6 Mon Sep 17 00:00:00 2001 From: = <=> Date: Mon, 18 Dec 2017 12:21:49 -0500 Subject: [PATCH 026/111] Date Scalar only added in graphene 2.0.1 --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index beee83c..e31f87b 100644 --- a/setup.py +++ b/setup.py @@ -57,7 +57,7 @@ setup( install_requires=[ 'six>=1.10.0', - 'graphene>=2.0,<3', + 'graphene>=2.0.1,<3', 'Django>=1.8.0', 'iso8601', 'singledispatch>=3.4.0.3', From fe35baa627cce4c8bca671df6e677d93bfefb96e Mon Sep 17 00:00:00 2001 From: = <=> Date: Wed, 6 Dec 2017 15:10:50 -0500 Subject: [PATCH 027/111] Fix merge conflict --- setup.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/setup.py b/setup.py index e31f87b..b4a1633 100644 --- a/setup.py +++ b/setup.py @@ -24,6 +24,7 @@ tests_require = [ 'pytest-django==2.9.1', ] + rest_framework_require +django_version = 'Django>=1.8.0,<2' if sys.version_info[0] < 3 else 'Django>=1.8.0' setup( name='graphene-django', version=version, @@ -59,6 +60,7 @@ setup( 'six>=1.10.0', 'graphene>=2.0.1,<3', 'Django>=1.8.0', + django_version, 'iso8601', 'singledispatch>=3.4.0.3', 'promise>=2.1', From 1352d4e02b0fe21c65ddeadc454ded07fe9523c2 Mon Sep 17 00:00:00 2001 From: = <=> Date: Mon, 18 Dec 2017 12:33:42 -0500 Subject: [PATCH 028/111] Fix func names --- graphene_django/converter.py | 2 +- graphene_django/rest_framework/serializer_converter.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/graphene_django/converter.py b/graphene_django/converter.py index fa771e2..dbcbbd5 100644 --- a/graphene_django/converter.py +++ b/graphene_django/converter.py @@ -122,7 +122,7 @@ def convert_field_to_float(field, registry=None): @convert_django_field.register(models.DateTimeField) -def convert_date_to_string(field, registry=None): +def convert_datetime_to_string(field, registry=None): return DateTime(description=field.help_text, required=not field.null) diff --git a/graphene_django/rest_framework/serializer_converter.py b/graphene_django/rest_framework/serializer_converter.py index 0c10a65..44cb01d 100644 --- a/graphene_django/rest_framework/serializer_converter.py +++ b/graphene_django/rest_framework/serializer_converter.py @@ -92,7 +92,7 @@ def convert_serializer_field_to_float(field): @get_graphene_type_from_serializer_field.register(serializers.DateTimeField) -def convert_serializer_field_to_date_time(field): +def convert_serializer_field_to_datetime_time(field): return graphene.types.datetime.DateTime From bb2d24ec2783881c0fb068957ec23c789f009569 Mon Sep 17 00:00:00 2001 From: Samuel Cormier-Iijima Date: Mon, 8 Jan 2018 13:48:47 -0500 Subject: [PATCH 029/111] Convert Date/Time/DateTime form fields to appropriate Graphene types --- graphene_django/form_converter.py | 16 ++++++++++++++++ graphene_django/tests/test_form_converter.py | 12 ++++++------ 2 files changed, 22 insertions(+), 6 deletions(-) diff --git a/graphene_django/form_converter.py b/graphene_django/form_converter.py index 195c8c4..fbda377 100644 --- a/graphene_django/form_converter.py +++ b/graphene_django/form_converter.py @@ -2,6 +2,7 @@ from django import forms from django.forms.fields import BaseTemporalField from graphene import ID, Boolean, Float, Int, List, String, UUID +from graphene.types.datetime import Date, DateTime, Time from .forms import GlobalIDFormField, GlobalIDMultipleChoiceField from .utils import import_single_dispatch @@ -63,6 +64,21 @@ def convert_form_field_to_list(field): return List(ID, required=field.required) +@convert_form_field.register(forms.DateField) +def convert_form_field_to_date(field): + return Date(description=field.help_text, required=field.required) + + +@convert_form_field.register(forms.DateTimeField) +def convert_form_field_to_datetime(field): + return DateTime(description=field.help_text, required=field.required) + + +@convert_form_field.register(forms.TimeField) +def convert_form_field_to_time(field): + return Time(description=field.help_text, required=field.required) + + @convert_form_field.register(forms.ModelChoiceField) @convert_form_field.register(GlobalIDFormField) def convert_form_field_to_id(field): diff --git a/graphene_django/tests/test_form_converter.py b/graphene_django/tests/test_form_converter.py index 5a13554..fbd0176 100644 --- a/graphene_django/tests/test_form_converter.py +++ b/graphene_django/tests/test_form_converter.py @@ -23,16 +23,16 @@ def test_should_unknown_django_field_raise_exception(): assert 'Don\'t know how to convert the Django form field' in str(excinfo.value) -def test_should_date_convert_string(): - assert_conversion(forms.DateField, graphene.String) +def test_should_date_convert_date(): + assert_conversion(forms.DateField, graphene.types.datetime.Date) -def test_should_time_convert_string(): - assert_conversion(forms.TimeField, graphene.String) +def test_should_time_convert_time(): + assert_conversion(forms.TimeField, graphene.types.datetime.Time) -def test_should_date_time_convert_string(): - assert_conversion(forms.DateTimeField, graphene.String) +def test_should_date_time_convert_date_time(): + assert_conversion(forms.DateTimeField, graphene.types.datetime.DateTime) def test_should_char_convert_string(): From cf35f7c76c582786d22ef94951671cd380a55da0 Mon Sep 17 00:00:00 2001 From: Jonathan Kim Date: Thu, 28 Dec 2017 08:55:03 +0000 Subject: [PATCH 030/111] Upgrade graphiql and react versions --- graphene_django/templates/graphene/graphiql.html | 10 +++++----- graphene_django/views.py | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/graphene_django/templates/graphene/graphiql.html b/graphene_django/templates/graphene/graphiql.html index 949b850..1ba0613 100644 --- a/graphene_django/templates/graphene/graphiql.html +++ b/graphene_django/templates/graphene/graphiql.html @@ -16,11 +16,11 @@ add "&raw" to the end of the URL within a browser. width: 100%; } - - - - - + + + + + From 9a5b3556d3d13ec3c46ea4bc953f1df844f0925d Mon Sep 17 00:00:00 2001 From: Dan Palmer Date: Thu, 30 Aug 2018 19:48:38 +0100 Subject: [PATCH 088/111] Special case reloads as allowed if we can --- graphene_django/templates/graphene/graphiql.html | 2 ++ 1 file changed, 2 insertions(+) diff --git a/graphene_django/templates/graphene/graphiql.html b/graphene_django/templates/graphene/graphiql.html index 6515da8..0303883 100644 --- a/graphene_django/templates/graphene/graphiql.html +++ b/graphene_django/templates/graphene/graphiql.html @@ -101,7 +101,9 @@ add "&raw" to the end of the URL within a browser. history.replaceState(null, null, locationQuery(parameters)); } // If there are any fragment parameters, confirm the user wants to use them. + var isReload = window.performance ? performance.navigation.type === 1 : false; if (Object.keys(parameters).length + && !isReload && !window.confirm("An untrusted query has been loaded, continue loading query?")) { parameters = {}; } From d1b734f07df87f97f3acc557d990952e3a250e7d Mon Sep 17 00:00:00 2001 From: Dan Palmer Date: Thu, 30 Aug 2018 20:31:39 +0100 Subject: [PATCH 089/111] Allow the user to see the query before prompting This also allows the introspection query through so that the user can edit with intellisense before being prompted. --- .../templates/graphene/graphiql.html | 29 ++++++++++++++----- 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/graphene_django/templates/graphene/graphiql.html b/graphene_django/templates/graphene/graphiql.html index 0303883..de3126a 100644 --- a/graphene_django/templates/graphene/graphiql.html +++ b/graphene_django/templates/graphene/graphiql.html @@ -58,9 +58,31 @@ add "&raw" to the end of the URL within a browser. otherParams[k] = parameters[k]; } } + + // If there are any fragment parameters, confirm the user wants to use them. + var isReload = window.performance ? performance.navigation.type === 1 : false; + var isQueryTrusted = Object.keys(parameters).length === 0 || isReload; + var fetchURL = locationQuery(otherParams); + // Defines a GraphQL fetcher using the fetch API. function graphQLFetcher(graphQLParams) { + var isIntrospectionQuery = ( + graphQLParams.query !== parameters.query + && graphQLParams.query.indexOf('IntrospectionQuery') !== -1 + ); + + if (!isQueryTrusted + && !isIntrospectionQuery + && !window.confirm("This query was loaded from a link, are you sure you want to execute it?")) { + return Promise.resolve('Aborting query.'); + } + + // We don't want to set this for the introspection query + if (!isIntrospectionQuery) { + isQueryTrusted = true; + } + var headers = { 'Accept': 'application/json', 'Content-Type': 'application/json' @@ -100,13 +122,6 @@ add "&raw" to the end of the URL within a browser. function updateURL() { history.replaceState(null, null, locationQuery(parameters)); } - // If there are any fragment parameters, confirm the user wants to use them. - var isReload = window.performance ? performance.navigation.type === 1 : false; - if (Object.keys(parameters).length - && !isReload - && !window.confirm("An untrusted query has been loaded, continue loading query?")) { - parameters = {}; - } var options = { fetcher: graphQLFetcher, onEditQuery: onEditQuery, From 24ebc20bf449b4688220e2dac0b43240d0fc5a6c Mon Sep 17 00:00:00 2001 From: Dan Palmer Date: Thu, 30 Aug 2018 20:32:38 +0100 Subject: [PATCH 090/111] Fix comment --- graphene_django/templates/graphene/graphiql.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/graphene_django/templates/graphene/graphiql.html b/graphene_django/templates/graphene/graphiql.html index de3126a..cf61686 100644 --- a/graphene_django/templates/graphene/graphiql.html +++ b/graphene_django/templates/graphene/graphiql.html @@ -39,7 +39,7 @@ add "&raw" to the end of the URL within a browser. decodeURIComponent(entry.slice(eq + 1)); } }); - // Produce a Location query string from a parameter object. + // Produce a Location fragment string from a parameter object. function locationQuery(params) { return '#' + Object.keys(params).map(function (key) { return encodeURIComponent(key) + '=' + From e50e12bc9fa693bde1af1b61f2a97eaba90007bd Mon Sep 17 00:00:00 2001 From: Dan Palmer Date: Thu, 30 Aug 2018 20:36:26 +0100 Subject: [PATCH 091/111] Move GraphiQL's JS into a separate file for ease of CSP --- .../static/graphene_django/graphiql.js | 119 +++++++++++++++++ .../templates/graphene/graphiql.html | 120 +----------------- 2 files changed, 121 insertions(+), 118 deletions(-) create mode 100644 graphene_django/static/graphene_django/graphiql.js diff --git a/graphene_django/static/graphene_django/graphiql.js b/graphene_django/static/graphene_django/graphiql.js new file mode 100644 index 0000000..ad55e03 --- /dev/null +++ b/graphene_django/static/graphene_django/graphiql.js @@ -0,0 +1,119 @@ +(function() { + + // Parse the cookie value for a CSRF token + var csrftoken; + var cookies = ('; ' + document.cookie).split('; csrftoken='); + if (cookies.length == 2) + csrftoken = cookies.pop().split(';').shift(); + + // Collect the URL parameters + var parameters = {}; + window.location.hash.substr(1).split('&').forEach(function (entry) { + var eq = entry.indexOf('='); + if (eq >= 0) { + parameters[decodeURIComponent(entry.slice(0, eq))] = + decodeURIComponent(entry.slice(eq + 1)); + } + }); + // Produce a Location fragment string from a parameter object. + function locationQuery(params) { + return '#' + Object.keys(params).map(function (key) { + return encodeURIComponent(key) + '=' + + encodeURIComponent(params[key]); + }).join('&'); + } + // Derive a fetch URL from the current URL, sans the GraphQL parameters. + var graphqlParamNames = { + query: true, + variables: true, + operationName: true + }; + var otherParams = {}; + for (var k in parameters) { + if (parameters.hasOwnProperty(k) && graphqlParamNames[k] !== true) { + otherParams[k] = parameters[k]; + } + } + + // If there are any fragment parameters, confirm the user wants to use them. + var isReload = window.performance ? performance.navigation.type === 1 : false; + var isQueryTrusted = Object.keys(parameters).length === 0 || isReload; + + var fetchURL = locationQuery(otherParams); + + // Defines a GraphQL fetcher using the fetch API. + function graphQLFetcher(graphQLParams) { + var isIntrospectionQuery = ( + graphQLParams.query !== parameters.query + && graphQLParams.query.indexOf('IntrospectionQuery') !== -1 + ); + + if (!isQueryTrusted + && !isIntrospectionQuery + && !window.confirm("This query was loaded from a link, are you sure you want to execute it?")) { + return Promise.resolve('Aborting query.'); + } + + // We don't want to set this for the introspection query + if (!isIntrospectionQuery) { + isQueryTrusted = true; + } + + var headers = { + 'Accept': 'application/json', + 'Content-Type': 'application/json' + }; + if (csrftoken) { + headers['X-CSRFToken'] = csrftoken; + } + return fetch(fetchURL, { + method: 'post', + headers: headers, + body: JSON.stringify(graphQLParams), + credentials: 'include', + }).then(function (response) { + return response.text(); + }).then(function (responseBody) { + try { + return JSON.parse(responseBody); + } catch (error) { + return responseBody; + } + }); + } + // When the query and variables string is edited, update the URL bar so + // that it can be easily shared. + function onEditQuery(newQuery) { + parameters.query = newQuery; + updateURL(); + } + function onEditVariables(newVariables) { + parameters.variables = newVariables; + updateURL(); + } + function onEditOperationName(newOperationName) { + parameters.operationName = newOperationName; + updateURL(); + } + function updateURL() { + history.replaceState(null, null, locationQuery(parameters)); + } + var options = { + fetcher: graphQLFetcher, + onEditQuery: onEditQuery, + onEditVariables: onEditVariables, + onEditOperationName: onEditOperationName, + query: parameters.query, + } + if (parameters.variables) { + options.variables = parameters.variables; + } + if (parameters.operation_name) { + options.operationName = parameters.operation_name; + } + // Render into the body. + ReactDOM.render( + React.createElement(GraphiQL, options), + document.body + ); +})(); diff --git a/graphene_django/templates/graphene/graphiql.html b/graphene_django/templates/graphene/graphiql.html index cf61686..7bd1178 100644 --- a/graphene_django/templates/graphene/graphiql.html +++ b/graphene_django/templates/graphene/graphiql.html @@ -5,6 +5,7 @@ exploring GraphQL. If you wish to receive JSON, provide the header "Accept: application/json" or add "&raw" to the end of the URL within a browser. --> +{% load static %} @@ -23,123 +24,6 @@ add "&raw" to the end of the URL within a browser. - + From 7e8f6dbd4ec0fe633507e5ba6bc22bda4a0e59fc Mon Sep 17 00:00:00 2001 From: Dan Palmer Date: Thu, 30 Aug 2018 20:58:00 +0100 Subject: [PATCH 092/111] Change quotes to improve some syntax highlighting --- graphene_django/templates/graphene/graphiql.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/graphene_django/templates/graphene/graphiql.html b/graphene_django/templates/graphene/graphiql.html index 7bd1178..af11274 100644 --- a/graphene_django/templates/graphene/graphiql.html +++ b/graphene_django/templates/graphene/graphiql.html @@ -24,6 +24,6 @@ add "&raw" to the end of the URL within a browser. - + From cb87f4016546aac5f4973e6d01fb31b0cbc10d4e Mon Sep 17 00:00:00 2001 From: Dan Palmer Date: Thu, 30 Aug 2018 20:59:09 +0100 Subject: [PATCH 093/111] Document that staticfiles is now a dependency. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 4e0b01d..ef3f40c 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ pip install "graphene-django>=2.0" ```python INSTALLED_APPS = ( # ... + 'django.contrib.staticfiles', # Required for GraphiQL 'graphene_django', ) From dc0c2900d159fd096b187902c5aea8bbb5716d0f Mon Sep 17 00:00:00 2001 From: Jay Hale Date: Sun, 5 Aug 2018 10:26:14 -0400 Subject: [PATCH 094/111] Making GrapheneFilterSetMixin compatible with django_filter 2 --- docs/filtering.rst | 14 +++++------- examples/cookbook/requirements.txt | 2 +- graphene_django/filter/filterset.py | 35 +++++++++-------------------- setup.py | 4 ++-- 4 files changed, 20 insertions(+), 35 deletions(-) diff --git a/docs/filtering.rst b/docs/filtering.rst index cfecf2c..feafd40 100644 --- a/docs/filtering.rst +++ b/docs/filtering.rst @@ -2,11 +2,9 @@ Filtering ========= Graphene integrates with -`django-filter `__ (< 2.0.0) to provide -filtering of results (this also means filtering is only compatible with Django < 2.0). - -See the `usage -documentation `__ +`django-filter `__ (2.x for +Python 3 or 1.x for Python 2) to provide filtering of results. See the `usage +documentation `__ for details on the format for ``filter_fields``. This filtering is automatically available when implementing a ``relay.Node``. @@ -17,7 +15,7 @@ You will need to install it manually, which can be done as follows: .. code:: bash # You'll need to django-filter - pip install django-filter==1.1.0 + pip install django-filter>=2 Note: The techniques below are demoed in the `cookbook example app `__. @@ -28,7 +26,7 @@ Filterable fields The ``filter_fields`` parameter is used to specify the fields which can be filtered upon. The value specified here is passed directly to ``django-filter``, so see the `filtering -documentation `__ +documentation `__ for full details on the range of options available. For example: @@ -129,7 +127,7 @@ create your own ``Filterset`` as follows: all_animals = DjangoFilterConnectionField(AnimalNode, filterset_class=AnimalFilter) -The context argument is passed on as the `request argument `__ +The context argument is passed on as the `request argument `__ in a ``django_filters.FilterSet`` instance. You can use this to customize your filters to be context-dependent. We could modify the ``AnimalFilter`` above to pre-filter animals owned by the authenticated user (set in ``context.user``). diff --git a/examples/cookbook/requirements.txt b/examples/cookbook/requirements.txt index 1900a39..b2ace1f 100644 --- a/examples/cookbook/requirements.txt +++ b/examples/cookbook/requirements.txt @@ -2,4 +2,4 @@ graphene graphene-django graphql-core>=2.1rc1 django==1.9 -django-filter<2 +django-filter>=2 diff --git a/graphene_django/filter/filterset.py b/graphene_django/filter/filterset.py index 29a275d..8789147 100644 --- a/graphene_django/filter/filterset.py +++ b/graphene_django/filter/filterset.py @@ -1,7 +1,6 @@ import itertools from django.db import models -from django.utils.text import capfirst from django_filters import Filter, MultipleChoiceFilter from django_filters.filterset import BaseFilterSet, FilterSet from django_filters.filterset import FILTER_FOR_DBFIELD_DEFAULTS @@ -15,7 +14,10 @@ class GlobalIDFilter(Filter): field_class = GlobalIDFormField def filter(self, qs, value): - _type, _id = from_global_id(value) + """ Convert the filter value to a primary key before filtering """ + _id = None + if value is not None: + _, _id = from_global_id(value) return super(GlobalIDFilter, self).filter(qs, _id) @@ -32,37 +34,22 @@ GRAPHENE_FILTER_SET_OVERRIDES = { models.OneToOneField: {"filter_class": GlobalIDFilter}, models.ForeignKey: {"filter_class": GlobalIDFilter}, models.ManyToManyField: {"filter_class": GlobalIDMultipleChoiceFilter}, + models.ManyToOneRel: {"filter_class": GlobalIDMultipleChoiceFilter}, + models.ManyToManyRel: {"filter_class": GlobalIDMultipleChoiceFilter}, } class GrapheneFilterSetMixin(BaseFilterSet): + """ A django_filters.filterset.BaseFilterSet with default filter overrides + to handle global IDs """ + FILTER_DEFAULTS = dict( itertools.chain( - FILTER_FOR_DBFIELD_DEFAULTS.items(), GRAPHENE_FILTER_SET_OVERRIDES.items() + FILTER_FOR_DBFIELD_DEFAULTS.items(), + GRAPHENE_FILTER_SET_OVERRIDES.items() ) ) - @classmethod - def filter_for_reverse_field(cls, f, name): - """Handles retrieving filters for reverse relationships - - We override the default implementation so that we can handle - Global IDs (the default implementation expects database - primary keys) - """ - try: - rel = f.field.remote_field - except AttributeError: - rel = f.field.rel - - default = {"name": name, "label": capfirst(rel.related_name)} - if rel.multiple: - # For to-many relationships - return GlobalIDMultipleChoiceFilter(**default) - else: - # For to-one relationships - return GlobalIDFilter(**default) - def setup_filterset(filterset_class): """ Wrap a provided filterset in Graphene-specific functionality diff --git a/setup.py b/setup.py index 2e1f463..933b6b5 100644 --- a/setup.py +++ b/setup.py @@ -19,7 +19,7 @@ tests_require = [ "coveralls", "mock", "pytz", - "django-filter<2", + "django-filter>=2", "pytest-django>=3.3.2", ] + rest_framework_require @@ -50,7 +50,7 @@ setup( "six>=1.10.0", "graphene>=2.1,<3", "graphql-core>=2.1rc1", - "Django>=1.8.0", + "Django>=1.11", "iso8601", "singledispatch>=3.4.0.3", "promise>=2.1", From 9152075ed85bb85e53601da6344d43bde9afdc8f Mon Sep 17 00:00:00 2001 From: Jay Hale Date: Tue, 7 Aug 2018 13:01:53 -0400 Subject: [PATCH 095/111] Remove unsupported python & Django test cases --- .travis.yml | 15 +++++---------- setup.py | 5 +++-- 2 files changed, 8 insertions(+), 12 deletions(-) diff --git a/.travis.yml b/.travis.yml index 348260b..4bbbba0 100644 --- a/.travis.yml +++ b/.travis.yml @@ -11,9 +11,6 @@ install: pip install -e .[test] pip install psycopg2 # Required for Django postgres fields testing pip install django==$DJANGO_VERSION - if (($(echo "$DJANGO_VERSION <= 1.9" | bc -l))); then # DRF dropped 1.8 and 1.9 support at 3.7.0 - pip install djangorestframework==3.6.4 - fi python setup.py develop elif [ "$TEST_TYPE" = lint ]; then pip install flake8 @@ -44,13 +41,11 @@ matrix: env: TEST_TYPE=build DJANGO_VERSION=2.0 - python: '3.6' env: TEST_TYPE=build DJANGO_VERSION=2.0 - - python: '2.7' - env: TEST_TYPE=build DJANGO_VERSION=1.8 - - python: '2.7' - env: TEST_TYPE=build DJANGO_VERSION=1.9 - - python: '2.7' - env: TEST_TYPE=build DJANGO_VERSION=1.10 - - python: '2.7' + - python: '3.5' + env: TEST_TYPE=build DJANGO_VERSION=2.1 + - python: '3.6' + env: TEST_TYPE=build DJANGO_VERSION=2.1 + - python: '3.6' env: TEST_TYPE=lint deploy: provider: pypi diff --git a/setup.py b/setup.py index 933b6b5..5529afa 100644 --- a/setup.py +++ b/setup.py @@ -19,7 +19,8 @@ tests_require = [ "coveralls", "mock", "pytz", - "django-filter>=2", + "django-filter<2;python_version<'3'", + "django-filter>=2;python_version>='3'", "pytest-django>=3.3.2", ] + rest_framework_require @@ -39,9 +40,9 @@ setup( "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", + "Programming Language :: Python :: 3.6", "Programming Language :: Python :: Implementation :: PyPy", ], keywords="api graphql protocol rest relay graphene", From d8bdda94dfcf60cf5cf560c32e18305f56d4ddf8 Mon Sep 17 00:00:00 2001 From: Jay Hale Date: Thu, 16 Aug 2018 14:05:34 -0400 Subject: [PATCH 096/111] Add back support for django-filter < 2 --- .travis.yml | 2 ++ graphene_django/filter/filterset.py | 33 ++++++++++++++++++++++++++++- 2 files changed, 34 insertions(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 4bbbba0..a8375ee 100644 --- a/.travis.yml +++ b/.travis.yml @@ -45,6 +45,8 @@ matrix: env: TEST_TYPE=build DJANGO_VERSION=2.1 - python: '3.6' env: TEST_TYPE=build DJANGO_VERSION=2.1 + - python: '2.7' + env: TEST_TYPE=lint - python: '3.6' env: TEST_TYPE=lint deploy: diff --git a/graphene_django/filter/filterset.py b/graphene_django/filter/filterset.py index 8789147..4059083 100644 --- a/graphene_django/filter/filterset.py +++ b/graphene_django/filter/filterset.py @@ -1,7 +1,7 @@ import itertools from django.db import models -from django_filters import Filter, MultipleChoiceFilter +from django_filters import Filter, MultipleChoiceFilter, VERSION from django_filters.filterset import BaseFilterSet, FilterSet from django_filters.filterset import FILTER_FOR_DBFIELD_DEFAULTS @@ -51,6 +51,37 @@ class GrapheneFilterSetMixin(BaseFilterSet): ) +# To support a Django 1.11 + Python 2.7 combination django-filter must be +# < 2.x.x. To support the earlier version of django-filter, the +# filter_for_reverse_field method must be present on GrapheneFilterSetMixin and +# must not be present for later versions of django-filter. +if VERSION[0] < 2: + from django.utils.text import capfirst + + class GrapheneFilterSetMixinPython2(GrapheneFilterSetMixin): + + @classmethod + def filter_for_reverse_field(cls, f, name): + """Handles retrieving filters for reverse relationships + We override the default implementation so that we can handle + Global IDs (the default implementation expects database + primary keys) + """ + try: + rel = f.field.remote_field + except AttributeError: + rel = f.field.rel + default = {"name": name, "label": capfirst(rel.related_name)} + if rel.multiple: + # For to-many relationships + return GlobalIDMultipleChoiceFilter(**default) + else: + # For to-one relationships + return GlobalIDFilter(**default) + + GrapheneFilterSetMixin = GrapheneFilterSetMixinPython2 + + def setup_filterset(filterset_class): """ Wrap a provided filterset in Graphene-specific functionality """ From f8dff38e29edc644ca27eadabb5afe10757be623 Mon Sep 17 00:00:00 2001 From: Jay Hale Date: Thu, 16 Aug 2018 14:27:30 -0400 Subject: [PATCH 097/111] Remove unnecessary compat utility for Django < 1.11 --- graphene_django/compat.py | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/graphene_django/compat.py b/graphene_django/compat.py index f43db04..4a51de8 100644 --- a/graphene_django/compat.py +++ b/graphene_django/compat.py @@ -5,13 +5,7 @@ class MissingType(object): try: # Postgres fields are only available in Django with psycopg2 installed # and we cannot have psycopg2 on PyPy - from django.contrib.postgres.fields import ArrayField, HStoreField, RangeField + from django.contrib.postgres.fields import (ArrayField, HStoreField, + JSONField, RangeField) except ImportError: ArrayField, HStoreField, JSONField, RangeField = (MissingType,) * 4 - - -try: - # Postgres fields are only available in Django 1.9+ - from django.contrib.postgres.fields import JSONField -except ImportError: - JSONField = MissingType From 0314931f120c01a74f46573689c0c413412bdbbb Mon Sep 17 00:00:00 2001 From: Jay Hale Date: Thu, 16 Aug 2018 14:32:10 -0400 Subject: [PATCH 098/111] Removed Django < 1.11 compatibility checks from tests --- graphene_django/tests/test_converter.py | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/graphene_django/tests/test_converter.py b/graphene_django/tests/test_converter.py index 196f008..5dc0184 100644 --- a/graphene_django/tests/test_converter.py +++ b/graphene_django/tests/test_converter.py @@ -237,16 +237,12 @@ def test_should_manytomany_convert_connectionorlist_connection(): def test_should_manytoone_convert_connectionorlist(): - # Django 1.9 uses 'rel', <1.9 uses 'related - related = getattr(Reporter.articles, "rel", None) or getattr( - Reporter.articles, "related" - ) - class A(DjangoObjectType): class Meta: model = Article - graphene_field = convert_django_field(related, A._meta.registry) + graphene_field = convert_django_field(Reporter.articles.rel, + A._meta.registry) assert isinstance(graphene_field, graphene.Dynamic) dynamic_field = graphene_field.get_type() assert isinstance(dynamic_field, graphene.Field) @@ -255,14 +251,12 @@ def test_should_manytoone_convert_connectionorlist(): def test_should_onetoone_reverse_convert_model(): - # Django 1.9 uses 'rel', <1.9 uses 'related - related = getattr(Film.details, "rel", None) or getattr(Film.details, "related") - class A(DjangoObjectType): class Meta: model = FilmDetails - graphene_field = convert_django_field(related, A._meta.registry) + graphene_field = convert_django_field(Film.details.related, + A._meta.registry) assert isinstance(graphene_field, graphene.Dynamic) dynamic_field = graphene_field.get_type() assert isinstance(dynamic_field, graphene.Field) From a59f41b08045b052c24d690e55baa6cfdca429cb Mon Sep 17 00:00:00 2001 From: Syrus Akbary Date: Wed, 5 Sep 2018 13:18:09 +0200 Subject: [PATCH 099/111] Remove iso8601 dependency, updated graphql-core --- setup.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/setup.py b/setup.py index 5529afa..3431cd5 100644 --- a/setup.py +++ b/setup.py @@ -49,10 +49,9 @@ setup( packages=find_packages(exclude=["tests"]), install_requires=[ "six>=1.10.0", - "graphene>=2.1,<3", - "graphql-core>=2.1rc1", + "graphene>=2.1.3,<3", + "graphql-core>=2.1.0,<3", "Django>=1.11", - "iso8601", "singledispatch>=3.4.0.3", "promise>=2.1", ], From 446013c75232bb4e9aee91d849516f48cb64d6a2 Mon Sep 17 00:00:00 2001 From: Syrus Akbary Date: Wed, 5 Sep 2018 13:21:39 +0200 Subject: [PATCH 100/111] Update authorization.rst --- docs/authorization.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/docs/authorization.rst b/docs/authorization.rst index bdd1c8e..aa40656 100644 --- a/docs/authorization.rst +++ b/docs/authorization.rst @@ -64,11 +64,8 @@ define a resolve method for that field and return the desired queryset. all_posts = DjangoFilterConnectionField(PostNode) def resolve_all_posts(self, info): - post = Post.objects.filter(published=True) - if post is not None: - return post - else: - return None + return Post.objects.filter(published=True) + User-based Queryset Filtering ----------------------------- From 2ccd483ffc34c22e3bb6fcf2027656711894a847 Mon Sep 17 00:00:00 2001 From: Syrus Akbary Date: Wed, 5 Sep 2018 13:22:54 +0200 Subject: [PATCH 101/111] Update authorization.rst --- docs/authorization.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/authorization.rst b/docs/authorization.rst index aa40656..7a08481 100644 --- a/docs/authorization.rst +++ b/docs/authorization.rst @@ -116,7 +116,7 @@ method to your ``DjangoObjectType``. @classmethod def get_node(cls, id, info): try: - post = cls._meta.model.objects.get(id=id, owner__user = info.context.user) + post = cls._meta.model.objects.get(id=id) except cls._meta.model.DoesNotExist: return None @@ -124,6 +124,7 @@ method to your ``DjangoObjectType``. return post return None + Adding Login Required --------------------- From f4bbae29df2b96b82fc7cd22415a56bfb2e4a073 Mon Sep 17 00:00:00 2001 From: Syrus Akbary Date: Wed, 5 Sep 2018 23:20:25 +0200 Subject: [PATCH 102/111] Updated version to 2.2.0 --- graphene_django/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/graphene_django/__init__.py b/graphene_django/__init__.py index 8b75093..4538cb3 100644 --- a/graphene_django/__init__.py +++ b/graphene_django/__init__.py @@ -1,6 +1,6 @@ from .types import DjangoObjectType from .fields import DjangoConnectionField -__version__ = "2.1.0" +__version__ = "2.2.0" __all__ = ["__version__", "DjangoObjectType", "DjangoConnectionField"] From 85527e1f94a659eb14094d8c343c43f8fcf67c07 Mon Sep 17 00:00:00 2001 From: Konstantin Alekseev Date: Sat, 8 Sep 2018 15:33:30 +0300 Subject: [PATCH 103/111] Provide a way to dump schema to stdout. --- .../management/commands/graphql_schema.py | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/graphene_django/management/commands/graphql_schema.py b/graphene_django/management/commands/graphql_schema.py index 099af5d..4e526ec 100644 --- a/graphene_django/management/commands/graphql_schema.py +++ b/graphene_django/management/commands/graphql_schema.py @@ -21,7 +21,7 @@ class CommandArguments(BaseCommand): type=str, dest="out", default=graphene_settings.SCHEMA_OUTPUT, - help="Output file (default: schema.json)", + help="Output file, --out=- prints to stdout (default: schema.json)", ) parser.add_argument( @@ -64,9 +64,12 @@ class Command(CommandArguments): indent = options.get("indent") schema_dict = {"data": schema.introspect()} - self.save_file(out, schema_dict, indent) + if out == '-': + self.stdout.write(json.dumps(schema_dict, indent=indent)) + else: + self.save_file(out, schema_dict, indent) - style = getattr(self, "style", None) - success = getattr(style, "SUCCESS", lambda x: x) + style = getattr(self, "style", None) + success = getattr(style, "SUCCESS", lambda x: x) - self.stdout.write(success("Successfully dumped GraphQL schema to %s" % out)) + self.stdout.write(success("Successfully dumped GraphQL schema to %s" % out)) From e6b21594d77778618e0f8b1ba56ff1a04202f23f Mon Sep 17 00:00:00 2001 From: Dan Palmer Date: Sun, 9 Sep 2018 18:59:28 +0100 Subject: [PATCH 104/111] Add some documentation to DjangoDebug --- graphene_django/debug/types.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/graphene_django/debug/types.py b/graphene_django/debug/types.py index 0d3701d..cda5725 100644 --- a/graphene_django/debug/types.py +++ b/graphene_django/debug/types.py @@ -4,4 +4,10 @@ from .sql.types import DjangoDebugSQL class DjangoDebug(ObjectType): - sql = List(DjangoDebugSQL) + class Meta: + description = "Debugging information for the current query." + + sql = List( + DjangoDebugSQL, + description="Executed SQL queries for this API query.", + ) From 040f6aa10e3a420b8dc10619ec16af25f9223c17 Mon Sep 17 00:00:00 2001 From: Dan Palmer Date: Sun, 9 Sep 2018 19:01:00 +0100 Subject: [PATCH 105/111] Document, including whether fields are required --- graphene_django/debug/sql/types.py | 62 +++++++++++++++++++++++------- 1 file changed, 48 insertions(+), 14 deletions(-) diff --git a/graphene_django/debug/sql/types.py b/graphene_django/debug/sql/types.py index 6ae4d31..850ced4 100644 --- a/graphene_django/debug/sql/types.py +++ b/graphene_django/debug/sql/types.py @@ -2,19 +2,53 @@ from graphene import Boolean, Float, ObjectType, String class DjangoDebugSQL(ObjectType): - vendor = String() - alias = String() - sql = String() - duration = Float() - raw_sql = String() - params = String() - start_time = Float() - stop_time = Float() - is_slow = Boolean() - is_select = Boolean() + class Meta: + description = ( + "Represents a single database query made to a Django managed DB." + ) + + vendor = String( + required=True, + description=( + "The type of database being used (e.g. postrgesql, mysql, sqlite)." + ), + ) + alias = String( + required=True, + description="The Django database alias (e.g. 'default').", + ) + sql = String(description="The actual SQL sent to this database.") + duration = Float( + required=True, + description="Duration of this database query in seconds.", + ) + raw_sql = String( + required=True, + description="The raw SQL of this query, without params.", + ) + params = String( + required=True, + description="JSON encoded database query parameters.", + ) + start_time = Float( + required=True, + description="Start time of this database query.", + ) + stop_time = Float( + required=True, + description="Stop time of this database query.", + ) + is_slow = Boolean( + required=True, + description="Whether this database query took more than 10 seconds.", + ) + is_select = Boolean( + required=True, + description="Whether this database query was a SELECT.", + ) # Postgres - trans_id = String() - trans_status = String() - iso_level = String() - encoding = String() + trans_id = String(description="Postgres transaction ID if available.") + trans_status = String(description="Postgres transaction status if available.") + iso_level = String(description="Postgres isolation level if available.") + encoding = String(description="Postgres connection encoding if available.") From 2b08e59bea2a0d84dc68832dc6d2deae98e77d3a Mon Sep 17 00:00:00 2001 From: Dan Palmer Date: Sun, 9 Sep 2018 21:44:30 +0100 Subject: [PATCH 106/111] Revert to default query execution behaviour The only security risk here is persuading a user to execute a mutation, which is probably not a big risk. To mitigate this risk and still keep the same UX (that is so valuable), would require more work than is proportionate for this PR. --- .../static/graphene_django/graphiql.js | 20 ------------------- 1 file changed, 20 deletions(-) diff --git a/graphene_django/static/graphene_django/graphiql.js b/graphene_django/static/graphene_django/graphiql.js index ad55e03..2be7e3c 100644 --- a/graphene_django/static/graphene_django/graphiql.js +++ b/graphene_django/static/graphene_django/graphiql.js @@ -35,30 +35,10 @@ } } - // If there are any fragment parameters, confirm the user wants to use them. - var isReload = window.performance ? performance.navigation.type === 1 : false; - var isQueryTrusted = Object.keys(parameters).length === 0 || isReload; - var fetchURL = locationQuery(otherParams); // Defines a GraphQL fetcher using the fetch API. function graphQLFetcher(graphQLParams) { - var isIntrospectionQuery = ( - graphQLParams.query !== parameters.query - && graphQLParams.query.indexOf('IntrospectionQuery') !== -1 - ); - - if (!isQueryTrusted - && !isIntrospectionQuery - && !window.confirm("This query was loaded from a link, are you sure you want to execute it?")) { - return Promise.resolve('Aborting query.'); - } - - // We don't want to set this for the introspection query - if (!isIntrospectionQuery) { - isQueryTrusted = true; - } - var headers = { 'Accept': 'application/json', 'Content-Type': 'application/json' From f3144bf996cac8f137b1838a0d2f3717b32907bf Mon Sep 17 00:00:00 2001 From: Alonso Date: Wed, 26 Sep 2018 13:07:50 -0500 Subject: [PATCH 107/111] fix order in params --- docs/authorization.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/authorization.rst b/docs/authorization.rst index 7a08481..86ad66a 100644 --- a/docs/authorization.rst +++ b/docs/authorization.rst @@ -114,7 +114,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: From 19ef9a094ad8dbf20234624b21d567fe86f7b413 Mon Sep 17 00:00:00 2001 From: Khaled Alqenaei Date: Thu, 18 Oct 2018 11:33:53 -0700 Subject: [PATCH 108/111] Making the example working for Django 2.1.2 --- .../cookbook/ingredients/models.py | 4 +++- .../cookbook/ingredients/schema.py | 18 +++++++++--------- .../cookbook-plain/cookbook/recipes/models.py | 9 +++++---- .../cookbook-plain/cookbook/recipes/schema.py | 16 ++++++++-------- examples/cookbook-plain/cookbook/settings.py | 3 +-- examples/cookbook-plain/cookbook/urls.py | 6 +++--- examples/cookbook-plain/requirements.txt | 2 +- 7 files changed, 30 insertions(+), 28 deletions(-) diff --git a/examples/cookbook-plain/cookbook/ingredients/models.py b/examples/cookbook-plain/cookbook/ingredients/models.py index 2f0eba3..5836949 100644 --- a/examples/cookbook-plain/cookbook/ingredients/models.py +++ b/examples/cookbook-plain/cookbook/ingredients/models.py @@ -2,6 +2,8 @@ from django.db import models class Category(models.Model): + class Meta: + verbose_name_plural = 'Categories' name = models.CharField(max_length=100) def __str__(self): @@ -11,7 +13,7 @@ class Category(models.Model): 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 diff --git a/examples/cookbook-plain/cookbook/ingredients/schema.py b/examples/cookbook-plain/cookbook/ingredients/schema.py index 1f3bb18..51f25ed 100644 --- a/examples/cookbook-plain/cookbook/ingredients/schema.py +++ b/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,16 +25,16 @@ 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, **kwargs): return Category.objects.all() - def resolve_all_ingredients(self, args, context, info): + def resolve_all_ingredients(self, context, **kwargs): # 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, **kwargs): + id = kwargs.get('id') + name = kwargs.get('name') if id is not None: return Category.objects.get(pk=id) @@ -44,9 +44,9 @@ class Query(object): return None - def resolve_ingredient(self, args, context, info): - id = args.get('id') - name = args.get('name') + def resolve_ingredient(self, context, **kwargs): + id = kwargs.get('id') + name = kwargs.get('name') if id is not None: return Ingredient.objects.get(pk=id) diff --git a/examples/cookbook-plain/cookbook/recipes/models.py b/examples/cookbook-plain/cookbook/recipes/models.py index ca12fac..382b88e 100644 --- a/examples/cookbook-plain/cookbook/recipes/models.py +++ b/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'), diff --git a/examples/cookbook-plain/cookbook/recipes/schema.py b/examples/cookbook-plain/cookbook/recipes/schema.py index 040c985..620d510 100644 --- a/examples/cookbook-plain/cookbook/recipes/schema.py +++ b/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,9 +24,9 @@ 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, **kwargs): + id = kwargs.get('id') + title = kwargs.get('title') if id is not None: return Recipe.objects.get(pk=id) @@ -36,17 +36,17 @@ class Query(object): return None - def resolve_recipeingredient(self, args, context, info): - id = args.get('id') + def resolve_recipeingredient(self, context, **kwargs): + id = kwargs.get('id') 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, **kwargs): return Recipe.objects.all() - def resolve_all_recipeingredients(self, args, context, info): + def resolve_all_recipeingredients(self, context, **kwargs): related = ['recipe', 'ingredient'] return RecipeIngredient.objects.select_related(*related).all() diff --git a/examples/cookbook-plain/cookbook/settings.py b/examples/cookbook-plain/cookbook/settings.py index 948292d..d846db4 100644 --- a/examples/cookbook-plain/cookbook/settings.py +++ b/examples/cookbook-plain/cookbook/settings.py @@ -44,13 +44,12 @@ INSTALLED_APPS = [ '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', ] diff --git a/examples/cookbook-plain/cookbook/urls.py b/examples/cookbook-plain/cookbook/urls.py index 9f8755b..4f87da0 100644 --- a/examples/cookbook-plain/cookbook/urls.py +++ b/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)), ] diff --git a/examples/cookbook-plain/requirements.txt b/examples/cookbook-plain/requirements.txt index 362a39a..539fd67 100644 --- a/examples/cookbook-plain/requirements.txt +++ b/examples/cookbook-plain/requirements.txt @@ -1,4 +1,4 @@ graphene graphene-django graphql-core>=2.1rc1 -django==1.9 +django==2.1.2 From 4359e1f312d3d27b203dec2a5bfd4c9a8346d42b Mon Sep 17 00:00:00 2001 From: Khaled Alqenaei Date: Thu, 18 Oct 2018 11:36:35 -0700 Subject: [PATCH 109/111] Making the example working for Django 2.1.2 --- .../migrations/0003_auto_20181018_1746.py | 17 +++++++++++++++++ .../migrations/0003_auto_20181018_1728.py | 18 ++++++++++++++++++ 2 files changed, 35 insertions(+) create mode 100644 examples/cookbook-plain/cookbook/ingredients/migrations/0003_auto_20181018_1746.py create mode 100644 examples/cookbook-plain/cookbook/recipes/migrations/0003_auto_20181018_1728.py diff --git a/examples/cookbook-plain/cookbook/ingredients/migrations/0003_auto_20181018_1746.py b/examples/cookbook-plain/cookbook/ingredients/migrations/0003_auto_20181018_1746.py new file mode 100644 index 0000000..184e79e --- /dev/null +++ b/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'}, + ), + ] diff --git a/examples/cookbook-plain/cookbook/recipes/migrations/0003_auto_20181018_1728.py b/examples/cookbook-plain/cookbook/recipes/migrations/0003_auto_20181018_1728.py new file mode 100644 index 0000000..7a8df49 --- /dev/null +++ b/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), + ), + ] From 905b4249f3ff71b35105638242c3f908ead70324 Mon Sep 17 00:00:00 2001 From: Khaled Alqenaei Date: Thu, 18 Oct 2018 12:27:23 -0700 Subject: [PATCH 110/111] Updated ingredients/schema.py and recipes/schema.py to be more readable. --- .../cookbook-plain/cookbook/ingredients/schema.py | 14 ++++---------- examples/cookbook-plain/cookbook/recipes/schema.py | 13 ++++--------- 2 files changed, 8 insertions(+), 19 deletions(-) diff --git a/examples/cookbook-plain/cookbook/ingredients/schema.py b/examples/cookbook-plain/cookbook/ingredients/schema.py index 51f25ed..e7ef688 100644 --- a/examples/cookbook-plain/cookbook/ingredients/schema.py +++ b/examples/cookbook-plain/cookbook/ingredients/schema.py @@ -25,17 +25,14 @@ class Query(object): name=graphene.String()) all_ingredients = graphene.List(IngredientType) - def resolve_all_categories(self, context, **kwargs): + def resolve_all_categories(self, context): return Category.objects.all() - def resolve_all_ingredients(self, context, **kwargs): + 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, context, **kwargs): - id = kwargs.get('id') - name = kwargs.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 @@ class Query(object): return None - def resolve_ingredient(self, context, **kwargs): - id = kwargs.get('id') - name = kwargs.get('name') - + def resolve_ingredient(self, context, id=None, name=None): if id is not None: return Ingredient.objects.get(pk=id) diff --git a/examples/cookbook-plain/cookbook/recipes/schema.py b/examples/cookbook-plain/cookbook/recipes/schema.py index 620d510..74692f8 100644 --- a/examples/cookbook-plain/cookbook/recipes/schema.py +++ b/examples/cookbook-plain/cookbook/recipes/schema.py @@ -24,10 +24,7 @@ class Query(object): id=graphene.Int()) all_recipeingredients = graphene.List(RecipeIngredientType) - def resolve_recipe(self, context, **kwargs): - id = kwargs.get('id') - title = kwargs.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 @@ class Query(object): return None - def resolve_recipeingredient(self, context, **kwargs): - id = kwargs.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, context, **kwargs): + def resolve_all_recipes(self, context): return Recipe.objects.all() - def resolve_all_recipeingredients(self, context, **kwargs): + def resolve_all_recipeingredients(self, context): related = ['recipe', 'ingredient'] return RecipeIngredient.objects.select_related(*related).all() From ce8fa7f9f2fa6afabae0d7fa93c8cc85dc5945b9 Mon Sep 17 00:00:00 2001 From: Jonathan Kim Date: Sat, 9 Mar 2019 22:39:04 +0100 Subject: [PATCH 111/111] Fix lint error --- graphene_django/types.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/graphene_django/types.py b/graphene_django/types.py index aa8b5a3..4441a9a 100644 --- a/graphene_django/types.py +++ b/graphene_django/types.py @@ -1,5 +1,7 @@ +import six from collections import OrderedDict +from django.db.models import Model from django.utils.functional import SimpleLazyObject from graphene import Field from graphene.relay import Connection, Node @@ -11,6 +13,10 @@ from .registry import Registry, get_global_registry from .utils import DJANGO_FILTER_INSTALLED, get_model_fields, is_valid_django_model +if six.PY3: + from typing import Type + + def construct_fields(model, registry, only_fields, exclude_fields): _model_fields = get_model_fields(model)