mirror of
https://github.com/django/django.git
synced 2024-11-18 15:34:16 +00:00
419 lines
12 KiB
Plaintext
419 lines
12 KiB
Plaintext
============================================
|
|
Django 2.1 release notes - UNDER DEVELOPMENT
|
|
============================================
|
|
|
|
Welcome to Django 2.1!
|
|
|
|
These release notes cover the :ref:`new features <whats-new-2.1>`, as well as
|
|
some :ref:`backwards incompatible changes <backwards-incompatible-2.1>` you'll
|
|
want to be aware of when upgrading from Django 2.0 or earlier. We've
|
|
:ref:`dropped some features<removed-features-2.1>` that have reached the end of
|
|
their deprecation cycle, and we've :ref:`begun the deprecation process for some
|
|
features <deprecated-features-2.1>`.
|
|
|
|
See the :doc:`/howto/upgrade-version` guide if you're updating an existing
|
|
project.
|
|
|
|
Python compatibility
|
|
====================
|
|
|
|
Django 2.1 supports Python 3.5, 3.6, and 3.7. Django 2.0 is the last version to
|
|
support Python 3.4. We **highly recommend** and only officially support the
|
|
latest release of each series.
|
|
|
|
.. _whats-new-2.1:
|
|
|
|
What's new in Django 2.1
|
|
========================
|
|
|
|
Minor features
|
|
--------------
|
|
|
|
:mod:`django.contrib.admin`
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
* :attr:`.ModelAdmin.search_fields` now accepts any lookup such as
|
|
``field__exact``.
|
|
|
|
* jQuery is upgraded from version 2.2.3 to 3.2.1.
|
|
|
|
* The new :meth:`.ModelAdmin.delete_queryset` method allows customizing the
|
|
deletion process of the "delete selected objects" action.
|
|
|
|
* You can now :ref:`override the the default admin site
|
|
<overriding-default-admin-site>`.
|
|
|
|
* The new :attr:`.ModelAdmin.sortable_by` attribute and
|
|
:meth:`.ModelAdmin.get_sortable_by` method allow limiting the columns that
|
|
can be sorted in the change list page.
|
|
|
|
* The ``admin_order_field`` attribute for elements in
|
|
:attr:`.ModelAdmin.list_display` may now be a query expression.
|
|
|
|
* The new :meth:`.ModelAdmin.get_deleted_objects()` method allows customizing
|
|
the deletion process of the delete view and the "delete selected" action.
|
|
|
|
* The ``actions.html``, ``change_list_results.html``, ``date_hierarchy.html``,
|
|
``pagination.html``, ``prepopulated_fields_js.html``, ``search_form.html``,
|
|
and ``submit_line.html`` templates can now be :ref:`overridden per app or
|
|
per model <admin-templates-overridden-per-app-or-model>` (besides overridden
|
|
globally).
|
|
|
|
* The admin change list and change form object tools can now be :ref:`overridden
|
|
per app, per model, or globally <admin-templates-overridden-per-app-or-model>`
|
|
with ``change_list_object_tools.html`` and
|
|
``change_form_object_tools.html`` templates.
|
|
|
|
:mod:`django.contrib.admindocs`
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
* ...
|
|
|
|
:mod:`django.contrib.auth`
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
* :djadmin:`createsuperuser` now gives a prompt to allow bypassing the
|
|
:setting:`AUTH_PASSWORD_VALIDATORS` checks.
|
|
|
|
* :class:`~django.contrib.auth.forms.UserCreationForm` and
|
|
:class:`~django.contrib.auth.forms.UserChangeForm` no longer need to be
|
|
rewritten for a custom user model.
|
|
|
|
:mod:`django.contrib.contenttypes`
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
* ...
|
|
|
|
:mod:`django.contrib.gis`
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
* The new :meth:`.GEOSGeometry.buffer_with_style` method is a version of
|
|
:meth:`~.GEOSGeometry.buffer` that allows customizing the style of the
|
|
buffer.
|
|
|
|
:mod:`django.contrib.messages`
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
* ...
|
|
|
|
:mod:`django.contrib.postgres`
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
* ...
|
|
|
|
:mod:`django.contrib.redirects`
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
* ...
|
|
|
|
:mod:`django.contrib.sessions`
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
* ...
|
|
|
|
:mod:`django.contrib.sitemaps`
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
* ...
|
|
|
|
:mod:`django.contrib.sites`
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
* ...
|
|
|
|
:mod:`django.contrib.staticfiles`
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
* ...
|
|
|
|
:mod:`django.contrib.syndication`
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
* ...
|
|
|
|
Cache
|
|
~~~~~
|
|
|
|
* The :ref:`local-memory cache backend <local-memory-caching>` now uses a
|
|
least-recently-used (LRU) culling strategy rather than a pseudo-random one.
|
|
|
|
CSRF
|
|
~~~~
|
|
|
|
* ...
|
|
|
|
Database backends
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
* ...
|
|
|
|
Email
|
|
~~~~~
|
|
|
|
* ...
|
|
|
|
File Storage
|
|
~~~~~~~~~~~~
|
|
|
|
* ...
|
|
|
|
File Uploads
|
|
~~~~~~~~~~~~
|
|
|
|
* ...
|
|
|
|
|
|
Forms
|
|
~~~~~
|
|
|
|
* ...
|
|
|
|
Generic Views
|
|
~~~~~~~~~~~~~
|
|
|
|
* ...
|
|
|
|
Internationalization
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
* Added the :meth:`~django.utils.translation.get_supported_language_variant`
|
|
function.
|
|
|
|
* Untranslated strings for territorial language variants now use the
|
|
translations of the generic language. For example, untranslated ``pt_BR``
|
|
strings use ``pt`` translations.
|
|
|
|
Management Commands
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
* The new :option:`inspectdb --include-views` option allows creating models
|
|
for database views.
|
|
|
|
Migrations
|
|
~~~~~~~~~~
|
|
|
|
* Added support for serialization of ``functools.partialmethod`` objects.
|
|
|
|
Models
|
|
~~~~~~
|
|
|
|
* Models can now use ``__init_subclass__()`` from :pep:`487`.
|
|
|
|
* A ``BinaryField`` may now be set to ``editable=True`` if you wish to include
|
|
it in model forms.
|
|
|
|
* A number of new text database functions are added:
|
|
:class:`~django.db.models.functions.Chr`,
|
|
:class:`~django.db.models.functions.Left`,
|
|
:class:`~django.db.models.functions.LTrim`,
|
|
:class:`~django.db.models.functions.Ord`,
|
|
:class:`~django.db.models.functions.Replace`,
|
|
:class:`~django.db.models.functions.Right`,
|
|
:class:`~django.db.models.functions.RTrim`, and
|
|
:class:`~django.db.models.functions.Trim`.
|
|
|
|
* The new :class:`~django.db.models.functions.TruncWeek` function truncates
|
|
:class:`~django.db.models.DateField` and
|
|
:class:`~django.db.models.DateTimeField` to the Monday of a week.
|
|
|
|
* Query expressions can now be negated using a minus sign.
|
|
|
|
* :meth:`.QuerySet.order_by` and :meth:`distinct(*fields) <.QuerySet.distinct>`
|
|
now support using field transforms.
|
|
|
|
Requests and Responses
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
* Added :meth:`.HttpRequest.get_full_path_info`.
|
|
|
|
Serialization
|
|
~~~~~~~~~~~~~
|
|
|
|
* ...
|
|
|
|
Signals
|
|
~~~~~~~
|
|
|
|
* ...
|
|
|
|
Templates
|
|
~~~~~~~~~
|
|
|
|
* The new :tfilter:`json_script` filter safely outputs a Python object as JSON,
|
|
wrapped in a ``<script>`` tag, ready for use with JavaScript.
|
|
|
|
Tests
|
|
~~~~~
|
|
|
|
* Added test :class:`~django.test.Client` support for 307 and 308 redirects.
|
|
|
|
* The test :class:`~django.test.Client` now serializes a request data
|
|
dictionary as JSON if ``content_type='application/json'``. You can customize
|
|
the JSON encoder with test client's ``json_encoder`` parameter.
|
|
|
|
URLs
|
|
~~~~
|
|
|
|
* ...
|
|
|
|
Validators
|
|
~~~~~~~~~~
|
|
|
|
* ...
|
|
|
|
.. _backwards-incompatible-2.1:
|
|
|
|
Backwards incompatible changes in 2.1
|
|
=====================================
|
|
|
|
Database backend API
|
|
--------------------
|
|
|
|
* To adhere to :pep:`249`, exceptions where a database doesn't support a
|
|
feature are changed from :exc:`NotImplementedError` to
|
|
:exc:`django.db.NotSupportedError`.
|
|
|
|
* Renamed the ``allow_sliced_subqueries`` database feature flag to
|
|
``allow_sliced_subqueries_with_in``.
|
|
|
|
* ``DatabaseOperations.distinct_sql()`` now requires an additional ``params``
|
|
argument and returns a tuple of SQL and parameters instead of a SQL string.
|
|
|
|
:mod:`django.contrib.gis`
|
|
-------------------------
|
|
|
|
* Support for SpatiaLite 4.0 is removed.
|
|
|
|
Dropped support for MySQL 5.5
|
|
-----------------------------
|
|
|
|
The end of upstream support for MySQL 5.5 is December 2018. Django 2.1 supports
|
|
MySQL 5.6 and higher.
|
|
|
|
Dropped support for PostgreSQL 9.3
|
|
----------------------------------
|
|
|
|
The end of upstream support for PostgreSQL 9.3 is September 2018. Django 2.1
|
|
supports PostgreSQL 9.4 and higher.
|
|
|
|
Removed ``BCryptPasswordHasher`` from the default ``PASSWORD_HASHERS`` setting
|
|
------------------------------------------------------------------------------
|
|
|
|
If you used bcrypt with Django 1.4 or 1.5 (before ``BCryptSHA256PasswordHasher``
|
|
was added in Django 1.6), you might have some passwords that use the
|
|
``BCryptPasswordHasher`` hasher.
|
|
|
|
You can check if that's the case like this::
|
|
|
|
from django.contrib.auth import get_user_model
|
|
User = get_user_model()
|
|
User.objects.filter(password__startswith='bcrypt$$')
|
|
|
|
If you want to continue to allow those passwords to be used, you'll
|
|
have to define the :setting:`PASSWORD_HASHERS` setting (if you don't already)
|
|
and include ``'django.contrib.auth.hashers.BCryptPasswordHasher'``.
|
|
|
|
Moved ``wrap_label`` widget template context variable
|
|
-----------------------------------------------------
|
|
|
|
To fix the lack of ``<label>`` when using ``RadioSelect`` and
|
|
``CheckboxSelectMultiple`` with ``MultiWidget``, the ``wrap_label`` context
|
|
variable now appears as an attribute of each option. For example, in a custom
|
|
``input_option.html`` template, change ``{% if wrap_label %}`` to
|
|
``{% if widget.wrap_label %}``.
|
|
|
|
Miscellaneous
|
|
-------------
|
|
|
|
* The minimum supported version of ``mysqlclient`` is increased from 1.3.3 to
|
|
1.3.7.
|
|
|
|
* The date format of ``Set-Cookie``'s ``Expires`` directive is changed to
|
|
follow :rfc:`7231#section-7.1.1.1` instead of Netscape's cookie standard.
|
|
Hyphens present in dates like ``Tue, 25-Dec-2018 22:26:13 GMT`` are removed.
|
|
This change should be merely cosmetic except perhaps for antiquated browsers
|
|
that don't parse the new format.
|
|
|
|
* ``allowed_hosts`` is now a required argument of private API
|
|
``django.utils.http.is_safe_url()``.
|
|
|
|
* The ``multiple`` attribute rendered by the
|
|
:class:`~django.forms.SelectMultiple` widget now uses HTML5 boolean syntax
|
|
rather than XHTML's ``multiple="multiple"``.
|
|
|
|
* HTML rendered by form widgets no longer includes a closing slash on void
|
|
elements, e.g. ``<br>``. This is incompatible within XHTML, although some
|
|
widgets already used aspects of HTML5 such as boolean attributes.
|
|
|
|
* The value of :class:`~django.forms.SelectDateWidget`'s empty options is
|
|
changed from 0 to an empty string, which mainly may require some adjustments
|
|
in tests that compare HTML.
|
|
|
|
.. _deprecated-features-2.1:
|
|
|
|
Features deprecated in 2.1
|
|
==========================
|
|
|
|
Miscellaneous
|
|
-------------
|
|
|
|
* The ``ForceRHR`` GIS function is deprecated in favor of the new
|
|
:class:`~django.contrib.gis.db.models.functions.ForcePolygonCW` function.
|
|
|
|
* ``django.utils.http.cookie_date()`` is deprecated in favor of
|
|
:func:`~django.utils.http.http_date`, which follows the format of the latest
|
|
RFC.
|
|
|
|
* ``{% load staticfiles %}`` and ``{% load admin_static %}`` are deprecated
|
|
in favor of ``{% load static %}``, which works the same.
|
|
|
|
* ``django.contrib.staticfiles.templatetags.static()`` is deprecated in favor
|
|
of ``django.templatetags.static.static()``.
|
|
|
|
.. _removed-features-2.1:
|
|
|
|
Features removed in 2.1
|
|
=======================
|
|
|
|
These features have reached the end of their deprecation cycle and are removed
|
|
in Django 2.1. See :ref:`deprecated-features-1.11` for details, including how
|
|
to remove usage of these features.
|
|
in Django 2.1. See :ref:`deprecated-features-1.11` and for details, including
|
|
how to remove usage of these features.
|
|
|
|
* ``contrib.auth.views.login()``, ``logout()``, ``password_change()``,
|
|
``password_change_done()``, ``password_reset()``, ``password_reset_done()``,
|
|
``password_reset_confirm()``, and ``password_reset_complete()`` are removed.
|
|
|
|
* The ``extra_context`` parameter of ``contrib.auth.views.logout_then_login()``
|
|
is removed.
|
|
|
|
* ``django.test.runner.setup_databases()`` is removed.
|
|
|
|
* ``django.utils.translation.string_concat()`` is removed.
|
|
|
|
* ``django.core.cache.backends.memcached.PyLibMCCache`` no longer supports
|
|
passing ``pylibmc`` behavior settings as top-level attributes of ``OPTIONS``.
|
|
|
|
* The ``host`` parameter of ``django.utils.http.is_safe_url()`` is removed.
|
|
|
|
* Silencing of exceptions raised while rendering the ``{% include %}`` template
|
|
tag is removed.
|
|
|
|
* ``DatabaseIntrospection.get_indexes()`` is removed.
|
|
|
|
* The ``authenticate()`` method of authentication backends requires ``request``
|
|
as the first positional argument.
|
|
|
|
* The ``django.db.models.permalink()`` decorator is removed.
|
|
|
|
* The ``USE_ETAGS`` setting is removed. ``CommonMiddleware`` and
|
|
``django.utils.cache.patch_response_headers()`` no longer set ETags.
|
|
|
|
* The ``Model._meta.has_auto_field`` attribute is removed.
|
|
|
|
* Support for regular expression groups with ``iLmsu#`` in ``url()`` is removed.
|
|
|
|
* Support for ``Widget.render()`` methods without the ``renderer`` argument
|
|
is removed.
|