Use Custom Filter with Django ModelChoice Filter

Question

I am trying to create use the filter method with django-filters

See an example of the models below:

class Chicken(TimeStampedModel):
    eggs = ForeignKey(Egg)

class Egg(TimeStampedModel):
    hatched = BooleanField(default=False)

See an example of my current set up for the filter:

class ChickenFilter(FilterSet):
    eggs__contains = ModelChoiceFilter(name="eggs", method='hatched_eggs', queryset=Eggs.objects.all())

   def hatched_eggs(self, queryset, name, value):
      print "We got eggs"
     return queryset.filter(eggs__hatched=True)

The problem is that the method doesnt even print We got eggs when I hit the url. It just returns an empty queryset.

What is the querystring that you're using? If eggs__contains isn't in the querystring, the filter won't execute. — Sherpa
– Sherpa, Commented Mar 26, 2017 at 0:09

Josh Correia · Accepted Answer · 2021-06-29 16:38:16Z

9

I did it like below:

In my urls I sent ?ids=1,2,3,4

class MyFilter(filters.FilterSet):
    ids = django_filters.CharFilter(method='ids__in')

    def ids__in(self, queryset, value, *args, **kwargs):
        try:
            if args:
                ids = args[0].split(',')
                ids = [int(_id) for _id in ids]
                queryset = queryset.filter(id__in=ids)
        except ValueError:
            pass
        return queryset

edited Jun 29, 2021 at 16:38

Josh Correia

4,4103 gold badges42 silver badges67 bronze badges

answered May 23, 2019 at 18:02

Fred Chevitarese

1544 silver badges7 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

AnnShress · Accepted Answer · 2017-09-18 14:07:58Z

4

I was going through the same problem. My method was not being called.

So came to conclusion, I can make a workaround using:

Using custom methods in filter with django-rest-framework

class ChickenFilter(FilterSet):
    eggs__contains = CharFilter(action='hatched_eggs')

def hatched_eggs(queryset, value):
      print "We got eggs"
     if value:
         return queryset.filter(eggs__hatched=True)
     return queryset

answered Sep 18, 2017 at 14:07

AnnShress

4861 gold badge5 silver badges12 bronze badges

1 Comment

Fred Chevitarese Over a year ago

action didnt work for me, i've used method instead.

Collectives™ on Stack Overflow

Use Custom Filter with Django ModelChoice Filter

2 Answers 2

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related