Merge pull request #61 from graphql-python/features/classtypes

Refactor ObjectTypes in ClassTypes. Fixed #30

Author: syrusakbary

bin/autolinter

@@ -1,5 +1,5 @@
 #!/bin/bash
 
-autoflake ./ -r --remove-unused-variables --remove-all-unused-imports --in-place
-autopep8 ./ -r --in-place --experimental --aggressive --max-line-length 120
-isort -rc .
+autoflake ./examples/ ./graphene/ -r --remove-unused-variables --remove-all-unused-imports --in-place
+autopep8 ./examples/ ./graphene/ -r --in-place --experimental --aggressive --max-line-length 120
+isort -rc ./examples/ ./graphene/

graphene/__init__.py

@@ -8,11 +8,15 @@
     Schema
 )
 
-from graphene.core.types import (
+from graphene.core.classtypes import (
     ObjectType,
     InputObjectType,
     Interface,
     Mutation,
+    Scalar
+)
+
+from graphene.core.types import (
     BaseType,
     LazyType,
     Argument,
@@ -59,6 +63,7 @@
     'InputObjectType',
     'Interface',
     'Mutation',
+    'Scalar',
     'Field',
     'InputField',
     'StringField',

graphene/contrib/django/__init__.py

@@ -1,13 +1,12 @@
 from graphene.contrib.django.types import (
     DjangoConnection,
     DjangoObjectType,
-    DjangoInterface,
     DjangoNode
 )
 from graphene.contrib.django.fields import (
     DjangoConnectionField,
     DjangoModelField
 )
 
-__all__ = ['DjangoObjectType', 'DjangoInterface', 'DjangoNode',
-           'DjangoConnection', 'DjangoConnectionField', 'DjangoModelField']
+__all__ = ['DjangoObjectType', 'DjangoNode', 'DjangoConnection',
+           'DjangoConnectionField', 'DjangoModelField']

graphene/contrib/django/options.py

@@ -1,24 +1,15 @@
-import inspect
-
-from django.db import models
-
-from ...core.options import Options
+from ...core.classtypes.objecttype import ObjectTypeOptions
 from ...relay.types import Node
 from ...relay.utils import is_node
 
 VALID_ATTRS = ('model', 'only_fields', 'exclude_fields')
 
 
-def is_base(cls):
-    from graphene.contrib.django.types import DjangoObjectType
-    return DjangoObjectType in cls.__bases__
-
-
-class DjangoOptions(Options):
+class DjangoOptions(ObjectTypeOptions):
 
     def __init__(self, *args, **kwargs):
-        self.model = None
         super(DjangoOptions, self).__init__(*args, **kwargs)
+        self.model = None
         self.valid_attrs += VALID_ATTRS
         self.only_fields = None
         self.exclude_fields = []
@@ -28,11 +19,3 @@ def contribute_to_class(self, cls, name):
         if is_node(cls):
             self.exclude_fields = list(self.exclude_fields) + ['id']
             self.interfaces.append(Node)
-        if not is_node(cls) and not is_base(cls):
-            return
-        if not self.model:
-            raise Exception(
-                'Django ObjectType %s must have a model in the Meta class attr' %
-                cls)
-        elif not inspect.isclass(self.model) or not issubclass(self.model, models.Model):
-            raise Exception('Provided model in %s is not a Django model' % cls)

graphene/contrib/django/tests/test_types.py

@@ -1,9 +1,8 @@
-from graphql.core.type import GraphQLInterfaceType, GraphQLObjectType
+from graphql.core.type import GraphQLObjectType
 from mock import patch
-from pytest import raises
 
 from graphene import Schema
-from graphene.contrib.django.types import DjangoInterface, DjangoNode
+from graphene.contrib.django.types import DjangoNode, DjangoObjectType
 from graphene.core.fields import Field
 from graphene.core.types.scalars import Int
 from graphene.relay.fields import GlobalIDField
@@ -14,7 +13,8 @@
 schema = Schema()
 
 
-class Character(DjangoInterface):
+@schema.register
+class Character(DjangoObjectType):
     '''Character description'''
     class Meta:
         model = Reporter
@@ -31,7 +31,7 @@ class Meta:
 
 
 def test_django_interface():
-    assert DjangoNode._meta.is_interface is True
+    assert DjangoNode._meta.interface is True
 
 
 @patch('graphene.contrib.django.tests.models.Article.objects.get', return_value=Article(id=1))
@@ -41,17 +41,6 @@ def test_django_get_node(get):
     assert human.id == 1
 
 
-def test_pseudo_interface_registered():
-    object_type = schema.T(Character)
-    assert Character._meta.is_interface is True
-    assert isinstance(object_type, GraphQLInterfaceType)
-    assert Character._meta.model == Reporter
-    assert_equal_lists(
-        object_type.get_fields().keys(),
-        ['articles', 'firstName', 'lastName', 'email', 'pets', 'id']
-    )
-
-
 def test_djangonode_idfield():
     idfield = DjangoNode._meta.fields_map['id']
     assert isinstance(idfield, GlobalIDField)
@@ -68,32 +57,21 @@ def test_node_replacedfield():
     assert schema.T(idfield).type == schema.T(Int())
 
 
-def test_interface_resolve_type():
-    resolve_type = Character._resolve_type(schema, Human())
-    assert isinstance(resolve_type, GraphQLObjectType)
-
-
-def test_interface_objecttype_init_none():
+def test_objecttype_init_none():
     h = Human()
     assert h._root is None
 
 
-def test_interface_objecttype_init_good():
+def test_objecttype_init_good():
     instance = Article()
     h = Human(instance)
     assert h._root == instance
 
 
-def test_interface_objecttype_init_unexpected():
-    with raises(AssertionError) as excinfo:
-        Human(object())
-    assert str(excinfo.value) == "Human received a non-compatible instance (object) when expecting Article"
-
-
 def test_object_type():
     object_type = schema.T(Human)
     Human._meta.fields_map
-    assert Human._meta.is_interface is False
+    assert Human._meta.interface is False
     assert isinstance(object_type, GraphQLObjectType)
     assert_equal_lists(
         object_type.get_fields().keys(),
@@ -103,5 +81,5 @@ def test_object_type():
 
 
 def test_node_notinterface():
-    assert Human._meta.is_interface is False
+    assert Human._meta.interface is False
     assert DjangoNode in Human._meta.interfaces

graphene/contrib/django/types.py

@@ -1,22 +1,19 @@
+import inspect
+
 import six
+from django.db import models
 
-from ...core.types import BaseObjectType, ObjectTypeMeta
-from ...relay.fields import GlobalIDField
-from ...relay.types import BaseNode, Connection
+from ...core.classtypes.objecttype import ObjectType, ObjectTypeMeta
+from ...relay.types import Connection, Node, NodeMeta
 from .converter import convert_django_field
 from .options import DjangoOptions
 from .utils import get_reverse_fields, maybe_queryset
 
 
 class DjangoObjectTypeMeta(ObjectTypeMeta):
-    options_cls = DjangoOptions
-
-    def is_interface(cls, parents):
-        return DjangoInterface in parents
+    options_class = DjangoOptions
 
-    def add_extra_fields(cls):
-        if not cls._meta.model:
-            return
+    def construct_fields(cls):
         only_fields = cls._meta.only_fields
         reverse_fields = get_reverse_fields(cls._meta.model)
         all_fields = sorted(list(cls._meta.model._meta.fields) +
@@ -35,8 +32,24 @@ def add_extra_fields(cls):
             converted_field = convert_django_field(field)
             cls.add_to_class(field.name, converted_field)
 
+    def construct(cls, *args, **kwargs):
+        cls = super(DjangoObjectTypeMeta, cls).construct(*args, **kwargs)
+        if not cls._meta.abstract:
+            if not cls._meta.model:
+                raise Exception(
+                    'Django ObjectType %s must have a model in the Meta class attr' %
+                    cls)
+            elif not inspect.isclass(cls._meta.model) or not issubclass(cls._meta.model, models.Model):
+                raise Exception('Provided model in %s is not a Django model' % cls)
+
+            cls.construct_fields()
+        return cls
+
 
-class InstanceObjectType(BaseObjectType):
+class InstanceObjectType(ObjectType):
+
+    class Meta:
+        abstract = True
 
     def __init__(self, _root=None):
         if _root:
@@ -63,12 +76,9 @@ def __getattr__(self, attr):
 
 class DjangoObjectType(six.with_metaclass(
         DjangoObjectTypeMeta, InstanceObjectType)):
-    pass
 
-
-class DjangoInterface(six.with_metaclass(
-        DjangoObjectTypeMeta, InstanceObjectType)):
-    pass
+    class Meta:
+        abstract = True
 
 
 class DjangoConnection(Connection):
@@ -79,8 +89,21 @@ def from_list(cls, iterable, *args, **kwargs):
         return super(DjangoConnection, cls).from_list(iterable, *args, **kwargs)
 
 
-class DjangoNode(BaseNode, DjangoInterface):
-    id = GlobalIDField()
+class DjangoNodeMeta(DjangoObjectTypeMeta, NodeMeta):
+    pass
+
+
+class NodeInstance(Node, InstanceObjectType):
+
+    class Meta:
+        abstract = True
+
+
+class DjangoNode(six.with_metaclass(
+        DjangoNodeMeta, NodeInstance)):
+
+    class Meta:
+        abstract = True
 
     @classmethod
     def get_node(cls, id, info=None):

graphene/core/classtypes/__init__.py

@@ -0,0 +1,16 @@
+from .inputobjecttype import InputObjectType
+from .interface import Interface
+from .mutation import Mutation
+from .objecttype import ObjectType
+from .options import Options
+from .scalar import Scalar
+from .uniontype import UnionType
+
+__all__ = [
+    'InputObjectType',
+    'Interface',
+    'Mutation',
+    'ObjectType',
+    'Options',
+    'Scalar',
+    'UnionType']