Skip to main content

Construct arbitrarily complex Django "Q" filters from flat data, such as query parameters.

Project description Code Health

Filternaut is a simple library which generates arbitrarily complex Django Q-objects from simple data. It fits nicely into situations where users provide data which you want to filter a queryset with.

Filternaut is indirectly a collection of fields, but it differs from Django forms in that you specify the logical relationships between fields, as well their names and types.

Filternaut is similar to Django Filters, but does not provide any machinery for rendering a user interface and does not inspect your models to autogenerate filters. However, Django Filters chains many calls to .filter() which means OR-like behaviour with more than one join. Filternaut supports either behaviour.


# filters are combined using logical operators
filters = (
    DateTimeFilter('created_date', lookups=['lt', 'gt']) &
    CharFilter('username', lookups=['icontains']))

# they can read their values from anything dict-like

# and have a form-like 'validity pattern'.
if filters.valid:
    queryset = queryset.filter(filters.Q)
    raise HttpResponseBadRequest(json.dumps(filters.errors))


$ pip install django-filternaut

Filternaut is compatible with:

  • Python 3

  • Django 2.2 and 3.0

  • Django REST Framework 3.11 (optional)

Python 2.7 support is still in the codebase but no longer tested. You are welcome to try your luck.


See for full documentation.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-filternaut-0.0.14.tar.gz (15.2 kB view hashes)

Uploaded source

Built Distribution

django_filternaut-0.0.14-py3-none-any.whl (11.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page