Skip to content

Configuration

FilterConfigDict

Bases: ConfigDict

A TypedDict for configuring filtering.

delimiter instance-attribute

delimiter: str

A delimiter before the suffix.

optional instance-attribute

optional: bool

Make otherwise-required fields optional.

default_filter_type instance-attribute

default_filter_type: FilterType

Default filter type if not specified directly in FilterField or by suffix.

default_search_type instance-attribute

default_search_type: SearchType

Default search type if not specified directly in SearchField.

suffixes_map instance-attribute

suffixes_map: dict[str, FilterType]

Mapping of recognized suffixes to filter types.

sequence_types instance-attribute

sequence_types: tuple[type, ...]

Annotation origins that are considered sequences.