Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

A django app to apply filters on drf querysetsusing query params with validations using voluptuous.

Project description


drf-url-filters is a simple django app to apply filters on drf modelviewset’s queryset in a clean, simple and configurable way. It also supports validations on incoming query params and their values. A beautiful python package voluptouos is being used for validations on the incoming query parameters. The best part about voluptouos is you can define your own validations as per your query params requirements.

# Quick start


  1. Download drf-url-filters app package from this git repo or can be isnatlled using python-pip like pip install drf-url-filters.
  2. Add filters in INSTALLED_APPS in file of django project.

How it works?

  1. Your View or ModelViewSet should inherit FiltersMixin from filters.mixins.FiltersMixin .
  2. To apply filters using drf-url-filters we need to configure our view to have a dict mapping filter_mappings which converts incoming query parameters to query you want to make on the column name on the queryset.

from filters.schema import base_query_param_schema
from filters.validations import (

# make a validation schema for players filter query params
players_query_schema = base_query_param_schema.extend(
        "id": IntegerLike(),
        "name": unicode,
        "team_id": CSVofIntegers(),  # /?team_id=1,2,3
        "install_ts": DatetimeWithTZ(),
        "update_ts": DatetimeWithTZ(),

from rest_framework import (

from .models import Player, Team
from .serializers import PlayerSerializer, TeamSerializer
from .pagination import ResultSetPagination
from .validations import teams_query_schema, players_query_schema
from filters.mixins import (

class PlayersViewSet(FiltersMixin, viewsets.ModelViewSet):
    This viewset automatically provides `list`, `create`, `retrieve`,
    `update` and `destroy` actions.
    serializer_class = PlayerSerializer
    pagination_class = ResultSetPagination
    filter_backends = (filters.OrderingFilter,)
    ordering_fields = ('id', 'name', 'update_ts')
    ordering = ('id',)

    # add a mapping of query_params to db_columns(queries)
    filter_mappings = {
        'id': 'id',
        'name': 'name__icontains',
        'team_id': 'teams',
        'install_ts': 'install_ts',
        'update_ts': 'update_ts',
        'update_ts__gte': 'update_ts__gte',
        'update_ts__lte': 'update_ts__lte',

    # add validation on filters
    filter_validation_schema = players_query_schema

    def get_queryset(self):
        Optionally restricts the queryset by filtering against
        query parameters in the URL.
        query_params = self.request.query_params
        queryset = Player.objects.prefetch_related(
            'teams'  # use prefetch_related to minimize db hits.

        # This dict will hold filter kwargs to pass in to Django ORM calls.
        db_filters = {}

        # update filters dict with incoming query params and then pass as
        # **kwargs to queryset.filter()
        return queryset.filter(**db_filters)

With the use of drf-url-filters adding a new filter on a new column is as simple as adding a new key in the dict. Prohibitting a filter on particular column is same as removing a key value mapping from the filter_mappings dict.


The content of this repository is licensed under a The MIT License (MIT) Copyright (c) 2016 Manjit Kumar Read more about it in LICENSE file available in repo.


Special thanks to authors of voluptouos and friends * ** who encourage people to contribute into open source community.


Please open an issue for support.

Project details

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page