Django-filter ForeignKey related Model filtering

Question

I've been struggling with dajngo-filter recently. I have 2 models: Book and Author.

class Book(models.Model):
   title = models.CharField(max_length=150)
   author = models.ForeignKey(Author, on_delete=model.CASCADE)
   length = models.PositiveIntegerField()

class Author(models.Model):
    first_name = models.CharField(max_length=150)
    last_name = models.CharField(max_length=150)
    year_of_birth = models.DateFiled()

So, I'd like to make filter page, where you can find book by it's properties (title, author etc) AND information about author. For example book shorter than 300 pages, which author is beetween 20-25 years old.

In filters.py I have:

import django_filters
from .models import Book, Author

class BookFilter(django_filters.FilterSet):
    class Meta():
        model = Book
        fields = ['title', 'author']

And have actually no idea how to also filter by different model, which is related by ForeignKey to Book model.

I have really little experience with Dajngo, I wonder if it's very complex problem or not. :) Thanks!

any help here please ? https://stackoverflow.com/questions/58508935/search-input-on-every-pages-django — kutaiba momani, Oct 22 '19 at 17:22

Toni Sredanović · Accepted Answer · 2021-10-16T05:51:06.557

Basically there are two important arguments for each filter:

field_name: The name of the model field to filter on. You can traverse “relationship paths” using Django’s __ syntax to filter fields on a related model. ex, author__last_name.

lookup_expr: The field lookup to use when filtering. Django’s __ syntax can again be used in order to support lookup transforms. ex, year__gte. For full list of field lookups you can use see here: https://docs.djangoproject.com/en/2.2/ref/models/querysets/#field-lookups.

Together, the field field_name and lookup_expr represent a complete Django lookup expression. A detailed explanation of lookup expressions is provided in Django’s lookup reference here: https://docs.djangoproject.com/en/2.2/ref/models/lookups/#module-django.db.models.lookups.

With that in mind here is the answer:

import django_filters
from .models import Book, Author

class BookFilter(django_filters.FilterSet):
    title = django_filters.CharFilter(field_name='title', lookup_expr='iexact')
    author = django_filters.CharFilter(field_name='author__last_name', lookup_expr='iexact')
    
    class Meta():
        model = Book

If you want to filter by exact date just add to your BookFilter class:

date_of_birth = django_filters.DateFilter(field_name='author__date_of_birth', lookup_expr='exact')

However it would make more sense to filter by year of birth (for example to get all the books from authors born between 1980 and 1990). To do that here is what you add to BookFilter class:

birth_year__gt = django_filters.NumberFilter(field_name='author__date_of_birth', lookup_expr='year__gt')
birth_year__lt = django_filters.NumberFilter(field_name='author__date_of_birth', lookup_expr='year__lt')

Ok, but how am I supposed to filter books but author's date of birth? How to add date_of_birth to filter fields in BookFilter Meta class — zorka5, Sep 18 '19 at 09:35
Thanks! It helped a lot! Is it similar things with numbers not years? for example lookup_expr='number__gt' ? — zorka5, Sep 18 '19 at 10:00

Toan Quoc Ho · Answer 2 · 2022-01-29T08:35:55.860

2

You can take a look at the document of django-filter package.

Items in the fields sequence in the Meta class may include “relationship paths” using Django’s __ syntax to filter on fields on a related model.

Like so:

import django_filters
from .models import Book, Author

class BookFilter(django_filters.FilterSet):
    class Meta():
        model = Book
        fields = ['title', 'author__first_name', 'author__last_name']

edited Jan 29 '22 at 08:35

answered Sep 18 '19 at 09:34

Toan Quoc Ho

3,266
1
14
22

SORRY / \ / \ This page does / ] not exist yet. – Diego Venâncio Jan 18 '22 at 00:54
Thanks @DiegoVenâncio, just updated it with the new url – Toan Quoc Ho Jan 29 '22 at 08:35

Django-filter ForeignKey related Model filtering

2 Answers2

Linked