Filter

Base class: Part

Class that describes a filter that you can search for.

See Query for more complete examples.

Parameters with the prefix field__ will be passed along downstream to the Field instance if applicable. This can be used to tweak the basic style interface.

Refinable members

after     (evaluated)

Type: Union[int, str]

See after

assets

Type: Namespace

See assets

attr     (evaluated)

See attr

choices     (evaluated)

endpoints

Type: Namespace

See endpoints

extra

Type: Dict[str, Any]

See extra

extra_evaluated

Type: Dict[str, Any]

See extra

extra_params

See extra_params

field

Type: Namespace

freetext     (evaluated)

Cookbook:

How do I make a freetext search field?

include     (evaluated)

Type: bool

See include

Cookbook:

How do I enable searching/filter on columns?

iommi_style

Type: str

See iommi_style

is_valid_filter

Default: iommi.query.default_filter__is_valid_filter

model     (evaluated)

Type: Type[django.db.models.base.Model]

model_field

model_field_name

parse

pk_lookup_to_q

query_name     (evaluated)

Default: lambda filter, **_: filter.iommi_name()

Cookbook:

How do I control what Q is produced?

query_operator_for_field     (evaluated)

Type: str

Default: =

query_operator_to_q_operator

Cookbook:

How do I override what operator is used for a query?

search_fields

unary

value_to_q

Cookbook:

How do I control what Q is produced?

Shortcuts

Filter.boolean

Defaults

• field__call_target__attribute

  • boolean

• parse

  • iommi.form.bool_parse

• unary

  • True

• query_operator_to_q_operator

  • iommi.query.boolean__query_operator_to_q_operator

Filter.boolean_tristate

Defaults

• field__call_target__attribute

  • boolean_tristate

• parse

  • iommi.form.boolean_tristate__parse

• query_operator_to_q_operator

  • iommi.query.boolean__query_operator_to_q_operator

• unary

  • True

Filter.case_sensitive

Defaults

• query_operator_to_q_operator

  • iommi.query.case_sensitive_query_operator_to_q_operator

Filter.choice

Field that has one value out of a set.

Defaults

• field__call_target__attribute

  • choice

Filter.choice_queryset

Field that has one value out of a set.

Defaults

• field__call_target__attribute

  • choice_queryset

• query_operator_to_q_operator

  • lambda op: 'exact'

• value_to_q

  • iommi.query.choice_queryset_value_to_q

• is_valid_filter

  • iommi.query.choice_queryset__is_valid_filter

Filter.date

Defaults

• field__call_target__attribute

  • date

• parse

  • iommi.form.date_parse

Filter.datetime

Defaults

• field__call_target__attribute

  • date

• parse

  • iommi.form.date_parse

• extra_evaluated__is_tz_aware

  • lambda **_: settings.USE_TZ

Filter.decimal

Parent: Filter.number

Defaults

• field__call_target__attribute

  • decimal

Filter.duration

Parent: Filter.text

Defaults

• field__call_target__attribute

  • duration

Filter.email

Defaults

• field__call_target__attribute

  • email

Filter.file

Defaults

• field__call_target__attribute

  • file

Filter.float

Parent: Filter.number

Defaults

• field__call_target__attribute

  • float

• parse

  • iommi.form.float_parse

Filter.foreign_key

Defaults

• field__call_target__attribute

  • foreign_key

Filter.foreign_key_reverse

Defaults

• field__call_target__attribute

  • foreign_key_reverse

Filter.integer

Parent: Filter.number

Defaults

• field__call_target__attribute

  • integer

• parse

  • iommi.form.int_parse

Filter.many_to_many

Defaults

• field__call_target__attribute

  • many_to_many

Filter.many_to_many_reverse

Filter.multi_choice

Field that has one value out of a set.

Defaults

• field__call_target__attribute

  • multi_choice

Filter.multi_choice_queryset

Defaults

• field__call_target__attribute

  • multi_choice_queryset

Filter.number

Defaults

• field__call_target__attribute

  • number

• query_operator_to_q_operator

  • iommi.query.case_sensitive_query_operator_to_q_operator

Filter.text

Defaults

• field__call_target__attribute

  • text

• query_operator_for_field

  • :

Filter.textarea

Parent: Filter.text

Filter.time

Defaults

• field__call_target__attribute

  • time

• parse

  • iommi.form.time_parse

Filter.url

Defaults

• field__call_target__attribute

  • url

Methods

on_bind

on_refine_done

own_evaluate_parameters

Class methods

checkboxes

from_model