Allow deprecating input fields and arguments

Replicates graphql/graphql-js@01bcc7d

Author: Cito

src/graphql/type/definition.py

@@ -604,6 +604,7 @@ class GraphQLArgument:
     type: "GraphQLInputType"
     default_value: Any
     description: Optional[str]
+    deprecation_reason: Optional[str]
     out_name: Optional[str]  # for transforming names (extension of GraphQL.js)
     extensions: Optional[Dict[str, Any]]
     ast_node: Optional[InputValueDefinitionNode]
@@ -613,6 +614,7 @@ def __init__(
         type_: "GraphQLInputType",
         default_value: Any = Undefined,
         description: Optional[str] = None,
+        deprecation_reason: Optional[str] = None,
         out_name: Optional[str] = None,
         extensions: Optional[Dict[str, Any]] = None,
         ast_node: Optional[InputValueDefinitionNode] = None,
@@ -621,6 +623,8 @@ def __init__(
             raise TypeError("Argument type must be a GraphQL input type.")
         if description is not None and not is_description(description):
             raise TypeError("Argument description must be a string.")
+        if deprecation_reason is not None and not is_description(deprecation_reason):
+            raise TypeError("Argument deprecation reason must be a string.")
         if out_name is not None and not isinstance(out_name, str):
             raise TypeError("Argument out name must be a string.")
         if extensions is not None and (
@@ -635,6 +639,7 @@ def __init__(
         self.type = type_
         self.default_value = default_value
         self.description = description
+        self.deprecation_reason = deprecation_reason
         self.out_name = out_name
         self.extensions = extensions
         self.ast_node = ast_node
@@ -645,6 +650,7 @@ def __eq__(self, other: Any) -> bool:
             and self.type == other.type
             and self.default_value == other.default_value
             and self.description == other.description
+            and self.deprecation_reason == other.deprecation_reason
             and self.out_name == other.out_name
             and self.extensions == other.extensions
         )
@@ -654,6 +660,7 @@ def to_kwargs(self) -> Dict[str, Any]:
             type_=self.type,
             default_value=self.default_value,
             description=self.description,
+            deprecation_reason=self.deprecation_reason,
             out_name=self.out_name,
             extensions=self.extensions,
             ast_node=self.ast_node,
@@ -1399,6 +1406,7 @@ class GraphQLInputField:
     type: "GraphQLInputType"
     default_value: Any
     description: Optional[str]
+    deprecation_reason: Optional[str]
     out_name: Optional[str]  # for transforming names (extension of GraphQL.js)
     extensions: Optional[Dict[str, Any]]
     ast_node: Optional[InputValueDefinitionNode]
@@ -1408,6 +1416,7 @@ def __init__(
         type_: "GraphQLInputType",
         default_value: Any = Undefined,
         description: Optional[str] = None,
+        deprecation_reason: Optional[str] = None,
         out_name: Optional[str] = None,
         extensions: Optional[Dict[str, Any]] = None,
         ast_node: Optional[InputValueDefinitionNode] = None,
@@ -1416,6 +1425,8 @@ def __init__(
             raise TypeError("Input field type must be a GraphQL input type.")
         if description is not None and not is_description(description):
             raise TypeError("Input field description must be a string.")
+        if deprecation_reason is not None and not is_description(deprecation_reason):
+            raise TypeError("Input field deprecation reason must be a string.")
         if out_name is not None and not isinstance(out_name, str):
             raise TypeError("Input field out name must be a string.")
         if extensions is not None and (
@@ -1430,6 +1441,7 @@ def __init__(
         self.type = type_
         self.default_value = default_value
         self.description = description
+        self.deprecation_reason = deprecation_reason
         self.out_name = out_name
         self.extensions = extensions
         self.ast_node = ast_node
@@ -1440,6 +1452,7 @@ def __eq__(self, other: Any) -> bool:
             and self.type == other.type
             and self.default_value == other.default_value
             and self.description == other.description
+            and self.deprecation_reason == other.deprecation_reason
             and self.extensions == other.extensions
             and self.out_name == other.out_name
         )
@@ -1449,6 +1462,7 @@ def to_kwargs(self) -> Dict[str, Any]:
             type_=self.type,
             default_value=self.default_value,
             description=self.description,
+            deprecation_reason=self.deprecation_reason,
             out_name=self.out_name,
             extensions=self.extensions,
             ast_node=self.ast_node,

src/graphql/type/directives.py

@@ -185,7 +185,12 @@ def assert_directive(directive: Any) -> GraphQLDirective:
 # Used to declare element of a GraphQL schema as deprecated:
 GraphQLDeprecatedDirective = GraphQLDirective(
     name="deprecated",
-    locations=[DirectiveLocation.FIELD_DEFINITION, DirectiveLocation.ENUM_VALUE],
+    locations=[
+        DirectiveLocation.FIELD_DEFINITION,
+        DirectiveLocation.ARGUMENT_DEFINITION,
+        DirectiveLocation.INPUT_FIELD_DEFINITION,
+        DirectiveLocation.ENUM_VALUE,
+    ],
     args={
         "reason": GraphQLArgument(
             GraphQLString,

src/graphql/type/introspection.py

@@ -243,6 +243,11 @@
         ),
         "inputFields": GraphQLField(
             GraphQLList(GraphQLNonNull(__InputValue)),
+            args={
+                "includeDeprecated": GraphQLArgument(
+                    GraphQLBoolean, default_value=False
+                )
+            },
             resolve=TypeFieldResolvers.input_fields,
         ),
         "ofType": GraphQLField(__Type, resolve=TypeFieldResolvers.of_type),
@@ -311,14 +316,22 @@ def possible_types(type_, info):
     def enum_values(type_, _info, includeDeprecated=False):
         if is_enum_type(type_):
             items = type_.values.items()
-            if not includeDeprecated:
-                return [item for item in items if item[1].deprecation_reason is None]
-            return items
+            return (
+                items
+                if includeDeprecated
+                else [item for item in items if item[1].deprecation_reason is None]
+            )
 
+    # noinspection PyPep8Naming
     @staticmethod
-    def input_fields(type_, _info):
+    def input_fields(type_, _info, includeDeprecated=False):
         if is_input_object_type(type_):
-            return type_.fields.items()
+            items = type_.fields.items()
+            return (
+                items
+                if includeDeprecated
+                else [item for item in items if item[1].deprecation_reason is None]
+            )
 
     @staticmethod
     def of_type(type_, _info):
@@ -332,29 +345,62 @@ def of_type(type_, _info):
     " and a return type.",
     fields=lambda: {
         "name": GraphQLField(
-            GraphQLNonNull(GraphQLString), resolve=lambda item, _info: item[0]
-        ),
-        "description": GraphQLField(
-            GraphQLString, resolve=lambda item, _info: item[1].description
+            GraphQLNonNull(GraphQLString), resolve=FieldResolvers.name
         ),
+        "description": GraphQLField(GraphQLString, resolve=FieldResolvers.description),
         "args": GraphQLField(
             GraphQLNonNull(GraphQLList(GraphQLNonNull(__InputValue))),
-            resolve=lambda item, _info: item[1].args.items(),
-        ),
-        "type": GraphQLField(
-            GraphQLNonNull(__Type), resolve=lambda item, _info: item[1].type
+            args={
+                "includeDeprecated": GraphQLArgument(
+                    GraphQLBoolean, default_value=False
+                )
+            },
+            resolve=FieldResolvers.args,
         ),
+        "type": GraphQLField(GraphQLNonNull(__Type), resolve=FieldResolvers.type),
         "isDeprecated": GraphQLField(
             GraphQLNonNull(GraphQLBoolean),
-            resolve=lambda item, _info: item[1].deprecation_reason is not None,
+            resolve=FieldResolvers.is_deprecated,
         ),
         "deprecationReason": GraphQLField(
-            GraphQLString, resolve=lambda item, _info: item[1].deprecation_reason
+            GraphQLString, resolve=FieldResolvers.deprecation_reason
         ),
     },
 )
 
 
+class FieldResolvers:
+    @staticmethod
+    def name(item, _info):
+        return item[0]
+
+    @staticmethod
+    def description(item, _info):
+        return item[1].description
+
+    # noinspection PyPep8Naming
+    @staticmethod
+    def args(item, _info, includeDeprecated=False):
+        items = item[1].args.items()
+        return (
+            items
+            if includeDeprecated
+            else [item for item in items if item[1].deprecation_reason is None]
+        )
+
+    @staticmethod
+    def type(item, _info):
+        return item[1].type
+
+    @staticmethod
+    def is_deprecated(item, _info):
+        return item[1].deprecation_reason is not None
+
+    @staticmethod
+    def deprecation_reason(item, _info):
+        return item[1].deprecation_reason
+
+
 __InputValue: GraphQLObjectType = GraphQLObjectType(
     name="__InputValue",
     description="Arguments provided to Fields or Directives and the input"
@@ -376,6 +422,13 @@ def of_type(type_, _info):
             " the default value for this input value.",
             resolve=InputValueFieldResolvers.default_value,
         ),
+        "isDeprecated": GraphQLField(
+            GraphQLNonNull(GraphQLBoolean),
+            resolve=InputValueFieldResolvers.is_deprecated,
+        ),
+        "deprecationReason": GraphQLField(
+            GraphQLString, resolve=InputValueFieldResolvers.deprecation_reason
+        ),
     },
 )
 
@@ -401,6 +454,14 @@ def default_value(item, _info):
         value_ast = ast_from_value(item[1].default_value, item[1].type)
         return print_ast(value_ast) if value_ast else None
 
+    @staticmethod
+    def is_deprecated(item, _info):
+        return item[1].deprecation_reason is not None
+
+    @staticmethod
+    def deprecation_reason(item, _info):
+        return item[1].deprecation_reason
+
 
 __EnumValue: GraphQLObjectType = GraphQLObjectType(
     name="__EnumValue",

src/graphql/type/validate.py

@@ -14,7 +14,14 @@
 
 from ..error import GraphQLError, located_error
 from ..pyutils import inspect
-from ..language import NamedTypeNode, Node, OperationType, OperationTypeDefinitionNode
+from ..language import (
+    DirectiveNode,
+    InputValueDefinitionNode,
+    NamedTypeNode,
+    Node,
+    OperationType,
+    OperationTypeDefinitionNode,
+)
 from .definition import (
     GraphQLEnumType,
     GraphQLInputField,
@@ -32,10 +39,11 @@
     is_output_type,
     is_union_type,
     is_required_argument,
+    is_required_input_field,
 )
 from ..utilities.assert_valid_name import is_valid_name_error
 from ..utilities.type_comparators import is_equal_type, is_type_sub_type_of
-from .directives import is_directive, GraphQLDirective
+from .directives import is_directive, GraphQLDirective, GraphQLDeprecatedDirective
 from .introspection import is_introspection_type
 from .schema import GraphQLSchema, assert_schema
 
@@ -163,6 +171,16 @@ def validate_directives(self) -> None:
                         arg.ast_node,
                     )
 
+                if is_required_argument(arg) and arg.deprecation_reason is not None:
+                    self.report_error(
+                        f"Required argument @{directive.name}({arg_name}:)"
+                        " cannot be deprecated.",
+                        [
+                            get_deprecated_directive_node(arg.ast_node),
+                            arg.ast_node and arg.ast_node.type,
+                        ],
+                    )
+
     def validate_name(self, node: Any, name: Optional[str] = None) -> None:
         # Ensure names are valid, however introspection types opt out.
         try:
@@ -261,6 +279,16 @@ def validate_fields(
                         arg.ast_node and arg.ast_node.type,
                     )
 
+                if is_required_argument(arg) and arg.deprecation_reason is not None:
+                    self.report_error(
+                        f"Required argument {type_.name}.{field_name}({arg_name}:)"
+                        " cannot be deprecated.",
+                        [
+                            get_deprecated_directive_node(arg.ast_node),
+                            arg.ast_node and arg.ast_node.type,
+                        ],
+                    )
+
     def validate_interfaces(
         self, type_: Union[GraphQLObjectType, GraphQLInterfaceType]
     ) -> None:
@@ -456,6 +484,16 @@ def validate_input_fields(self, input_obj: GraphQLInputObjectType) -> None:
                     field.ast_node.type if field.ast_node else None,
                 )
 
+            if is_required_input_field(field) and field.deprecation_reason is not None:
+                self.report_error(
+                    f"Required input field {input_obj.name}.{field_name}"
+                    " cannot be deprecated.",
+                    [
+                        get_deprecated_directive_node(field.ast_node),
+                        field.ast_node and field.ast_node.type,
+                    ],
+                )
+
 
 def get_operation_type_node(
     schema: GraphQLSchema, operation: OperationType
@@ -575,3 +613,16 @@ def get_union_member_type_nodes(
     return [
         union_node for union_node in union_nodes if union_node.name.value == type_name
     ]
+
+
+def get_deprecated_directive_node(
+    definition_node: Optional[Union[InputValueDefinitionNode]],
+) -> Optional[DirectiveNode]:
+    directives = definition_node and definition_node.directives
+    if directives:
+        for directive in directives:
+            if (
+                directive.name.value == GraphQLDeprecatedDirective.name
+            ):  # pragma: no cover else
+                return directive
+    return None  # pragma: no cover

src/graphql/utilities/extend_schema.py

@@ -448,6 +448,7 @@ def build_argument_map(
                 type_=type_,
                 description=arg.description.value if arg.description else None,
                 default_value=value_from_ast(arg.default_value, type_),
+                deprecation_reason=get_deprecation_reason(arg),
                 ast_node=arg,
             )
         return arg_map
@@ -468,6 +469,7 @@ def build_input_field_map(
                     type_=type_,
                     description=field.description.value if field.description else None,
                     default_value=value_from_ast(field.default_value, type_),
+                    deprecation_reason=get_deprecation_reason(field),
                     ast_node=field,
                 )
         return input_field_map
@@ -676,7 +678,7 @@ def build_type(ast_node: TypeDefinitionNode) -> GraphQLNamedType:
 
 
 def get_deprecation_reason(
-    node: Union[EnumValueDefinitionNode, FieldDefinitionNode]
+    node: Union[EnumValueDefinitionNode, FieldDefinitionNode, InputValueDefinitionNode]
 ) -> Optional[str]:
     """Given a field or enum value node, get deprecation reason as string."""
     from ..execution import get_directive_values