from asyncio import ensure_future from inspect import isawaitable from typing import Any, Callable, Dict, Optional, Type, Union from .error import GraphQLError from .execution import ExecutionContext, ExecutionResult, Middleware, execute from .language import Source, parse from .pyutils import AwaitableOrValue from .type import ( GraphQLFieldResolver, GraphQLSchema, GraphQLTypeResolver, validate_schema, ) __all__ = ["graphql", "graphql_sync"] async def graphql( schema: GraphQLSchema, source: Union[str, Source], root_value: Any = None, context_value: Any = None, variable_values: Optional[Dict[str, Any]] = None, operation_name: Optional[str] = None, field_resolver: Optional[GraphQLFieldResolver] = None, type_resolver: Optional[GraphQLTypeResolver] = None, middleware: Optional[Middleware] = None, execution_context_class: Optional[Type[ExecutionContext]] = None, is_awaitable: Optional[Callable[[Any], bool]] = None, ) -> ExecutionResult: """Execute a GraphQL operation asynchronously. This is the primary entry point function for fulfilling GraphQL operations by parsing, validating, and executing a GraphQL document along side a GraphQL schema. More sophisticated GraphQL servers, such as those which persist queries, may wish to separate the validation and execution phases to a static time tooling step, and a server runtime step. Accepts the following arguments: :arg schema: The GraphQL type system to use when validating and executing a query. :arg source: A GraphQL language formatted string representing the requested operation. :arg root_value: The value provided as the first argument to resolver functions on the top level type (e.g. the query object type). :arg context_value: The context value is provided as an attribute of the second argument (the resolve info) to resolver functions. It is used to pass shared information useful at any point during query execution, for example the currently logged in user and connections to databases or other services. :arg variable_values: A mapping of variable name to runtime value to use for all variables defined in the request string. :arg operation_name: The name of the operation to use if request string contains multiple possible operations. Can be omitted if request string contains only one operation. :arg field_resolver: A resolver function to use when one is not provided by the schema. If not provided, the default field resolver is used (which looks for a value or method on the source value with the field's name). :arg type_resolver: A type resolver function to use when none is provided by the schema. If not provided, the default type resolver is used (which looks for a ``__typename`` field or alternatively calls the :meth:`~graphql.type.GraphQLObjectType.is_type_of` method). :arg middleware: The middleware to wrap the resolvers with :arg execution_context_class: The execution context class to use to build the context :arg is_awaitable: The predicate to be used for checking whether values are awaitable """ # Always return asynchronously for a consistent API. result = graphql_impl( schema, source, root_value, context_value, variable_values, operation_name, field_resolver, type_resolver, middleware, execution_context_class, is_awaitable, ) if isawaitable(result): return await result return result def assume_not_awaitable(_value: Any) -> bool: """Replacement for isawaitable if everything is assumed to be synchronous.""" return False def graphql_sync( schema: GraphQLSchema, source: Union[str, Source], root_value: Any = None, context_value: Any = None, variable_values: Optional[Dict[str, Any]] = None, operation_name: Optional[str] = None, field_resolver: Optional[GraphQLFieldResolver] = None, type_resolver: Optional[GraphQLTypeResolver] = None, middleware: Optional[Middleware] = None, execution_context_class: Optional[Type[ExecutionContext]] = None, check_sync: bool = False, ) -> ExecutionResult: """Execute a GraphQL operation synchronously. The graphql_sync function also fulfills GraphQL operations by parsing, validating, and executing a GraphQL document along side a GraphQL schema. However, it guarantees to complete synchronously (or throw an error) assuming that all field resolvers are also synchronous. Set check_sync to True to still run checks that no awaitable values are returned. """ is_awaitable = ( check_sync if callable(check_sync) else (None if check_sync else assume_not_awaitable) ) result = graphql_impl( schema, source, root_value, context_value, variable_values, operation_name, field_resolver, type_resolver, middleware, execution_context_class, is_awaitable, ) # Assert that the execution was synchronous. if isawaitable(result): ensure_future(result).cancel() raise RuntimeError("GraphQL execution failed to complete synchronously.") return result def graphql_impl( schema: GraphQLSchema, source: Union[str, Source], root_value: Any, context_value: Any, variable_values: Optional[Dict[str, Any]], operation_name: Optional[str], field_resolver: Optional[GraphQLFieldResolver], type_resolver: Optional[GraphQLTypeResolver], middleware: Optional[Middleware], execution_context_class: Optional[Type[ExecutionContext]], is_awaitable: Optional[Callable[[Any], bool]], ) -> AwaitableOrValue[ExecutionResult]: """Execute a query, return asynchronously only if necessary.""" # Validate Schema schema_validation_errors = validate_schema(schema) if schema_validation_errors: return ExecutionResult(data=None, errors=schema_validation_errors) # Parse try: document = parse(source) except GraphQLError as error: return ExecutionResult(data=None, errors=[error]) # Validate from .validation import validate validation_errors = validate(schema, document) if validation_errors: return ExecutionResult(data=None, errors=validation_errors) # Execute return execute( schema, document, root_value, context_value, variable_values, operation_name, field_resolver, type_resolver, None, middleware, execution_context_class, is_awaitable, )