strawberry-graphql 0.266.0__tar.gz → 0.266.1__tar.gz

{strawberry_graphql-0.266.0 → strawberry_graphql-0.266.1}/PKG-INFO

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

{strawberry_graphql-0.266.0 → strawberry_graphql-0.266.1}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "strawberry-graphql"
 packages = [ { include = "strawberry" } ]
-version = "0.266.0"
+version = "0.266.1"
 description = "A library for creating GraphQL APIs"
 authors = ["Patrick Arminio <patrick.arminio@gmail.com>"]
 license = "MIT"

{strawberry_graphql-0.266.0 → strawberry_graphql-0.266.1}/strawberry/__init__.py

@@ -18,6 +18,7 @@ from .types.enum import enum, enum_value
 from .types.field import field
 from .types.info import Info
 from .types.lazy_type import LazyType, lazy
+from .types.maybe import Maybe, Some
 from .types.mutation import mutation, subscription
 from .types.object_type import asdict, input, interface, type  # noqa: A004
 from .types.private import Private
@@ -31,9 +32,11 @@ __all__ = [
     "BasePermission",
     "Info",
     "LazyType",
+    "Maybe",
     "Parent",
     "Private",
     "Schema",
+    "Some",
     "argument",
     "asdict",
     "auto",

{strawberry_graphql-0.266.0 → strawberry_graphql-0.266.1}/strawberry/annotation.py

@@ -19,6 +19,7 @@ from typing_extensions import Self, get_args, get_origin
 
 from strawberry.types.base import (
     StrawberryList,
+    StrawberryMaybe,
     StrawberryObjectDefinition,
     StrawberryOptional,
     StrawberryTypeVar,
@@ -28,6 +29,7 @@ from strawberry.types.base import (
 from strawberry.types.enum import EnumDefinition
 from strawberry.types.enum import enum as strawberry_enum
 from strawberry.types.lazy_type import LazyType
+from strawberry.types.maybe import _annotation_is_maybe
 from strawberry.types.private import is_private
 from strawberry.types.scalar import ScalarDefinition
 from strawberry.types.unset import UNSET
@@ -143,6 +145,10 @@ class StrawberryAnnotation:
             return evaled_type
         if self._is_list(evaled_type):
             return self.create_list(evaled_type)
+        if type_of := self._get_maybe_type(evaled_type):
+            return StrawberryMaybe(
+                of_type=type_of,
+            )
 
         if self._is_graphql_generic(evaled_type):
             if any(is_type_var(type_) for type_ in get_args(evaled_type)):
@@ -313,6 +319,10 @@ class StrawberryAnnotation:
             or is_list
         )
 
+    @classmethod
+    def _get_maybe_type(cls, annotation: Any) -> type | None:
+        return get_args(annotation)[0] if _annotation_is_maybe(annotation) else None
+
     @classmethod
     def _is_strawberry_type(cls, evaled_type: Any) -> bool:
         # Prevent import cycles

{strawberry_graphql-0.266.0 → strawberry_graphql-0.266.1}/strawberry/schema/schema_converter.py

@@ -52,6 +52,7 @@ from strawberry.schema.types.scalar import _make_scalar_type
 from strawberry.types.arguments import StrawberryArgument, convert_arguments
 from strawberry.types.base import (
     StrawberryList,
+    StrawberryMaybe,
     StrawberryObjectDefinition,
     StrawberryOptional,
     StrawberryType,
@@ -254,7 +255,10 @@ class GraphQLCoreConverter:
         argument_type = cast(
             "GraphQLInputType", self.from_maybe_optional(argument.type)
         )
-        default_value = Undefined if argument.default is UNSET else argument.default
+        if argument.is_maybe:
+            default_value: Any = Undefined
+        else:
+            default_value = Undefined if argument.default is UNSET else argument.default
 
         return GraphQLArgument(
             type_=argument_type,
@@ -419,8 +423,9 @@ class GraphQLCoreConverter:
             ),
         )
         default_value: object
-
-        if field.default_value is UNSET or field.default_value is dataclasses.MISSING:
+        if isinstance(field.type, StrawberryMaybe):
+            default_value = Undefined
+        elif field.default_value is UNSET or field.default_value is dataclasses.MISSING:
             default_value = Undefined
         else:
             default_value = field.default_value

{strawberry_graphql-0.266.0 → strawberry_graphql-0.266.1}/strawberry/types/arguments.py

@@ -17,13 +17,17 @@ from strawberry.exceptions import MultipleStrawberryArgumentsError, UnsupportedT
 from strawberry.scalars import is_scalar
 from strawberry.types.base import (
     StrawberryList,
+    StrawberryMaybe,
     StrawberryOptional,
     has_object_definition,
 )
 from strawberry.types.enum import EnumDefinition
 from strawberry.types.lazy_type import LazyType, StrawberryLazyReference
+from strawberry.types.maybe import Some
 from strawberry.types.unset import UNSET as _deprecated_UNSET  # noqa: N811
-from strawberry.types.unset import _deprecated_is_unset  # noqa: F401
+from strawberry.types.unset import (
+    _deprecated_is_unset,  # noqa: F401
+)
 
 if TYPE_CHECKING:
     from collections.abc import Iterable, Mapping
@@ -135,6 +139,10 @@ class StrawberryArgument:
 
         return is_graphql_generic(self.type)
 
+    @property
+    def is_maybe(self) -> bool:
+        return isinstance(self.type, StrawberryMaybe)
+
 
 def convert_argument(
     value: object,
@@ -143,6 +151,10 @@ def convert_argument(
     config: StrawberryConfig,
 ) -> object:
     # TODO: move this somewhere else and make it first class
+    if isinstance(type_, StrawberryOptional):
+        res = convert_argument(value, type_.of_type, scalar_registry, config)
+
+        return Some(res) if isinstance(type_, StrawberryMaybe) else res
 
     if value is None:
         return None
@@ -150,9 +162,6 @@ def convert_argument(
     if value is _deprecated_UNSET:
         return _deprecated_UNSET
 
-    if isinstance(type_, StrawberryOptional):
-        return convert_argument(value, type_.of_type, scalar_registry, config)
-
     if isinstance(type_, StrawberryList):
         value_list = cast("Iterable", value)
         return [

{strawberry_graphql-0.266.0 → strawberry_graphql-0.266.1}/strawberry/types/base.py

@@ -152,7 +152,16 @@ class StrawberryContainer(StrawberryType):
 class StrawberryList(StrawberryContainer): ...
 
 
-class StrawberryOptional(StrawberryContainer): ...
+class StrawberryOptional(StrawberryContainer):
+    def __init__(
+        self,
+        of_type: Union[StrawberryType, type[WithStrawberryObjectDefinition], type],
+    ) -> None:
+        super().__init__(of_type)
+
+
+class StrawberryMaybe(StrawberryOptional):
+    pass
 
 
 class StrawberryTypeVar(StrawberryType):

strawberry_graphql-0.266.1/strawberry/types/maybe.py

@@ -0,0 +1,47 @@
+import typing
+from typing import TYPE_CHECKING, Any, Generic, TypeVar, Union
+from typing_extensions import TypeAlias
+
+T = TypeVar("T")
+
+
+class Some(Generic[T]):
+    """A special value that can be used to represent an unset value in a field or argument.
+
+    Similar to `undefined` in JavaScript, this value can be used to differentiate between
+    a field that was not set and a field that was set to `None` or `null`.
+    """
+
+    __slots__ = ("value",)
+
+    def __init__(self, value: T) -> None:
+        self.value = value
+
+    def __repr__(self) -> str:
+        return f"Some({self.value!r})"
+
+    def __eq__(self, other: object) -> bool:
+        return self.value == other.value if isinstance(other, Some) else False
+
+    def __hash__(self) -> int:
+        return hash(self.value)
+
+    def __bool__(self) -> bool:
+        return True
+
+
+if TYPE_CHECKING:
+    Maybe: TypeAlias = Union[Some[Union[T, None]], None]
+else:
+    # we do this trick so we can inspect that at runtime
+    class Maybe(Generic[T]): ...
+
+
+def _annotation_is_maybe(annotation: Any) -> bool:
+    return (orig := typing.get_origin(annotation)) and orig is Maybe
+
+
+__all__ = [
+    "Maybe",
+    "Some",
+]

{strawberry_graphql-0.266.0 → strawberry_graphql-0.266.1}/strawberry/types/object_type.py

@@ -20,6 +20,7 @@ from strawberry.exceptions import (
     ObjectIsNotClassError,
 )
 from strawberry.types.base import get_object_definition
+from strawberry.types.maybe import _annotation_is_maybe
 from strawberry.utils.deprecations import DEPRECATION_MESSAGES, DeprecatedDescriptor
 from strawberry.utils.str_converters import to_camel_case
 
@@ -122,6 +123,15 @@ def _wrap_dataclass(cls: builtins.type[T]) -> builtins.type[T]:
     return dclass
 
 
+def _inject_default_for_maybe_annotations(
+    cls: builtins.type[T], annotations: dict[str, Any]
+) -> None:
+    """Inject `= None` for fields with `Maybe` annotations and no default value."""
+    for name, annotation in annotations.copy().items():
+        if _annotation_is_maybe(annotation) and not hasattr(cls, name):
+            setattr(cls, name, None)
+
+
 def _process_type(
     cls: T,
     *,
@@ -286,7 +296,8 @@ def type(
 
             if field and isinstance(field, StrawberryField) and field.type_annotation:
                 original_type_annotations[field_name] = field.type_annotation.annotation
-
+        if is_input:
+            _inject_default_for_maybe_annotations(cls, annotations)
         wrapped = _wrap_dataclass(cls)
 
         return _process_type(  # type: ignore