Adds enhanced support for proxy models.

Author: Andrew Bettke

graphene_django/tests/models.py

@@ -65,6 +65,11 @@ def __init__(self, *args, **kwargs):
             self.__class__ = CNNReporter
 
 
+class CNNReporterManager(models.Manager):
+    def get_queryset(self):
+        return super(CNNReporterManager, self).get_queryset().filter(reporter_type=2)
+
+
 class CNNReporter(Reporter):
     """
     This class is a proxy model for Reporter, used for testing
@@ -74,6 +79,8 @@ class CNNReporter(Reporter):
     class Meta:
         proxy = True
 
+    objects = CNNReporterManager()
+
 
 class Article(models.Model):
     headline = models.CharField(max_length=100)

graphene_django/tests/test_query.py

@@ -1,3 +1,4 @@
+import base64
 import datetime
 
 import pytest
@@ -895,8 +896,7 @@ class Query(graphene.ObjectType):
 
 def test_proxy_model_support():
     """
-    This test asserts that we can query for all Reporters,
-    even if some are of a proxy model type at runtime.
+    This test asserts that we can query for all Reporters and proxied Reporters.
     """
 
     class ReporterType(DjangoObjectType):
@@ -905,11 +905,17 @@ class Meta:
             interfaces = (Node,)
             use_connection = True
 
-    reporter_1 = Reporter.objects.create(
+    class CNNReporterType(DjangoObjectType):
+        class Meta:
+            model = CNNReporter
+            interfaces = (Node,)
+            use_connection = True
+
+    reporter = Reporter.objects.create(
         first_name="John", last_name="Doe", email="[email protected]", a_choice=1
     )
 
-    reporter_2 = CNNReporter.objects.create(
+    cnn_reporter = CNNReporter.objects.create(
         first_name="Some",
         last_name="Guy",
         email="[email protected]",
@@ -919,6 +925,7 @@ class Meta:
 
     class Query(graphene.ObjectType):
         all_reporters = DjangoConnectionField(ReporterType)
+        cnn_reporters = DjangoConnectionField(CNNReporterType)
 
     schema = graphene.Schema(query=Query)
     query = """
@@ -930,63 +937,7 @@ class Query(graphene.ObjectType):
                     }
                 }
             }
-        }
-    """
-
-    expected = {
-        "allReporters": {
-            "edges": [
-                {"node": {"id": "UmVwb3J0ZXJUeXBlOjE="}},
-                {"node": {"id": "UmVwb3J0ZXJUeXBlOjI="}},
-            ]
-        }
-    }
-
-    result = schema.execute(query)
-    assert not result.errors
-    assert result.data == expected
-
-
-def test_proxy_model_fails():
-    """
-    This test asserts that if you try to query for a proxy model,
-    that query will fail with:
-        GraphQLError('Expected value of type "CNNReporterType" but got:
-            CNNReporter.',)
-
-    This is because a proxy model has the identical model definition
-    to its superclass, and defines its behavior at runtime, rather than
-    at the database level. Currently, filtering objects of the proxy models'
-    type isn't supported. It would require a field on the model that would
-    represent the type, and it doesn't seem like there is a clear way to
-    enforce this pattern across all projects
-    """
-
-    class CNNReporterType(DjangoObjectType):
-        class Meta:
-            model = CNNReporter
-            interfaces = (Node,)
-            use_connection = True
-
-    reporter_1 = Reporter.objects.create(
-        first_name="John", last_name="Doe", email="[email protected]", a_choice=1
-    )
-
-    reporter_2 = CNNReporter.objects.create(
-        first_name="Some",
-        last_name="Guy",
-        email="[email protected]",
-        a_choice=1,
-        reporter_type=2,  # set this guy to be CNN
-    )
-
-    class Query(graphene.ObjectType):
-        all_reporters = DjangoConnectionField(CNNReporterType)
-
-    schema = graphene.Schema(query=Query)
-    query = """
-        query ProxyModelQuery {
-            allReporters {
+            cnnReporters {
                 edges {
                     node {
                         id
@@ -999,11 +950,17 @@ class Query(graphene.ObjectType):
     expected = {
         "allReporters": {
             "edges": [
-                {"node": {"id": "UmVwb3J0ZXJUeXBlOjE="}},
-                {"node": {"id": "UmVwb3J0ZXJUeXBlOjI="}},
+                {"node": {"id": base64.b64encode("ReporterType:{}".format(reporter.id))}},
+                {"node": {"id": base64.b64encode("ReporterType:{}".format(cnn_reporter.id))}},
+            ]
+        },
+        "cnnReporters": {
+            "edges": [
+                {"node": {"id": base64.b64encode("CNNReporterType:{}".format(cnn_reporter.id))}}
             ]
         }
     }
 
     result = schema.execute(query)
-    assert result.errors
+    assert not result.errors
+    assert result.data == expected

graphene_django/types.py

@@ -130,7 +130,11 @@ def is_type_of(cls, root, info):
         if not is_valid_django_model(type(root)):
             raise Exception(('Received incompatible instance "{}".').format(root))
 
-        model = root._meta.model._meta.concrete_model
+        if cls._meta.model._meta.proxy:
+            model = root._meta.model
+        else:
+            model = root._meta.model._meta.concrete_model
+            
         return model == cls._meta.model
 
     @classmethod