strawberry-graphql 0.235.2__tar.gz → 0.236.1__tar.gz

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: strawberry-graphql
-Version: 0.235.2
+Version: 0.236.1
 Summary: A library for creating GraphQL APIs
 Home-page: https://strawberry.rocks/
 License: MIT

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "strawberry-graphql"
 packages = [ { include = "strawberry" } ]
-version = "0.235.2"
+version = "0.236.1"
 description = "A library for creating GraphQL APIs"
 authors = ["Patrick Arminio <patrick.arminio@gmail.com>"]
 license = "MIT"
@@ -68,7 +68,7 @@ asgiref = "^3.2"
 ddtrace = ">=1.6.4"
 email-validator = {version = ">=1.1.3,<3.0.0", optional = false}
 freezegun = "^1.2.1"
-libcst = {version = ">=0.4.7", optional = false}
+libcst = {version = ">=1.0.0", optional = false}
 MarkupSafe = "2.1.3"
 nox = "^2023.4.22"
 nox-poetry = "^1.0.3"
@@ -235,9 +235,6 @@ ignore = [
     "S102",
     "S104",
     "S324",
-    # maybe we can enable this in future
-    # we'd want to have consistent docstrings in future
-    "D",
     "ANN101", # missing annotation for self?
     # definitely enable these, maybe not in tests
     "ANN102",
@@ -351,6 +348,17 @@ ignore = [
     "FIX001",
     "FIX002",
     "FA100",
+
+    # Docstrings, maybe to enable later
+    "D100",
+    "D101",
+    "D102",
+    "D103",
+    "D104",
+    "D105",
+    "D106",
+    "D107",
+    "D412",
 ]
 
 [tool.ruff.lint.per-file-ignores]
@@ -370,6 +378,7 @@ ignore = [
     "S603",
     "S607",
     "B018",
+    "D",
 ]
 "strawberry/extensions/tracing/__init__.py" = ["TCH004"]
 "tests/http/clients/__init__.py" = ["F401"]
@@ -384,3 +393,6 @@ exclude =[
     'tests/codegen/snapshots/',
     'tests/cli/snapshots/'
 ]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/__init__.py

@@ -1,22 +1,28 @@
+"""Strawberry is a Python library for GraphQL.
+
+Strawberry is a Python library for GraphQL that aims to stay close to the GraphQL
+specification and allow for a more natural way of defining GraphQL schemas.
+"""
+
 from . import experimental, federation, relay
-from .arguments import argument
-from .auto import auto
-from .custom_scalar import scalar
 from .directive import directive, directive_field
-from .enum import enum, enum_value
-from .field import field
-from .lazy_type import LazyType, lazy
-from .mutation import mutation, subscription
-from .object_type import asdict, input, interface, type
 from .parent import Parent
 from .permission import BasePermission
-from .private import Private
 from .scalars import ID
 from .schema import Schema
 from .schema_directive import schema_directive
+from .types.arguments import argument
+from .types.auto import auto
+from .types.enum import enum, enum_value
+from .types.field import field
 from .types.info import Info
-from .union import union
-from .unset import UNSET
+from .types.lazy_type import LazyType, lazy
+from .types.mutation import mutation, subscription
+from .types.object_type import asdict, input, interface, type
+from .types.private import Private
+from .types.scalar import scalar
+from .types.union import union
+from .types.unset import UNSET
 
 __all__ = [
     "BasePermission",

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/aiohttp/handlers/graphql_transport_ws_handler.py

@@ -57,3 +57,6 @@ class GraphQLTransportWSHandler(BaseGraphQLTransportWSHandler):
             await self.shutdown()
 
         return self._ws
+
+
+__all__ = ["GraphQLTransportWSHandler"]

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/aiohttp/handlers/graphql_ws_handler.py

@@ -60,3 +60,6 @@ class GraphQLWSHandler(BaseGraphQLWSHandler):
                 await self.cleanup_operation(operation_id)
 
         return self._ws
+
+
+__all__ = ["GraphQLWSHandler"]

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/aiohttp/test/client.py

@@ -48,3 +48,6 @@ class GraphQLTestClient(BaseGraphQLTestClient):
         )
 
         return response
+
+
+__all__ = ["GraphQLTestClient"]

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/aiohttp/views.py

@@ -177,3 +177,6 @@ class GraphQLView(
         sub_response.content_type = "application/json"
 
         return sub_response
+
+
+__all__ = ["GraphQLView"]

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/annotation.py

@@ -20,26 +20,26 @@ from typing import (
 )
 from typing_extensions import Annotated, Self, get_args, get_origin
 
-from strawberry.custom_scalar import ScalarDefinition
-from strawberry.enum import EnumDefinition
 from strawberry.exceptions.not_a_strawberry_enum import NotAStrawberryEnumError
-from strawberry.lazy_type import LazyType
-from strawberry.private import is_private
-from strawberry.type import (
+from strawberry.types.base import (
     StrawberryList,
+    StrawberryObjectDefinition,
     StrawberryOptional,
     StrawberryTypeVar,
     get_object_definition,
     has_object_definition,
 )
-from strawberry.types.types import StrawberryObjectDefinition
-from strawberry.unset import UNSET
+from strawberry.types.enum import EnumDefinition
+from strawberry.types.lazy_type import LazyType
+from strawberry.types.private import is_private
+from strawberry.types.scalar import ScalarDefinition
+from strawberry.types.unset import UNSET
 from strawberry.utils.typing import eval_type, is_generic, is_type_var
 
 if TYPE_CHECKING:
-    from strawberry.field import StrawberryField
-    from strawberry.type import StrawberryType
-    from strawberry.union import StrawberryUnion
+    from strawberry.types.base import StrawberryType
+    from strawberry.types.field import StrawberryField
+    from strawberry.types.union import StrawberryUnion
 
 
 ASYNC_TYPES = (
@@ -226,7 +226,7 @@ class StrawberryAnnotation:
 
     def create_union(self, evaled_type: Type[Any], args: list[Any]) -> StrawberryUnion:
         # Prevent import cycles
-        from strawberry.union import StrawberryUnion
+        from strawberry.types.union import StrawberryUnion
 
         # TODO: Deal with Forward References/origin
         if isinstance(evaled_type, StrawberryUnion):
@@ -290,8 +290,7 @@ class StrawberryAnnotation:
 
     @classmethod
     def _is_optional(cls, annotation: Any, args: List[Any]) -> bool:
-        """Returns True if the annotation is Optional[SomeType]"""
-
+        """Returns True if the annotation is Optional[SomeType]."""
         # Optionals are represented as unions
         if not cls._is_union(annotation, args):
             return False
@@ -303,8 +302,7 @@ class StrawberryAnnotation:
 
     @classmethod
     def _is_list(cls, annotation: Any) -> bool:
-        """Returns True if annotation is a List"""
-
+        """Returns True if annotation is a List."""
         annotation_origin = get_origin(annotation)
         annotation_mro = getattr(annotation, "__mro__", [])
         is_list = any(x is list for x in annotation_mro)
@@ -318,7 +316,7 @@ class StrawberryAnnotation:
     @classmethod
     def _is_strawberry_type(cls, evaled_type: Any) -> bool:
         # Prevent import cycles
-        from strawberry.union import StrawberryUnion
+        from strawberry.types.union import StrawberryUnion
 
         if isinstance(evaled_type, EnumDefinition):
             return True
@@ -344,8 +342,7 @@ class StrawberryAnnotation:
 
     @classmethod
     def _is_union(cls, annotation: Any, args: List[Any]) -> bool:
-        """Returns True if annotation is a Union"""
-
+        """Returns True if annotation is a Union."""
         # this check is needed because unions declared with the new syntax `A | B`
         # don't have a `__origin__` property on them, but they are instances of
         # `UnionType`, which is only available in Python 3.10+
@@ -363,7 +360,7 @@ class StrawberryAnnotation:
         if annotation_origin is typing.Union:
             return True
 
-        from strawberry.union import StrawberryUnion
+        from strawberry.types.union import StrawberryUnion
 
         return any(isinstance(arg, StrawberryUnion) for arg in args)
 
@@ -386,3 +383,6 @@ def _is_input_type(type_: Any) -> bool:
         return False
 
     return type_.__strawberry_definition__.is_input
+
+
+__all__ = ["StrawberryAnnotation"]

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/asgi/__init__.py

@@ -117,12 +117,12 @@ class GraphQL(
         else:
             self.graphql_ide = graphql_ide
 
-    async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
+    async def __call__(self, scope: Request, receive: Receive, send: Send) -> None:
         if scope["type"] == "http":
-            return await self.handle_http(scope, receive, send)
+            return await self.handle_http(scope, receive, send)  # type: ignore
 
         elif scope["type"] == "websocket":
-            ws = WebSocket(scope=scope, receive=receive, send=send)
+            ws = WebSocket(scope, receive=receive, send=send)  # type: ignore
             preferred_protocol = self.pick_preferred_protocol(ws)
 
             if preferred_protocol == GRAPHQL_TRANSPORT_WS_PROTOCOL:

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/asgi/handlers/graphql_transport_ws_handler.py

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

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/asgi/handlers/graphql_ws_handler.py

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

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/asgi/test/client.py

@@ -48,3 +48,6 @@ class GraphQLTestClient(BaseGraphQLTestClient):
 
     def _decode(self, response: Any, type: Literal["multipart", "json"]) -> Any:
         return response.json()
+
+
+__all__ = ["GraphQLTestClient"]

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/chalice/views.py

@@ -94,10 +94,16 @@ class GraphQLView(
         http_status_code: int,
         headers: Optional[Dict[str, str | List[str]]] = None,
     ) -> Response:
-        """
-        A wrapper for error responses
+        """A wrapper for error responses.
+
+        Args:
+            message: The error message.
+            error_code: The error code.
+            http_status_code: The HTTP status code.
+            headers: The headers to include in the response.
+
         Returns:
-        An errors response
+            An errors response.
         """
         body = {"Code": error_code, "Message": message}
 
@@ -139,3 +145,6 @@ class GraphQLView(
                 message=e.reason,
                 http_status_code=e.status_code,
             )
+
+
+__all__ = ["GraphQLView"]

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/channels/handlers/base.py

@@ -92,7 +92,7 @@ class ChannelsConsumer(AsyncConsumer):
         Utility to listen for channels messages for this consumer inside
         a resolver (usually inside a subscription).
 
-        Parameters:
+        Args:
             type:
                 The type of the message to wait for.
             timeout:
@@ -104,7 +104,6 @@ class ChannelsConsumer(AsyncConsumer):
                 execution and then discarded using `self.channel_layer.group_discard`
                 at the end of the execution.
         """
-
         warnings.warn("Use listen_to_channel instead", DeprecationWarning, stacklevel=2)
         if self.channel_layer is None:
             raise RuntimeError(
@@ -152,7 +151,7 @@ class ChannelsConsumer(AsyncConsumer):
         Utility to listen for channels messages for this consumer inside
         a resolver (usually inside a subscription).
 
-        Parameters:
+        Args:
             type:
                 The type of the message to wait for.
             timeout:
@@ -164,7 +163,6 @@ class ChannelsConsumer(AsyncConsumer):
                 execution and then discarded using `self.channel_layer.group_discard`
                 at the end of the execution.
         """
-
         # Code to acquire resource (Channels subscriptions)
         if self.channel_layer is None:
             raise RuntimeError(
@@ -201,7 +199,6 @@ class ChannelsConsumer(AsyncConsumer):
         Seperated to allow user code to be run after subscribing to channels
         and before blocking to wait for incoming channel messages.
         """
-
         while True:
             awaitable = queue.get()
             if timeout is not None:
@@ -215,3 +212,6 @@ class ChannelsConsumer(AsyncConsumer):
 
 class ChannelsWSConsumer(ChannelsConsumer, AsyncJsonWebsocketConsumer):
     """Base channels websocket async consumer."""
+
+
+__all__ = ["ChannelsConsumer", "ChannelsWSConsumer"]

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/channels/handlers/graphql_transport_ws_handler.py

@@ -57,3 +57,6 @@ class GraphQLTransportWSHandler(BaseGraphQLTransportWSHandler):
 
     async def handle_disconnect(self, code: int) -> None:
         await self.shutdown()
+
+
+__all__ = ["GraphQLTransportWSHandler"]

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/channels/handlers/graphql_ws_handler.py

@@ -67,3 +67,6 @@ class GraphQLWSHandler(BaseGraphQLWSHandler):
         # channels integration is a high level wrapper that forwards this to
         # both us and the BaseGraphQLTransportWSHandler.
         pass
+
+
+__all__ = ["GraphQLWSHandler"]

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/channels/handlers/http_handler.py

@@ -1,4 +1,4 @@
-"""GraphQLHTTPHandler
+"""GraphQLHTTPHandler.
 
 A consumer to provide a graphql endpoint, and optionally graphiql.
 """
@@ -25,7 +25,7 @@ from strawberry.http.sync_base_view import SyncBaseHTTPView, SyncHTTPRequestAdap
 from strawberry.http.temporal_response import TemporalResponse
 from strawberry.http.types import FormData
 from strawberry.http.typevars import Context, RootValue
-from strawberry.unset import UNSET
+from strawberry.types.unset import UNSET
 
 from .base import ChannelsConsumer
 
@@ -304,3 +304,6 @@ class SyncGraphQLHTTPConsumer(
         root_value: Optional[RootValue] = UNSET,
     ) -> ChannelsResponse:
         return super().run(request, context, root_value)
+
+
+__all__ = ["GraphQLHTTPConsumer", "SyncGraphQLHTTPConsumer"]

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/channels/handlers/ws_handler.py

@@ -15,7 +15,7 @@ if TYPE_CHECKING:
 
 
 class GraphQLWSConsumer(ChannelsWSConsumer):
-    """A channels websocket consumer for GraphQL
+    """A channels websocket consumer for GraphQL.
 
     This handles the connections, then hands off to the appropriate
     handler based on the subprotocol.
@@ -126,3 +126,6 @@ class GraphQLWSConsumer(ChannelsWSConsumer):
             "connection_params": connection_params,
             "ws": request,
         }  # type: ignore
+
+
+__all__ = ["GraphQLWSConsumer"]

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/channels/router.py

@@ -1,4 +1,4 @@
-"""GraphQLWebSocketRouter
+"""GraphQLWebSocketRouter.
 
 This is a simple router class that might be better placed as part of Channels itself.
 It's a simple "SubProtocolRouter" that selects the websocket subprotocol based
@@ -21,11 +21,12 @@ if TYPE_CHECKING:
 
 
 class GraphQLProtocolTypeRouter(ProtocolTypeRouter):
-    """
-    Convenience class to set up GraphQL on both HTTP and Websocket, optionally with a
-    Django application for all other HTTP routes:
+    """HTTP and Websocket GraphQL type router.
 
-    ```
+    Convenience class to set up GraphQL on both HTTP and Websocket,
+    optionally with a Django application for all other HTTP routes.
+
+    ```python
     from strawberry.channels import GraphQLProtocolTypeRouter
     from django.core.asgi import get_asgi_application
 
@@ -63,3 +64,6 @@ class GraphQLProtocolTypeRouter(ProtocolTypeRouter):
                 ),
             }
         )
+
+
+__all__ = ["GraphQLProtocolTypeRouter"]

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/channels/testing.py

@@ -41,8 +41,8 @@ if TYPE_CHECKING:
 
 
 class GraphQLWebsocketCommunicator(WebsocketCommunicator):
-    """
-    Usage:
+    """A test communicator for GraphQL over Websockets.
+
     ```python
     import pytest
     from strawberry.channels.testing import GraphQLWebsocketCommunicator
@@ -72,12 +72,16 @@ class GraphQLWebsocketCommunicator(WebsocketCommunicator):
         connection_params: dict = {},
         **kwargs: Any,
     ) -> None:
-        """
+        """Create a new communicator.
 
         Args:
             application: Your asgi application that encapsulates the strawberry schema.
             path: the url endpoint for the schema.
             protocol: currently this supports `graphql-transport-ws` only.
+            connection_params: a dictionary of connection parameters to send to the server.
+            headers: a list of tuples to be sent as headers to the server.
+            subprotocols: an ordered list of preferred subprotocols to be sent to the server.
+            **kwargs: additional arguments to be passed to the `WebsocketCommunicator` constructor.
         """
         self.protocol = protocol
         subprotocols = kwargs.get("subprotocols", [])
@@ -155,7 +159,7 @@ class GraphQLWebsocketCommunicator(WebsocketCommunicator):
                 return
 
     def process_errors(self, errors: List[GraphQLFormattedError]) -> List[GraphQLError]:
-        """Reconst a GraphQLError from a FormattedGraphQLError"""
+        """Reconstructs a GraphQLError from a FormattedGraphQLError."""
         result = []
         for f_error in errors:
             error = GraphQLError(
@@ -165,3 +169,6 @@ class GraphQLWebsocketCommunicator(WebsocketCommunicator):
             error.path = f_error.get("path", None)
             result.append(error)
         return result
+
+
+__all__ = ["GraphQLWebsocketCommunicator"]

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/cli/commands/upgrade/__init__.py

@@ -11,11 +11,13 @@ from libcst.codemod import CodemodContext
 
 from strawberry.cli.app import app
 from strawberry.codemods.annotated_unions import ConvertUnionToAnnotatedUnion
+from strawberry.codemods.update_imports import UpdateImportsCodemod
 
 from ._run_codemod import run_codemod
 
 codemods = {
     "annotated-union": ConvertUnionToAnnotatedUnion,
+    "update-imports": UpdateImportsCodemod,
 }
 
 
@@ -46,11 +48,17 @@ def upgrade(
 
     python_target_version = tuple(int(x) for x in python_target.split("."))
 
-    transformer = ConvertUnionToAnnotatedUnion(
-        CodemodContext(),
-        use_pipe_syntax=python_target_version >= (3, 10),
-        use_typing_extensions=use_typing_extensions,
-    )
+    transformer: ConvertUnionToAnnotatedUnion | UpdateImportsCodemod
+
+    if codemod == "update-imports":
+        transformer = UpdateImportsCodemod(context=CodemodContext())
+
+    else:
+        transformer = ConvertUnionToAnnotatedUnion(
+            CodemodContext(),
+            use_pipe_syntax=python_target_version >= (3, 10),
+            use_typing_extensions=use_typing_extensions,
+        )
 
     files: list[str] = []
 

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/cli/commands/upgrade/_fake_progress.py

@@ -6,7 +6,8 @@ from rich.progress import TaskID
 class FakeProgress:
     """A fake progress bar that does nothing.
 
-    This is used when the user has only one file to process."""
+    This is used when the user has only one file to process.
+    """
 
     def advance(self, task_id: TaskID) -> None:
         pass

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/cli/commands/upgrade/_run_codemod.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import contextlib
 import os
+from importlib.metadata import version
 from multiprocessing import Pool, cpu_count
 from typing import TYPE_CHECKING, Any, Dict, Generator, Sequence, Type, Union
 
@@ -18,13 +19,29 @@ ProgressType = Union[Type[Progress], Type[FakeProgress]]
 PoolType = Union[Type[Pool], Type[DummyPool]]  # type: ignore
 
 
+def _get_libcst_version() -> tuple[int, int, int]:
+    package_version_str = version("libcst")
+
+    try:
+        major, minor, patch = map(int, package_version_str.split("."))
+    except ValueError:
+        major, minor, patch = (0, 0, 0)
+
+    return major, minor, patch
+
+
 def _execute_transform_wrap(
     job: Dict[str, Any],
 ) -> ExecutionResult:
+    additional_kwargs: Dict[str, Any] = {}
+
+    if _get_libcst_version() >= (1, 4, 0):
+        additional_kwargs["scratch"] = {}
+
     # TODO: maybe capture warnings?
     with open(os.devnull, "w") as null:  # noqa: PTH123
         with contextlib.redirect_stderr(null):
-            return _execute_transform(**job)
+            return _execute_transform(**job, **additional_kwargs)
 
 
 def _get_progress_and_pool(

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/codegen/exceptions.py

@@ -12,3 +12,11 @@ class NoOperationNameProvidedError(CodegenError):
 
 class MultipleOperationsProvidedError(CodegenError):
     pass
+
+
+__all__ = [
+    "CodegenError",
+    "NoOperationProvidedError",
+    "NoOperationNameProvidedError",
+    "MultipleOperationsProvidedError",
+]

{strawberry_graphql-0.235.2 → strawberry_graphql-0.236.1}/strawberry/codegen/query_codegen.py

@@ -42,19 +42,19 @@ from graphql import (
     parse,
 )
 
-from strawberry.custom_scalar import ScalarDefinition, ScalarWrapper
-from strawberry.enum import EnumDefinition
-from strawberry.lazy_type import LazyType
-from strawberry.type import (
+from strawberry.types.base import (
     StrawberryList,
+    StrawberryObjectDefinition,
     StrawberryOptional,
     StrawberryType,
     get_object_definition,
     has_object_definition,
 )
-from strawberry.types.types import StrawberryObjectDefinition
-from strawberry.union import StrawberryUnion
-from strawberry.unset import UNSET
+from strawberry.types.enum import EnumDefinition
+from strawberry.types.lazy_type import LazyType
+from strawberry.types.scalar import ScalarDefinition, ScalarWrapper
+from strawberry.types.union import StrawberryUnion
+from strawberry.types.unset import UNSET
 from strawberry.utils.str_converters import capitalize_first, to_camel_case
 
 from .exceptions import (
@@ -917,3 +917,12 @@ class QueryCodegen:
         )
         self._collect_type(graphql_enum)
         return graphql_enum
+
+
+__all__ = [
+    "QueryCodegen",
+    "QueryCodegenPlugin",
+    "ConsolePlugin",
+    "CodegenFile",
+    "CodegenResult",
+]