Skip to main content

A collection of custom extensions for Django GraphQL

Project description

Pypi Wheel Build Status Codecov Code Climate

A collection of custom extensions for Django GraphQL

Dependencies

  • Python ≥ 3.4
  • Django ≥ 1.11

Installation

Install last stable version from Pypi.

pip install django-graphql-extensions

Authentication

  • @login_required
  • @staff_member_required
  • @permission_required
  • @user_passes_test

See the documentation to know the full list of decorators.

from django.contrib.auth import get_user_model

import graphene
from graphql_extensions.auth.decorators import (
    login_required, staff_member_required,
)


class Query(graphene.ObjectType):
    viewer = graphene.Field(UserType)
    users = graphene.List(UserType)

    @login_required
    def resolve_viewer(self, info, **kwargs):
        return info.context.user

    @staff_member_required
    def resolve_users(self, info, **kwargs):
        return get_user_model().objects.all()

Errors

Returning appropriate error responses and masking error messages sent to the client.

Configure your GraphQLView.

from django.urls import include, path

from graphql_extensions.views import GraphQLView

urlpatterns = [
    path('', GraphQLView.as_view(), name='index'),
]

Exceptions

from graphql_extensions import exceptions
  • exceptions.GraphQLError
  • exceptions.PermissionDenied
  • exceptions.ValidationError
  • exceptions.NotFound

Payload

{
  "errors": [
    {
      "type": "NotFound",
      "message": "GraphQL object not found",
      "code": "notFound",
      "data": {
        "id": 1
      },
      "path": ["updateGroup"],
      "operation": "mutation",
      "trace": [
        "  File \"/app/schema.py\", line 30, in mutate\n    group = cls.update(info, **kwargs)\n",
        "  File \"/graphql_extensions/mixins.py\", line 32, in update\n    instance = cls.get_object(context, id=id)\n",
        "  File \"/graphql_extensions/mixins.py\", line 21, in get_object\n    raise exceptions.NotFound(**kwargs)\n"
      ]
    }
  ],
  "data": {
    "updateGroup": null
  }
}

Mixins

Pre-built mutations that provide for commonly used patterns.

  • RetrieveMixin
  • UpdateMixin
from django.contrib.auth.models import Group

import graphene
from graphene_django import DjangoObjectType
from graphql_extensions import mixins
from graphql_extensions.auth.decorators import login_required


class GroupType(DjangoObjectType):

    class Meta:
        model = Group


class UpdateGroup(mixins.UpdateMixin, graphene.Mutation):
    group = graphene.Field(GroupType)

    class Arguments:
        id = graphene.Int(required=True)
        name = graphene.String()

    @classmethod
    def get_queryset(cls, info, **kwargs):
        return info.context.user.groups.all()

    @classmethod
    @login_required
    def mutate(cls, root, info, **kwargs):
        group = cls.update(info, **kwargs)
        return cls(group=group)

Writing tests

This package includes a subclass of unittest.TestCase SchemaTestCase and improve support for making GraphQL queries.

from django.contrib.auth import get_user_model

from graphql_extensions.testcases import SchemaTestCase


class UsersTests(SchemaTestCase):

    def test_create_user(self):
        query = '''
        mutation CreateUser($username: String!, $password: String!) {
          createUser(username: $username, password: $password) {
            user {
              id
            }
          }
        }'''

        response = self.client.execute(query, {
            'username': 'test',
            'password': 'dolphins',
        })

        self.assertFalse(response.errors)
        self.assertTrue(response.data['user'])

    def test_get_viewer(self):
        user = get_user_model().objects.create_user(
            username='test',
            password='dolphins')

        self.client.force_login(self.user)

        query = '''
        {
          viewer {
            username
          }
        }'''

        response = self.client.execute(query)
        data = response.data['viewer']

        self.assertEqual(data['username'], user.username)

Types

Custom Graphene types.

  • Email
  • Timestamp
  • Choices
  • CamelJSON

Relay

Complete support for Relay.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-graphql-extensions, version 0.0.7
Filename, size File type Python version Upload date Hashes
Filename, size django_graphql_extensions-0.0.7-py2.py3-none-any.whl (14.7 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size django-graphql-extensions-0.0.7.tar.gz (11.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page