Introspection: Add support for repeatable directives

Replicates graphql/graphql-js@cc4c363

Author: Cito

src/graphql/type/introspection.py

@@ -88,6 +88,10 @@
         "description": GraphQLField(
             GraphQLString, resolve=lambda obj, _info: obj.description
         ),
+        "isRepeatable": GraphQLField(
+            GraphQLNonNull(GraphQLBoolean),
+            resolve=lambda obj, _info: obj.is_repeatable,
+        ),
         "locations": GraphQLField(
             GraphQLNonNull(GraphQLList(GraphQLNonNull(__DirectiveLocation))),
             resolve=lambda obj, _info: obj.locations,

src/graphql/utilities/build_client_schema.py

@@ -313,6 +313,7 @@ def build_directive(directive_introspection: Dict) -> GraphQLDirective:
         return GraphQLDirective(
             name=directive_introspection["name"],
             description=directive_introspection.get("description"),
+            is_repeatable=directive_introspection.get("isRepeatable", False),
             locations=list(
                 cast(
                     Collection[DirectiveLocation],

src/graphql/utilities/get_introspection_query.py

@@ -3,8 +3,13 @@
 __all__ = ["get_introspection_query"]
 
 
-def get_introspection_query(descriptions=True) -> str:
-    """Get a query for introspection, optionally without descriptions."""
+def get_introspection_query(descriptions=True, directive_is_repeatable=False) -> str:
+    """Get a query for introspection.
+
+    Optionally, you can exclude descriptions and include repeatability of directives.
+    """
+    maybe_description = "description" if descriptions else ""
+    maybe_directive_is_repeatable = "isRepeatable" if directive_is_repeatable else ""
     return dedent(
         f"""
         query IntrospectionQuery {{
@@ -17,7 +22,8 @@ def get_introspection_query(descriptions=True) -> str:
             }}
             directives {{
               name
-              {'description' if descriptions else ''}
+              {maybe_description}
+              {maybe_directive_is_repeatable}
               locations
               args {{
                 ...InputValue
@@ -29,10 +35,10 @@ def get_introspection_query(descriptions=True) -> str:
         fragment FullType on __Type {{
           kind
           name
-          {'description' if descriptions else ''}
+          {maybe_description}
           fields(includeDeprecated: true) {{
             name
-            {'description' if descriptions else ''}
+            {maybe_description}
             args {{
               ...InputValue
             }}
@@ -50,7 +56,7 @@ def get_introspection_query(descriptions=True) -> str:
           }}
           enumValues(includeDeprecated: true) {{
             name
-            {'description' if descriptions else ''}
+            {maybe_description}
             isDeprecated
             deprecationReason
           }}
@@ -61,7 +67,7 @@ def get_introspection_query(descriptions=True) -> str:
 
         fragment InputValue on __InputValue {{
           name
-          {'description' if descriptions else ''}
+          {maybe_description}
           type {{ ...TypeRef }}
           defaultValue
         }}

src/graphql/utilities/introspection_from_schema.py

@@ -12,7 +12,9 @@
 
 
 def introspection_from_schema(
-    schema: GraphQLSchema, descriptions: bool = True
+    schema: GraphQLSchema,
+    descriptions: bool = True,
+    directive_is_repeatable: bool = True,
 ) -> IntrospectionSchema:
     """Build an IntrospectionQuery from a GraphQLSchema
 
@@ -22,7 +24,7 @@ def introspection_from_schema(
     This is the inverse of build_client_schema. The primary use case is outside of the
     server context, for instance when doing schema comparisons.
     """
-    document = parse(get_introspection_query(descriptions))
+    document = parse(get_introspection_query(descriptions, directive_is_repeatable))
 
     from ..execution.execute import execute, ExecutionResult
 

tests/type/test_introspection.py

@@ -19,7 +19,9 @@ def executes_an_introspection_query():
         schema = GraphQLSchema(
             GraphQLObjectType("QueryRoot", {"onlyField": GraphQLField(GraphQLString)})
         )
-        source = get_introspection_query(descriptions=False)
+        source = get_introspection_query(
+            descriptions=False, directive_is_repeatable=True
+        )
 
         result = graphql_sync(schema=schema, source=source)
         assert result.errors is None
@@ -638,6 +640,21 @@ def executes_an_introspection_query():
                                 "isDeprecated": False,
                                 "deprecationReason": None,
                             },
+                            {
+                                "name": "isRepeatable",
+                                "args": [],
+                                "type": {
+                                    "kind": "NON_NULL",
+                                    "name": None,
+                                    "ofType": {
+                                        "kind": "SCALAR",
+                                        "name": "Boolean",
+                                        "ofType": None,
+                                    },
+                                },
+                                "isDeprecated": False,
+                                "deprecationReason": None,
+                            },
                             {
                                 "name": "locations",
                                 "args": [],
@@ -799,6 +816,7 @@ def executes_an_introspection_query():
                 "directives": [
                     {
                         "name": "include",
+                        "isRepeatable": False,
                         "locations": ["FIELD", "FRAGMENT_SPREAD", "INLINE_FRAGMENT"],
                         "args": [
                             {
@@ -818,6 +836,7 @@ def executes_an_introspection_query():
                     },
                     {
                         "name": "skip",
+                        "isRepeatable": False,
                         "locations": ["FIELD", "FRAGMENT_SPREAD", "INLINE_FRAGMENT"],
                         "args": [
                             {
@@ -837,6 +856,7 @@ def executes_an_introspection_query():
                     },
                     {
                         "name": "deprecated",
+                        "isRepeatable": False,
                         "locations": ["FIELD_DEFINITION", "ENUM_VALUE"],
                         "args": [
                             {
@@ -1329,7 +1349,7 @@ def executes_introspection_query_without_calling_global_field_resolver():
         )
 
         schema = GraphQLSchema(query_root)
-        source = get_introspection_query()
+        source = get_introspection_query(directive_is_repeatable=True)
 
         def field_resolver(_obj, info):
             assert False, f"Called on {info.parent_type.name}.{info.field_name}"

tests/utilities/test_build_client_schema.py

@@ -31,12 +31,14 @@ def cycle_introspection(sdl_string):
     build in-memory GraphQLSchema from it, produce a client-side representation of the
     schema by using "build_client_schema" and then return that schema printed as SDL.
     """
+    options = dict(directive_is_repeatable=True)
+
     server_schema = build_schema(sdl_string)
-    initial_introspection = introspection_from_schema(server_schema)
+    initial_introspection = introspection_from_schema(server_schema, **options)
     client_schema = build_client_schema(initial_introspection)
     # If the client then runs the introspection query against the client-side schema,
     # it should get a result identical to what was returned by the server
-    second_introspection = introspection_from_schema(client_schema)
+    second_introspection = introspection_from_schema(client_schema, **options)
 
     # If the client then runs the introspection query against the client-side
     # schema, it should get a result identical to what was returned by the server.
@@ -460,7 +462,7 @@ def builds_a_schema_with_custom_directives():
         sdl = dedent(
             '''
             """This is a custom directive"""
-            directive @customDirective on FIELD
+            directive @customDirective repeatable on FIELD
 
             type Query {
               string: String

tests/utilities/test_get_introspection_query.py

@@ -0,0 +1,25 @@
+import re
+
+from graphql.utilities import get_introspection_query
+
+
+def describe_get_introspection_query():
+    def skips_all_description_fields():
+        has_descriptions = re.compile(r"\bdescription\b").search
+
+        assert has_descriptions(get_introspection_query())
+
+        assert has_descriptions(get_introspection_query(descriptions=True))
+
+        assert not has_descriptions(get_introspection_query(descriptions=False))
+
+    def includes_is_repeatable_field():
+        has_repeatability = re.compile(r"\bisRepeatable\b").search
+
+        assert not has_repeatability(get_introspection_query())
+
+        assert has_repeatability(get_introspection_query(directive_is_repeatable=True))
+
+        assert not has_repeatability(
+            get_introspection_query(directive_is_repeatable=False)
+        )

tests/utilities/test_schema_printer.py

@@ -744,6 +744,7 @@ def prints_introspection_schema():
             type __Directive {
               name: String!
               description: String
+              isRepeatable: Boolean!
               locations: [__DirectiveLocation!]!
               args: [__InputValue!]!
             }