.. image:: https://badge.fury.io/py/django-url-filter.svg :target: http://badge.fury.io/py/django-url-filter .. image:: https://readthedocs.org/projects/django-url-filter/badge/?version=latest :target: http://django-url-filter.readthedocs.io/en/latest/?badge=latest .. image:: https://drone.miki725.com/api/badges/miki725/django-url-filter/status.svg :target: https://drone.miki725.com/miki725/django-url-filter .. image:: https://codecov.io/gh/miki725/django-url-filter/branch/master/graph/badge.svg :target: https://codecov.io/gh/miki725/django-url-filter
Django URL Filter provides a safe way to filter data via human-friendly URLs.
The main goal of Django URL Filter is to provide an easy URL interface for filtering data. It allows the user to safely filter by model attributes and also allows to specify the lookup type for each filter (very much like Django's filtering system in ORM).
For example the following will retrieve all items where the id is
5 and title contains
In addition to basic lookup types, Django URL Filter allows to
use more sophisticated lookups such as
Easiest way to install this library is by using
$ pip install django-url-filter
To make example short, it demonstrates Django URL Filter integration with Django REST Framework but it can be used without DRF (see below).
from url_filter.integrations.drf import DjangoFilterBackend
class UserViewSet(ModelViewSet): queryset = User.objects.all() serializer_class = UserSerializer filter_backends = [DjangoFilterBackend] filter_fields = ['username', 'email']
Alternatively filterset can be manually created and used directly to filter querysets::
from django.http import QueryDict from url_filter.filtersets import ModelFilterSet
class UserFilterSet(ModelFilterSet): class Meta(object): model = User
query = QueryDict('emailcontains=gmail&joinedgt=2015-01-01') fs = UserFilterSet(data=query, queryset=User.objects.all()) filtered_users = fs.filter()
Above will automatically allow the use of all of the Django URL Filter features. Some possibilities::
# get user with id 5 example.com/users/?id=5 # get user with id either 5, 10 or 15 example.com/users/?id__in=5,10,15 # get user with id between 5 and 10 example.com/users/?id__range=5,10 # get user with username "foo" example.com/users/?username=foo # get user with username containing case insensitive "foo" example.com/users/?username__icontains=foo # get user where username does NOT contain "foo" example.com/users/?username__icontains!=foo # get user who joined in 2015 as per user profile example.com/users/?profile__joined__year=2015 # get user who joined in between 2010 and 2015 as per user profile example.com/users/?profile__joined__range=2010-01-01,2015-12-31 # get user who joined in after 2010 as per user profile example.com/users/?profile__joined__gt=2010-01-01
Filter querystring format looks very similar to syntax for filtering in Django ORM. Even negated filters are supported! Some examples::
example.com/users/?emailcontains=gmail&joinedgt=2015-01-01 example.com/users/?email__contains!=gmail # note !
Support related fields so that filtering can be applied to related models. For example::
How URLs are parsed and how data is filtered is decoupled. This allows the actual filtering logic to be decoupled from Django hence filtering is possible not only with Django ORM QuerySet but any set of data can be filtered (e.g. SQLAlchemy query objects) assuming corresponding filtering backend is implemented.
This library decouples filtering from any particular usage-pattern. It implements all the basic building blocks for creating filtersets but it does not assume how they will be used. To make the library easy to use, it ships with some integrations with common usage patterns like integration with Django REST Framework. This means that its easy to use in custom applications with custom requirements (which is probably most of the time!)
* Fixes ``date`` lookup when using Django ORM. See `#92 <https://github.com/miki725/django-url-filter/issues/92>`_. 0.3.14 (2019-10-30)
SQLAlchemyFilterBackenddoes not join models if already join path is partially joined already.
* Fixing `iregex` documentation in DRF coreapi integration. 0.3.12 (2019-01-24)
FilterSet.Meta.fields == '__all__'which is useful in DRF integration. See
* Not modifying queryset in Django backend if no filters were applied. See `#73 <https://github.com/miki725/django-url-filter/pull/73>`_. 0.3.10 (2018-11-14)
distincton queryset when one of filters is on one-to-many relation. This should help with performance. See
* Adding ``iin`` form field overwrite for SQLAlchemy as otherwise by default ``iin`` lookup is not validated correctly. 0.3.8 (2018-08-08)
SQLAlchemyFilterBackendby not joining nested models when they are already eager loaded via
* Added ``StrictModel.empty`` which is new default. It returns empty queryset when any filter validations fail. * Fixed ``in`` lookup. Previously if any of the items were invalid whole filter would fail and depending on strict mode would either return all results, no results or will raise exception. Now in ``StrictMode.empty`` and ``StrictMode.drop`` any invalid items are ignored which will filter results for valid items. See `#63 <https://github.com/miki725/django-url-filter/issues/64>`_. * Added ability in ``ModelFilterSet`` to customize filter names by providing ``extra_kwargs`` with field ``source``. See `#66 <https://github.com/miki725/django-url-filter/issues/66>`_. 0.3.6 (2018-07-23)
CoreAPIURLFilterBackendwhich enables documented filters in swagger docs.
iinlookup in plain and sqlalchemy backends.
week_daylookup. Now both are consistent with
* Django 2 support. * Using `tox-travis <https://github.com/tox-dev/tox-travis>`_ for travis builds. * Fixed negated queries in Django backend. Previously negation did ``NOT (condition1 and condition2)`` vs expected ``NOT condition1 and NOT condition2``. See `#53 <https://github.com/miki725/django-url-filter/issues/53>`_. 0.3.4 (2017-08-17)
READMEby including imports in code examples
* Fixed bug which did not allow to use SQLAlchemy backend fully without having ``django.contrib.contenttypes`` in installed apps. See `#36 <https://github.com/miki725/django-url-filter/issues/36>`_. * Improved SQLAlchemy versions compatibility. * Added ``URLFilterBackend`` alias in DRF integration for backend to reduce confusion with ``DjangoFilterBackend`` as in url filter core backend. 0.3.2 (2017-05-19)
filter()generator which is not compatible with Django pagination since it requires
len()to be implemented.
* Fixed bug where default filters were used in root filtersets. As a result additional querystring parameters were validation which broke other functionality such as pagination. 0.3.0 (2017-01-26)
docs <https://django-url-filter.readthedocs.io/en/latest/usage.html#plain-filtering>and GitHub issue
CallableFilter <https://django-url-filter.readthedocs.io/en/latest/api/url_filter.filters.html#url_filter.filters.CallableFilter>_ which allows to implement custom filters.
StrictMode.Failsince filterset raises Django's
ValidationErrorwhich caused 500 status code.
ModelFilterSetautomatic introspection to ignore
GenericForeignKeysince they dont have form fields associated with them. See
* Added `SQLAlchemy <http://www.sqlalchemy.org/>`_ support. * ``FilterSet`` instances have much more useful ``__repr__`` which shows all filters at a glance. For example:: >>> PlaceFilterSet() PlaceFilterSet() address = Filter(form_field=CharField, lookups=ALL, default_lookup="exact", is_default=False) id = Filter(form_field=IntegerField, lookups=ALL, default_lookup="exact", is_default=True) name = Filter(form_field=CharField, lookups=ALL, default_lookup="exact", is_default=False) restaurant = RestaurantFilterSet() serves_hot_dogs = Filter(form_field=BooleanField, lookups=ALL, default_lookup="exact", is_default=False) serves_pizza = Filter(form_field=BooleanField, lookups=ALL, default_lookup="exact", is_default=False) waiter = WaiterFilterSet() id = Filter(form_field=IntegerField, lookups=ALL, default_lookup="exact", is_default=True) name = Filter(form_field=CharField, lookups=ALL, default_lookup="exact", is_default=False) 0.1.1 (2015-09-06)
* First release on PyPI. Credits ------- Development Lead ---------------- * Miroslav Shubernetskiy - https://github.com/miki725 Contributors ------------ * João Neto - https://github.com/netjinho * Jorik Kraaikamp - https://github.com/JostCrow * Håken Lid - https://github.com/haakenlid * Ryan O’Hara - https://github.com/ryan-copperleaf * webrunners - https://github.com/webrunners * Simone Pellizzari - https://github.com/simone6021 * Jonathon Farzanfar - https://github.com/pctSW1 License ------- :: The MIT License (MIT) Copyright (c) 2015, Miroslav Shubernetskiy Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.