Skip to content

BaseFilter

BaseFilter

Bases: BaseModel

A base class for creating pydantic-based filters.

filter_fields class-attribute 

filter_fields: Dict[str, FilterFieldInfo]

Metadata about the filters fields defined on the model, mapping of field names to FilterFieldInfo objects.

search_fields class-attribute 

search_fields: Dict[str, SearchFieldInfo]

Metadata about the search fields defined on the model, mapping of field names to SearchFieldInfo objects.

nested_filters class-attribute 

nested_filters: Dict[str, Type[BaseFilter]]

Metadata about the nested filters defined on the model, mapping of field names to BaseFilter objects.

model_config class-attribute instance-attribute 

model_config = FilterConfigDict(
    delimiter="__",
    optional=True,
    default_filter_type=eq,
    default_search_type=case_insensitive,
    suffixes_map=get_suffixes_map(),
    sequence_types=(list, set),
)

Configuration for the model, should be a dictionary conforming to FilterConfigDict.