RFC: Directive location: schema definition. Commit: graphql/graphql-js@0aa78f6

Author: markusdap

graphql/language/ast.py

@@ -845,30 +845,34 @@ class TypeSystemDefinition(TypeDefinition):
 
 
 class SchemaDefinition(TypeSystemDefinition):
-    __slots__ = ('loc', 'operation_types',)
+    __slots__ = ('loc', 'directives', 'operation_types',)
     _fields = ('operation_types',)
 
-    def __init__(self, operation_types, loc=None):
+    def __init__(self, operation_types, loc=None, directives=None):
         self.operation_types = operation_types
         self.loc = loc
+        self.directives = directives
 
     def __eq__(self, other):
         return (
             self is other or (
                 isinstance(other, SchemaDefinition) and
-                self.operation_types == other.operation_types
+                self.operation_types == other.operation_types and
+                self.directives == other.directives
             )
         )
 
     def __repr__(self):
         return ('SchemaDefinition('
                 'operation_types={self.operation_types!r}'
+                ', directives={self.directives!r}'
                 ')').format(self=self)
 
     def __copy__(self):
         return type(self)(
             self.operation_types,
-            self.loc
+            self.loc,
+            self.directives,
         )
 
     def __hash__(self):

graphql/language/parser.py

@@ -571,6 +571,7 @@ def parse_type_system_definition(parser):
 def parse_schema_definition(parser):
     start = parser.token.start
     expect_keyword(parser, 'schema')
+    directives = parse_directives(parser)
     operation_types = many(
         parser,
         TokenKind.BRACE_L,
@@ -579,6 +580,7 @@ def parse_schema_definition(parser):
     )
 
     return ast.SchemaDefinition(
+        directives=directives,
         operation_types=operation_types,
         loc=loc(parser, start)
     )

graphql/language/printer.py

@@ -112,7 +112,11 @@ def leave_NonNullType(self, node, *args):
     # Type Definitions:
 
     def leave_SchemaDefinition(self, node, *args):
-        return 'schema ' + block(node.operation_types)
+        return join([
+            'schema',
+            join(node.directives, ' '),
+            block(node.operation_types),
+            ], ' ')
 
     def leave_OperationTypeDefinition(self, node, *args):
         return '{}: {}'.format(node.operation, node.type)

graphql/language/visitor_meta.py

@@ -30,7 +30,7 @@
     ast.ListType: ('type',),
     ast.NonNullType: ('type',),
 
-    ast.SchemaDefinition: ('operation_types',),
+    ast.SchemaDefinition: ('directives', 'operation_types',),
     ast.OperationTypeDefinition: ('type',),
 
     ast.ScalarTypeDefinition: ('name', 'directives',),

graphql/type/directives.py

@@ -17,6 +17,7 @@ class DirectiveLocation(object):
     INLINE_FRAGMENT = 'INLINE_FRAGMENT'
 
     # Schema Definitions
+    SCHEMA = 'SCHEMA'
     SCALAR = 'SCALAR'
     OBJECT = 'OBJECT'
     FIELD_DEFINITION = 'FIELD_DEFINITION'

graphql/type/introspection.py

@@ -120,6 +120,10 @@
             DirectiveLocation.INLINE_FRAGMENT,
             description='Location adjacent to an inline fragment.'
         )),
+        ('SCHEMA', GraphQLEnumValue(
+            DirectiveLocation.SCHEMA,
+            description='Location adjacent to a schema definition.'
+        )),
         ('SCALAR', GraphQLEnumValue(
             DirectiveLocation.SCALAR,
             description='Location adjacent to a scalar definition.'

graphql/utils/tests/test_schema_printer.py

@@ -559,6 +559,7 @@ def test_prints_introspection_schema():
   FRAGMENT_DEFINITION
   FRAGMENT_SPREAD
   INLINE_FRAGMENT
+  SCHEMA
   SCALAR
   OBJECT
   FIELD_DEFINITION

graphql/validation/rules/known_directives.py

@@ -63,6 +63,9 @@ def get_directive_location_for_ast_path(ancestors):
     elif isinstance(applied_to, ast.FragmentDefinition):
         return DirectiveLocation.FRAGMENT_DEFINITION
 
+    elif isinstance(applied_to, ast.SchemaDefinition):
+        return DirectiveLocation.SCHEMA
+
     elif isinstance(applied_to, ast.ScalarTypeDefinition):
         return DirectiveLocation.SCALAR
 

graphql/validation/tests/test_known_directives.py

@@ -133,6 +133,10 @@ def test_within_schema_language_with_well_placed_directives():
       input MyInput @onInputObject {
         myField: Int @onInputFieldDefinition
       }
+
+      schema @OnSchema {
+        query: MyQuery
+      }
     ''')
 
 
@@ -157,6 +161,10 @@ def test_within_schema_language_with_misplaced_directives():
         input MyInput @onEnum {
           myField: Int @onArgumentDefinition
         }
+
+        schema @onObject {
+          query: MyQuery
+        }
     ''', [
         misplaced_directive('onInterface', 'OBJECT', 2, 43),
         misplaced_directive('onInputFieldDefinition', 'ARGUMENT_DEFINITION', 3, 30),
@@ -170,4 +178,5 @@ def test_within_schema_language_with_misplaced_directives():
         misplaced_directive('onUnion', 'ENUM_VALUE', 15, 20),
         misplaced_directive('onEnum', 'INPUT_OBJECT', 18, 23),
         misplaced_directive('onArgumentDefinition', 'INPUT_FIELD_DEFINITION', 19, 24),
+        misplaced_directive('onObject', 'SCHEMA', 22, 16),
     ])

graphql/validation/tests/utils.py

@@ -187,6 +187,7 @@
         GraphQLDirective(name='onFragmentDefinition', locations=[DirectiveLocation.FRAGMENT_DEFINITION]),
         GraphQLDirective(name='onFragmentSpread', locations=[DirectiveLocation.FRAGMENT_SPREAD]),
         GraphQLDirective(name='onInlineFragment', locations=[DirectiveLocation.INLINE_FRAGMENT]),
+        GraphQLDirective(name='OnSchema', locations=[DirectiveLocation.SCHEMA]),
         GraphQLDirective(name='onScalar', locations=[DirectiveLocation.SCALAR]),
         GraphQLDirective(name='onObject', locations=[DirectiveLocation.OBJECT]),
         GraphQLDirective(name='onFieldDefinition', locations=[DirectiveLocation.FIELD_DEFINITION]),