url_filter.filtersets.django module¶
-
class
url_filter.filtersets.django.
ModelFilterSet
(source=None, *args, **kwargs)[source]¶ Bases:
url_filter.filtersets.base.FilterSet
FilterSet
for Django models.The filterset can be configured via
Meta
class attribute, very much like Django’sModelForm
is configured.-
Meta
= <url_filter.filtersets.django.ModelFilterSetOptions object>¶
Build a
FilterSet
for a Django relation model field such asForeignKey
.
-
build_filterset_from_reverse_field
(field)[source]¶ Build a
FilterSet
for a Django reverse relation model field.
-
filter_options_class
¶ alias of
ModelFilterSetOptions
-
get_filters
()[source]¶ Get all filters defined in this filterset including filters corresponding to Django model fields.
-
get_form_field_for_field
(field)[source]¶ Get form field for the given Django model field.
By default
Field.formfield()
is used to get the form field unless an overwrite is present for the field. Overwrites are useful for non-standard fields likeFileField
since in that caseCharField
should be used.
-
-
class
url_filter.filtersets.django.
ModelFilterSetOptions
(options=None)[source]¶ Bases:
object
Custom options for ``FilterSet``s used for Django models.
-
model
¶ Model
Django model class from which
FilterSet
will extract necessary filters.
-
fields
¶ None, list, optional
Specific model fields for which filters should be created for. By default it is
None
in which case for all fields filters will be created for.
-
exclude
¶ list, optional
Specific model fields for which filters should not be created for.
bool, optional
bool, optional
-