strawberry-graphql 0.276.1__tar.gz → 0.277.0__tar.gz

{strawberry_graphql-0.276.1 → strawberry_graphql-0.277.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: strawberry-graphql
-Version: 0.276.1
+Version: 0.277.0
 Summary: A library for creating GraphQL APIs
 License: MIT
 Keywords: graphql,api,rest,starlette,async

{strawberry_graphql-0.276.1 → strawberry_graphql-0.277.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "strawberry-graphql"
-version = "0.276.1"
+version = "0.277.0"
 description = "A library for creating GraphQL APIs"
 authors = [{ name = "Patrick Arminio", email = "patrick.arminio@gmail.com" }]
 license = { text = "MIT" }
@@ -327,6 +327,7 @@ ignore = [
   "Q002",
   "Q003",
   "W191",
+  "PLR0915",
 ]
 exclude = ["tests/python_312/*"] # SyntaxError because we support Python 3.9+
 

{strawberry_graphql-0.276.1 → strawberry_graphql-0.277.0}/strawberry/__init__.py

@@ -11,6 +11,7 @@ from .permission import BasePermission
 from .scalars import ID
 from .schema import Schema
 from .schema_directive import schema_directive
+from .streamable import Streamable
 from .types.arguments import argument
 from .types.auto import auto
 from .types.cast import cast
@@ -37,6 +38,7 @@ __all__ = [
     "Private",
     "Schema",
     "Some",
+    "Streamable",
     "argument",
     "asdict",
     "auto",

{strawberry_graphql-0.276.1 → strawberry_graphql-0.277.0}/strawberry/annotation.py

@@ -17,6 +17,7 @@ from typing import (
 )
 from typing_extensions import Self, get_args, get_origin
 
+from strawberry.streamable import StrawberryStreamable
 from strawberry.types.base import (
     StrawberryList,
     StrawberryMaybe,
@@ -143,6 +144,8 @@ class StrawberryAnnotation:
 
         if self._is_lazy_type(evaled_type):
             return evaled_type
+        if self._is_streamable(evaled_type, args):
+            return self.create_list(list[evaled_type])  # type: ignore[valid-type]
         if self._is_list(evaled_type):
             return self.create_list(evaled_type)
         if self._is_maybe(evaled_type):
@@ -332,6 +335,10 @@ class StrawberryAnnotation:
     def _is_maybe(cls, annotation: Any) -> bool:
         return _annotation_is_maybe(annotation)
 
+    @classmethod
+    def _is_streamable(cls, annotation: Any, args: list[Any]) -> bool:
+        return any(isinstance(arg, StrawberryStreamable) for arg in args)
+
     @classmethod
     def _is_strawberry_type(cls, evaled_type: Any) -> bool:
         # Prevent import cycles

{strawberry_graphql-0.276.1 → strawberry_graphql-0.277.0}/strawberry/experimental/pydantic/object_type.py

@@ -116,7 +116,7 @@ if TYPE_CHECKING:
     )
 
 
-def type(  # noqa: PLR0915
+def type(
     model: builtins.type[PydanticModel],
     *,
     fields: Optional[list[str]] = None,
@@ -129,7 +129,7 @@ def type(  # noqa: PLR0915
     include_computed: bool = False,
     use_pydantic_alias: bool = True,
 ) -> Callable[..., builtins.type[StrawberryTypeFromPydantic[PydanticModel]]]:
-    def wrap(cls: Any) -> builtins.type[StrawberryTypeFromPydantic[PydanticModel]]:  # noqa: PLR0915
+    def wrap(cls: Any) -> builtins.type[StrawberryTypeFromPydantic[PydanticModel]]:
         compat = PydanticCompat.from_model(model)
         model_fields = compat.get_model_fields(model, include_computed=include_computed)
         original_fields_set = set(fields) if fields else set()

{strawberry_graphql-0.276.1 → strawberry_graphql-0.277.0}/strawberry/extensions/directives.py

@@ -29,7 +29,9 @@ class DirectivesExtension(SchemaExtension):
     ) -> AwaitableOrValue[Any]:
         value = await await_maybe(_next(root, info, *args, **kwargs))
 
-        for directive in info.field_nodes[0].directives:
+        nodes = list(info.field_nodes)
+
+        for directive in nodes[0].directives:
             if directive.name.value in SPECIFIED_DIRECTIVES:
                 continue
             strawberry_directive, arguments = process_directive(directive, value, info)
@@ -49,7 +51,9 @@ class DirectivesExtensionSync(SchemaExtension):
     ) -> AwaitableOrValue[Any]:
         value = _next(root, info, *args, **kwargs)
 
-        for directive in info.field_nodes[0].directives:
+        nodes = list(info.field_nodes)
+
+        for directive in nodes[0].directives:
             if directive.name.value in SPECIFIED_DIRECTIVES:
                 continue
             strawberry_directive, arguments = process_directive(directive, value, info)

{strawberry_graphql-0.276.1 → strawberry_graphql-0.277.0}/strawberry/extensions/mask_errors.py

@@ -1,7 +1,8 @@
 from collections.abc import Iterator
-from typing import Callable
+from typing import Any, Callable
 
 from graphql.error import GraphQLError
+from graphql.execution import ExecutionResult
 
 from strawberry.extensions.base_extension import SchemaExtension
 
@@ -33,18 +34,30 @@ class MaskErrors(SchemaExtension):
             original_error=None,
         )
 
+    # TODO: proper typing
+    def _process_result(self, result: Any) -> None:
+        if not result.errors:
+            return
+
+        processed_errors: list[GraphQLError] = []
+
+        for error in result.errors:
+            if self.should_mask_error(error):
+                processed_errors.append(self.anonymise_error(error))
+            else:
+                processed_errors.append(error)
+
+        result.errors = processed_errors
+
     def on_operation(self) -> Iterator[None]:
         yield
+
         result = self.execution_context.result
-        if result and result.errors:
-            processed_errors: list[GraphQLError] = []
-            for error in result.errors:
-                if self.should_mask_error(error):
-                    processed_errors.append(self.anonymise_error(error))
-                else:
-                    processed_errors.append(error)
-
-            result.errors = processed_errors
+
+        if isinstance(result, ExecutionResult):
+            self._process_result(result)
+        elif result:
+            self._process_result(result.initial_result)
 
 
 __all__ = ["MaskErrors"]

{strawberry_graphql-0.276.1 → strawberry_graphql-0.277.0}/strawberry/extensions/validation_cache.py

@@ -43,7 +43,7 @@ class ValidationCache(SchemaExtension):
             execution_context.graphql_document,
             execution_context.validation_rules,
         )
-        execution_context.errors = errors
+        execution_context.pre_execution_errors = errors
         yield
 
 

{strawberry_graphql-0.276.1 → strawberry_graphql-0.277.0}/strawberry/http/__init__.py

@@ -1,26 +1,36 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, Any, Optional
+from typing import Any, Optional
 from typing_extensions import Literal, TypedDict
 
-if TYPE_CHECKING:
-    from strawberry.types import ExecutionResult
+from strawberry.schema._graphql_core import (
+    GraphQLIncrementalExecutionResults,
+    ResultType,
+)
 
 
 class GraphQLHTTPResponse(TypedDict, total=False):
     data: Optional[dict[str, object]]
     errors: Optional[list[object]]
     extensions: Optional[dict[str, object]]
-
-
-def process_result(result: ExecutionResult) -> GraphQLHTTPResponse:
-    data: GraphQLHTTPResponse = {"data": result.data}
-
-    if result.errors:
-        data["errors"] = [err.formatted for err in result.errors]
-    if result.extensions:
-        data["extensions"] = result.extensions
+    hasNext: Optional[bool]
+    completed: Optional[list[Any]]
+    pending: Optional[list[Any]]
+    initial: Optional[list[Any]]
+    incremental: Optional[list[Any]]
+
+
+def process_result(result: ResultType) -> GraphQLHTTPResponse:
+    if isinstance(result, GraphQLIncrementalExecutionResults):
+        return result
+
+    errors, extensions = result.errors, result.extensions
+    data: GraphQLHTTPResponse = {
+        "data": result.data,
+        **({"errors": [err.formatted for err in errors]} if errors else {}),
+        **({"extensions": extensions} if extensions else {}),
+    }
 
     return data
 

{strawberry_graphql-0.276.1 → strawberry_graphql-0.277.0}/strawberry/http/async_base_view.py

@@ -25,6 +25,9 @@ from strawberry.http import (
     process_result,
 )
 from strawberry.http.ides import GraphQL_IDE
+from strawberry.schema._graphql_core import (
+    GraphQLIncrementalExecutionResults,
+)
 from strawberry.schema.base import BaseSchema
 from strawberry.schema.exceptions import (
     CannotGetOperationTypeError,
@@ -352,6 +355,75 @@ class AsyncBaseHTTPView(
                     "Content-Type": "multipart/mixed;boundary=graphql;subscriptionSpec=1.0,application/json",
                 },
             )
+        if isinstance(result, GraphQLIncrementalExecutionResults):
+
+            async def stream() -> AsyncGenerator[str, None]:
+                yield "---"
+
+                response = await self.process_result(request, result.initial_result)
+
+                response["hasNext"] = result.initial_result.has_next
+                response["pending"] = [
+                    p.formatted for p in result.initial_result.pending
+                ]
+                response["extensions"] = result.initial_result.extensions
+
+                yield self.encode_multipart_data(response, "-")
+
+                all_pending = result.initial_result.pending
+
+                async for value in result.subsequent_results:
+                    response = {
+                        "hasNext": value.has_next,
+                        "extensions": value.extensions,
+                    }
+
+                    if value.pending:
+                        response["pending"] = [p.formatted for p in value.pending]
+
+                    if value.completed:
+                        response["completed"] = [p.formatted for p in value.completed]
+
+                    if value.incremental:
+                        incremental = []
+
+                        all_pending.extend(value.pending)
+
+                        for incremental_value in value.incremental:
+                            pending_value = next(
+                                (
+                                    v
+                                    for v in all_pending
+                                    if v.id == incremental_value.id
+                                ),
+                                None,
+                            )
+
+                            assert pending_value
+
+                            incremental.append(
+                                {
+                                    **incremental_value.formatted,
+                                    "path": pending_value.path,
+                                    "label": pending_value.label,
+                                }
+                            )
+
+                        response["incremental"] = incremental
+
+                    yield self.encode_multipart_data(response, "-")
+
+                yield "--\r\n"
+
+            return await self.create_streaming_response(
+                request,
+                stream,
+                sub_response,
+                headers={
+                    "Transfer-Encoding": "chunked",
+                    "Content-Type": 'multipart/mixed; boundary="-"',
+                },
+            )
 
         response_data = await self.process_result(request=request, result=result)
 
@@ -363,12 +435,16 @@ class AsyncBaseHTTPView(
         )
 
     def encode_multipart_data(self, data: Any, separator: str) -> str:
+        encoded_data = self.encode_json(data)
+
         return "".join(
             [
-                f"\r\n--{separator}\r\n",
-                "Content-Type: application/json\r\n\r\n",
-                self.encode_json(data),
-                "\n",
+                "\r\n",
+                "Content-Type: application/json; charset=utf-8\r\n",
+                "Content-Length: " + str(len(encoded_data)) + "\r\n",
+                "\r\n",
+                encoded_data,
+                f"\r\n--{separator}",
             ]
         )
 

{strawberry_graphql-0.276.1 → strawberry_graphql-0.277.0}/strawberry/printer/printer.py

@@ -561,9 +561,9 @@ def print_schema_definition(
 def print_directive(
     directive: GraphQLDirective, *, schema: BaseSchema
 ) -> Optional[str]:
-    strawberry_directive = directive.extensions["strawberry-definition"]
+    strawberry_directive = directive.extensions.get("strawberry-definition")
 
-    if (
+    if strawberry_directive is None or (
         isinstance(strawberry_directive, StrawberrySchemaDirective)
         and not strawberry_directive.print_definition
     ):
@@ -621,6 +621,14 @@ def print_schema(schema: BaseSchema) -> str:
         if (printed_directive := print_directive(directive, schema=schema)) is not None
     ]
 
+    if schema.config.enable_experimental_incremental_execution:
+        directives.append(
+            "directive @defer(if: Boolean, label: String) on FRAGMENT_SPREAD | INLINE_FRAGMENT"
+        )
+        directives.append(
+            "directive @stream(if: Boolean, label: String, initialCount: Int = 0) on FIELD"
+        )
+
     def _name_getter(type_: Any) -> str:
         if hasattr(type_, "name"):
             return type_.name

{strawberry_graphql-0.276.1 → strawberry_graphql-0.277.0}/strawberry/relay/types.py

@@ -762,7 +762,7 @@ class ListConnection(Connection[NodeType]):
     )
 
     @classmethod
-    def resolve_connection(  # noqa: PLR0915
+    def resolve_connection(
         cls,
         nodes: NodeIterableType[NodeType],
         *,

strawberry_graphql-0.277.0/strawberry/schema/_graphql_core.py

@@ -0,0 +1,55 @@
+from typing import Union
+
+from graphql.execution import ExecutionContext as GraphQLExecutionContext
+from graphql.execution import ExecutionResult as OriginalGraphQLExecutionResult
+from graphql.execution import execute, subscribe
+
+from strawberry.types import ExecutionResult
+
+try:
+    from graphql import (  # type: ignore[attr-defined]
+        ExperimentalIncrementalExecutionResults as GraphQLIncrementalExecutionResults,
+    )
+    from graphql.execution import (  # type: ignore[attr-defined]
+        InitialIncrementalExecutionResult,
+        experimental_execute_incrementally,
+    )
+    from graphql.type.directives import (  # type: ignore[attr-defined]
+        GraphQLDeferDirective,
+        GraphQLStreamDirective,
+    )
+
+    incremental_execution_directives = (
+        GraphQLDeferDirective,
+        GraphQLStreamDirective,
+    )
+
+    GraphQLExecutionResult = Union[
+        OriginalGraphQLExecutionResult, InitialIncrementalExecutionResult
+    ]
+
+except ImportError:
+    GraphQLIncrementalExecutionResults = type(None)
+    GraphQLExecutionResult = OriginalGraphQLExecutionResult  # type: ignore
+
+    incremental_execution_directives = ()  # type: ignore
+    experimental_execute_incrementally = None
+
+
+# TODO: give this a better name, maybe also a better place
+ResultType = Union[
+    OriginalGraphQLExecutionResult,
+    GraphQLIncrementalExecutionResults,
+    ExecutionResult,
+]
+
+__all__ = [
+    "GraphQLExecutionContext",
+    "GraphQLExecutionResult",
+    "GraphQLIncrementalExecutionResults",
+    "ResultType",
+    "execute",
+    "experimental_execute_incrementally",
+    "incremental_execution_directives",
+    "subscribe",
+]

{strawberry_graphql-0.276.1 → strawberry_graphql-0.277.0}/strawberry/schema/config.py

@@ -17,6 +17,7 @@ class StrawberryConfig:
     relay_use_legacy_global_id: bool = False
     disable_field_suggestions: bool = False
     info_class: type[Info] = Info
+    enable_experimental_incremental_execution: bool = False
     _unsafe_disable_same_type_validation: bool = False
 
     def __post_init__(