FilterSet Meta options

final class rest_filters.filtersets.Options

__init__(*, fields: list[str] | tuple[str] | NotSet = NotSet.notset, known_parameters: list[str] | tuple[str] | NotSet = NotSet.notset, extend_known_parameters: list[str] | tuple[str] | NotSet = NotSet.notset, handle_unknown_parameters: bool | NotSet = NotSet.notset, constraints: Sequence[Constraint] | NotSet = NotSet.notset, combinators: dict[str, Any] | NotSet = NotSet.notset, blank: str | NotSet = NotSet.notset, default_group: str | NotSet = NotSet.notset) → None

The following parameters can be used as class attributes in FilterSet.Meta:

Parameters:

• fields – A subset of available query parameters that will be used in this FilterSet. Use this to disable certain query parameters.

• known_parameters – Overrides rest_filters.conf.AppSettings.KNOWN_PARAMETERS

• extend_known_parameters – Extends rest_filters.conf.AppSettings.KNOWN_PARAMETERS

• handle_unknown_parameters – Overrides rest_filters.conf.AppSettings.HANDLE_UNKNOWN_PARAMETERS

• constraints – A list of constraint instances that are going to be enforced for this FilterSet.

• combinators – A dictionary that contains the query combination operator for given groups. The default operator for groups is operator.and_.

• blank – Overrides rest_filters.conf.AppSettings.BLANK

• default_group – Overrides rest_filters.conf.AppSettings.DEFAULT_GROUP