New YearFilter

[naveeng2402]

What about creating a filter that filters based on the year of a DateField or DateTimeField

This is the final output and the code implementation is as follows

class YearFilterBackend(filters.BaseFilterBackend):
    template = "api/year_filter.html"
    filter_pram = "date__year"

    def filter_queryset(self, request, queryset, view):
        given_date = request.query_params.get(self.filter_pram)
        print(given_date)
        if given_date:
            return queryset.filter(date__year=given_date).order_by("-date")
        else:
            return queryset

    def get_search_terms(self, request):
        params = request.query_params.get(self.filter_pram, "")
        params = params.replace("\x00", "")  # strip null characters
        params = params.replace(",", " ")
        return params.split()

    def to_html(self, request, queryset, view):
        #    To be implemented to show date__year in UI
        term = self.get_search_terms(request)
        term = term[0] if term else ""
        context = {"param": self.filter_pram, "term": term}
        template = loader.get_template(self.template)
        return template.render(context)

[carltongibson]

Hi @naveeng2402 — thanks for the input.

I'd rather folks added custom filters to their own projects, rather than expand the list of shipped filters for every option. (The trouble is the list of requests just grows and grows.)

I hope that makes sense.