Skip to content

Field groups ​

The field groups that include and exclude accept in place of a list of field names.

FieldGroup ​

source

Field-group selectors for include/exclude sequences.

ALL ​

python
ALL = 'all'

Include all fields from model.

RELATIONSHIPS ​

python
RELATIONSHIPS = 'relationships'

Include only relationships.

SCALARS ​

python
SCALARS = 'scalars'

Include everything but relationships.

is_group ​

python
is_group(value: str) -> TypeIs[FieldGroupStr]

list_str ​

python
list_str() -> str

values ​

python
values() -> frozenset[str]

ALL ​

source

python
ALL = FieldGroup.ALL

RELATIONSHIPS ​

source

python
RELATIONSHIPS = FieldGroup.RELATIONSHIPS

SCALARS ​

source

python
SCALARS = FieldGroup.SCALARS