Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add FileField example to filter_overrides #1680

Merged
merged 1 commit into from
Aug 2, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/ref/filterset.txt
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,27 @@ This is a map of model fields to filter classes with options::
}



A possible usecase would be creating a custom filter to be able to filter on ``FileFields``
(``FileField`` filtering is hard to define in a generalised way, which is why there is no ``FileFilter``).

This example shows an override used to filter on a ``FileField``::

class Questionnaire(models.Model):
file = models.FileField(upload_to=questionnaire_path)

class QuestionnaireFilter(FilterSet):
class Meta:
model = Questionnaire
fields = ['file']
filter_overrides = {
models.FileField: {
'filter_class': CharFilter,
'extra': lambda f: {'lookup_expr': 'exact'},
},
}


.. _unknown_field_behavior:

Handling unknown fields with ``unknown_field_behavior``
Expand Down
Loading