Warn if fields or exclude are not defined on DjangoObjectType (#981)

Author: radekwlsk

docs/authorization.rst

@@ -111,6 +111,7 @@ If you are using ``DjangoObjectType`` you can define a custom `get_queryset`.
     class PostNode(DjangoObjectType):
         class Meta:
             model = Post
+            fields = '__all__'
 
         @classmethod
         def get_queryset(cls, queryset, info):

docs/filtering.rst

@@ -45,6 +45,7 @@ For example:
         class Meta:
             # Assume you have an Animal model defined with the following fields
             model = Animal
+            fields = '__all__'
             filter_fields = ['name', 'genus', 'is_domesticated']
             interfaces = (relay.Node, )
 
@@ -75,6 +76,7 @@ You can also make more complex lookup types available:
     class AnimalNode(DjangoObjectType):
         class Meta:
             model = Animal
+            fields = '__all__'
             # Provide more complex lookup types
             filter_fields = {
                 'name': ['exact', 'icontains', 'istartswith'],
@@ -116,6 +118,7 @@ create your own ``FilterSet``. You can pass it directly as follows:
         class Meta:
             # Assume you have an Animal model defined with the following fields
             model = Animal
+            fields = '__all__'
             filter_fields = ['name', 'genus', 'is_domesticated']
             interfaces = (relay.Node, )
 
@@ -179,6 +182,7 @@ in unison  with the ``filter_fields`` parameter:
     class AnimalNode(DjangoObjectType):
         class Meta:
             model = Animal
+            fields = '__all__'
             filterset_class = AnimalFilter
             interfaces = (relay.Node, )
 
@@ -236,6 +240,7 @@ Extend the tuple of fields if you want to order by more than one field.
       class Meta:
           name = 'Group'
           model = GroupModel
+          fields = '__all__'
           interfaces = (relay.Node,)
 
       def resolve_users(self, info, **kwargs):

docs/mutations.rst

@@ -25,6 +25,7 @@ Simple example
     class QuestionType(DjangoObjectType):
         class Meta:
             model = Question
+            fields = '__all__'
 
 
     class QuestionMutation(graphene.Mutation):
@@ -90,6 +91,7 @@ DjangoModelFormMutation
     class PetType(DjangoObjectType):
         class Meta:
             model = Pet
+            fields = '__all__'
 
     class PetMutation(DjangoModelFormMutation):
         pet = Field(PetType)

docs/queries.rst

@@ -28,6 +28,7 @@ Full example
     class QuestionType(DjangoObjectType):
         class Meta:
             model = Question
+            fields = '__all__'
 
 
     class Query:
@@ -53,6 +54,9 @@ all fields that should be exposed using the fields attribute.
 This will make it less likely to result in unintentionally exposing data when
 your models change.
 
+Setting neither ``fields`` nor ``exclude`` is deprecated and will raise a warning, you should at least explicitly make
+``DjangoObjectType`` include all fields in the model as described below.
+
 ``fields``
 ~~~~~~~~~~
 
@@ -127,6 +131,7 @@ For example the following ``Model`` and ``DjangoObjectType``:
    class Pet(DjangoObjectType):
       class Meta:
          model = PetModel
+         fields = '__all__'
 
 Results in the following GraphQL schema definition:
 
@@ -151,6 +156,7 @@ You can disable this automatic conversion by setting
    class Pet(DjangoObjectType):
       class Meta:
          model = PetModel
+         fields = '__all__'
          convert_choices_to_enum = False
 
 .. code::
@@ -168,6 +174,7 @@ automatically converted into enums:
    class Pet(DjangoObjectType):
       class Meta:
          model = PetModel
+         fields = '__all__'
          convert_choices_to_enum = ['kind']
 
 **Note:** Setting ``convert_choices_to_enum = []`` is the same as setting it to
@@ -206,6 +213,7 @@ need to create the most basic class for this to work:
     class CategoryType(DjangoObjectType):
         class Meta:
             model = Category
+            fields = '__all__'
 
 .. _django-objecttype-get-queryset:
 
@@ -224,6 +232,7 @@ Use this to control filtering on the ObjectType level instead of the Query objec
     class QuestionType(DjangoObjectType):
         class Meta:
             model = Question
+            fields = '__all__'
 
         @classmethod
         def get_queryset(cls, queryset, info):
@@ -347,6 +356,7 @@ the core graphene pages for more information on customizing the Relay experience
     class QuestionType(DjangoObjectType):
         class Meta:
             model = Question
+            fields = '__all__'
             interfaces = (relay.Node,)
 
 

docs/schema.py

@@ -8,11 +8,13 @@
   class CategoryType(DjangoObjectType):
       class Meta:
           model = Category
+          fields = '__all__'
 
 
   class IngredientType(DjangoObjectType):
       class Meta:
           model = Ingredient
+          fields = '__all__'
 
 
   class Query(object):

docs/tutorial-plain.rst

@@ -157,11 +157,13 @@ Create ``cookbook/ingredients/schema.py`` and type the following:
     class CategoryType(DjangoObjectType):
         class Meta:
             model = Category
+            fields = '__all__'
 
 
     class IngredientType(DjangoObjectType):
         class Meta:
             model = Ingredient
+            fields = '__all__'
 
 
     class Query(object):

docs/tutorial-relay.rst

@@ -130,13 +130,15 @@ Create ``cookbook/ingredients/schema.py`` and type the following:
     class CategoryNode(DjangoObjectType):
         class Meta:
             model = Category
+            fields = '__all__'
             filter_fields = ['name', 'ingredients']
             interfaces = (relay.Node, )
 
 
     class IngredientNode(DjangoObjectType):
         class Meta:
             model = Ingredient
+            fields = '__all__'
             # Allow for some more advanced filtering here
             filter_fields = {
                 'name': ['exact', 'icontains', 'istartswith'],

examples/cookbook-plain/cookbook/ingredients/schema.py

@@ -7,11 +7,13 @@
 class CategoryType(DjangoObjectType):
     class Meta:
         model = Category
+        fields = "__all__"
 
 
 class IngredientType(DjangoObjectType):
     class Meta:
         model = Ingredient
+        fields = "__all__"
 
 
 class Query(object):

examples/cookbook-plain/cookbook/recipes/schema.py

@@ -7,11 +7,13 @@
 class RecipeType(DjangoObjectType):
     class Meta:
         model = Recipe
+        fields = "__all__"
 
 
 class RecipeIngredientType(DjangoObjectType):
     class Meta:
         model = RecipeIngredient
+        fields = "__all__"
 
 
 class Query(object):

examples/cookbook/cookbook/ingredients/schema.py

@@ -10,6 +10,7 @@ class CategoryNode(DjangoObjectType):
     class Meta:
         model = Category
         interfaces = (Node,)
+        fields = "__all__"
         filter_fields = ["name", "ingredients"]
 
 
@@ -18,6 +19,7 @@ class Meta:
         model = Ingredient
         # Allow for some more advanced filtering here
         interfaces = (Node,)
+        fields = "__all__"
         filter_fields = {
             "name": ["exact", "icontains", "istartswith"],
             "notes": ["exact", "icontains"],

examples/cookbook/cookbook/recipes/schema.py

@@ -8,6 +8,7 @@ class RecipeNode(DjangoObjectType):
     class Meta:
         model = Recipe
         interfaces = (Node,)
+        fields = "__all__"
         filter_fields = ["title", "amounts"]
 
 
@@ -16,6 +17,7 @@ class Meta:
         model = RecipeIngredient
         # Allow for some more advanced filtering here
         interfaces = (Node,)
+        fields = "__all__"
         filter_fields = {
             "ingredient__name": ["exact", "icontains", "istartswith"],
             "recipe": ["exact"],

examples/starwars/schema.py

@@ -12,6 +12,7 @@ class Ship(DjangoObjectType):
     class Meta:
         model = ShipModel
         interfaces = (relay.Node,)
+        fields = "__all__"
 
     @classmethod
     def get_node(cls, info, id):
@@ -22,12 +23,14 @@ def get_node(cls, info, id):
 class Character(DjangoObjectType):
     class Meta:
         model = CharacterModel
+        fields = "__all__"
 
 
 class Faction(DjangoObjectType):
     class Meta:
         model = FactionModel
         interfaces = (relay.Node,)
+        fields = "__all__"
 
     @classmethod
     def get_node(cls, info, id):

graphene_django/debug/tests/test_query.py

@@ -21,6 +21,7 @@ class ReporterType(DjangoObjectType):
         class Meta:
             model = Reporter
             interfaces = (Node,)
+            fields = "__all__"
 
     class Query(graphene.ObjectType):
         reporter = graphene.Field(ReporterType)
@@ -65,6 +66,7 @@ class ReporterType(DjangoObjectType):
         class Meta:
             model = Reporter
             interfaces = (Node,)
+            fields = "__all__"
 
     class Query(graphene.ObjectType):
         reporter = graphene.Field(ReporterType)
@@ -130,6 +132,7 @@ class ReporterType(DjangoObjectType):
         class Meta:
             model = Reporter
             interfaces = (Node,)
+            fields = "__all__"
 
     class Query(graphene.ObjectType):
         all_reporters = graphene.List(ReporterType)
@@ -172,6 +175,7 @@ class ReporterType(DjangoObjectType):
         class Meta:
             model = Reporter
             interfaces = (Node,)
+            fields = "__all__"
 
     class Query(graphene.ObjectType):
         all_reporters = DjangoConnectionField(ReporterType)
@@ -220,6 +224,7 @@ class ReporterType(DjangoObjectType):
         class Meta:
             model = Reporter
             interfaces = (Node,)
+            fields = "__all__"
 
     class Query(graphene.ObjectType):
         all_reporters = DjangoFilterConnectionField(ReporterType, fields=["last_name"])