Moved django-graphql-view and django-graphiql into graphene-django 😎

Author: syrusakbary

.gitignore

@@ -59,20 +59,6 @@ docs/_build/
 # PyBuilder
 target/
 
-
-/tests/django.sqlite
-
-/graphene/index.json
-/graphene/meta.json
-
-/meta.json
-/index.json
-
-/docs/playground/graphene-js/pypyjs-release-nojit/
-/docs/static/playground/lib
-
-/docs/static/playground
-
 # PyCharm
 .idea
 

README.md

@@ -16,6 +16,33 @@ For instaling graphene, just run this command in your shell
 pip install "graphene-django>=1.0.dev"
 ```
 
+### Settings
+
+```python
+INSTALLED_APPS = (
+    # ...
+    'graphene_django',
+)
+
+GRAPHENE = {
+    'SCHEMA': 'app.schema.schema' # Where your Graphene schema lives
+}
+```
+
+### Urls
+
+We need to set up a `GraphQL` endpoint in our Django app, so we can serve the queries.
+
+```python
+from django.conf.urls import url
+from graphene_django.views import GraphQLView
+
+urlpatterns = [
+    # ...
+    url(r'^graphql', GraphQLView.as_view(graphiql=True)),
+]
+```
+
 ## Examples
 
 Here is a simple Django model:

README.rst

@@ -20,6 +20,36 @@ For instaling graphene, just run this command in your shell
 
     pip install "graphene-django>=1.0.dev"
 
+Settings
+~~~~~~~~
+
+.. code:: python
+
+    INSTALLED_APPS = (
+        # ...
+        'graphene_django',
+    )
+
+    GRAPHENE = {
+        'SCHEMA': 'app.schema.schema' # Where your Graphene schema lives
+    }
+
+Urls
+~~~~
+
+We need to set up a ``GraphQL`` endpoint in our Django app, so we can
+serve the queries.
+
+.. code:: python
+
+    from django.conf.urls import url
+    from graphene_django.views import GraphQLView
+
+    urlpatterns = [
+        # ...
+        url(r'^graphql', GraphQLView.as_view(graphiql=True)),
+    ]
+
 Examples
 --------
 

django_test_settings.py

@@ -18,3 +18,17 @@
         'NAME': 'django_test.sqlite',
     }
 }
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+    },
+]
+
+GRAPHENE = {
+    'SCHEMA': 'graphene_django.tests.schema_view.schema'
+}
+
+ROOT_URLCONF = 'graphene_django.tests.urls'

examples/cookbook/cookbook/settings.py

@@ -37,7 +37,7 @@
     'django.contrib.sessions',
     'django.contrib.messages',
     'django.contrib.staticfiles',
-    'django_graphiql',
+    'graphene_django',
 
     'cookbook.ingredients.apps.IngredientsConfig',
     'cookbook.recipes.apps.RecipesConfig',
@@ -54,6 +54,10 @@
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
 ]
 
+GRAPHENE = {
+    'SCHEMA': 'cookbook.schema.schema'
+}
+
 ROOT_URLCONF = 'cookbook.urls'
 
 TEMPLATES = [

examples/cookbook/cookbook/urls.py

@@ -1,12 +1,10 @@
 from django.conf.urls import include, url
 from django.contrib import admin
-from django.views.decorators.csrf import csrf_exempt
 
 from cookbook.schema import schema
 from graphene_django.views import GraphQLView
 
 urlpatterns = [
     url(r'^admin/', admin.site.urls),
-    url(r'^graphql', csrf_exempt(GraphQLView.as_view(schema=schema))),
-    url(r'^graphiql', include('django_graphiql.urls')),
+    url(r'^graphql', GraphQLView.as_view(graphiql=True)),
 ]

graphene_django/management/commands/graphql_schema.py

@@ -6,6 +6,8 @@
 from django import get_version as get_django_version
 from django.core.management.base import BaseCommand, CommandError
 
+from graphene_django.settings import graphene_settings
+
 LT_DJANGO_1_8 = StrictVersion(get_django_version()) < StrictVersion('1.8')
 
 if LT_DJANGO_1_8:
@@ -16,7 +18,7 @@ class CommandArguments(BaseCommand):
                 type=str,
                 dest='schema',
                 default='',
-                help='Django app containing schema to dump, e.g. myproject.core.schema',
+                help='Django app containing schema to dump, e.g. myproject.core.schema.schema',
             ),
             make_option(
                 '--out',
@@ -35,14 +37,14 @@ def add_arguments(self, parser):
                 '--schema',
                 type=str,
                 dest='schema',
-                default=getattr(settings, 'GRAPHENE_SCHEMA', ''),
-                help='Django app containing schema to dump, e.g. myproject.core.schema')
+                default=graphene_settings.SCHEMA,
+                help='Django app containing schema to dump, e.g. myproject.core.schema.schema')
 
             parser.add_argument(
                 '--out',
                 type=str,
                 dest='out',
-                default=getattr(settings, 'GRAPHENE_SCHEMA_OUTPUT', 'schema.json'),
+                default=graphene_settings.SCHEMA_OUTPUT,
                 help='Output file (default: schema.json)')
 
 
@@ -56,14 +58,18 @@ def save_file(self, out, schema_dict):
 
     def handle(self, *args, **options):
         from django.conf import settings
-        schema = options.get('schema') or getattr(settings, 'GRAPHENE_SCHEMA', '')
-        out = options.get('out') or getattr(settings, 'GRAPHENE_SCHEMA_OUTPUT', 'schema.json')
+        options_schema = options.get('schema')
+        if options_schema:
+            schema = importlib.import_module(options_schema)
+        else:
+            schema = graphene_settings.SCHEMA
+
+        out = options.get('out') or graphene_settings.SCHEMA_OUTPUT
 
-        if schema == '':
-            raise CommandError('Specify schema on GRAPHENE_SCHEMA setting or by using --schema')
-        i = importlib.import_module(schema)
+        if not schema:
+            raise CommandError('Specify schema on GRAPHENE.SCHEMA setting or by using --schema')
 
-        schema_dict = {'data': i.schema.introspect()}
+        schema_dict = {'data': schema.introspect()}
         self.save_file(out, schema_dict)
 
         style = getattr(self, 'style', None)

graphene_django/settings.py

@@ -0,0 +1,127 @@
+"""
+Settings for Graphene are all namespaced in the GRAPHENE setting.
+For example your project's `settings.py` file might look like this:
+GRAPHENE = {
+    'SCHEMA': 'my_app.schema.schema'
+    'MIDDLEWARE': (
+        'graphene_django.debug.DjangoDebugMiddleware',
+    )
+}
+This module provides the `graphene_settings` object, that is used to access
+Graphene settings, checking for user settings first, then falling
+back to the defaults.
+"""
+from __future__ import unicode_literals
+
+from django.conf import settings
+from django.test.signals import setting_changed
+from django.utils import six
+
+try:
+    import importlib  # Available in Python 3.1+
+except ImportError:
+    from django.utils import importlib  # Will be removed in Django 1.9
+
+
+# Copied shamelessly from Django REST Framework
+
+DEFAULTS = {
+    'SCHEMA': None,
+    'SCHEMA_OUTPUT': 'schema.json',
+    'MIDDLEWARE': (),
+}
+
+if settings.DEBUG:
+    DEFAULTS['MIDDLEWARE'] += (
+        'graphene_django.debug.DjangoDebugMiddleware',
+    )
+
+# List of settings that may be in string import notation.
+IMPORT_STRINGS = (
+    'MIDDLEWARE',
+    'SCHEMA',
+)
+
+
+
+def perform_import(val, setting_name):
+    """
+    If the given setting is a string import notation,
+    then perform the necessary import or imports.
+    """
+    if val is None:
+        return None
+    elif isinstance(val, six.string_types):
+        return import_from_string(val, setting_name)
+    elif isinstance(val, (list, tuple)):
+        return [import_from_string(item, setting_name) for item in val]
+    return val
+
+
+def import_from_string(val, setting_name):
+    """
+    Attempt to import a class from a string representation.
+    """
+    try:
+        # Nod to tastypie's use of importlib.
+        parts = val.split('.')
+        module_path, class_name = '.'.join(parts[:-1]), parts[-1]
+        module = importlib.import_module(module_path)
+        return getattr(module, class_name)
+    except (ImportError, AttributeError) as e:
+        msg = "Could not import '%s' for Graphene setting '%s'. %s: %s." % (val, setting_name, e.__class__.__name__, e)
+        raise ImportError(msg)
+
+
+class GrapheneSettings(object):
+    """
+    A settings object, that allows API settings to be accessed as properties.
+    For example:
+        from graphene_django.settings import settings
+        print(settings.SCHEMA)
+    Any setting with string import paths will be automatically resolved
+    and return the class, rather than the string literal.
+    """
+    def __init__(self, user_settings=None, defaults=None, import_strings=None):
+        if user_settings:
+            self._user_settings = user_settings
+        self.defaults = defaults or DEFAULTS
+        self.import_strings = import_strings or IMPORT_STRINGS
+
+    @property
+    def user_settings(self):
+        if not hasattr(self, '_user_settings'):
+            self._user_settings = getattr(settings, 'GRAPHENE', {})
+        return self._user_settings
+
+    def __getattr__(self, attr):
+        if attr not in self.defaults:
+            raise AttributeError("Invalid Graphene setting: '%s'" % attr)
+
+        try:
+            # Check if present in user settings
+            val = self.user_settings[attr]
+        except KeyError:
+            # Fall back to defaults
+            val = self.defaults[attr]
+
+        # Coerce import strings into classes
+        if attr in self.import_strings:
+            val = perform_import(val, attr)
+
+        # Cache the result
+        setattr(self, attr, val)
+        return val
+
+
+graphene_settings = GrapheneSettings(None, DEFAULTS, IMPORT_STRINGS)
+
+
+def reload_graphene_settings(*args, **kwargs):
+    global graphene_settings
+    setting, value = kwargs['setting'], kwargs['value']
+    if setting == 'GRAPHENE':
+        graphene_settings = GrapheneSettings(value, DEFAULTS, IMPORT_STRINGS)
+
+
+setting_changed.connect(reload_graphene_settings)