class Schema:
def __init__(
self,
# TODO: can we make sure we only allow to pass something that has been decorated?
query: Type,
mutation: Optional[Type] = None,
subscription: Optional[Type] = None,
directives=(),
types=(),
extensions: Sequence[Type[Extension]] = (),
execution_context_class: Optional[
Type[GraphQLExecutionContext]] = None,
):
self.extensions = extensions
self.execution_context_class = execution_context_class
self.schema_converter = GraphQLCoreConverter()
query_type = self.schema_converter.from_object_type(query)
mutation_type = (self.schema_converter.from_object_type(mutation)
if mutation else None)
subscription_type = (
self.schema_converter.from_object_type(subscription)
if subscription else None)
self.middleware: List[Middleware] = [DirectivesMiddleware(directives)]
directives = [
self.schema_converter.from_directive(
directive.directive_definition) for directive in directives
]
self._schema = GraphQLSchema(
query=query_type,
mutation=mutation_type,
subscription=subscription_type if subscription else None,
directives=specified_directives + directives,
types=list(map(self.schema_converter.from_object_type, types)),
)
# Validate schema early because we want developers to know about
# possible issues as soon as possible
errors = validate_schema(self._schema)
if errors:
formatted_errors = "\n\n".join(f"❌ {error.message}"
for error in errors)
raise ValueError(f"Invalid Schema. Errors:\n\n{formatted_errors}")
self.query = self.schema_converter.type_map[query_type.name]
def get_type_by_name(
self, name: str
) -> Optional[Union[TypeDefinition, ScalarDefinition, EnumDefinition,
StrawberryUnion]]:
if name in self.schema_converter.type_map:
return self.schema_converter.type_map[name].definition
return None
def process_errors(self, errors: List[GraphQLError],
execution_context: ExecutionContext) -> None:
for error in errors:
actual_error = error.original_error or error
logger.error(actual_error, exc_info=actual_error)
async def execute(
self,
query: str,
variable_values: Optional[Dict[str, Any]] = None,
context_value: Optional[Any] = None,
root_value: Optional[Any] = None,
operation_name: Optional[str] = None,
validate_queries: bool = True,
) -> ExecutionResult:
# Create execution context
execution_context = ExecutionContext(
query=query,
context=context_value,
variables=variable_values,
operation_name=operation_name,
)
result = await execute(
self._schema,
query,
variable_values=variable_values,
root_value=root_value,
context_value=context_value,
operation_name=operation_name,
additional_middlewares=self.middleware,
extensions=self.extensions,
execution_context_class=self.execution_context_class,
validate_queries=validate_queries,
execution_context=execution_context,
)
if result.errors:
self.process_errors(result.errors,
execution_context=execution_context)
return ExecutionResult(
data=result.data,
errors=result.errors,
extensions=result.extensions,
)
def execute_sync(
self,
query: str,
variable_values: Optional[Dict[str, Any]] = None,
context_value: Optional[Any] = None,
root_value: Optional[Any] = None,
operation_name: Optional[str] = None,
validate_queries: bool = True,
) -> ExecutionResult:
execution_context = ExecutionContext(
query=query,
context=context_value,
variables=variable_values,
operation_name=operation_name,
)
result = execute_sync(
self._schema,
query,
variable_values=variable_values,
root_value=root_value,
context_value=context_value,
operation_name=operation_name,
additional_middlewares=self.middleware,
extensions=self.extensions,
execution_context_class=self.execution_context_class,
validate_queries=validate_queries,
execution_context=execution_context,
)
if result.errors:
self.process_errors(result.errors,
execution_context=execution_context)
return ExecutionResult(
data=result.data,
errors=result.errors,
extensions=result.extensions,
)
async def subscribe(
self,
query: str,
variable_values: Optional[Dict[str, Any]] = None,
context_value: Optional[Any] = None,
root_value: Optional[Any] = None,
operation_name: Optional[str] = None,
):
return await subscribe(
self._schema,
parse(query),
root_value=root_value,
context_value=context_value,
variable_values=variable_values,
operation_name=operation_name,
)
def as_str(self) -> str:
return print_schema(self)
__str__ = as_str
def introspect(self) -> Dict[str, Any]:
"""Return the introspection query result for the current schema
Raises:
ValueError: If the introspection query fails due to an invalid schema
"""
introspection = self.execute_sync(get_introspection_query())
if introspection.errors or not introspection.data:
raise ValueError(
f"Invalid Schema. Errors {introspection.errors!r}")
return introspection.data
class Schema:
def __init__(
self,
# TODO: can we make sure we only allow to pass something that has been decorated?
query: Type,
mutation: Optional[Type] = None,
subscription: Optional[Type] = None,
directives=(),
types=(),
extensions: Sequence[Union[Type[Extension], Extension]] = (),
execution_context_class: Optional[Type[GraphQLExecutionContext]] = None,
config: Optional[StrawberryConfig] = None,
scalar_overrides: Optional[
Dict[object, Union[ScalarWrapper, ScalarDefinition]]
] = None,
):
self.extensions = extensions
self.execution_context_class = execution_context_class
self.config = config or StrawberryConfig()
scalar_registry: Dict[object, Union[ScalarWrapper, ScalarDefinition]] = {
**DEFAULT_SCALAR_REGISTRY
}
if scalar_overrides:
scalar_registry.update(scalar_overrides)
self.schema_converter = GraphQLCoreConverter(self.config, scalar_registry)
self.directives = directives
query_type = self.schema_converter.from_object(query._type_definition)
mutation_type = (
self.schema_converter.from_object(mutation._type_definition)
if mutation
else None
)
subscription_type = (
self.schema_converter.from_object(subscription._type_definition)
if subscription
else None
)
directives = [
self.schema_converter.from_directive(directive.directive_definition)
for directive in directives
]
graphql_types = []
for type_ in types:
graphql_type = self.schema_converter.from_object(type_._type_definition)
graphql_types.append(graphql_type)
self._schema = GraphQLSchema(
query=query_type,
mutation=mutation_type,
subscription=subscription_type if subscription else None,
directives=specified_directives + directives,
types=graphql_types,
)
# Validate schema early because we want developers to know about
# possible issues as soon as possible
errors = validate_schema(self._schema)
if errors:
formatted_errors = "\n\n".join(f"❌ {error.message}" for error in errors)
raise ValueError(f"Invalid Schema. Errors:\n\n{formatted_errors}")
self.query = self.schema_converter.type_map[query_type.name]
def get_type_by_name(
self, name: str
) -> Optional[
Union[TypeDefinition, ScalarDefinition, EnumDefinition, StrawberryUnion]
]:
if name in self.schema_converter.type_map:
return self.schema_converter.type_map[name].definition
return None
def process_errors(
self, errors: List[GraphQLError], execution_context: ExecutionContext
) -> None:
kwargs: Dict[str, Any] = {
"stack_info": True,
}
# stacklevel was added in version 3.8
# https://docs.python.org/3/library/logging.html#logging.Logger.debug
if sys.version_info >= (3, 8):
kwargs["stacklevel"] = 3
for error in errors:
logger.error(error, exc_info=error.original_error, **kwargs)
async def execute(
self,
query: str,
variable_values: Optional[Dict[str, Any]] = None,
context_value: Optional[Any] = None,
root_value: Optional[Any] = None,
operation_name: Optional[str] = None,
) -> ExecutionResult:
# Create execution context
execution_context = ExecutionContext(
query=query,
schema=self,
context=context_value,
root_value=root_value,
variables=variable_values,
operation_name=operation_name,
)
result = await execute(
self._schema,
query,
extensions=self.extensions,
directives=self.directives,
execution_context_class=self.execution_context_class,
execution_context=execution_context,
)
if result.errors:
self.process_errors(result.errors, execution_context=execution_context)
return result
def execute_sync(
self,
query: str,
variable_values: Optional[Dict[str, Any]] = None,
context_value: Optional[Any] = None,
root_value: Optional[Any] = None,
operation_name: Optional[str] = None,
) -> ExecutionResult:
execution_context = ExecutionContext(
query=query,
schema=self,
context=context_value,
root_value=root_value,
variables=variable_values,
operation_name=operation_name,
)
result = execute_sync(
self._schema,
query,
extensions=self.extensions,
directives=self.directives,
execution_context_class=self.execution_context_class,
execution_context=execution_context,
)
if result.errors:
self.process_errors(result.errors, execution_context=execution_context)
return result
async def subscribe(
self,
query: str,
variable_values: Optional[Dict[str, Any]] = None,
context_value: Optional[Any] = None,
root_value: Optional[Any] = None,
operation_name: Optional[str] = None,
):
return await subscribe(
self._schema,
parse(query),
root_value=root_value,
context_value=context_value,
variable_values=variable_values,
operation_name=operation_name,
)
def as_str(self) -> str:
return print_schema(self)
__str__ = as_str
def introspect(self) -> Dict[str, Any]:
"""Return the introspection query result for the current schema
Raises:
ValueError: If the introspection query fails due to an invalid schema
"""
introspection = self.execute_sync(get_introspection_query())
if introspection.errors or not introspection.data:
raise ValueError(f"Invalid Schema. Errors {introspection.errors!r}")
return introspection.data
class Schema(BaseSchema):
def __init__(
self,
# TODO: can we make sure we only allow to pass something that has been decorated?
query: Type,
mutation: Optional[Type] = None,
subscription: Optional[Type] = None,
directives: Sequence[StrawberryDirective] = (),
types=(),
extensions: Sequence[Union[Type[Extension], Extension]] = (),
execution_context_class: Optional[
Type[GraphQLExecutionContext]] = None,
config: Optional[StrawberryConfig] = None,
scalar_overrides: Optional[Dict[object,
Union[ScalarWrapper,
ScalarDefinition]]] = None,
):
self.extensions = extensions
self.execution_context_class = execution_context_class
self.config = config or StrawberryConfig()
scalar_registry: Dict[object, Union[ScalarWrapper,
ScalarDefinition]] = {
**DEFAULT_SCALAR_REGISTRY
}
if scalar_overrides:
scalar_registry.update(scalar_overrides)
self.schema_converter = GraphQLCoreConverter(self.config,
scalar_registry)
self.directives = directives
query_type = self.schema_converter.from_object(query._type_definition)
mutation_type = (self.schema_converter.from_object(
mutation._type_definition) if mutation else None)
subscription_type = (self.schema_converter.from_object(
subscription._type_definition) if subscription else None)
graphql_directives = [
self.schema_converter.from_directive(directive)
for directive in directives
]
graphql_types = []
for type_ in types:
graphql_type = self.schema_converter.from_object(
type_._type_definition)
graphql_types.append(graphql_type)
self._schema = GraphQLSchema(
query=query_type,
mutation=mutation_type,
subscription=subscription_type if subscription else None,
directives=specified_directives + graphql_directives,
types=graphql_types,
)
# attach our schema to the GraphQL schema instance
self._schema._strawberry_schema = self # type: ignore
# Validate schema early because we want developers to know about
# possible issues as soon as possible
errors = validate_schema(self._schema)
if errors:
formatted_errors = "\n\n".join(f"❌ {error.message}"
for error in errors)
raise ValueError(f"Invalid Schema. Errors:\n\n{formatted_errors}")
self.query = self.schema_converter.type_map[query_type.name]
def get_type_by_name(
self, name: str
) -> Optional[Union[TypeDefinition, ScalarDefinition, EnumDefinition,
StrawberryUnion]]:
if name in self.schema_converter.type_map:
return self.schema_converter.type_map[name].definition
return None
@lru_cache()
def get_directive_by_name(
self, graphql_name: str) -> Optional[StrawberryDirective]:
return next(
(directive for directive in self.directives if self.config.
name_converter.from_directive(directive) == graphql_name),
None,
)
async def execute(
self,
query: str,
variable_values: Optional[Dict[str, Any]] = None,
context_value: Optional[Any] = None,
root_value: Optional[Any] = None,
operation_name: Optional[str] = None,
) -> ExecutionResult:
# Create execution context
execution_context = ExecutionContext(
query=query,
schema=self,
context=context_value,
root_value=root_value,
variables=variable_values,
provided_operation_name=operation_name,
)
result = await execute(
self._schema,
query,
extensions=list(self.extensions) + [DirectivesExtension],
execution_context_class=self.execution_context_class,
execution_context=execution_context,
)
if result.errors:
self.process_errors(result.errors,
execution_context=execution_context)
return result
def execute_sync(
self,
query: str,
variable_values: Optional[Dict[str, Any]] = None,
context_value: Optional[Any] = None,
root_value: Optional[Any] = None,
operation_name: Optional[str] = None,
) -> ExecutionResult:
execution_context = ExecutionContext(
query=query,
schema=self,
context=context_value,
root_value=root_value,
variables=variable_values,
provided_operation_name=operation_name,
)
result = execute_sync(
self._schema,
query,
extensions=list(self.extensions) + [DirectivesExtensionSync],
execution_context_class=self.execution_context_class,
execution_context=execution_context,
)
if result.errors:
self.process_errors(result.errors,
execution_context=execution_context)
return result
async def subscribe(
self,
query: str,
variable_values: Optional[Dict[str, Any]] = None,
context_value: Optional[Any] = None,
root_value: Optional[Any] = None,
operation_name: Optional[str] = None,
):
return await subscribe(
self._schema,
parse(query),
root_value=root_value,
context_value=context_value,
variable_values=variable_values,
operation_name=operation_name,
)
def as_str(self) -> str:
return print_schema(self)
__str__ = as_str
def introspect(self) -> Dict[str, Any]:
"""Return the introspection query result for the current schema
Raises:
ValueError: If the introspection query fails due to an invalid schema
"""
introspection = self.execute_sync(get_introspection_query())
if introspection.errors or not introspection.data:
raise ValueError(
f"Invalid Schema. Errors {introspection.errors!r}")
return introspection.data