backport: Add @OneOf support to introspection query (#241)

Also backport support for @OneOf directives in print_schema.

Replicates graphql/graphql-js@7df786e
and graphql/graphql-js@0b7590f

Author: Cito

setup.cfg

@@ -5,17 +5,20 @@ python-tag = py3
 test = pytest
 
 [tool:pytest]
+minversion = 7.4
 # Only run benchmarks as tests.
 # To actually run the benchmarks, use --benchmark-enable on the command line.
 # To run the slow tests (fuzzing), add --run-slow on the command line.
 addopts = --benchmark-disable
 # Deactivate default name pattern for test classes (we use pytest_describe).
 python_classes = PyTest*
 # Handle all async fixtures and tests automatically by asyncio
-asyncio_mode = auto
+asyncio_mode = strict
 # Default event loop scope used for asynchronous fixtures
 asyncio_default_fixture_loop_scope = function
 # Set a timeout in seconds for aborting tests that run too long.
 timeout = 100
 # Ignore config options not (yet) available in older Python versions.
 filterwarnings = ignore::pytest.PytestConfigWarning
+# All tests can be found in the tests directory.
+testpaths = tests

src/graphql/utilities/build_client_schema.py

@@ -226,6 +226,7 @@ def build_input_object_def(
             fields=lambda: build_input_value_def_map(
                 input_object_introspection["inputFields"]
             ),
+            is_one_of=input_object_introspection.get("isOneOf", False),
         )
 
     type_builders: Dict[str, Callable[[IntrospectionType], GraphQLNamedType]] = {

src/graphql/utilities/get_introspection_query.py

@@ -34,6 +34,7 @@ def get_introspection_query(
     directive_is_repeatable: bool = False,
     schema_description: bool = False,
     input_value_deprecation: bool = False,
+    input_object_one_of: bool = False,
 ) -> str:
     """Get a query for introspection.
 
@@ -45,6 +46,7 @@ def get_introspection_query(
     maybe_specified_by_url = "specifiedByURL" if specified_by_url else ""
     maybe_directive_is_repeatable = "isRepeatable" if directive_is_repeatable else ""
     maybe_schema_description = maybe_description if schema_description else ""
+    maybe_input_object_one_of = "isOneOf" if input_object_one_of else ""
 
     def input_deprecation(string: str) -> Optional[str]:
         return string if input_value_deprecation else ""
@@ -77,6 +79,7 @@ def input_deprecation(string: str) -> Optional[str]:
           name
           {maybe_description}
           {maybe_specified_by_url}
+          {maybe_input_object_one_of}
           fields(includeDeprecated: true) {{
             name
             {maybe_description}
@@ -243,6 +246,7 @@ class IntrospectionEnumType(WithName):
 class IntrospectionInputObjectType(WithName):
     kind: Literal["input_object"]
     inputFields: List[IntrospectionInputValue]
+    isOneOf: bool
 
 
 IntrospectionType = Union[
@@ -254,7 +258,6 @@ class IntrospectionInputObjectType(WithName):
     IntrospectionInputObjectType,
 ]
 
-
 IntrospectionOutputType = Union[
     IntrospectionScalarType,
     IntrospectionObjectType,
@@ -263,7 +266,6 @@ class IntrospectionInputObjectType(WithName):
     IntrospectionEnumType,
 ]
 
-
 IntrospectionInputType = Union[
     IntrospectionScalarType, IntrospectionEnumType, IntrospectionInputObjectType
 ]

src/graphql/utilities/introspection_from_schema.py

@@ -15,6 +15,7 @@ def introspection_from_schema(
     directive_is_repeatable: bool = True,
     schema_description: bool = True,
     input_value_deprecation: bool = True,
+    input_object_one_of: bool = True,
 ) -> IntrospectionQuery:
     """Build an IntrospectionQuery from a GraphQLSchema
 
@@ -31,6 +32,7 @@ def introspection_from_schema(
             directive_is_repeatable,
             schema_description,
             input_value_deprecation,
+            input_object_one_of,
         )
     )
 

src/graphql/utilities/print_schema.py

@@ -189,7 +189,12 @@ def print_input_object(type_: GraphQLInputObjectType) -> str:
         print_description(field, "  ", not i) + "  " + print_input_value(name, field)
         for i, (name, field) in enumerate(type_.fields.items())
     ]
-    return print_description(type_) + f"input {type_.name}" + print_block(fields)
+    return (
+        print_description(type_)
+        + f"input {type_.name}"
+        + (" @oneOf" if type_.is_one_of else "")
+        + print_block(fields)
+    )
 
 
 def print_fields(type_: Union[GraphQLObjectType, GraphQLInterfaceType]) -> str:

tests/utilities/test_build_client_schema.py

@@ -591,6 +591,22 @@ def builds_a_schema_with_specified_by_url():
 
         assert cycle_introspection(sdl) == sdl
 
+    def builds_a_schema_with_one_of_directive():
+        sdl = dedent(
+            """
+            type Query {
+              someField(someArg: SomeInputObject): String
+            }
+
+            input SomeInputObject @oneOf {
+              someInputField1: String
+              someInputField2: String
+            }
+            """
+        )
+
+        assert cycle_introspection(sdl) == sdl
+
     def can_use_client_schema_for_limited_execution():
         schema = build_schema(
             """

tests/utilities/test_get_introspection_query.py

@@ -79,6 +79,11 @@ def includes_deprecation_reason_field_on_input_values():
             "deprecationReason", 2
         )
 
+    def includes_input_object_one_of_field():
+        ExcpectIntrospectionQuery().to_not_match("isOneOf")
+        ExcpectIntrospectionQuery(input_object_one_of=True).to_match("isOneOf")
+        ExcpectIntrospectionQuery(input_object_one_of=False).to_not_match("isOneOf")
+
     def includes_deprecated_input_field_and_args():
         ExcpectIntrospectionQuery().to_match("includeDeprecated: true", 2)
         ExcpectIntrospectionQuery(input_value_deprecation=True).to_match(

tests/utilities/test_print_schema.py

@@ -511,6 +511,22 @@ def prints_input_type():
             """
         )
 
+    def prints_input_type_with_one_of_directive():
+        input_type = GraphQLInputObjectType(
+            name="InputType",
+            fields={"int": GraphQLInputField(GraphQLInt)},
+            is_one_of=True,
+        )
+
+        schema = GraphQLSchema(types=[input_type])
+        assert expect_printed_schema(schema) == dedent(
+            """
+            input InputType @oneOf {
+              int: Int
+            }
+            """
+        )
+
     def prints_custom_scalar():
         odd_type = GraphQLScalarType(name="Odd")