Frequently Asked Questions

How can I hide a field from GraphQL?

Strawberry provides a Private type that can be used to hide fields from GraphQL, for example, the following code:

import strawberry
class User:
    name: str
    age: int
    password: strawberry.Private[str]
class Query:
    def user(self) -> User:
        return User(name="Patrick", age=100, password="This is fake")
schema = strawberry.Schema(query=Query)

will result in the following schema:

type Query {
  user: User!
type User {
  name: String!
  age: Int!

How can I deal with circular imports?

In cases where you have circular imports, you can use strawberry.lazy to resolve the circular imports, for example:

from typing import TYPE_CHECKING, Annotated
import strawberry
    from .users import User
class Post:
    title: str
    author: Annotated["User", strawberry.lazy(".users")]

For more information, see the Lazy types documentation.

Can I reuse Object Types with Input Objects?

Unfortunately not because, as the GraphQL spec specifies, there is a difference between Objects Types and Inputs types:

The GraphQL Object type (ObjectTypeDefinition) defined above is inappropriate for re‐use here, because Object types can contain fields that define arguments or contain references to interfaces and unions, neither of which is appropriate for use as an input argument. For this reason, input objects have a separate type in the system.

And this is also true for Input types' fields: you can only use Strawberry Input types or scalar.

See our Input Types docs.

Can I use asyncio with Strawberry and Django?

Yes, Strawberry provides an async view that can be used with Django, you can Check Async Django for more information.

Edit this page on GitHub