Object Extension Draft

strawberry/object_type.py

@@ -16,17 +16,17 @@
 )
 from typing_extensions import dataclass_transform
 
+from graphql import GraphQLAbstractType, GraphQLResolveInfo
+
 from .exceptions import (
  MissingFieldAnnotationError,
  MissingReturnAnnotationError,
  ObjectIsNotClassError,
 )
 from .field import StrawberryField, field
-from .type import get_object_definition
+from .type import WithStrawberryObjectDefinition, get_object_definition
 from .types.type_resolver import _get_fields
-from .types.types import (
- StrawberryObjectDefinition,
-)
+from .types.types import StrawberryObjectDefinition
 from .utils.dataclasses import add_custom_init_fn
 from .utils.deprecations import DEPRECATION_MESSAGES, DeprecatedDescriptor
 from .utils.str_converters import to_camel_case
@@ -124,6 +124,57 @@ def _wrap_dataclass(cls: Type[Any]):
  return dclass
 
 
+class StrawberryObjectBuilder:
+ def before_wrap_dataclass(self, cls: Type):
+ """Modify class before any processing, one could add fields here"""
+
+ def on_field(self, field: dataclasses.Field[Any]) -> Any:
+ """Modify field during _get_fields
+
+ translate from `auto` type
+ completely change field class to custom one
+ """
+ return field
+
+ def create_object_definition(
+ self,
+ origin: Type[Any],
+ name: str,
+ is_input: bool,
+ is_interface: bool,
+ interfaces: List[StrawberryObjectDefinition],
+ description: Optional[str],
+ directives: Optional[Sequence[object]],
+ extend: bool,
+ fields: List[StrawberryField],
+ is_type_of: Optional[Callable[[Any, GraphQLResolveInfo], bool]],
+ resolve_type: Optional[
+ Callable[[Any, GraphQLResolveInfo, GraphQLAbstractType], str]
+ ],
+ ) -> StrawberryObjectDefinition:
+ """Posibility to use custom StrawberryObjectDefinition"""
+
+ return StrawberryObjectDefinition(
+ name=name,
+ is_input=is_input,
+ is_interface=is_interface,
+ interfaces=interfaces,
+ description=description,
+ directives=directives,
+ origin=origin,
+ extend=extend,
+ fields=fields,
+ is_type_of=is_type_of,
+ resolve_type=resolve_type,
+ )
+
+ def after_process(self, cls: Type[WithStrawberryObjectDefinition]):
+ """Dont know tbh"""
+
+
+_DEFAULT_STRAWBERRY_BUILDER = StrawberryObjectBuilder()
+
+
 def _process_type(
  cls: Type,
  *,
@@ -133,15 +184,22 @@ def _process_type(
  description: Optional[str] = None,
  directives: Optional[Sequence[object]] = (),
  extend: bool = False,
+ builder: Optional[StrawberryObjectBuilder] = None,
 ):
- name = name or to_camel_case(cls.__name__)
+ # TODO: Can _process_type be changes so builder is required?
+ # breaks peoples code, but IS internal function
+ if builder is None:
+ builder = _DEFAULT_STRAWBERRY_BUILDER
+ elif not isinstance(builder, StrawberryObjectBuilder):
+ raise TypeError("Appropriate Strawberry Error about invalid Builder")
 
- interfaces = _get_interfaces(cls)
- fields = _get_fields(cls)
+ name = name or to_camel_case(cls.__name__)
  is_type_of = getattr(cls, "is_type_of", None)
  resolve_type = getattr(cls, "resolve_type", None)
+ interfaces = _get_interfaces(cls)
+ fields = _get_fields(cls, builder)
 
- cls.__strawberry_definition__ = StrawberryObjectDefinition(
+ cls.__strawberry_definition__ = builder.create_object_definition(
  name=name,
  is_input=is_input,
  is_interface=is_interface,
@@ -182,6 +240,7 @@ def _process_type(
 
  setattr(cls, field_.python_name, wrapped_func)
 
+ builder.after_process(cls)
  return cls
 
 
@@ -198,6 +257,7 @@ def type(
  description: Optional[str] = None,
  directives: Optional[Sequence[object]] = (),
  extend: bool = False,
+ builder: Optional[StrawberryObjectBuilder] = None,
 ) -> T:
  ...
 
@@ -214,6 +274,7 @@ def type(
  description: Optional[str] = None,
  directives: Optional[Sequence[object]] = (),
  extend: bool = False,
+ builder: Optional[StrawberryObjectBuilder] = None,
 ) -> Callable[[T], T]:
  ...
 
@@ -227,6 +288,7 @@ def type(
  description: Optional[str] = None,
  directives: Optional[Sequence[object]] = (),
  extend: bool = False,
+ builder: Optional[StrawberryObjectBuilder] = None,
 ) -> Union[T, Callable[[T], T]]:
  """Annotates a class as a GraphQL type.
 
@@ -247,6 +309,12 @@ def wrap(cls: Type):
  exc = ObjectIsNotClassError.type
  raise exc(cls)
 
+ if builder is not None:
+ if not isinstance(builder, StrawberryObjectBuilder):
+ raise TypeError("Appropriate Strawberry Error about invalid Builder")
+
+ builder.before_wrap_dataclass(cls)
+
  wrapped = _wrap_dataclass(cls)
  return _process_type(
  wrapped,
@@ -256,6 +324,7 @@ def wrap(cls: Type):
  description=description,
  directives=directives,
  extend=extend,
+ builder=builder,
  )
 
  if cls is None:
@@ -274,6 +343,7 @@ def input(
  name: Optional[str] = None,
  description: Optional[str] = None,
  directives: Optional[Sequence[object]] = (),
+ builder: Optional[StrawberryObjectBuilder] = None,
 ) -> T:
  ...
 
@@ -287,6 +357,7 @@ def input(
  name: Optional[str] = None,
  description: Optional[str] = None,
  directives: Optional[Sequence[object]] = (),
+ builder: Optional[StrawberryObjectBuilder] = None,
 ) -> Callable[[T], T]:
  ...
 
@@ -297,6 +368,7 @@ def input(
  name: Optional[str] = None,
  description: Optional[str] = None,
  directives: Optional[Sequence[object]] = (),
+ builder: Optional[StrawberryObjectBuilder] = None,
 ):
  """Annotates a class as a GraphQL Input type.
  Example usage:
@@ -311,6 +383,7 @@ def input(
  description=description,
  directives=directives,
  is_input=True,
+ builder=builder,
  )
 
 
@@ -324,6 +397,7 @@ def interface(
  name: Optional[str] = None,
  description: Optional[str] = None,
  directives: Optional[Sequence[object]] = (),
+ builder: Optional[StrawberryObjectBuilder] = None,
 ) -> T:
  ...
 
@@ -337,6 +411,7 @@ def interface(
  name: Optional[str] = None,
  description: Optional[str] = None,
  directives: Optional[Sequence[object]] = (),
+ builder: Optional[StrawberryObjectBuilder] = None,
 ) -> Callable[[T], T]:
  ...
 
@@ -350,6 +425,7 @@ def interface(
  name: Optional[str] = None,
  description: Optional[str] = None,
  directives: Optional[Sequence[object]] = (),
+ builder: Optional[StrawberryObjectBuilder] = None,
 ):
  """Annotates a class as a GraphQL Interface.
  Example usage:
@@ -364,6 +440,7 @@ def interface(
  description=description,
  directives=directives,
  is_interface=True,
+ builder=builder,
  )
 
 

strawberry/types/type_resolver.py

@@ -2,7 +2,7 @@
 
 import dataclasses
 import sys
-from typing import Dict, List, Type
+from typing import TYPE_CHECKING, Dict, List, Optional, Type
 
 from strawberry.annotation import StrawberryAnnotation
 from strawberry.exceptions import (
@@ -15,8 +15,13 @@
 from strawberry.type import has_object_definition
 from strawberry.unset import UNSET
 
+if TYPE_CHECKING:
+ from strawberry.object_type import StrawberryObjectBuilder
 
-def _get_fields(cls: Type) -> List[StrawberryField]:
+
+def _get_fields(
+ cls: Type, builder: Optional[StrawberryObjectBuilder] = None
+) -> List[StrawberryField]:
  """Get all the strawberry fields off a strawberry.type cls
 
  This function returns a list of StrawberryFields (one for each field item), while
@@ -49,6 +54,12 @@ class if one is not set by either using an explicit strawberry.field(name=...) o
  passing a named function (i.e. not an anonymous lambda) to strawberry.field
  (typically as a decorator).
  """
+ if builder is None:
+ # Builder would be required here
+ from strawberry.object_type import _DEFAULT_STRAWBERRY_BUILDER
+
+ builder = _DEFAULT_STRAWBERRY_BUILDER
+
  fields: Dict[str, StrawberryField] = {}
 
  # before trying to find any fields, let's first add the fields defined in
@@ -76,6 +87,9 @@ class if one is not set by either using an explicit strawberry.field(name=...) o
 
  # then we can proceed with finding the fields for the current class
  for field in dataclasses.fields(cls): # type: ignore
+ # Builder field hook
+ field = builder.on_field(field=field) # noqa: PLW2901
+
  if isinstance(field, StrawberryField):
  # Check that the field type is not Private
  if is_private(field.type):