strawberry-graphql 0.235.2__py3-none-any.whl → 0.236.0__py3-none-any.whl

strawberry/relay/utils.py

@@ -6,8 +6,8 @@ import sys
 from typing import TYPE_CHECKING, Any, Tuple, Union
 from typing_extensions import Self, assert_never
 
+from strawberry.types.base import StrawberryObjectDefinition
 from strawberry.types.nodes import InlineFragment, Selection
-from strawberry.types.types import StrawberryObjectDefinition
 
 if TYPE_CHECKING:
     from strawberry.types.info import Info
@@ -86,6 +86,7 @@ def should_resolve_list_connection_edges(info: Info) -> bool:
 
     def _check_selection(selection: Selection) -> bool:
         """Recursively inspect the selection to check if the user requested to resolve the `edges` field.
+
         Args:
             selection (Selection): The selection to check.
 
@@ -187,3 +188,11 @@ class SliceMetadata:
             end=end,
             expected=expected,
         )
+
+
+__all__ = [
+    "from_base64",
+    "to_base64",
+    "should_resolve_list_connection_edges",
+    "SliceMetadata",
+]

strawberry/resolvers.py

@@ -4,3 +4,6 @@ from typing import Any, Callable
 def is_default_resolver(func: Callable[..., Any]) -> bool:
     """Check whether the function is a default resolver or a user provided one."""
     return getattr(func, "_is_default", False)
+
+
+__all__ = ["is_default_resolver"]

strawberry/sanic/context.py

@@ -22,3 +22,6 @@ class StrawberrySanicContext(TypedDict):
         )
 
         return super().__getitem__(key)
+
+
+__all__ = ["StrawberrySanicContext"]

strawberry/sanic/utils.py

@@ -10,18 +10,17 @@ if TYPE_CHECKING:
 
 
 def convert_request_to_files_dict(request: Request) -> Dict[str, Any]:
-    """
-    request.files has the following format, even if only a single file is uploaded:
+    """Converts the request.files dictionary to a dictionary of BytesIO objects.
+
+    `request.files` has the following format, even if only a single file is uploaded:
 
+    ```python
     {
-        'textFile': [
-            sanic.request.File(
-                type='text/plain',
-                body=b'strawberry',
-                name='textFile.txt'
-            )
+        "textFile": [
+            sanic.request.File(type="text/plain", body=b"strawberry", name="textFile.txt")
         ]
     }
+    ```
 
     Note that the dictionary entries are lists.
     """
@@ -38,3 +37,6 @@ def convert_request_to_files_dict(request: Request) -> Dict[str, Any]:
         files_dict[field_name] = BytesIO(file_list[0].body)
 
     return files_dict
+
+
+__all__ = ["convert_request_to_files_dict"]

strawberry/sanic/views.py

@@ -72,8 +72,7 @@ class GraphQLView(
     AsyncBaseHTTPView[Request, HTTPResponse, TemporalResponse, Context, RootValue],
     HTTPMethodView,
 ):
-    """
-    Class based view to handle GraphQL HTTP Requests
+    """Class based view to handle GraphQL HTTP Requests.
 
     Args:
         schema: strawberry.Schema
@@ -172,3 +171,6 @@ class GraphQLView(
             return await self.run(request)
         except HTTPException as e:
             return HTTPResponse(e.reason, status=e.status_code)
+
+
+__all__ = ["GraphQLView"]

strawberry/scalars.py

@@ -3,13 +3,14 @@ from __future__ import annotations
 import base64
 from typing import TYPE_CHECKING, Any, Dict, NewType, Union
 
-from .custom_scalar import scalar
+from strawberry.types.scalar import scalar
 
 if TYPE_CHECKING:
-    from .custom_scalar import ScalarDefinition, ScalarWrapper
+    from strawberry.types.scalar import ScalarDefinition, ScalarWrapper
 
 
 ID = NewType("ID", str)
+"""Represent the GraphQL `ID` scalar type."""
 
 JSON = scalar(
     NewType("JSON", object),  # mypy doesn't like `NewType("name", Any)`
@@ -62,3 +63,6 @@ def is_scalar(
         return True
 
     return hasattr(annotation, "_scalar_definition")
+
+
+__all__ = ["ID", "JSON", "Base16", "Base32", "Base64", "is_scalar"]

strawberry/schema/base.py

@@ -10,14 +10,14 @@ from strawberry.utils.logging import StrawberryLogger
 if TYPE_CHECKING:
     from graphql import GraphQLError
 
-    from strawberry.custom_scalar import ScalarDefinition
     from strawberry.directive import StrawberryDirective
-    from strawberry.enum import EnumDefinition
     from strawberry.schema.schema_converter import GraphQLCoreConverter
     from strawberry.types import ExecutionContext, ExecutionResult
+    from strawberry.types.base import StrawberryObjectDefinition
+    from strawberry.types.enum import EnumDefinition
     from strawberry.types.graphql import OperationType
-    from strawberry.types.types import StrawberryObjectDefinition
-    from strawberry.union import StrawberryUnion
+    from strawberry.types.scalar import ScalarDefinition
+    from strawberry.types.union import StrawberryUnion
 
     from .config import StrawberryConfig
 
@@ -113,3 +113,6 @@ class BaseSchema(Protocol):
     ) -> None:
         for error in errors:
             StrawberryLogger.error(error, execution_context)
+
+
+__all__ = ["BaseSchema"]

strawberry/schema/compat.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 from typing import TYPE_CHECKING, Dict, Union
 
 from strawberry.scalars import is_scalar as is_strawberry_scalar
-from strawberry.type import StrawberryType, has_object_definition
+from strawberry.types.base import StrawberryType, has_object_definition
 
 # TypeGuard is only available in typing_extensions => 3.10, we don't want
 # to force updates to the typing_extensions package so we only use it when
@@ -12,7 +12,7 @@ from strawberry.type import StrawberryType, has_object_definition
 if TYPE_CHECKING:
     from typing_extensions import TypeGuard
 
-    from strawberry.custom_scalar import ScalarDefinition, ScalarWrapper
+    from strawberry.types.scalar import ScalarDefinition, ScalarWrapper
 
 
 def is_input_type(type_: Union[StrawberryType, type]) -> TypeGuard[type]:
@@ -51,3 +51,13 @@ def is_graphql_generic(type_: Union[StrawberryType, type]) -> bool:
         return type_.is_graphql_generic
 
     return False
+
+
+__all__ = [
+    "is_input_type",
+    "is_interface_type",
+    "is_scalar",
+    "is_enum",
+    "is_schema_directive",
+    "is_graphql_generic",
+]

strawberry/schema/config.py

@@ -20,3 +20,6 @@ class StrawberryConfig:
     ) -> None:
         if auto_camel_case is not None:
             self.name_converter.auto_camel_case = auto_camel_case
+
+
+__all__ = ["StrawberryConfig"]

strawberry/schema/exceptions.py

@@ -13,3 +13,6 @@ class InvalidOperationTypeError(Exception):
         }[self.operation_type]
 
         return f"{operation_type} are not allowed when using {method}"
+
+
+__all__ = ["InvalidOperationTypeError"]

strawberry/schema/execute.py

@@ -277,3 +277,6 @@ def execute_sync(
         errors=execution_context.result.errors,
         extensions=extensions_runner.get_extensions_results_sync(),
     )
+
+
+__all__ = ["execute", "execute_sync"]

strawberry/schema/name_converter.py

@@ -3,25 +3,25 @@ from __future__ import annotations
 from typing import TYPE_CHECKING, List, Optional, Union, cast
 from typing_extensions import Protocol
 
-from strawberry.custom_scalar import ScalarDefinition
 from strawberry.directive import StrawberryDirective
-from strawberry.enum import EnumDefinition, EnumValue
-from strawberry.lazy_type import LazyType
 from strawberry.schema_directive import StrawberrySchemaDirective
-from strawberry.type import (
+from strawberry.types.base import (
     StrawberryList,
+    StrawberryObjectDefinition,
     StrawberryOptional,
     has_object_definition,
 )
-from strawberry.types.types import StrawberryObjectDefinition
-from strawberry.union import StrawberryUnion
+from strawberry.types.enum import EnumDefinition, EnumValue
+from strawberry.types.lazy_type import LazyType
+from strawberry.types.scalar import ScalarDefinition
+from strawberry.types.union import StrawberryUnion
 from strawberry.utils.str_converters import capitalize_first, to_camel_case
 from strawberry.utils.typing import eval_type
 
 if TYPE_CHECKING:
-    from strawberry.arguments import StrawberryArgument
-    from strawberry.field import StrawberryField
-    from strawberry.type import StrawberryType
+    from strawberry.types.arguments import StrawberryArgument
+    from strawberry.types.base import StrawberryType
+    from strawberry.types.field import StrawberryField
 
 
 class HasGraphQLName(Protocol):
@@ -184,3 +184,6 @@ class NameConverter:
         assert obj.python_name
 
         return self.apply_naming_config(obj.python_name)
+
+
+__all__ = ["NameConverter"]

strawberry/schema/schema.py

@@ -36,10 +36,9 @@ from strawberry.extensions.directives import (
 )
 from strawberry.schema.schema_converter import GraphQLCoreConverter
 from strawberry.schema.types.scalar import DEFAULT_SCALAR_REGISTRY
-from strawberry.type import has_object_definition
 from strawberry.types import ExecutionContext
+from strawberry.types.base import StrawberryObjectDefinition, has_object_definition
 from strawberry.types.graphql import OperationType
-from strawberry.types.types import StrawberryObjectDefinition
 
 from ..printer import print_schema
 from . import compat
@@ -51,14 +50,14 @@ if TYPE_CHECKING:
     from graphql import ExecutionContext as GraphQLExecutionContext
     from graphql import ExecutionResult as GraphQLExecutionResult
 
-    from strawberry.custom_scalar import ScalarDefinition, ScalarWrapper
     from strawberry.directive import StrawberryDirective
-    from strawberry.enum import EnumDefinition
     from strawberry.extensions import SchemaExtension
-    from strawberry.field import StrawberryField
-    from strawberry.type import StrawberryType
     from strawberry.types import ExecutionResult
-    from strawberry.union import StrawberryUnion
+    from strawberry.types.base import StrawberryType
+    from strawberry.types.enum import EnumDefinition
+    from strawberry.types.field import StrawberryField
+    from strawberry.types.scalar import ScalarDefinition, ScalarWrapper
+    from strawberry.types.union import StrawberryUnion
 
 DEFAULT_ALLOWED_OPERATION_TYPES = {
     OperationType.QUERY,
@@ -81,10 +80,45 @@ class Schema(BaseSchema):
         execution_context_class: Optional[Type[GraphQLExecutionContext]] = None,
         config: Optional[StrawberryConfig] = None,
         scalar_overrides: Optional[
-            Dict[object, Union[Type, ScalarWrapper, ScalarDefinition]]
+            Dict[object, Union[Type, ScalarWrapper, ScalarDefinition]],
         ] = None,
         schema_directives: Iterable[object] = (),
     ) -> None:
+        """Default Schema to be to be used in a Strawberry application.
+
+        A GraphQL Schema class used to define the structure and configuration
+        of GraphQL queries, mutations, and subscriptions.
+
+        This class allows the creation of a GraphQL schema by specifying the types
+        for queries, mutations, and subscriptions, along with various configuration
+        options such as directives, extensions, and scalar overrides.
+
+        Args:
+            query: The entry point for queries.
+            mutation: The entry point for mutations.
+            subscription: The entry point for subscriptions.
+            directives: A list of operation directives that clients can use.
+                The bult-in `@include` and `@skip` are included by default.
+            types: A list of additional types that will be included in the schema.
+            extensions: A list of Strawberry extensions.
+            execution_context_class: The execution context class.
+            config: The configuration for the schema.
+            scalar_overrides: A dictionary of overrides for scalars.
+            schema_directives: A list of schema directives for the schema.
+
+        Example:
+        ```python
+        import strawberry
+
+
+        @strawberry.type
+        class Query:
+            name: str = "Patrick"
+
+
+        schema = strawberry.Schema(query=Query)
+        ```
+        """
         self.query = query
         self.mutation = mutation
         self.subscription = subscription
@@ -395,7 +429,7 @@ class Schema(BaseSchema):
     __str__ = as_str
 
     def introspect(self) -> Dict[str, Any]:
-        """Return the introspection query result for the current schema
+        """Return the introspection query result for the current schema.
 
         Raises:
             ValueError: If the introspection query fails due to an invalid schema
@@ -405,3 +439,6 @@ class Schema(BaseSchema):
             raise ValueError(f"Invalid Schema. Errors {introspection.errors!r}")
 
         return introspection.data
+
+
+__all__ = ["Schema"]

strawberry/schema/schema_converter.py

@@ -44,9 +44,6 @@ from graphql import (
 from graphql.language.directive_locations import DirectiveLocation
 
 from strawberry.annotation import StrawberryAnnotation
-from strawberry.arguments import StrawberryArgument, convert_arguments
-from strawberry.custom_scalar import ScalarWrapper
-from strawberry.enum import EnumDefinition
 from strawberry.exceptions import (
     DuplicatedTypeName,
     InvalidTypeInputForUnion,
@@ -55,21 +52,24 @@ from strawberry.exceptions import (
     ScalarAlreadyRegisteredError,
     UnresolvedFieldTypeError,
 )
-from strawberry.field import UNRESOLVED
-from strawberry.lazy_type import LazyType
-from strawberry.private import is_private
 from strawberry.schema.types.scalar import _make_scalar_type
-from strawberry.type import (
+from strawberry.types.arguments import StrawberryArgument, convert_arguments
+from strawberry.types.base import (
     StrawberryList,
+    StrawberryObjectDefinition,
     StrawberryOptional,
     StrawberryType,
     get_object_definition,
     has_object_definition,
 )
+from strawberry.types.enum import EnumDefinition
+from strawberry.types.field import UNRESOLVED
 from strawberry.types.info import Info
-from strawberry.types.types import StrawberryObjectDefinition
-from strawberry.union import StrawberryUnion
-from strawberry.unset import UNSET
+from strawberry.types.lazy_type import LazyType
+from strawberry.types.private import is_private
+from strawberry.types.scalar import ScalarWrapper
+from strawberry.types.union import StrawberryUnion
+from strawberry.types.unset import UNSET
 from strawberry.utils.await_maybe import await_maybe
 
 from ..extensions.field_extension import build_field_extension_resolvers
@@ -85,12 +85,12 @@ if TYPE_CHECKING:
         GraphQLScalarType,
     )
 
-    from strawberry.custom_scalar import ScalarDefinition
     from strawberry.directive import StrawberryDirective
-    from strawberry.enum import EnumValue
-    from strawberry.field import StrawberryField
     from strawberry.schema.config import StrawberryConfig
     from strawberry.schema_directive import StrawberrySchemaDirective
+    from strawberry.types.enum import EnumValue
+    from strawberry.types.field import StrawberryField
+    from strawberry.types.scalar import ScalarDefinition
 
 
 FieldType = TypeVar(
@@ -681,7 +681,6 @@ class GraphQLCoreConverter:
 
         def wrap_field_extensions() -> Callable[..., Any]:
             """Wrap the provided field resolver with the middleware."""
-
             for extension in field.extensions:
                 extension.apply(field)
 
@@ -999,3 +998,6 @@ class GraphQLCoreConverter:
             second_origin = None
 
         raise DuplicatedTypeName(first_origin, second_origin, name)
+
+
+__all__ = ["GraphQLCoreConverter"]

strawberry/schema/types/base_scalars.py

@@ -7,7 +7,7 @@ from typing import Callable
 import dateutil.parser
 from graphql import GraphQLError
 
-from strawberry.custom_scalar import scalar
+from strawberry.types.scalar import scalar
 
 
 def wrap_parser(parser: Callable, type_: str) -> Callable:
@@ -80,3 +80,5 @@ Void = scalar(
     parse_value=_verify_void,
     description="Represents NULL values",
 )
+
+__all__ = ["Date", "DateTime", "Time", "Decimal", "UUID", "Void"]

strawberry/schema/types/concrete_type.py

@@ -6,10 +6,10 @@ from typing import TYPE_CHECKING, Dict, Union
 from graphql import GraphQLField, GraphQLInputField, GraphQLType
 
 if TYPE_CHECKING:
-    from strawberry.custom_scalar import ScalarDefinition
-    from strawberry.enum import EnumDefinition
-    from strawberry.types.types import StrawberryObjectDefinition
-    from strawberry.union import StrawberryUnion
+    from strawberry.types.base import StrawberryObjectDefinition
+    from strawberry.types.enum import EnumDefinition
+    from strawberry.types.scalar import ScalarDefinition
+    from strawberry.types.union import StrawberryUnion
 
 Field = Union[GraphQLInputField, GraphQLField]
 

strawberry/schema/types/scalar.py

@@ -12,11 +12,11 @@ from graphql import (
     GraphQLString,
 )
 
-from strawberry.custom_scalar import ScalarDefinition, scalar
 from strawberry.file_uploads.scalars import Upload
 from strawberry.relay.types import GlobalID
 from strawberry.scalars import ID
 from strawberry.schema.types import base_scalars
+from strawberry.types.scalar import ScalarDefinition, scalar
 
 
 def _make_scalar_type(definition: ScalarDefinition) -> GraphQLScalarType:
@@ -78,3 +78,10 @@ DEFAULT_SCALAR_REGISTRY: Dict[object, ScalarDefinition] = {
         )
     ),
 }
+
+__all__ = [
+    "DEFAULT_SCALAR_REGISTRY",
+    "_get_scalar_definition",
+    "_make_scalar_definition",
+    "_make_scalar_type",
+]

strawberry/schema/validation_rules/one_of.py

@@ -78,3 +78,6 @@ class OneOfInputValidationRule(ValidationRule):
                         nodes=[node],
                     )
                 )
+
+
+__all__ = ["OneOfInputValidationRule"]

strawberry/schema_codegen/__init__.py

@@ -802,3 +802,6 @@ def codegen(schema: str) -> str:
     module = cst.Module(body=body)  # type: ignore
 
     return module.code
+
+
+__all__ = ["codegen"]

strawberry/schema_directive.py

@@ -3,11 +3,11 @@ from enum import Enum
 from typing import Callable, List, Optional, Type, TypeVar
 from typing_extensions import dataclass_transform
 
-from strawberry.object_type import _wrap_dataclass
+from strawberry.types.field import StrawberryField, field
+from strawberry.types.object_type import _wrap_dataclass
 from strawberry.types.type_resolver import _get_fields
 
 from .directive import directive_field
-from .field import StrawberryField, field
 
 
 class Location(Enum):

strawberry/starlite/controller.py

@@ -382,3 +382,6 @@ def make_graphql_controller(
             )
 
     return GraphQLController
+
+
+__all__ = ["make_graphql_controller"]

strawberry/starlite/handlers/graphql_transport_ws_handler.py

@@ -54,3 +54,6 @@ class GraphQLTransportWSHandler(BaseGraphQLTransportWSHandler):
             pass
         finally:
             await self.shutdown()
+
+
+__all__ = ["GraphQLTransportWSHandler"]

strawberry/starlite/handlers/graphql_ws_handler.py

@@ -59,3 +59,6 @@ class GraphQLWSHandler(BaseGraphQLWSHandler):
 
             for operation_id in list(self.subscriptions.keys()):
                 await self.cleanup_operation(operation_id)
+
+
+__all__ = ["GraphQLWSHandler"]

strawberry/subscriptions/__init__.py

@@ -1,2 +1,8 @@
 GRAPHQL_TRANSPORT_WS_PROTOCOL = "graphql-transport-ws"
 GRAPHQL_WS_PROTOCOL = "graphql-ws"
+
+
+__all__ = [
+    "GRAPHQL_TRANSPORT_WS_PROTOCOL",
+    "GRAPHQL_WS_PROTOCOL",
+]

strawberry/subscriptions/protocols/graphql_transport_ws/__init__.py

@@ -1,2 +1,7 @@
 # Code 4406 is "Subprotocol not acceptable"
 WS_4406_PROTOCOL_NOT_ACCEPTABLE = 4406
+
+
+__all__ = [
+    "WS_4406_PROTOCOL_NOT_ACCEPTABLE",
+]

strawberry/subscriptions/protocols/graphql_transport_ws/handlers.py

@@ -30,7 +30,7 @@ from strawberry.subscriptions.protocols.graphql_transport_ws.types import (
     SubscribeMessagePayload,
 )
 from strawberry.types.graphql import OperationType
-from strawberry.unset import UNSET
+from strawberry.types.unset import UNSET
 from strawberry.utils.debug import pretty_print_graphql_operation
 from strawberry.utils.operation import get_operation_type
 
@@ -66,23 +66,23 @@ class BaseGraphQLTransportWSHandler(ABC):
 
     @abstractmethod
     async def get_context(self) -> Any:
-        """Return the operations context"""
+        """Return the operations context."""
 
     @abstractmethod
     async def get_root_value(self) -> Any:
-        """Return the schemas root value"""
+        """Return the schemas root value."""
 
     @abstractmethod
     async def send_json(self, data: dict) -> None:
-        """Send the data JSON encoded to the WebSocket client"""
+        """Send the data JSON encoded to the WebSocket client."""
 
     @abstractmethod
     async def close(self, code: int, reason: str) -> None:
-        """Close the WebSocket with the passed code and reason"""
+        """Close the WebSocket with the passed code and reason."""
 
     @abstractmethod
     async def handle_request(self) -> Any:
-        """Handle the request this instance was created for"""
+        """Handle the request this instance was created for."""
 
     async def handle(self) -> Any:
         return await self.handle_request()
@@ -286,10 +286,7 @@ class BaseGraphQLTransportWSHandler(ABC):
     async def operation_task(
         self, result_source: AsyncGenerator, operation: Operation
     ) -> None:
-        """
-        Operation task top level method.  Cleans up and de-registers the operation
-        once it is done.
-        """
+        """The operation task's top level method. Cleans-up and de-registers the operation once it is done."""
         # TODO: Handle errors in this method using self.handle_task_exception()
         try:
             await self.handle_async_results(result_source, operation)
@@ -371,9 +368,7 @@ class BaseGraphQLTransportWSHandler(ABC):
         # websocket handler Task.
 
     async def reap_completed_tasks(self) -> None:
-        """
-        Await tasks that have completed
-        """
+        """Await tasks that have completed."""
         tasks, self.completed_tasks = self.completed_tasks, []
         for task in tasks:
             with suppress(BaseException):
@@ -381,10 +376,7 @@ class BaseGraphQLTransportWSHandler(ABC):
 
 
 class Operation:
-    """
-    A class encapsulating a single operation with its id.
-    Helps enforce protocol state transition.
-    """
+    """A class encapsulating a single operation with its id. Helps enforce protocol state transition."""
 
     __slots__ = ["handler", "id", "operation_type", "completed", "task"]
 
@@ -408,3 +400,6 @@ class Operation:
             # de-register the operation _before_ sending the final message
             self.handler.forget_id(self.id)
         await self.handler.send_message(message)
+
+
+__all__ = ["BaseGraphQLTransportWSHandler", "Operation"]