What's Changed

Bug fixes

• Fix HTMLFormRenderer with empty datetime values by @p-r-a-v-i-n in #9928

Full Changelog: 3.17.0...3.17.1

What's Changed

Breaking changes

• Drop support for Python 3.9 by @auvipy in #9781
• Drop deprecated coreapi support by @browniebroke in #9895

Features

• Add ability to specify output format for DurationField by @sevdog in #8532
• Add missing decorators: @versioning_class(), @content_negotiation_class(), @metadata_class() for function-based views by @qqii in #9719
• Add support for Python 3.14 by @cclauss in #9780
• Support violation_error_code and violation_error_message from UniqueConstraint in UniqueTogetherValidator by @s-aleshin in #9766
• Add support for ipaddress objects in JSONEncoder by @corenting in #9087
• Add optional support to serialize BigInteger to string by @HoodyH in #9775
• Add Django 6.0 support by @MehrazRumman in #9819

Bug fixes

• Prevent small risk of Token overwrite by @mahdirahimi1999 in #9754
• Fix UniqueTogetherValidator validation when condition references a read-only field by @ticosax in #9764
• Fix validation on many to many field when default=None by @Genarito in #9790
• Fix invalid SPDX license expression in __init__.py by @TheFunctionalGuy in #9799
• Fix HTMLFormRenderer to ensure a valid datetime-local format by @mgaligniana in #9365
• Fix mutable default arguments in OrderingFilter methods by @killerdevildog in #9742
• Update TokenAdmin to respect USERNAME_FIELD of the user model by @m000 in #9836
• Preserve ordering in MultipleChoiceField by @fbozhang in #9735

Translations

• Update French translation by @SebCorbin in #9770
• Update Brazilian Portuguese translations by @JVPinheiroReis in #9828
• Fix and improve French translations by @deronnax in #9896
• Add missing Russian translation by @minorytanaka in #9903

Packaging

• Migrate packaging to pyproject.toml by @deronnax in #9056
• Move package data rules from MANIFEST.in to pyproject.toml by @p-r-a-v-i-n in #9825
• Set up release workflow with trusted publisher by @browniebroke in #9852

Other changes

• Refactor token generation to use the secrets module by @mahdirahimi1999 in #9760
• Add validation for decorator out-of-order with @api_view by @kernelshard in #9821
• Switch to mkdocs material theme for documentation by @browniebroke in #9849

New Contributors

• @khaledsukkar2 made their first contribution in #9717
• @qqii made their first contribution in #9719
• @zankoAn made their first contribution in #9788
• @uche-wealth made their first contribution in #9795
• @s-aleshin made their first contribution in #9766
• @Infamous003 made their first contribution in #9794
• @Genarito made their first contribution in #9790
• @TheFunctionalGuy made their first contribution in #9799
• @mahdighadiriii made their first contribution in #9800
• @p-r-a-v-i-n made their first contribution in #9801
• @itssimon made their first contribution in #9718
• @huynguyengl99 made their first contribution in #9785
• @corenting made their first contribution in #9087
• @killerdevildog made their first contribution in #9742
• @dayandavid made their first contribution in #9820
• @abhishektiwari made their first contribution in #9826
• @HoodyH made their first contribution in #9775
• @Shrikantgiri25 made their first contribution in #9808
• @JVPinheiroReis made their first contribution in #9828
• @m000 made their first contribution in #9836
• @Nabute made their first contribution in #9767
• @therealjozber made their first contribution in #9845
• @nexapytech made their first contribution in #9867
• @RispaJoseph made their first contribution in #9874
• @LorenzoGuideri made their first contribution in #9875
• @maldoinc made their first contribution in #9893
• @0Nafi0 made their first contribution in #9861
• @MoeSalah1999 made their first contribution in #9870
• @kelsonbrito50 made their first contribution in #9901
• @fbozhang made their first contribution in #9735
• @minorytanaka made their first contribution in #9903
• @kosbemrunal made their first contribution in #9904
• @htvictoire made their first contribution in #9916

Full Changelog: 3.16.1...3.17.0

This release fixes a few bugs, clean-up some old code paths for unsupported Python versions and improve translations.

Minor changes

• Cleanup optional backports.zoneinfo dependency and conditions on unsupported Python 3.8 and lower in #9681. Python versions prior to 3.9 were already unsupported so this isn't considered as a breaking change.

Bug fixes

• Fix regression in unique_together validation with SerializerMethodField in #9712
• Fix UniqueTogetherValidator to handle fields with source attribute in #9688
• Drop HTML line breaks on long headers in browsable API in #9438

Translations

• Add Kazakh locale support in #9713
• Update translations for Korean translations in #9571
• Update German translations in #9676
• Update Chinese translations in #9675
• Update Arabic translations-sal in #9595
• Update Persian translations in #9576
• Update Spanish translations in #9701
• Update Turkish Translations in #9749
• Fix some typos in Brazilian Portuguese translations in #9673

Documentation

• Removed reference to GitHub Issues and Discussions in #9660
• Add drf-restwind and update outdated images in browsable-api.md in #9680
• Updated funding page to represent current scope in #9686
• Fix broken Heroku JSON Schema link in #9693
• Update Django documentation links to use stable version in #9698
• Expand docs on unique constraints cause 'required=True' in #9725
• Revert extension back from djangorestframework-guardian2 to djangorestframework-guardian in #9734
• Add note to tutorial about required request in serializer context when using HyperlinkedModelSerializer in #9732

Internal changes

• Update GitHub Actions to use Ubuntu 24.04 for testing in #9677
• Update test matrix to use Django 5.2 stable version in #9679
• Add pyupgrade to pre-commit hooks in #9682
• Fix test with Django 5 when pytz is available in #9715

New Contributors

• @araggohnxd made their first contribution in #9673
• @mbeijen made their first contribution in #9660
• @stefan6419846 made their first contribution in #9676
• @ren000thomas made their first contribution in #9675
• @ulgens made their first contribution in #9682
• @bukh-sal made their first contribution in #9595
• @rezatn0934 made their first contribution in #9576
• @Rohit10jr made their first contribution in #9693
• @kushibayev made their first contribution in #9713
• @alihassancods made their first contribution in #9732
• @kulikjak made their first contribution in #9715
• @Natgho made their first contribution in #9749

Full Changelog: 3.16.0...3.16.1

This release is considered a significant release to improve upstream support with Django and Python. Some of these may change the behaviour of existing features and pre-existing behaviour. Specifically, some fixes were added to around the support of UniqueConstraint with nullable fields which will improve built-in serializer validation.

Features

• Add official support for Django 5.1 and its new LoginRequiredMiddleware in #9514 and #9657
• Add official Django 5.2a1 support in #9634
• Add support for Python 3.13 in #9527 and #9556
• Support Django 2.1+ test client JSON data automatically serialized in #6511 and fix a regression in #9615

Bug fixes

• Fix unique together validator to respect condition's fields from UniqueConstraint in #9360
• Fix raising on nullable fields part of UniqueConstraint in #9531
• Fix unique_together validation with source in #9482
• Added protections to AttributeError raised within properties in #9455
• Fix get_template_context to handle also lists in #9467
• Fix "Converter is already registered" deprecation warning. in #9512
• Fix noisy warning and accept integers as min/max values of DecimalField in #9515
• Fix usages of open() in setup.py in #9661

Translations

• Add some missing Chinese translations in #9505
• Fix spelling mistakes in Farsi language were corrected in #9521
• Fixing and adding missing Brazilian Portuguese translations in #9535

Removals

• Remove support for Python 3.8 in #9670
• Remove long deprecated code from request wrapper in #9441
• Remove deprecated AutoSchema._get_reference method in #9525

Documentation and internal changes

• Provide tests for hashing of OperandHolder in #9437
• Update documentation: Add adrf third party package in #9198
• Update tutorials links in Community contributions docs in #9476
• Fix usage of deprecated Django function in example from docs in #9509
• Move path converter docs into a separate section in #9524
• Add test covering update view without queryset attribute in #9528
• Fix Transifex link in #9541
• Fix example httpie call in docs in #9543
• Fix example for serializer field with choices in docs in #9563
• Remove extra <> in validators example in #9590
• Update strftime link in the docs in #9624
• Switch to codecov GHA in #9618
• Add note regarding availability of the action attribute in 'Introspecting ViewSet actions' docs section in #9633
• Improved description of allowed throttling rates in documentation in #9640
• Add rest-framework-gm2m-relations package to the list of 3rd party libraries in #9063
• Fix a number of typos in the test suite in the docs in #9662
• Add django-pyoidc as a third party authentication library in #9667

New Contributors

• @maerteijn made their first contribution in #9198
• @FraCata00 made their first contribution in #9444
• @AlvaroVega made their first contribution in #9451
• @james-mchugh made their first contribution in #9455
• @ifeanyidavid made their first contribution in #9479
• @p-schlickmann made their first contribution in #9480
• @akkuman made their first contribution in #9505
• @rafaelgramoschi made their first contribution in #9509
• @Sinaatkd made their first contribution in #9521
• @gtkacz made their first contribution in #9535
• @sliverc made their first contribution in #9556
• @gabrielromagnoli1987 made their first contribution in #9543
• @cheehong1030 made their first contribution in #9563
• @amansharma612 made their first contribution in #9590
• @Gluroda made their first contribution in #9616
• @deepakangadi made their first contribution in #9624
• @EXG1O made their first contribution in #9633
• @decadenza made their first contribution in #9640
• @mojtabaakbari221b made their first contribution in #9063
• @mikemanger made their first contribution in #9661
• @gbip made their first contribution in #9667

Full Changelog: 3.15.2...3.16.0

What's Changed

• Add @api_view example to caching documentation by @BradWells in #9131
• Update docstring by @jthevos in #9340
• Apply black formatting to caching markdown by @jthevos in #9341
• Update renderers documentation example by @mgaligniana in #9362
• Removing live examples of tutorial code that are no longer hosted by @TGoddessana in #9363
• Docs: Remove an unnecessary step from quickstart.md by @Gogowitsch in #9387
• Documentation: Add Python 3.12 to the requirements by @Szaroslav in #9382
• Tweak README.md links. by @tomchristie in #9375
• Revert "Ensure CursorPagination respects nulls in the ordering field" by @max-muoto in #9381
• use warnings rather than logging a warning for DecimalField warnings by @terencehonles in #9367
• 20240426 docs by @peterthomassen in #9392
• Cleanup by @peterthomassen in #9393
• tests: Check urlpatterns after cleanups by @stanislavlevin in #9400
• docs: Correct some evaluation results and a httpie option in Tutorial1 by @wkwkhautbois in #9421
• Add __hash__ method for permissions.OperandHolder class by @vanya909 in #9417
• Fix potential XSS vulnerability in break_long_headers template filter by @ch4n3-yoon in #9435
• Version 3.15.2. by @tomchristie in #9439

New Contributors

• @BradWells made their first contribution in #9131
• @jthevos made their first contribution in #9340
• @Gogowitsch made their first contribution in #9387
• @Szaroslav made their first contribution in #9382
• @wkwkhautbois made their first contribution in #9421
• @ch4n3-yoon made their first contribution in #9435

Full Changelog: 3.15.1...3.15.2

What's Changed

• Update the message to be consistent with the Django `HttpResponseBa… by @MayCuaTroi in #9287
• Make inflection package truly optional by @browniebroke in #9303
• Fix broken links in release notes for 3.15 by @browniebroke in #9305
• TokenAdmin.autocomplete_fields Breaks Some Use Cases, Revert by @alexdlaird in #9301
• Add drf-sendables to third-party-packages.md by @amikrop in #9261
• Revert "feat: Add some changes to ValidationError to support django style vad…" by @auvipy in #9326
• Revert "Re-prefetch related objects after updating" by @auvipy in #9327
• Revert #8863 by @tomchristie in #9330
• Revert #8009 by @tomchristie in #9332
• Revert #9030 by @tomchristie in #9333
• Revert "Fix NamespaceVersioning ignoring DEFAULT_VERSION on non-None namespaces" by @auvipy in #9335
• SearchFilter.get_search_terms returns list. by @tomchristie in #9338
• Version 3.15.1 by @tomchristie in #9339

New Contributors

• @MayCuaTroi made their first contribution in #9287
• @alexdlaird made their first contribution in #9301

Full Changelog: 3.15.0...3.15.1

What's Changed

Released 15th March 2024

• Django 5.0 and Python 3.12 support [#9157]
• Use POST method instead of GET to perform logout in browsable API [9208]
• Added jQuery 3.7.1 support & dropped previous version [#9094]
• Use str as default path converter [#9066]
• Document support for http.HTTPMethod in the @action decorator added in Python 3.11 [#9067]
• Update exceptions.md [#9071]
• Partial serializer should not have required fields [#7563]
• Propagate 'default' from model field to serializer field. [#9030]
• Allow to override child.run_validation call in ListSerializer [#8035]
• Align SearchFilter behavior to django.contrib.admin search [#9017]
• Class name added to unknown field error [#9019]
• Fix: Pagination response schemas. [#9049]
• Fix choices in ChoiceField to support IntEnum [#8955]
• Fix SearchFilter rendering search field with invalid value [#9023]
• Fix OpenAPI Schema yaml rendering for timedelta [#9007]
• Fix NamespaceVersioning ignoring DEFAULT_VERSION on non-None namespaces [#7278]
• Added Deprecation Warnings for CoreAPI [#7519]
• Removed usage of field.choices that triggered full table load [#8950]
• Permit mixed casing of string values for BooleanField validation [#8970]
• Fixes BrowsableAPIRenderer for usage with ListSerializer. [#7530]
• Change semantic of OR of two permission classes [#7522]
• Remove dependency on pytz [#8984]
• Make set_value a method within Serializer [#8001]
• Fix URLPathVersioning reverse fallback [#7247]
• Warn about Decimal type in min_value and max_value arguments of DecimalField [#8972]
• Fix mapping for choice values [#8968]
• Refactor read function to use context manager for file handling [#8967]
• Fix: fallback on CursorPagination ordering if unset on the view [#8954]
• Replaced OrderedDict with dict [#8964]
• Refactor get_field_info method to include max_digits and decimal_places attributes in SimpleMetadata class [#8943]
• Implement __eq__ for validators [#8925]
• Ensure CursorPagination respects nulls in the ordering field [#8912]
• Use ZoneInfo as primary source of timezone data [#8924]
• Add username search field for TokenAdmin (#8927) [#8934]
• Handle Nested Relation in SlugRelatedField when many=False [#8922]
• Bump version of jQuery to 3.6.4 & updated ref links [#8909]
• Support UniqueConstraint [#7438]
• Allow Request, Response, Field, and GenericAPIView to be subscriptable. This allows the classes to be made generic for type checking. [#8825]
• Feat: Add some changes to ValidationError to support django style validation errors [#8863]
• Fix Respect can_read_model permission in DjangoModelPermissions [#8009]
• Add SimplePathRouter [#6789]
• Re-prefetch related objects after updating [#8043]
• Fix FilePathField required argument [#8805]
• Raise ImproperlyConfigured exception if basename is not unique [#8438]
• Use PrimaryKeyRelatedField pkfield in openapi [#8315]
• replace partition with split in BasicAuthentication [#8790]
• Fix BooleanField's allow_null behavior [#8614]
• Handle Django's ValidationErrors in ListField [#6423]
• Remove a bit of inline CSS. Add CSP nonce where it might be required and is available [#8783]
• Use autocomplete widget for user selection in Token admin [#8534]
• Make browsable API compatible with strong CSP [#8784]
• Avoid inline script execution for injecting CSRF token [#7016]
• Mitigate global dependency on inflection [#8017] [#8781]
• Register Django urls [#8778]
• Implemented Verbose Name Translation for TokenProxy [#8713]
• Properly handle OverflowError in DurationField deserialization [#8042]
• Fix OpenAPI operation name plural appropriately [#8017]
• Represent SafeString as plain string on schema rendering [#8429]
• Fix #8771 - Checking for authentication even if _ignore_model_permissions = True [#8772]
• Fix 404 when page query parameter is empty string [#8578]
• Fixes instance check in ListSerializer.to_representation [#8726] [#8727]
• FloatField will crash if the input is a number that is too big [#8725]
• Add missing DurationField to SimpleMetadata label_lookup [#8702]
• Add support for Python 3.11 [#8752]
• Make request consistently available in pagination classes [#8764]
• Possibility to remove trailing zeros on DecimalFields representation [#6514]
• Add a method for getting serializer field name (OpenAPI) [#7493]
• Add __eq__ method for OperandHolder class [#8710]
• Avoid importing django.test package when not testing [#8699]
• Preserve exception messages for wrapped Django exceptions [#8051]
• Include examples and format to OpenAPI schema of CursorPagination [#8687] [#8686]
• Fix infinite recursion with deepcopy on Request [#8684]
• Refactor: Replace try/except with contextlib.suppress() [#8676]
• Minor fix to SerializeMethodField docstring [#8629]
• Minor refactor: Unnecessary use of list() function [#8672]
• Unnecessary list comprehension [#8670]
• Use correct class to indicate present deprecation [#8665]

Full Changelog: https://github.com/encode/django-rest-framework/compa...

• Django 2.2 is no longer supported. #8662
• Django 4.1 compatibility. #8591
• Add --api-version CLI option to generateschema management command. #8663
• Enforce is_valid(raise_exception=False) as a keyword-only argument. #7952
• Stop calling set_context on Validators. #8589
• Return NotImplemented from ErrorDetails.__ne__. #8538
• Don't evaluate DateTimeField.default_timezone when a custom timezone is set. #8531
• Make relative URLs clickable in Browseable API. #8464
• Support ManyRelatedField falling back to the default value when the attribute specified by dot notation doesn't exist. Matches ManyRelatedField.get_attribute to Field.get_attribute. #7574
• Make schemas.openapi.get_reference public. #7515
• Make ReturnDict support dict union operators on Python 3.9 and later. #8302
• Update throttling to check if request.user is set before checking if the user is authenticated. #8370

• Revert schema naming changes with function based @api_view. #8297

• Django 4.0 compatability. #8178
• Add max_length and min_length options to ListSerializer. #8165
• Add get_request_serializer and get_response_serializer hooks to AutoSchema. #7424
• Fix OpenAPI representation of null-able read only fields. #8116
• Respect UNICODE_JSON setting in API schema outputs. #7991
• Fix for RemoteUserAuthentication. #7158
• Make Field constructors keyword-only. #7632