Skip to content

Latest commit

 

History

History
558 lines (340 loc) · 16.1 KB

CHANGES.rst

File metadata and controls

558 lines (340 loc) · 16.1 KB
Raw

Version 24.3 (2024-08-02)

  • Adds official support for Django 5.1.

  • Allow using dictionaries for grouped choices on Django 5.0+.

    Thanks to Sævar Öfjörð Magnússon.

  • Adds unknown_field_behavior FilterSet option to allowing warning and ignore behaviours for unknown field types during FilterSet generation.

    Thanks to Loes.

Version 24.2 (2024-03-27)

  • Fixed a regression in v23.4 where callable choices were incorrectly evaluated at filter instantiation, on Django versions prior to 5.0.

    Thanks to Craig de Stigter for the report and reproduce.

Version 24.1 (2024-03-08)

  • Updated supported Python and Django versions, and resolved upcoming Django deprecations.

    Required versions are now at least Python 3.8 and Django 4.2.

    Thanks to Michael Manganiello.

  • Allowed passing a FilterSet class to the filterset_factory().

    Thanks to Birger Schacht.

  • Set empty default value of filterset data to MultiValueDict.

    Thanks to Shlomo Gordon.

  • Preserve list values passed to the data dict in CSV widgets.

    Thanks to Bryan Brancotte.

  • Updates French and Ukrainian localisations.

    Thanks to Weblate.

Version 23.5 (2023-12-05)

  • Fixed OrderingFilter handling of empty values. (#1628)

    Thanks to Matt Munns.

Version 23.4 (2023-11-20)

  • Official support for Django 5.0 and Python 3.12.

  • Fix DeprecationWarning for pkgutil.find_loader.

    Thanks to wmorrell.

  • Adopted Furo theme for docs.

Version 23.3 (2023-9-17)

  • Adds initial compatibility with Django 5.0, prior to Django 5.0a1.
  • Updates packaging to use pyproject.toml and Flit.

Version 23.2 (2023-4-30)

  • Deprecated the schema generation methods of the DRF related DjangoFilterBackend. These will be removed in version 25.1.

    You should use drf-spectacular for generating OpenAPI schemas with DRF.

  • In addition, stopped testing against the (very old now) coreapi schema generation. These methods should continue to work if you're using them until v25.1, but coreapi is no longer maintained, and is raising warnings against the current versions of Python. To workaround this is not worth the effort at this point.

  • Updated Polish translations.

Version 23.1 (2023-3-26)

  • Declared support for Django 4.2.
  • Various updated and new translations. Thanks to all who contributed, and Weblate for hosting.
  • Fixed QueryArrayWidget.value_from_datadict() to not mutate input data. (#1540)

Version 22.1 (2022-6-17)

  • Update supported Python and Django versions: minimal Python is now 3.7, minimum Django is now 3.2.
  • Added testing for Python 3.10 and Django 4.1.
  • Removed outdated deprecated warnings for code removed in version 2.1.
  • Removed filter_class (use filterset_class) and filter_fields (filterset_fields) that were deprecated in [version 2.0 (2018)](https://django-filter.readthedocs.io/en/main/guide/migration.html#view-attributes-renamed-867).
  • The code base is now formatted with Black.

Version 21.1 (2021-9-24)

This is a maintenance release updating CI testing for the latest non-end-of-life versions of Python and Django, and updating package metadata accordingly.

With this release django-filter is switching to a two-part CalVer versioning scheme, such as 21.1. The first number is the year. The second is the release number within that year.

On an on-going basis, Django-Filter aims to support all current Django versions, the matching current Python versions, and the latest version of Django REST Framework.

Please see:

Support for Python and Django versions will be dropped when they reach end-of-life. Support for Python versions will dropped when they reach end-of-life, even when still supported by a current version of Django.

Other breaking changes are rare. Where required, every effort will be made to apply a "Year plus two" deprecation period. For example, a change initially introduced in 23.x would offer a fallback where feasible and finally be removed in 25.1. Where fallbacks are not feasible, breaking changes without deprecation will be called out in the release notes.

Beyond that change, there are few changes. Some small bugfixes, improvements to localisation, and documentation tweaks. Thanks to all who were involved.

Version 2.4.0 (2020-9-27)

  • SECURITY: Added a MaxValueValidator to the form field for NumberFilter. This prevents a potential DoS attack if numbers with very large exponents were subsequently converted to integers.

    The default limit value for the validator is 1e50.

    The new NumberFilter.get_max_validator() allows customising the used validator, and may return None to disable the validation entirely.

  • Added testing against Django 3.1 and Python 3.9.

    In addition tests against Django main development branch are now required to pass.

Version 2.3.0 (2020-6-5)

  • Fixed import of FieldDoesNotExist. (#1127)
  • Added testing against Django 3.0. (#1125)
  • Declared support for, and added testing against, Python 3.8. (#1138)
  • Fix filterset multiple inheritance bug (#1131)
  • Allowed customising default lookup expression. (#1129)
  • Drop Django 2.1 and below (#1180)
  • Fixed IsoDateTimeRangeFieldTests for Django 3.1
  • Require tests to pass against Django master.

Version 2.2 (2019-7-16)

  • Added DjangoFilterBackend.get_schema_operation_parameters() for DRF 3.10+ OpenAPI schema generation. (#1086)
  • Added lookup_expr to MultipleChoiceFilter (#1054)
  • Dropped support for EOL Python 3.4

Version 2.1 (2019-1-20)

  • Fixed a regression in FilterView introduced in 2.0. An empty QuerySet was incorrectly used whenever the FilterSet was unbound (i.e. when there were no GET parameters). The correct, pre-2.0 behaviour is now restored.

    A workaround was to set strict=False on the FilterSet. This is no longer necessary, so you may restore strict behaviour as desired.

  • Added IsoDateTimeFromToRangeFilter. Allows From-To filtering using ISO-8601 formatted dates.

Version 2.0 (2018-7-13)

2.0 introduced a number of small changes and tidy-ups. Please see the migration guide:

https://django-filter.readthedocs.io/en/main/guide/migration.html#migrating-to-2-0

  • Added testing for Python 3.7 (#944)
  • Improve exception message for invalid filter result (#943)
  • Test QueryDict against CSV filters (#937)
  • Add renderer argument to render() method of BooleanWidget (#923)
  • Fix lookups for reverse relationships (#915)
  • Refactor backend filterset instantiation (#865)
  • Improve view-related attribute name consistency (#867)
  • Fix distinct call for range filters (#855)
  • Fix empty value check for CSV range (#854)
  • Rework DateRangeFilter (#852)
  • Added testing for Django 2.1
  • Rework 'lookup types' handling into LookupChoiceFilter (#851)
  • Add linting and docs builds to CI (#850)
  • Use DRF BooleanFilter for NullBooleanField (#844)
  • Added Brazilian locale (#841)
  • List Django as a dependency in setup.py (#846)
  • Keep coverage reports files off version control. (#924)
  • Update migration docs (#866)
  • Added be, cs and uk translations. Updated de and ru (#861)
  • Slovak translation (#886)
  • Added Django 2.0 support. (#836)
  • Fix warnings build (#829)
  • Add greek translation (#827)
  • Replaced super(ClassName, self) with super() (#821)
  • Fixed doc URL in utils.deprecate(). (#820)
  • Added danish translation to django-filter (#809)
  • Rework validation, add queryset filter method (#788)
  • Fix Schema warnings (#803)
  • Update {Range,LookupType}Widgets to use suffixes (#770)
  • Method signature improvements (#800)
  • Remove more deprecations (#801)
  • Drop python 2, Django<1.11 support (#797)
  • Remove 'Meta.together' option (#791)
  • [2.x] Remove some deprecations (#795)

Version 1.1 (2017-10-19)

  • Add Deprecations for 2.0 (#792)
  • Improve IsoDateTimeField test clarity (#790)
  • Fix form attr references in tests (#789)
  • Simplify tox config, drop python 3.3 & django 1.8 (#787)
  • Make get_filter_name a classmethod, allowing it to be overriden for each FilterClass (#775)
  • Support active timezone (#750)
  • Docs Typo: django_filters -> filters in docs (#773)
  • Add Polish translations for some messages (#771)
  • Remove support for Django 1.9 (EOL) (#752)
  • Use required attribute from field when getting schema fields (#766)
  • Prevent circular ImportError hiding for rest_framework sub-package (#741)
  • Deprecate 'extra' field attrs on Filter (#734)
  • Add SuffixedMultiWidget (#681)
  • Fix null filtering for *Choice filters (#680)
  • Use isort on imports (#761)
  • Use urlencode from django.utils.http (#760)
  • Remove OrderingFilter.help_text (#757)
  • Update DRF test dependency to 3.6 (#747)

Version 1.0.4 (2017-05-19)

Quick fix for verbose_field_name issue from 1.0.3 (#722)

Version 1.0.3 (2017-05-16)

Improves compatibility with Django REST Framework schema generation.

See the 1.0.3 Milestone for full details.

Version 1.0.2 (2017-03-20)

Updates for compatibility with Django 1.11 and Django REST Framework 3.6.

Adds CI testing against Python 3.6

See the 1.0.2 Milestone for full details.

Version 1.0.1 (2016-11-28)

Small release to ease compatibility with DRF:

  • #568 Adds rest_framework to the django_filters namespace to allow single ``import django_filters` usage.
  • A number of small updates to the docs

Version 1.0 (2016-11-17)

This release removes all the deprecated code from 0.14 and 0.15 for 1.0 #480.

Please see the Migration Notes for details of how to migrate. Stick with 0.15.3 if you're not ready to update.

The release includes a number of small fixes and documentation updates.

See the 1.0 Milestone for full details.

Version 0.15.3 (2016-10-17)

Adds compatibility for DRF (3.5+) get_schema_fields filter backend introspection.

  • #492 Port get_schema_fields from DRF

Version 0.15.2 (2016-09-29)

  • #507 Fix compatibility issue when not using the DTL

Version 0.15.1 (2016-09-28)

A couple of quick bug fixes:

  • #496 OrderingFilter not working with Select widget
  • #498 DRF Backend Templates not loading

Version 0.15.0 (2016-09-20)

This is a preparatory release for a 1.0. Lots of clean-up, lots of changes, mostly backwards compatible.

Special thanks to Ryan P Kilby (@rpkilby) for lots of hard work.

Most changes should raise a Deprecation Warning.

Note: if you're doing Clever Things™ with the various filter options — filter_overrides etc — you may run into an AttributeError since these are now defined on the metaclass and not on the filter itself. (See the discussion on #459)

Summary: Highly Recommended, but take a moment to ensure everything still works.

  • Added the DRF backend. #481
  • Deprecated MethodFilter in favour of Filter.method #382
  • Move filter options to metaclass #459
  • Added get_filter_predicate hook. (Allows e.g. filtering on annotated fields) #469
  • Rework Ordering options into a filter #472
  • Hardened all deprecations for 1.0. Please do see the Migration Notes

Version 0.14.0 (2016-08-14)

  • Confirmed support for Django 1.10.
  • Add support for filtering on DurationField (new in Django 1.8).
  • Fix UUIDFilter import issue
  • Improve FieldLookupError message
  • Add filters_for_model to improve extensibility
  • Fix limit_choices_to behavior with callables
  • Fix distinct behavior for range filters
  • Various Minor Clean up issues.

Version 0.13.0 (2016-03-11)

  • Add support for filtering by CSV #363
  • Add DateTimeFromToRangeFilter #376
  • Add Chinese translation #359
  • Lots of fixes.

Version 0.12.0 (2016-01-07)

  • Raised minimum Django version to 1.8.x

  • FEATURE: Add support for custom ORM lookup types #221

  • FEATURE: Add JavaScript friendly BooleanWidget #270

  • FIXED: (More) Compatability with Django 1.8 and Django 1.9+

  • BREAKING CHANGE: custom filter names are now also be used for ordering #230

    If you use ordering on a field you defined as custom filter with custom name, you should now use the filter name as ordering key as well.

    Eg. For a filter like :

    class F(FilterSet):

    account = CharFilter(name='username') class Meta:

    model = User fields = ['account', 'status'] order_by = True

    Before, ordering was like ?o=username. Since 0.12.0 it's o=account.

Version 0.11.0 (2015-08-14)

  • FEATURE: Added default filter method lookup for MethodFilter #222
  • FEATURE: Added support for yesterday in daterangefilter #234
  • FEATURE: Created Filter for NumericRange. #236
  • FEATURE: Added Date/time range filters #215
  • FEATURE: Added option to raise with strict #255
  • FEATURE: Added Form Field and Filter to parse ISO-8601 timestamps

Version 0.10.0 (2015-05-13)

  • FEATURE: Added conjoined parameter to MultipleChoiceFilter
  • FEATURE: Added together meta option to validate fields as a group
  • FIXED: Added testing on Django 1.8
  • FIXED: get_model_field on Django 1.8

Version 0.9.2 (2015-01-23)

  • FIXED: Compatibility with Django v1.8a1

Version 0.9.1 (2014-12-03)

  • FIXED: Compatibility with Debug Toolbar's versions panel

Version 0.9 (2014-11-28)

  • FEATURE: Allow Min/Max-Only use of RangeFilter

  • FEATURE: Added TypedChoiceFilter

  • FIXED: Correct logic for short circuit on MultipleChoiceFilter

    Added always_filter attribute and is_noop() test to apply short-circuiting.

    Set always_filter to False on init to apply default is_noop() test. Override is_noop() for more complex cases.

  • MISC: Version bumping with bumpversion

Version 0.8 (2014-09-29)

  • FEATURE: Added exclusion filters support
  • FEATURE: Added fields dictionary shorthand syntax
  • FEATURE: Added MethodFilter.
  • FIXED: #115 "filters.Filter.filter() fails if it receives [] or () as value"
  • MISC: Various Documentation and Testing improvements

Version 0.7 (2013-08-10)

  • FEATURE: Added support for AutoField.
  • FEATURE: There is a "distinct" flag to ensure that only unique rows are returned.
  • FEATURE: Support descending ordering (slighty backwards incompatible).
  • FEATURE: Support "strict" querysets, ie wrong filter data returns no results.
  • FIXED: Some translation strings were changed to be in line with admin.
  • FIXED: Support for Django 1.7.

Version 0.6 (2013-03-25)

  • raised minimum Django version to 1.4.x
  • added Python 3.2 and Python 3.3 support
  • added Django 1.5 support and initial 1.6 compatability
  • FEATURE: recognition of custom model field subclasses
  • FEATURE: allow optional display names for order_by values
  • FEATURE: addition of class-based FilterView
  • FEATURE: addition of count() method on FilterSet to prevent pagination from loading entire queryset
  • FIXED: attempts to filter on reverse side of m2m, o2o or fk would raise an error

Version 0.5.4 (2012-11-16)

  • project brought back to life