Hello!
I’m trying to combine django-filter together with django autocomplete in order to dynamically query region and cities within a country.
I have a filter form which I’ve built using the django-filter package. It looks like this:
class RoomFilterForm(FilterSet):
country = ModelChoiceFilter(lookup_expr="exact",
queryset=Country.objects.all(),
widget=autocomplete.ModelSelect2(url="auth_app:country-autocomplete"),
label=_("Land"),)
region = ModelChoiceFilter(lookup_expr="exact",
queryset=Region.objects.all(),
widget=autocomplete.ModelSelect2(url="auth_app:region-autocomplete", forward=["country"]),
label=_("Län"))
city = ModelChoiceFilter(lookup_expr="exact",
queryset=City.objects.all(),
widget=autocomplete.ModelSelect2(url="auth_app:city-autocomplete", forward=["region"]),
label=_("Stad"))
class Meta():
model = Room
fields = ["country", "region", "city"]
The model that I want to filter is:
class Room(models.Model):
member = models.ForeignKey(Member, on_delete=models.CASCADE, null=True, related_name="rooms")
room_category = models.CharField(blank=False, choices=RoomCategory.choices(), max_length=100, default=RoomCategory.choices()[0][0])
title = models.CharField(max_length=settings.ROOM_TITLE_LENGTH, blank=False, validators=[text_validator])
country = models.ForeignKey(Country, blank=False, max_length=128, on_delete=models.PROTECT)
region = models.ForeignKey(Region, blank=False, max_length=128, on_delete=models.PROTECT)
city = models.ForeignKey(City, blank=False, max_length=128, on_delete=models.PROTECT)
The country, city and region field have a ForeignKey relation to django-cities-light models.
This form is instantiated in a utility function:
def pagination(request, rooms):
paginator = Paginator(rooms, 15)
page_number = request.GET.get("page")
page_obj = paginator.get_page(page_number)
return page_obj
def get_filtered_rooms(request, category_slug=None) -> QuerySet:
categories_obj = Category.objects.all()
rooms = Room.objects.select_related("member").all()
if category_slug:
categorized_rooms = rooms.filter(category_slug=category_slug)
# Apply filters using RoomFilter
filtered_result = RoomFilterForm(request.GET, queryset=categorized_rooms)
search_result = pagination(request, filtered_result.qs if filtered_result else Room.objects.none())
# Paginate the rooms
paginated_rooms = pagination(request, filtered_result.qs if filtered_result else categorized_rooms)
else:
# Apply filters using RoomFilter
filtered_result = RoomFilterForm(request.GET, queryset=rooms)
search_result = pagination(request, filtered_result.qs if filtered_result else Room.objects.none())
# Paginate the rooms
paginated_rooms = pagination(request, filtered_result.qs if filtered_result else rooms)
# Sorted categories by number of rooms
if rooms.exists():
# Use annotate to count rooms per category and store it in a dict
categories_with_counts = (rooms.values('room_category').annotate(count=Count('room_category')))
# Create a dictionary from the annotated queryset
num_of_categories_dic = {
category['room_category']: category['count'] for category in categories_with_counts
}
else:
num_of_categories_dic = {category.category_name: 0 for category in categories_obj}
# Sort the dictionary by values in descending order
sorted_categories = dict(sorted(num_of_categories_dic.items(), key=lambda item: item[1], reverse=True))
return search_result, paginated_rooms, sorted_categories, filtered_result
The get_filtered_rooms() function is then called with the request object in a view function and the parameters are passed to the context dictionary:
def rooms_page_list(request):
"""Render the page to display all the roomsss"""
search_result, paginated_rooms, sorted_categories, filtered_result = get_filtered_rooms(request)
context = {"sorted_categories": sorted_categories,
"paginated_rooms": paginated_rooms,
"search_result": search_result,
"filtered_result": filtered_result}
return render(request, "main_app/rooms_page_templates/main_rooms_page.html", context)
Beside the setup above, I have done the following:
- Included {{ filtered_result.form.media }} in my base template (filters are rendered in template).
- Verified that django autocompletion works with other forms which does not include django filter.
For some reason, when I select a country, the value is not forwarded to region. In the console, I see:
For the other forms in which autocompeletion and forwarding works, I see this:
Can someone please explain what I’m missing or how I can approach the root cause?