Merge pull request #140 from graphql-python/features/django-fields

Improved support for Django fields

Author: syrusakbary

.travis.yml

@@ -24,6 +24,7 @@ install:
 - |
   if [ "$TEST_TYPE" = build ]; then
     pip install --download-cache $HOME/.cache/pip/ pytest pytest-cov coveralls six pytest-django django-filter sqlalchemy_utils
+    pip install --download-cache $HOME/.cache/pip psycopg2 > /dev/null 2>&1
     pip install --download-cache $HOME/.cache/pip/ -e .[django]
     pip install --download-cache $HOME/.cache/pip/ -e .[sqlalchemy]
     pip install django==$DJANGO_VERSION

docs/pages/docs/basic-types.md

@@ -16,6 +16,10 @@ Also the following Types are available:
 - `graphene.List`
 - `graphene.NonNull`
 
+Graphene also provides custom scalars for Dates and JSON:
+- `graphene.core.types.custom_scalars.DateTime`
+- `graphene.core.types.custom_scalars.JSONString`
+
 ## Shortcuts
 
 There are some shortcuts for building schemas more easily.

examples/flask_sqlalchemy/app.py

@@ -1,8 +1,8 @@
 from flask import Flask
-from database import db_session, init_db
 
-from schema import schema
+from database import db_session, init_db
 from flask_graphql import GraphQL
+from schema import schema
 
 app = Flask(__name__)
 app.debug = True

examples/flask_sqlalchemy/database.py

@@ -1,6 +1,6 @@
 from sqlalchemy import create_engine
-from sqlalchemy.orm import scoped_session, sessionmaker
 from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import scoped_session, sessionmaker
 
 engine = create_engine('sqlite:///database.sqlite3', convert_unicode=True)
 db_session = scoped_session(sessionmaker(autocommit=False,

examples/flask_sqlalchemy/models.py

@@ -1,6 +1,7 @@
+from sqlalchemy import Column, DateTime, ForeignKey, Integer, String, func
+from sqlalchemy.orm import backref, relationship
+
 from database import Base
-from sqlalchemy import Column, DateTime, String, Integer, ForeignKey, func
-from sqlalchemy.orm import relationship, backref
 
 
 class Department(Base):

examples/flask_sqlalchemy/schema.py

@@ -1,19 +1,23 @@
 import graphene
 from graphene import relay
-from graphene.contrib.sqlalchemy import SQLAlchemyNode, SQLAlchemyConnectionField
-from models import Department as DepartmentModel, Employee as EmployeeModel
+from graphene.contrib.sqlalchemy import (SQLAlchemyConnectionField,
+                                         SQLAlchemyNode)
+from models import Department as DepartmentModel
+from models import Employee as EmployeeModel
 
 schema = graphene.Schema()
 
 
 @schema.register
 class Department(SQLAlchemyNode):
+
     class Meta:
         model = DepartmentModel
 
 
 @schema.register
 class Employee(SQLAlchemyNode):
+
     class Meta:
         model = EmployeeModel
 

graphene/contrib/django/compat.py

@@ -1,15 +1,24 @@
 from django.db import models
 
+
+class MissingType(object):
+    pass
+
 try:
     UUIDField = models.UUIDField
 except AttributeError:
     # Improved compatibility for Django 1.6
-    class UUIDField(object):
-        pass
+    UUIDField = MissingType
 
 try:
     from django.db.models.related import RelatedObject
 except:
     # Improved compatibility for Django 1.6
-    class RelatedObject(object):
-        pass
+    RelatedObject = MissingType
+
+
+try:
+    # Postgres fields are only available in Django 1.8+
+    from django.contrib.postgres.fields import ArrayField, HStoreField, JSONField, RangeField
+except ImportError:
+    ArrayField, HStoreField, JSONField, RangeField = (MissingType, ) * 4

graphene/contrib/django/converter.py

@@ -1,9 +1,12 @@
 from django.db import models
 
-from ...core.types.scalars import ID, Boolean, Float, Int, String
 from ...core.classtypes.enum import Enum
+from ...core.types.custom_scalars import DateTime, JSONString
+from ...core.types.definitions import List
+from ...core.types.scalars import ID, Boolean, Float, Int, String
 from ...utils import to_const
-from .compat import RelatedObject, UUIDField
+from .compat import (ArrayField, HStoreField, JSONField, RangeField,
+                     RelatedObject, UUIDField)
 from .utils import get_related_model, import_single_dispatch
 
 singledispatch = import_single_dispatch()
@@ -30,13 +33,13 @@ def convert_django_field(field):
         (field, field.__class__))
 
 
-@convert_django_field.register(models.DateField)
 @convert_django_field.register(models.CharField)
 @convert_django_field.register(models.TextField)
 @convert_django_field.register(models.EmailField)
 @convert_django_field.register(models.SlugField)
 @convert_django_field.register(models.URLField)
 @convert_django_field.register(models.GenericIPAddressField)
+@convert_django_field.register(models.FileField)
 @convert_django_field.register(UUIDField)
 def convert_field_to_string(field):
     return String(description=field.help_text)
@@ -72,6 +75,11 @@ def convert_field_to_float(field):
     return Float(description=field.help_text)
 
 
+@convert_django_field.register(models.DateField)
+def convert_date_to_string(field):
+    return DateTime(description=field.help_text)
+
+
 @convert_django_field.register(models.ManyToManyField)
 @convert_django_field.register(models.ManyToOneRel)
 @convert_django_field.register(models.ManyToManyRel)
@@ -94,3 +102,21 @@ def convert_relatedfield_to_djangomodel(field):
 def convert_field_to_djangomodel(field):
     from .fields import DjangoModelField
     return DjangoModelField(get_related_model(field), description=field.help_text)
+
+
+@convert_django_field.register(ArrayField)
+def convert_postgres_array_to_list(field):
+    base_type = convert_django_field(field.base_field)
+    return List(base_type, description=field.help_text)
+
+
+@convert_django_field.register(HStoreField)
+@convert_django_field.register(JSONField)
+def convert_posgres_field_to_string(field):
+    return JSONString(description=field.help_text)
+
+
+@convert_django_field.register(RangeField)
+def convert_posgres_range_to_string(field):
+    inner_type = convert_django_field(field.base_field)
+    return List(inner_type, description=field.help_text)

graphene/contrib/django/debug/tests/test_query.py

@@ -1,7 +1,7 @@
 import pytest
 
 import graphene
-from graphene.contrib.django import DjangoNode, DjangoConnectionField
+from graphene.contrib.django import DjangoConnectionField, DjangoNode
 from graphene.contrib.django.utils import DJANGO_FILTER_INSTALLED
 
 from ...tests.models import Reporter
@@ -19,6 +19,7 @@ def test_should_query_field():
     r2.save()
 
     class ReporterType(DjangoNode):
+
         class Meta:
             model = Reporter
 

graphene/contrib/django/filter/filterset.py

@@ -2,10 +2,10 @@
 from django.conf import settings
 from django.db import models
 from django.utils.text import capfirst
-from graphql_relay.node.node import from_global_id
-
 from django_filters import Filter, MultipleChoiceFilter
 from django_filters.filterset import FilterSet, FilterSetMetaclass
+from graphql_relay.node.node import from_global_id
+
 from graphene.contrib.django.forms import (GlobalIDFormField,
                                            GlobalIDMultipleChoiceField)