improve new leaf type coerce_input_literal() method

Rename the new scalar/enum leaf method `parse_const_literal()` to
`coerce_input_literal()`, and the type alias
`GraphQLScalarConstLiteralParser` to `GraphQLScalarInputLiteralCoercer`
(now the public coercer type). The old `GraphQLScalarLiteralParser`
alias is kept but marked deprecated.

Replicates graphql/graphql-js@755d591

Author: Cito

src/graphql/__init__.py

@@ -360,7 +360,7 @@
     GraphQLScalarSerializer,
     GraphQLScalarValueParser,
     GraphQLScalarLiteralParser,
-    GraphQLScalarConstLiteralParser,
+    GraphQLScalarInputLiteralCoercer,
     GraphQLScalarValueToLiteral,
     GraphQLDefaultValueUsage,
     GraphQLIsTypeOfFn,
@@ -587,7 +587,7 @@
     "GraphQLOneOfDirective",
     "GraphQLOutputType",
     "GraphQLResolveInfo",
-    "GraphQLScalarConstLiteralParser",
+    "GraphQLScalarInputLiteralCoercer",
     "GraphQLScalarLiteralParser",
     "GraphQLScalarSerializer",
     "GraphQLScalarType",

src/graphql/type/__init__.py

@@ -103,7 +103,7 @@
     GraphQLScalarSerializer,
     GraphQLScalarValueParser,
     GraphQLScalarLiteralParser,
-    GraphQLScalarConstLiteralParser,
+    GraphQLScalarInputLiteralCoercer,
     GraphQLScalarValueToLiteral,
     GraphQLDefaultValueUsage,
     # Keyword Args
@@ -236,7 +236,7 @@
     "GraphQLOneOfDirective",
     "GraphQLOutputType",
     "GraphQLResolveInfo",
-    "GraphQLScalarConstLiteralParser",
+    "GraphQLScalarInputLiteralCoercer",
     "GraphQLScalarLiteralParser",
     "GraphQLScalarSerializer",
     "GraphQLScalarType",

src/graphql/type/definition.py

@@ -109,7 +109,7 @@
     "GraphQLObjectTypeKwargs",
     "GraphQLOutputType",
     "GraphQLResolveInfo",
-    "GraphQLScalarConstLiteralParser",
+    "GraphQLScalarInputLiteralCoercer",
     "GraphQLScalarLiteralParser",
     "GraphQLScalarSerializer",
     "GraphQLScalarType",
@@ -315,10 +315,11 @@ def resolve_thunk(thunk: Thunk[T]) -> T:
 
 GraphQLScalarSerializer: TypeAlias = Callable[[Any], Any]
 GraphQLScalarValueParser: TypeAlias = Callable[[Any], Any]
+# Deprecated in favor of GraphQLScalarInputLiteralCoercer, will be removed in v3.4
 GraphQLScalarLiteralParser: TypeAlias = Callable[
     [ValueNode, dict[str, Any] | None], Any
 ]
-GraphQLScalarConstLiteralParser: TypeAlias = Callable[[ConstValueNode], Any]
+GraphQLScalarInputLiteralCoercer: TypeAlias = Callable[[ConstValueNode], Any]
 GraphQLScalarValueToLiteral: TypeAlias = Callable[[Any], "ConstValueNode | None"]
 
 
@@ -328,7 +329,7 @@ class GraphQLScalarTypeKwargs(GraphQLNamedTypeKwargs, total=False):
     serialize: GraphQLScalarSerializer | None
     parse_value: GraphQLScalarValueParser | None
     parse_literal: GraphQLScalarLiteralParser | None
-    parse_const_literal: GraphQLScalarConstLiteralParser | None
+    coerce_input_literal: GraphQLScalarInputLiteralCoercer | None
     value_to_literal: GraphQLScalarValueToLiteral | None
     specified_by_url: str | None
 
@@ -365,7 +366,7 @@ def serialize_odd(value: Any) -> int:
     ast_node: ScalarTypeDefinitionNode | None
     extension_ast_nodes: tuple[ScalarTypeExtensionNode, ...]
 
-    parse_const_literal: GraphQLScalarConstLiteralParser | None
+    coerce_input_literal: GraphQLScalarInputLiteralCoercer | None
     value_to_literal: GraphQLScalarValueToLiteral | None
 
     def __init__(
@@ -374,7 +375,7 @@ def __init__(
         serialize: GraphQLScalarSerializer | None = None,
         parse_value: GraphQLScalarValueParser | None = None,
         parse_literal: GraphQLScalarLiteralParser | None = None,
-        parse_const_literal: GraphQLScalarConstLiteralParser | None = None,
+        coerce_input_literal: GraphQLScalarInputLiteralCoercer | None = None,
         value_to_literal: GraphQLScalarValueToLiteral | None = None,
         description: str | None = None,
         specified_by_url: str | None = None,
@@ -396,17 +397,17 @@ def __init__(
             self.parse_value = parse_value  # type: ignore
         if parse_literal is not None:
             self.parse_literal = parse_literal  # type: ignore
-        self.parse_const_literal = parse_const_literal
+        self.coerce_input_literal = coerce_input_literal
         self.value_to_literal = value_to_literal
         if parse_literal is not None and parse_value is None:
             msg = (
                 f"{name} must provide both 'parse_value' and 'parse_literal' functions."
             )
             raise TypeError(msg)
-        if parse_const_literal is not None and parse_value is None:
+        if coerce_input_literal is not None and parse_value is None:
             msg = (
                 f"{name} must provide both 'parse_value'"
-                " and 'parse_const_literal' functions."
+                " and 'coerce_input_literal' functions."
             )
             raise TypeError(msg)
         self.specified_by_url = specified_by_url
@@ -444,7 +445,7 @@ def parse_literal(
         with a more specific version when creating a scalar type.
 
         .. deprecated:: 3.3
-            Use ``replace_variables()`` and ``parse_const_literal()`` instead.
+            Use ``replace_variables()`` and ``coerce_input_literal()`` instead.
             ``parse_literal()`` will be removed in a future version.
         """
         return self.parse_value(value_from_ast_untyped(node, variables))
@@ -463,7 +464,7 @@ def to_kwargs(self) -> GraphQLScalarTypeKwargs:
             if getattr(self.parse_literal, "__func__", None)
             is GraphQLScalarType.parse_literal
             else self.parse_literal,
-            parse_const_literal=self.parse_const_literal,
+            coerce_input_literal=self.coerce_input_literal,
             value_to_literal=self.value_to_literal,
             specified_by_url=self.specified_by_url,
         )
@@ -1259,18 +1260,18 @@ def parse_literal(
         """Parse literal value.
 
         .. deprecated:: 3.3
-            Use ``parse_const_literal()`` instead. ``parse_literal()`` will be
+            Use ``coerce_input_literal()`` instead. ``parse_literal()`` will be
             removed in a future version.
         """
         # Note: variables will be resolved before calling this method.
-        return self.parse_const_literal(
+        return self.coerce_input_literal(
             cast("ConstValueNode", value_node), hide_suggestions
         )
 
-    def parse_const_literal(
+    def coerce_input_literal(
         self, value_node: ConstValueNode, hide_suggestions: bool = False
     ) -> Any:
-        """Parse const literal value."""
+        """Coerce a const input literal value."""
         if isinstance(value_node, EnumValueNode):
             try:
                 enum_value = self.values[value_node.value]

src/graphql/type/scalars.py

@@ -129,7 +129,7 @@ def int_value_to_literal(value: Any) -> ConstValueNode | None:
     " Int can represent values between -(2^31) and 2^31 - 1.",
     serialize=serialize_int,
     parse_value=coerce_int,
-    parse_const_literal=parse_int_literal,
+    coerce_input_literal=parse_int_literal,
     value_to_literal=int_value_to_literal,
 )
 
@@ -186,7 +186,7 @@ def float_value_to_literal(value: Any) -> ConstValueNode | None:
     "(https://en.wikipedia.org/wiki/IEEE_floating_point).",
     serialize=serialize_float,
     parse_value=coerce_float,
-    parse_const_literal=parse_float_literal,
+    coerce_input_literal=parse_float_literal,
     value_to_literal=float_value_to_literal,
 )
 
@@ -241,7 +241,7 @@ def string_value_to_literal(value: Any) -> ConstValueNode | None:
     " to represent free-form human-readable text.",
     serialize=serialize_string,
     parse_value=coerce_string,
-    parse_const_literal=parse_string_literal,
+    coerce_input_literal=parse_string_literal,
     value_to_literal=string_value_to_literal,
 )
 
@@ -289,7 +289,7 @@ def boolean_value_to_literal(value: Any) -> ConstValueNode | None:
     description="The `Boolean` scalar type represents `true` or `false`.",
     serialize=serialize_boolean,
     parse_value=coerce_boolean,
-    parse_const_literal=parse_boolean_literal,
+    coerce_input_literal=parse_boolean_literal,
     value_to_literal=boolean_value_to_literal,
 )
 
@@ -368,7 +368,7 @@ def id_value_to_literal(value: Any) -> ConstValueNode | None:
     " `4`) input value will be accepted as an ID.",
     serialize=serialize_id,
     parse_value=coerce_id,
-    parse_const_literal=parse_id_literal,
+    coerce_input_literal=parse_id_literal,
     value_to_literal=id_value_to_literal,
 )
 

src/graphql/utilities/coerce_input_value.py

@@ -345,17 +345,17 @@ def coerce_input_literal(
     leaf_type = assert_leaf_type(type_)
     try:
         # Note: only enum types accept `hide_suggestions`, since scalar
-        # `parse_const_literal`/`parse_literal` functions are user-provided
+        # `coerce_input_literal`/`parse_literal` functions are user-provided
         # with a fixed signature.
         if is_enum_type(leaf_type):
-            return leaf_type.parse_const_literal(
+            return leaf_type.coerce_input_literal(
                 replace_variables(
                     value_node, variable_values, fragment_variable_values
                 ),
                 hide_suggestions,
             )
-        if leaf_type.parse_const_literal is not None:
-            return leaf_type.parse_const_literal(
+        if leaf_type.coerce_input_literal is not None:
+            return leaf_type.coerce_input_literal(
                 replace_variables(value_node, variable_values, fragment_variable_values)
             )
         return leaf_type.parse_literal(

src/graphql/validation/rules/values_of_correct_type.py

@@ -169,18 +169,18 @@ def is_valid_value_node(self, node: ValueNode) -> None:
             return
 
         # Scalars and Enums determine if a literal value is valid via
-        # `parse_const_literal()`, which may raise or return ``Undefined`` to
+        # `coerce_input_literal()`, which may raise or return ``Undefined`` to
         # indicate an invalid value.
         # Note: only enum types accept `hide_suggestions`, since scalar
-        # `parse_const_literal`/`parse_literal` functions are user-provided
+        # `coerce_input_literal`/`parse_literal` functions are user-provided
         # with a fixed signature.
         try:
             if is_enum_type(type_):
-                parse_result = type_.parse_const_literal(
+                parse_result = type_.coerce_input_literal(
                     replace_variables(node), self.context.hide_suggestions
                 )
-            elif type_.parse_const_literal is not None:
-                parse_result = type_.parse_const_literal(replace_variables(node))
+            elif type_.coerce_input_literal is not None:
+                parse_result = type_.coerce_input_literal(replace_variables(node))
             else:
                 parse_result = type_.parse_literal(node)
             if parse_result is Undefined:

tests/execution/test_variables.py

@@ -33,14 +33,14 @@ def faulty_parse_value(_value: str) -> str:
     raise TestFaultyScalarGraphQLError
 
 
-def faulty_parse_const_literal(_ast: ValueNode) -> str:
+def faulty_coerce_input_literal(_ast: ValueNode) -> str:
     raise TestFaultyScalarGraphQLError
 
 
 TestFaultyScalar = GraphQLScalarType(
     name="FaultyScalar",
     parse_value=faulty_parse_value,
-    parse_const_literal=faulty_parse_const_literal,
+    coerce_input_literal=faulty_coerce_input_literal,
 )
 
 
@@ -49,7 +49,7 @@ def parse_serialized_value(value: str) -> str:
     return "DeserializedValue"
 
 
-def parse_const_literal_value(ast: ValueNode) -> str:
+def coerce_input_literal_value(ast: ValueNode) -> str:
     assert isinstance(ast, StringValueNode)
     assert ast.value == "SerializedValue"
     return parse_serialized_value(ast.value)
@@ -58,7 +58,7 @@ def parse_const_literal_value(ast: ValueNode) -> str:
 TestComplexScalar = GraphQLScalarType(
     name="ComplexScalar",
     parse_value=parse_serialized_value,
-    parse_const_literal=parse_const_literal_value,
+    coerce_input_literal=coerce_input_literal_value,
 )
 
 
@@ -279,7 +279,7 @@ def does_not_use_incorrect_value():
                     ],
                 )
 
-            def properly_runs_parse_const_literal_on_complex_scalar_types():
+            def properly_runs_coerce_input_literal_on_complex_scalar_types():
                 result = execute_query(
                     """
                     {

tests/type/test_custom_scalars.py

@@ -47,7 +47,7 @@ def parse_money_value(input_value: Any) -> Money:
     return input_value
 
 
-def parse_money_const_literal(value_node: ConstValueNode) -> Money:
+def coerce_money_input_literal(value_node: ConstValueNode) -> Money:
     money = value_from_ast_untyped(value_node)
     amount: Any = money.get("amount") if isinstance(money, dict) else None
     currency: Any = money.get("currency") if isinstance(money, dict) else None
@@ -65,7 +65,7 @@ def parse_money_const_literal(value_node: ConstValueNode) -> Money:
     name="Money",
     serialize=serialize_money,
     parse_value=parse_money_value,
-    parse_const_literal=parse_money_const_literal,
+    coerce_input_literal=coerce_money_input_literal,
 )
 
 

tests/type/test_definition.py

@@ -107,7 +107,7 @@ def defines_a_scalar_type():
             "serialize": None,
             "parse_value": None,
             "parse_literal": None,
-            "parse_const_literal": None,
+            "coerce_input_literal": None,
             "value_to_literal": None,
             "extensions": {},
             "ast_node": None,
@@ -124,7 +124,7 @@ def can_be_converted_to_a_configuration_object():
             "serialize": pass_through,
             "parse_value": pass_through,
             "parse_literal": pass_through,
-            "parse_const_literal": pass_through,
+            "coerce_input_literal": pass_through,
             "value_to_literal": pass_through,
             "extensions": {"some_extension": "extension"},
             "ast_node": ast_node,
@@ -170,24 +170,24 @@ def parse_literal(_value_node, _variables):
         assert kwargs["parse_value"] is parse_value
         assert kwargs["parse_literal"] is parse_literal
 
-    def accepts_a_scalar_type_defining_parse_value_and_parse_const_literal():
+    def accepts_a_scalar_type_defining_parse_value_and_coerce_input_literal():
         def parse_value(_value):
             pass
 
-        def parse_const_literal(_value_node):
+        def coerce_input_literal(_value_node):
             pass
 
         scalar = GraphQLScalarType(
             "SomeScalar",
             parse_value=parse_value,
-            parse_const_literal=parse_const_literal,
+            coerce_input_literal=coerce_input_literal,
         )
         assert scalar.parse_value is parse_value
-        assert scalar.parse_const_literal is parse_const_literal
+        assert scalar.coerce_input_literal is coerce_input_literal
 
         kwargs = scalar.to_kwargs()
         assert kwargs["parse_value"] is parse_value
-        assert kwargs["parse_const_literal"] is parse_const_literal
+        assert kwargs["coerce_input_literal"] is coerce_input_literal
 
     def provides_default_methods_if_omitted():
         scalar = GraphQLScalarType("Foo")
@@ -199,7 +199,7 @@ def provides_default_methods_if_omitted():
             is GraphQLScalarType.parse_literal
         )
         # A default will be provided in v18 when parse_literal is removed.
-        assert scalar.parse_const_literal is None
+        assert scalar.coerce_input_literal is None
         assert scalar.value_to_literal is None
 
         # The default serialize and parse_value methods just pass values through.
@@ -211,7 +211,7 @@ def provides_default_methods_if_omitted():
         assert kwargs["serialize"] is None
         assert kwargs["parse_value"] is None
         assert kwargs["parse_literal"] is None
-        assert kwargs["parse_const_literal"] is None
+        assert kwargs["coerce_input_literal"] is None
         assert kwargs["value_to_literal"] is None
 
     def use_parse_value_for_parsing_literals_if_parse_literal_omitted():
@@ -268,15 +268,15 @@ def parse_literal(_node: ValueNode, _vars=None):
             "SomeScalar must provide both 'parse_value' and 'parse_literal' functions."
         )
 
-    def rejects_a_scalar_type_defining_parse_const_literal_but_not_parse_value():
-        def parse_const_literal(_node: ValueNode):
+    def rejects_a_scalar_type_defining_coerce_input_literal_but_not_parse_value():
+        def coerce_input_literal(_node: ValueNode):
             return Undefined  # pragma: no cover
 
         with pytest.raises(TypeError) as exc_info:
-            GraphQLScalarType("SomeScalar", parse_const_literal=parse_const_literal)
+            GraphQLScalarType("SomeScalar", coerce_input_literal=coerce_input_literal)
         assert str(exc_info.value) == (
             "SomeScalar must provide both 'parse_value'"
-            " and 'parse_const_literal' functions."
+            " and 'coerce_input_literal' functions."
         )
 
     def pickles_a_custom_scalar_type():