Add missing assert_directive and assert_schema

Replicates graphql/graphql-js@958eb96

Author: Cito

graphql/__init__.py

@@ -105,6 +105,8 @@
     is_introspection_type,
     is_specified_directive,
     # Assertions
+    assert_schema,
+    assert_directive,
     assert_type,
     assert_scalar_type,
     assert_object_type,
@@ -419,6 +421,8 @@
     "is_specified_scalar_type",
     "is_introspection_type",
     "is_specified_directive",
+    "assert_schema",
+    "assert_directive",
     "assert_type",
     "assert_scalar_type",
     "assert_object_type",

graphql/type/__init__.py

@@ -6,6 +6,8 @@
 from .schema import (
     # Predicate
     is_schema,
+    # Assertion
+    assert_schema,
     # GraphQL Schema definition
     GraphQLSchema,
 )
@@ -95,6 +97,8 @@
 from .directives import (
     # Predicate
     is_directive,
+    # Assertion
+    assert_directive,
     # Directives Definition
     GraphQLDirective,
     # Built-in Directives defined by the Spec
@@ -134,6 +138,7 @@
 
 __all__ = [
     "is_schema",
+    "assert_schema",
     "GraphQLSchema",
     "is_type",
     "is_scalar_type",
@@ -210,6 +215,7 @@
     "GraphQLResolveInfo",
     "ResponsePath",
     "is_directive",
+    "assert_directive",
     "is_specified_directive",
     "specified_directives",
     "GraphQLDirective",

graphql/type/definition.py

@@ -142,7 +142,7 @@ def is_type(type_: Any) -> bool:
 def assert_type(type_: Any) -> GraphQLType:
     if not is_type(type_):
         raise TypeError(f"Expected {type_} to be a GraphQL type.")
-    return type_
+    return cast(GraphQLType, type_)
 
 
 # These types wrap and modify other types
@@ -170,7 +170,7 @@ def is_wrapping_type(type_: Any) -> bool:
 def assert_wrapping_type(type_: Any) -> GraphQLWrappingType:
     if not is_wrapping_type(type_):
         raise TypeError(f"Expected {type_} to be a GraphQL wrapping type.")
-    return type_
+    return cast(GraphQLWrappingType, type_)
 
 
 # These named types do not include modifiers like List or NonNull.
@@ -229,7 +229,7 @@ def is_named_type(type_: Any) -> bool:
 def assert_named_type(type_: Any) -> GraphQLNamedType:
     if not is_named_type(type_):
         raise TypeError(f"Expected {type_} to be a GraphQL named type.")
-    return type_
+    return cast(GraphQLNamedType, type_)
 
 
 @overload
@@ -358,7 +358,7 @@ def is_scalar_type(type_: Any) -> bool:
 def assert_scalar_type(type_: Any) -> GraphQLScalarType:
     if not is_scalar_type(type_):
         raise TypeError(f"Expected {type_} to be a GraphQL Scalar type.")
-    return type_
+    return cast(GraphQLScalarType, type_)
 
 
 GraphQLArgumentMap = Dict[str, "GraphQLArgument"]
@@ -652,7 +652,7 @@ def is_object_type(type_: Any) -> bool:
 def assert_object_type(type_: Any) -> GraphQLObjectType:
     if not is_object_type(type_):
         raise TypeError(f"Expected {type_} to be a GraphQL Object type.")
-    return type_
+    return cast(GraphQLObjectType, type_)
 
 
 class GraphQLInterfaceType(GraphQLNamedType):
@@ -742,7 +742,7 @@ def is_interface_type(type_: Any) -> bool:
 def assert_interface_type(type_: Any) -> GraphQLInterfaceType:
     if not is_interface_type(type_):
         raise TypeError(f"Expected {type_} to be a GraphQL Interface type.")
-    return type_
+    return cast(GraphQLInterfaceType, type_)
 
 
 GraphQLTypeList = Sequence[GraphQLObjectType]
@@ -831,7 +831,7 @@ def is_union_type(type_: Any) -> bool:
 def assert_union_type(type_: Any) -> GraphQLUnionType:
     if not is_union_type(type_):
         raise TypeError(f"Expected {type_} to be a GraphQL Union type.")
-    return type_
+    return cast(GraphQLUnionType, type_)
 
 
 GraphQLEnumValueMap = Dict[str, "GraphQLEnumValue"]
@@ -978,7 +978,7 @@ def is_enum_type(type_: Any) -> bool:
 def assert_enum_type(type_: Any) -> GraphQLEnumType:
     if not is_enum_type(type_):
         raise TypeError(f"Expected {type_} to be a GraphQL Enum type.")
-    return type_
+    return cast(GraphQLEnumType, type_)
 
 
 class GraphQLEnumValue:
@@ -1113,7 +1113,7 @@ def is_input_object_type(type_: Any) -> bool:
 def assert_input_object_type(type_: Any) -> GraphQLInputObjectType:
     if not is_input_object_type(type_):
         raise TypeError(f"Expected {type_} to be a GraphQL Input Object type.")
-    return type_
+    return cast(GraphQLInputObjectType, type_)
 
 
 class GraphQLInputField:
@@ -1188,7 +1188,7 @@ def is_list_type(type_: Any) -> bool:
 def assert_list_type(type_: Any) -> GraphQLList:
     if not is_list_type(type_):
         raise TypeError(f"Expected {type_} to be a GraphQL List type.")
-    return type_
+    return cast(GraphQLList, type_)
 
 
 GNT = TypeVar("GNT", bound="GraphQLNullableType")
@@ -1233,7 +1233,7 @@ def is_non_null_type(type_: Any) -> bool:
 def assert_non_null_type(type_: Any) -> GraphQLNonNull:
     if not is_non_null_type(type_):
         raise TypeError(f"Expected {type_} to be a GraphQL Non-Null type.")
-    return type_
+    return cast(GraphQLNonNull, type_)
 
 
 # These types can all accept null as a value.
@@ -1266,7 +1266,7 @@ def is_nullable_type(type_: Any) -> bool:
 def assert_nullable_type(type_: Any) -> GraphQLNullableType:
     if not is_nullable_type(type_):
         raise TypeError(f"Expected {type_} to be a GraphQL nullable type.")
-    return type_
+    return cast(GraphQLNullableType, type_)
 
 
 @overload
@@ -1310,7 +1310,7 @@ def is_input_type(type_: Any) -> bool:
 def assert_input_type(type_: Any) -> GraphQLInputType:
     if not is_input_type(type_):
         raise TypeError(f"Expected {type_} to be a GraphQL input type.")
-    return type_
+    return cast(GraphQLInputType, type_)
 
 
 # These types may be used as output types as the result of fields.
@@ -1342,7 +1342,7 @@ def is_output_type(type_: Any) -> bool:
 def assert_output_type(type_: Any) -> GraphQLOutputType:
     if not is_output_type(type_):
         raise TypeError(f"Expected {type_} to be a GraphQL output type.")
-    return type_
+    return cast(GraphQLOutputType, type_)
 
 
 # These types may describe types which may be leaf values.
@@ -1359,7 +1359,7 @@ def is_leaf_type(type_: Any) -> bool:
 def assert_leaf_type(type_: Any) -> GraphQLLeafType:
     if not is_leaf_type(type_):
         raise TypeError(f"Expected {type_} to be a GraphQL leaf type.")
-    return type_
+    return cast(GraphQLLeafType, type_)
 
 
 # These types may describe the parent context of a selection set.
@@ -1376,7 +1376,7 @@ def is_composite_type(type_: Any) -> bool:
 def assert_composite_type(type_: Any) -> GraphQLType:
     if not is_composite_type(type_):
         raise TypeError(f"Expected {type_} to be a GraphQL composite type.")
-    return type_
+    return cast(GraphQLType, type_)
 
 
 # These types may describe abstract types.
@@ -1393,4 +1393,4 @@ def is_abstract_type(type_: Any) -> bool:
 def assert_abstract_type(type_: Any) -> GraphQLAbstractType:
     if not is_abstract_type(type_):
         raise TypeError(f"Expected {type_} to be a GraphQL composite type.")
-    return type_
+    return cast(GraphQLAbstractType, type_)

graphql/type/directives.py

@@ -1,11 +1,13 @@
 from typing import Any, Dict, Sequence, cast
 
 from ..language import ast, DirectiveLocation
+from ..pyutils import inspect
 from .definition import GraphQLArgument, GraphQLInputType, GraphQLNonNull, is_input_type
 from .scalars import GraphQLBoolean, GraphQLString
 
 __all__ = [
     "is_directive",
+    "assert_directive",
     "is_specified_directive",
     "specified_directives",
     "GraphQLDirective",
@@ -17,11 +19,6 @@
 ]
 
 
-def is_directive(directive: Any) -> bool:
-    """Test if the given value is a GraphQL directive."""
-    return isinstance(directive, GraphQLDirective)
-
-
 class GraphQLDirective:
     """GraphQL Directive
 
@@ -90,6 +87,17 @@ def __repr__(self):
         return f"<{self.__class__.__name__}({self})>"
 
 
+def is_directive(directive: Any) -> bool:
+    """Test if the given value is a GraphQL directive."""
+    return isinstance(directive, GraphQLDirective)
+
+
+def assert_directive(directive: Any) -> GraphQLDirective:
+    if not is_directive(directive):
+        raise TypeError(f"Expected {inspect(directive)} to be a GraphQL directive.")
+    return cast(GraphQLDirective, directive)
+
+
 # Used to conditionally include fields or fragments.
 GraphQLIncludeDirective = GraphQLDirective(
     name="include",

graphql/type/schema.py

@@ -3,6 +3,7 @@
 
 from ..error import GraphQLError
 from ..language import ast
+from ..pyutils import inspect
 from .definition import (
     GraphQLAbstractType,
     GraphQLInterfaceType,
@@ -21,17 +22,12 @@
 from .directives import GraphQLDirective, specified_directives, is_directive
 from .introspection import introspection_types
 
-__all__ = ["GraphQLSchema", "is_schema"]
+__all__ = ["GraphQLSchema", "is_schema", "assert_schema"]
 
 
 TypeMap = Dict[str, GraphQLNamedType]
 
 
-def is_schema(schema: Any) -> bool:
-    """Test if the given value is a GraphQL schema."""
-    return isinstance(schema, GraphQLSchema)
-
-
 class GraphQLSchema:
     """Schema Definition
 
@@ -177,6 +173,17 @@ def validation_errors(self):
         return self._validation_errors
 
 
+def is_schema(schema: Any) -> bool:
+    """Test if the given value is a GraphQL schema."""
+    return isinstance(schema, GraphQLSchema)
+
+
+def assert_schema(schema: Any) -> GraphQLSchema:
+    if not is_schema(schema):
+        raise TypeError(f"Expected {inspect(schema)} to be a GraphQL schema.")
+    return cast(GraphQLSchema, schema)
+
+
 def type_map_reducer(map_: TypeMap, type_: GraphQLNamedType = None) -> TypeMap:
     """Reducer function for creating the type map from given types."""
     if not type_:

graphql/type/validate.py

@@ -2,6 +2,7 @@
 from typing import Any, Callable, List, Optional, Sequence, Set, Union, cast
 
 from ..error import GraphQLError
+from ..pyutils import inspect
 from ..language import (
     EnumValueDefinitionNode,
     FieldDefinitionNode,
@@ -28,12 +29,11 @@
     is_union_type,
     is_required_argument,
 )
-from ..pyutils import inspect
 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 GraphQLDirective, is_directive
 from .introspection import is_introspection_type
-from .schema import GraphQLSchema, is_schema
+from .schema import GraphQLSchema, assert_schema
 
 __all__ = ["validate_schema", "assert_valid_schema"]
 
@@ -48,8 +48,7 @@ def validate_schema(schema: GraphQLSchema) -> List[GraphQLError]:
     list if no errors were encountered and the Schema is valid.
     """
     # First check to ensure the provided value is in fact a GraphQLSchema.
-    if not is_schema(schema):
-        raise TypeError(f"Expected {inspect(schema)} to be a GraphQL schema.")
+    assert_schema(schema)
 
     # If this Schema has already been validated, return the previous results.
     # noinspection PyProtectedMember
@@ -70,7 +69,7 @@ def validate_schema(schema: GraphQLSchema) -> List[GraphQLError]:
     return errors
 
 
-def assert_valid_schema(schema: GraphQLSchema):
+def assert_valid_schema(schema: GraphQLSchema) -> None:
     """Utility function which asserts a schema is valid.
 
     Throws a TypeError if the schema is invalid.

graphql/utilities/extend_schema.py

@@ -41,14 +41,14 @@
     GraphQLSchema,
     GraphQLType,
     GraphQLUnionType,
+    assert_schema,
     is_enum_type,
     is_input_object_type,
     is_interface_type,
     is_list_type,
     is_non_null_type,
     is_object_type,
     is_scalar_type,
-    is_schema,
     is_union_type,
     is_introspection_type,
     is_specified_scalar_type,
@@ -80,9 +80,7 @@ def extend_schema(
     schema is valid. Set `assume_valid` to true to assume the produced schema is valid.
     Set `assume_valid_sdl` to True to assume it is already a valid SDL document.
     """
-
-    if not is_schema(schema):
-        raise TypeError("Must provide valid GraphQLSchema")
+    assert_schema(schema)
 
     if not isinstance(document_ast, DocumentNode):
         "Must provide valid Document AST"

tests/execution/test_abstract_async.py

@@ -1,4 +1,3 @@
-from collections import namedtuple
 from typing import NamedTuple
 
 from pytest import mark

tests/utilities/test_build_ast_schema.py

@@ -8,6 +8,7 @@
     GraphQLDeprecatedDirective,
     GraphQLIncludeDirective,
     GraphQLSkipDirective,
+    assert_directive,
     assert_enum_type,
     assert_input_object_type,
     assert_interface_type,
@@ -708,8 +709,7 @@ def correctly_assign_ast_nodes():
         test_interface = assert_interface_type(schema.get_type("TestInterface"))
         test_type = assert_object_type(schema.get_type("TestType"))
         test_scalar = assert_scalar_type(schema.get_type("TestScalar"))
-        test_directive = schema.get_directive("test")
-        assert test_directive
+        test_directive = assert_directive(schema.get_directive("test"))
 
         restored_schema_ast = DocumentNode(
             definitions=[