Merge pull request #175 from jkimbo/add-is-deprecated

Add `is_deprecated` property to GraphQLField

Author: syrusakbary

graphql/type/definition.py

@@ -195,6 +195,9 @@ def define_field_map(type, field_map):
 
     for field_name, field in field_map.items():
         assert_valid_name(field_name)
+        assert isinstance(field, GraphQLField), (
+            '{}.{} must be an instance of GraphQLField.'.format(type, field_name)
+        )
         field_args = getattr(field, 'args', None)
 
         if field_args:
@@ -261,6 +264,10 @@ def __eq__(self, other):
     def __hash__(self):
         return id(self)
 
+    @property
+    def is_deprecated(self):
+        return bool(self.deprecation_reason)
+
 
 class GraphQLArgument(object):
     __slots__ = 'type', 'default_value', 'description', 'out_name'

graphql/type/tests/test_definition.py

@@ -118,6 +118,23 @@ def test_defines_a_subscription_schema():
     # assert subscription.name == 'articleSubscribe'
 
 
+def test_defines_an_object_type_with_deprecated_field():
+    TypeWithDeprecatedField = GraphQLObjectType('foo', fields={
+        'bar': GraphQLField(
+            type=GraphQLString,
+            deprecation_reason='A terrible reason'
+        ),
+    })
+
+    field = TypeWithDeprecatedField.fields['bar']
+    assert field.type == GraphQLString
+    assert field.description is None
+    assert field.deprecation_reason == 'A terrible reason'
+    assert field.is_deprecated is True
+    # assert field.name == 'bar'
+    assert field.args == OrderedDict()
+
+
 def test_includes_nested_input_objects_in_the_map():
     NestedInputObject = GraphQLInputObjectType(
         name='NestedInputObject',

graphql/type/typemap.py

@@ -2,7 +2,7 @@
 from functools import reduce
 
 from ..utils.type_comparators import is_equal_type, is_type_sub_type_of
-from .definition import (GraphQLArgument, GraphQLField,
+from .definition import (GraphQLArgument,
                          GraphQLInputObjectField, GraphQLInputObjectType,
                          GraphQLInterfaceType, GraphQLList, GraphQLNonNull,
                          GraphQLObjectType, GraphQLUnionType, is_input_type,
@@ -87,9 +87,6 @@ def reducer(cls, map, type):
                         '{}.{} field type must be Input Type but got: {}.'.format(type, field_name, field.type)
                     )
                 else:
-                    assert isinstance(field, (GraphQLField, GraphQLField)), (
-                        '{}.{} must be an instance of GraphQLField.'.format(type, field_name)
-                    )
                     assert is_output_type(field.type), (
                         '{}.{} field type must be Output Type but got: {}.'.format(type, field_name, field.type)
                     )