GitHub Search Django REST framework

Release Notes

Release Early, Release Often

— Eric S. Raymond, The Cathedral and the Bazaar.

Versioning

Minor version numbers (0.0.x) are used for changes that are API compatible. You should be able to upgrade between minor point releases without any other code changes.

Medium version numbers (0.x.0) may include API changes, in line with the deprecation policy. You should read the release notes carefully before upgrading between medium point releases.

Major version numbers (x.0.0) are reserved for substantial project milestones.

Deprecation policy

REST framework releases follow a formal deprecation policy, which is in line with Django's deprecation policy.

The timeline for deprecation of a feature present in version 1.0 would work as follows:

  • Version 1.1 would remain fully backwards compatible with 1.0, but would raise PendingDeprecationWarning warnings if you use the feature that are due to be deprecated. These warnings are silent by default, but can be explicitly enabled when you're ready to start migrating any required changes. For example if you start running your tests using python -Wd manage.py test, you'll be warned of any API changes you need to make.

  • Version 1.2 would escalate these warnings to DeprecationWarning, which is loud by default.

  • Version 1.3 would remove the deprecated bits of API entirely.

Note that in line with Django's policy, any parts of the framework not mentioned in the documentation should generally be considered private API, and may be subject to change.

Upgrading

To upgrade Django REST framework to the latest version, use pip:

pip install -U djangorestframework

You can determine your currently installed version using pip freeze:

pip freeze | grep djangorestframework

3.1.x series

3.1.3

Date: 4th June 2015.

  • Add DurationField. (#2481, #2989)
  • Add format argument to UUIDField. (#2788, #3000)
  • MultipleChoiceField empties incorrectly on a partial update using multipart/form-data (#2993, #2894)
  • Fix a bug in options related to read-only RelatedField. (#2981, #2811)
  • Fix nested serializers with unique_together relations. (#2975)
  • Allow unexpected values for ChoiceField/MultipleChoiceField representations. (#2839, #2940)
  • Rollback the transaction on error if ATOMIC_REQUESTS is set. (#2887, #2034)
  • Set the action on a view when override_method regardless of its None-ness. (#2933)
  • DecimalField accepts 2E+2 as 200 and validates decimal place correctly. (#2948, #2947)
  • Support basic authentication with custom UserModel that change username. (#2952)
  • IPAddressField improvements. (#2747, #2618, #3008)
  • Improve DecimalField for easier subclassing. (#2695)

3.1.2

Date: 13rd May 2015.

  • DateField.to_representation can handle str and empty values. (#2656, #2687, #2869)
  • Use default reason phrases from HTTP standard. (#2764, #2763)
  • Raise error when ModelSerializer used with abstract model. (#2757, #2630)
  • Handle reversal of non-API view_name in HyperLinkedRelatedField (#2724, #2711)
  • Dont require pk strictly for related fields. (#2745, #2754)
  • Metadata detects null boolean field type. (#2762)
  • Proper handling of depth in nested serializers. (#2798)
  • Display viewset without paginator. (#2807)
  • Don't check for deprecated .model attribute in permissions (#2818)
  • Restrict integer field to integers and strings. (#2835, #2836)
  • Improve IntegerField to use compiled decimal regex. (#2853)
  • Prevent empty queryset to raise AssertionError. (#2862)
  • DjangoModelPermissions rely on get_queryset. (#2863)
  • Check AcceptHeaderVersioning with content negotiation in place. (#2868)
  • Allow DjangoObjectPermissions to use views that define get_queryset. (#2905)

3.1.1

Date: 23rd March 2015.

  • Security fix: Escape tab switching cookie name in browsable API.
  • Display input forms in browsable API if serializer_class is used, even when get_serializer method does not exist on the view. (#2743)
  • Use a password input for the AuthTokenSerializer. (#2741)
  • Fix missing anchor closing tag after next button. (#2691)
  • Fix lookup_url_kwarg handling in viewsets. (#2685, #2591)
  • Fix problem with importing rest_framework.views in apps.py (#2678)
  • LimitOffsetPagination raises TypeError if PAGE_SIZE not set (#2667, #2700)
  • German translation for min_value field error message references max_value. (#2645)
  • Remove MergeDict. (#2640)
  • Support serializing unsaved models with related fields. (#2637, #2641)
  • Allow blank/null on radio.html choices. (#2631)

3.1.0

Date: 5th March 2015.

For full details see the 3.1 release announcement.

3.0.x series

3.0.5

Date: 10th February 2015.

  • Fix a bug where _closable_objects breaks pickling. (#1850, #2492)
  • Allow non-standard User models with Throttling. (#2524)
  • Support custom User.db_table in TokenAuthentication migration. (#2479)
  • Fix misleading AttributeError tracebacks on Request objects. (#2530, #2108)
  • ManyRelatedField.get_value clearing field on partial update. (#2475)
  • Removed '.model' shortcut from code. (#2486)
  • Fix detail_route and list_route mutable argument. (#2518)
  • Prefetching the user object when getting the token in TokenAuthentication. (#2519)

3.0.4

Date: 28th January 2015.

  • Django 1.8a1 support. (#2425, #2446, #2441)
  • Add DictField and support Django 1.8 HStoreField. (#2451, #2106)
  • Add UUIDField and support Django 1.8 UUIDField. (#2448, #2433, #2432)
  • BaseRenderer.render now raises NotImplementedError. (#2434)
  • Fix timedelta JSON serialization on Python 2.6. (#2430)
  • ResultDict and ResultList now appear as standard dict/list. (#2421)
  • Fix visible HiddenField in the HTML form of the web browsable API page. (#2410)
  • Use OrderedDict for RelatedField.choices. (#2408)
  • Fix ident format when using HTTP_X_FORWARDED_FOR. (#2401)
  • Fix invalid key with memcached while using throttling. (#2400)
  • Fix FileUploadParser with version 3.x. (#2399)
  • Fix the serializer inheritance. (#2388)
  • Fix caching issues with ReturnDict. (#2360)

3.0.3

Date: 8th January 2015.

  • Fix MinValueValidator on models.DateField. (#2369)
  • Fix serializer missing context when pagination is used. (#2355)
  • Namespaced router URLs are now supported by the DefaultRouter. (#2351)
  • required=False allows omission of value for output. (#2342)
  • Use textarea input for models.TextField. (#2340)
  • Use custom ListSerializer for pagination if required. (#2331, #2327)
  • Better behavior with null and '' for blank HTML fields. (#2330)
  • Ensure fields in exclude are model fields. (#2319)
  • Fix IntegerField and max_length argument incompatibility. (#2317)
  • Fix the YAML encoder for 3.0 serializers. (#2315, #2283)
  • Fix the behavior of empty HTML fields. (#2311, #1101)
  • Fix Metaclass attribute depth ignoring fields attribute. (#2287)
  • Fix format_suffix_patterns to work with Django's i18n_patterns. (#2278)
  • Ability to customize router URLs for custom actions, using url_path. (#2010)
  • Don't install Django REST Framework as egg. (#2386)

3.0.2

Date: 17th December 2014.

  • Ensure request.user is made available to response middleware. (#2155)
  • Client.logout() also cancels any existing force_authenticate. (#2218, #2259)
  • Extra assertions and better checks to preventing incorrect serializer API use. (#2228, #2234, #2262, #2263, #2266, #2267, #2289, #2291)
  • Fixed min_length message for CharField. (#2255)
  • Fix UnicodeDecodeError, which can occur on serializer repr. (#2270, #2279)
  • Fix empty HTML values when a default is provided. (#2280, #2294)
  • Fix SlugRelatedField raising UnicodeEncodeError when used as a multiple choice input. (#2290)

3.0.1

Date: 11th December 2014.

  • More helpful error message when the default Serializer create() fails. (#2013)
  • Raise error when attempting to save serializer if data is not valid. (#2098)
  • Fix FileUploadParser breaks with empty file names and multiple upload handlers. (#2109)
  • Improve BindingDict to support standard dict-functions. (#2135, #2163)
  • Add validate() to ListSerializer. (#2168, #2225, #2232)
  • Fix JSONP renderer failing to escape some characters. (#2169, #2195)
  • Add missing default style for FileField. (#2172)
  • Actions are required when calling ViewSet.as_view(). (#2175)
  • Add allow_blank to ChoiceField. (#2184, #2239)
  • Cosmetic fixes in the HTML renderer. (#2187)
  • Raise error if fields on serializer is not a list of strings. (#2193, #2213)
  • Improve checks for nested creates and updates. (#2194, #2196)
  • validated_attrs argument renamed to validated_data in Serializer create()/update(). (#2197)
  • Remove deprecated code to reflect the dropped Django versions. (#2200)
  • Better serializer errors for nested writes. (#2202, #2215)
  • Fix pagination and custom permissions incompatibility. (#2205)
  • Raise error if fields on serializer is not a list of strings. (#2213)
  • Add missing translation markers for relational fields. (#2231)
  • Improve field lookup behavior for dicts/mappings. (#2244, #2243)
  • Optimized hyperlinked PK. (#2242)

3.0.0

Date: 1st December 2014

For full details see the 3.0 release announcement.

For older release notes, please see the version 2.x documentation.