StrawberryField

Constructor:

def __init__(
    self,
    python_name: str | None = None,
    graphql_name: str | None = None,
    type_annotation: StrawberryAnnotation | None = None,
    origin: Type | Callable | staticmethod | classmethod | None = None,
    is_subscription: bool = False,
    description: str | None = None,
    base_resolver: StrawberryResolver | None = None,
    permission_classes: List[Type[BasePermission]] = (),
    default: object = dataclasses.MISSING,
    default_factory: Callable[[], Any] | object = dataclasses.MISSING,
    metadata: Mapping[Any, Any] | None = None,
    deprecation_reason: str | None = None,
    directives: Sequence[object] = (),
    extensions: List[FieldExtension] = (),
) -> None:
  ...

Methods:

• get_result

  Calls the resolver defined for the StrawberryField.

  If the field doesn’t have a resolver defined we default to using the default resolver specified in StrawberryConfig.

  Signature:

  def get_result(
      self,
      source: Any,
      info: Info | None,
      args: List[Any],
      kwargs: Any,
  ) -> Awaitable[Any] | Any:
    ...

  Parameters:

  1. source:

     Type

     Any

  2. info:

     Type

     Info | None

  3. args:

     Type

     List[Any]

  4. kwargs:

     Type

     Any

• resolve_type

  Signature:

  def resolve_type(self, type_definition: StrawberryObjectDefinition | None = None) -> StrawberryType | Type[WithStrawberryObjectDefinition] | Literal[UNRESOLVED]:
    ...

  Parameters:

  1. type_definition:

     Type

     StrawberryObjectDefinition | None

     Default

     None

• copy_with

  Signature:

  def copy_with(self, type_var_map: Mapping[str, StrawberryType | builtins.type]) -> Self:
    ...

  Parameters:

  1. type_var_map:

     Type

     Mapping[str, StrawberryType | builtins.type]

Attributes:

1. type_annotation:

   Type

   StrawberryAnnotation | None

2. default_resolver:

   Type

   Callable[[Any, str], object]

3. graphql_name:

4. python_name:

   Type

   str

5. description:

   Type

   str | None

6. origin:

7. base_resolver:

   Type

   StrawberryResolver | None

8. default_value:

9. is_subscription:

10. permission_classes:

    Type

    List[Type[BasePermission]]

11. directives:

12. extensions:

    Type

    List[FieldExtension]

13. deprecation_reason:

14. is_basic_field:

    Returns a boolean indicating if the field is a basic field.

    A “basic” field us a field that has no resolver or permission classes, i.e. it just returns the relevant attribute from the source object. If it is a basic field we can avoid constructing an Info object and running any permission checks in the resolver which improves performance.

    Type

    bool

15. arguments:

    Type

    List[StrawberryArgument]

16. is_graphql_generic:

    Type

    bool

17. type:

    Type

    StrawberryType | Type[WithStrawberryObjectDefinition] | Literal[UNRESOLVED]

18. type_params:

    Type

    List[TypeVar]

19. is_async:

    Type

    bool