mozilla / distribution-viewer

Mozilla Public License 2.0
6 stars 9 forks source link

Update django to 2.0 #318

Closed pyup-bot closed 6 years ago

pyup-bot commented 6 years ago

There's a new version of Django available. You are currently using 1.10.8. I have updated it to 2.0

These links might come in handy: PyPI | Changelog | Homepage

Changelog

2.0

========================

December 2, 2017

Welcome to Django 2.0!

These release notes cover the :ref:new features <whats-new-2.0>, as well as some :ref:backwards incompatible changes <backwards-incompatible-2.0> you'll want to be aware of when upgrading from Django 1.11 or earlier. We've :ref:dropped some features<removed-features-2.0> that have reached the end of their deprecation cycle, and we've :ref:begun the deprecation process for some features <deprecated-features-2.0>.

This release starts Django's use of a :ref:loose form of semantic versioning <internal-release-cadence>, but there aren't any major backwards incompatible changes that might be expected of a 2.0 release. Upgrading should be a similar amount of effort as past feature releases.

See the :doc:/howto/upgrade-version guide if you're updating an existing project.

Python compatibility

Django 2.0 supports Python 3.4, 3.5, and 3.6. We highly recommend and only officially support the latest release of each series.

The Django 1.11.x series is the last to support Python 2.7.

Django 2.0 will be the last release series to support Python 3.4. If you plan a deployment of Python 3.4 beyond the end-of-life for Django 2.0 (April 2019), stick with Django 1.11 LTS (supported until April 2020) instead. Note, however, that the end-of-life for Python 3.4 is March 2019.

Third-party library support for older version of Django

Following the release of Django 2.0, we suggest that third-party app authors drop support for all versions of Django prior to 1.11. At that time, you should be able to run your package's tests using python -Wd so that deprecation warnings do appear. After making the deprecation warning fixes, your app should be compatible with Django 2.0.

.. _whats-new-2.0:

What's new in Django 2.0

Simplified URL routing syntax

The new :func:django.urls.path() function allows a simpler, more readable URL routing syntax. For example, this example from previous Django releases::

url(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive),

could be written as::

path('articles/<int:year>/', views.year_archive),

The new syntax supports type coercion of URL parameters. In the example, the view will receive the year keyword argument as an integer rather than as a string. Also, the URLs that will match are slightly less constrained in the rewritten example. For example, the year 10000 will now match since the year integers aren't constrained to be exactly four digits long as they are in the regular expression.

The django.conf.urls.url() function from previous versions is now available as :func:django.urls.re_path. The old location remains for backwards compatibility, without an imminent deprecation. The old django.conf.urls.include() function is now importable from django.urls so you can use from django.urls import include, path, re_path in your URLconfs.

The :doc:/topics/http/urls document is rewritten to feature the new syntax and provide more details.

Mobile-friendly contrib.admin

The admin is now responsive and supports all major mobile devices. Older browsers may experience varying levels of graceful degradation.

Window expressions

The new :class:~django.db.models.expressions.Window expression allows adding an OVER clause to querysets. You can use :ref:window functions &lt;window-functions&gt; and :ref:aggregate functions &lt;aggregation-functions&gt; in the expression.

Minor features

:mod:django.contrib.admin


* The new :attr:`.ModelAdmin.autocomplete_fields` attribute and
 :meth:`.ModelAdmin.get_autocomplete_fields` method allow using an
 `Select2 &lt;https://select2.org&gt;`_ search widget for ``ForeignKey`` and
 ``ManyToManyField``.

:mod:`django.contrib.auth`
  • The default iteration count for the PBKDF2 password hasher is increased from 36,000 to 100,000.

:mod:django.contrib.gis


* Added MySQL support for the
 :class:`~django.contrib.gis.db.models.functions.AsGeoJSON` function,
 :class:`~django.contrib.gis.db.models.functions.GeoHash` function,
 :class:`~django.contrib.gis.db.models.functions.IsValid` function,
 :lookup:`isvalid` lookup, and :ref:`distance lookups &lt;distance-lookups&gt;`.

* Added the :class:`~django.contrib.gis.db.models.functions.Azimuth` and
 :class:`~django.contrib.gis.db.models.functions.LineLocatePoint` functions,
 supported on PostGIS and SpatiaLite.

* Any :class:`~django.contrib.gis.geos.GEOSGeometry` imported from GeoJSON now
 has its SRID set.

* Added the :attr:`.OSMWidget.default_zoom` attribute to customize the map&#39;s
 default zoom level.

* Made metadata readable and editable on rasters through the
 :attr:`~django.contrib.gis.gdal.GDALRaster.metadata`,
 :attr:`~django.contrib.gis.gdal.GDALRaster.info`, and
 :attr:`~django.contrib.gis.gdal.GDALBand.metadata` attributes.

* Allowed passing driver-specific creation options to
 :class:`~django.contrib.gis.gdal.GDALRaster` objects using ``papsz_options``.

* Allowed creating :class:`~django.contrib.gis.gdal.GDALRaster` objects in
 GDAL&#39;s internal virtual filesystem. Rasters can now be :ref:`created from and
 converted to binary data &lt;gdal-raster-vsimem&gt;` in-memory.

* The new :meth:`GDALBand.color_interp()
 &lt;django.contrib.gis.gdal.GDALBand.color_interp&gt;` method returns the color
 interpretation for the band.

:mod:`django.contrib.postgres`
  • The new distinct argument for :class:~django.contrib.postgres.aggregates.ArrayAgg determines if concatenated values will be distinct.

  • The new :class:~django.contrib.postgres.functions.RandomUUID database function returns a version 4 UUID. It requires use of PostgreSQL's pgcrypto extension which can be activated using the new :class:~django.contrib.postgres.operations.CryptoExtension migration operation.

  • :class:django.contrib.postgres.indexes.GinIndex now supports the fastupdate and gin_pending_list_limit parameters.

  • The new :class:~django.contrib.postgres.indexes.GistIndex class allows creating GiST indexes in the database. The new :class:~django.contrib.postgres.operations.BtreeGistExtension migration operation installs the btree_gist extension to add support for operator classes that aren't built-in.

  • :djadmin:inspectdb can now introspect JSONField and various RangeField\s (django.contrib.postgres must be in INSTALLED_APPS).

:mod:django.contrib.sitemaps


* Added the ``protocol`` keyword argument to the
 :class:`~django.contrib.sitemaps.GenericSitemap` constructor.

Cache
  • cache.set_many() now returns a list of keys that failed to be inserted. For the built-in backends, failed inserts can only happen on memcached.

File Storage


* :meth:`File.open() &lt;django.core.files.File.open&gt;` can be used as a context
 manager, e.g. ``with file.open() as f:``.

Forms
  • The new date_attrs and time_attrs arguments for :class:~django.forms.SplitDateTimeWidget and :class:~django.forms.SplitHiddenDateTimeWidget allow specifying different HTML attributes for the DateInput and TimeInput (or hidden) subwidgets.

  • The new :meth:Form.errors.get_json_data() &lt;django.forms.Form.errors.get_json_data&gt; method returns form errors as a dictionary suitable for including in a JSON response.

Generic Views


* The new :attr:`.ContextMixin.extra_context` attribute allows adding context
 in ``View.as_view()``.

Management Commands
  • :djadmin:inspectdb now translates MySQL's unsigned integer columns to PositiveIntegerField or PositiveSmallIntegerField.

  • The new :option:makemessages --add-location option controls the comment format in PO files.

  • :djadmin:loaddata can now :ref:read from stdin &lt;loading-fixtures-stdin&gt;.

  • The new :option:diffsettings --output option allows formatting the output in a unified diff format.

  • On Oracle, :djadmin:inspectdb can now introspect AutoField if the column is created as an identity column.

  • On MySQL, :djadmin:dbshell now supports client-side TLS certificates.

Migrations


* The new :option:`squashmigrations --squashed-name` option allows naming the
 squashed migration.

Models
  • The new :class:~django.db.models.functions.StrIndex database function finds the starting index of a string inside another string.

  • On Oracle, AutoField and BigAutoField are now created as identity columns_.

    .. _identity columns: https://docs.oracle.com/database/121/DRDAA/migr_tools_feat.htmDRDAA109

  • The new chunk_size parameter of :meth:.QuerySet.iterator controls the number of rows fetched by the Python database client when streaming results from the database. For databases that don't support server-side cursors, it controls the number of results Django fetches from the database adapter.

  • :meth:.QuerySet.earliest, :meth:.QuerySet.latest, and :attr:Meta.get_latest_by &lt;django.db.models.Options.get_latest_by&gt; now allow ordering by several fields.

  • Added the :class:~django.db.models.functions.ExtractQuarter function to extract the quarter from :class:~django.db.models.DateField and :class:~django.db.models.DateTimeField, and exposed it through the :lookup:quarter lookup.

  • Added the :class:~django.db.models.functions.TruncQuarter function to truncate :class:~django.db.models.DateField and :class:~django.db.models.DateTimeField to the first day of a quarter.

  • Added the :attr:~django.db.models.Index.db_tablespace parameter to class-based indexes.

  • If the database supports a native duration field (Oracle and PostgreSQL), :class:~django.db.models.functions.Extract now works with :class:~django.db.models.DurationField.

  • Added the of argument to :meth:.QuerySet.select_for_update(), supported on PostgreSQL and Oracle, to lock only rows from specific tables rather than all selected tables. It may be helpful particularly when :meth:~.QuerySet.select_for_update() is used in conjunction with :meth:~.QuerySet.select_related().

  • The new field_name parameter of :meth:.QuerySet.in_bulk allows fetching results based on any unique model field.

  • :meth:.CursorWrapper.callproc() now takes an optional dictionary of keyword parameters, if the backend supports this feature. Of Django's built-in backends, only Oracle supports it.

  • The new :meth:connection.execute_wrapper() &lt;django.db.backends.base.DatabaseWrapper.execute_wrapper&gt; method allows :doc:installing wrappers around execution of database queries &lt;/topics/db/instrumentation&gt;.

  • The new filter argument for built-in aggregates allows :ref:adding different conditionals &lt;conditional-aggregation&gt; to multiple aggregations over the same fields or relations.

  • Added support for expressions in :attr:Meta.ordering &lt;django.db.models.Options.ordering&gt;.

  • The new named parameter of :meth:.QuerySet.values_list allows fetching results as named tuples.

  • The new :class:.FilteredRelation class allows adding an ON clause to querysets.

Pagination


* Added :meth:`Paginator.get_page() &lt;django.core.paginator.Paginator.get_page&gt;`
 to provide the documented pattern of handling invalid page numbers.

Requests and Responses
  • The :djadmin:runserver Web server supports HTTP 1.1.

Templates


* To increase the usefulness of :meth:`.Engine.get_default` in third-party
 apps, it now returns the first engine if multiple ``DjangoTemplates`` engines
 are configured in ``TEMPLATES`` rather than raising ``ImproperlyConfigured``.

* Custom template tags may now accept keyword-only arguments.

Tests
  • Added threading support to :class:~django.test.LiveServerTestCase.

  • Added settings that allow customizing the test tablespace parameters for Oracle: :setting:DATAFILE_SIZE, :setting:DATAFILE_TMP_SIZE, :setting:DATAFILE_EXTSIZE, and :setting:DATAFILE_TMP_EXTSIZE.

Validators


* The new :class:`.ProhibitNullCharactersValidator` disallows the null
 character in the input of the :class:`~django.forms.CharField` form field
 and its subclasses. Null character input was observed from vulnerability
 scanning tools. Most databases silently discard null characters, but
 psycopg2 2.7+ raises an exception when trying to save a null character to
 a char/text field with PostgreSQL.

.. _backwards-incompatible-2.0:

Backwards incompatible changes in 2.0
=====================================

Removed support for bytestrings in some places
----------------------------------------------

To support native Python 2 strings, older Django versions had to accept both
bytestrings and unicode strings. Now that Python 2 support is dropped,
bytestrings should only be encountered around input/output boundaries (handling
of binary fields or HTTP streams, for example). You might have to update your
code to limit bytestring usage to a minimum, as Django no longer accepts
bytestrings in certain code paths.

For example, ``reverse()`` now uses ``str()`` instead of ``force_text()`` to
coerce the ``args`` and ``kwargs`` it receives, prior to their placement in
the URL. For bytestrings, this creates a string with an undesired ``b`` prefix
as well as additional quotes (``str(b&#39;foo&#39;)`` is ``&quot;b&#39;foo&#39;&quot;``). To adapt, call
``decode()`` on the bytestring before passing it to ``reverse()``.

Database backend API
--------------------

This section describes changes that may be needed in third-party database
backends.

* The ``DatabaseOperations.datetime_cast_date_sql()``,
 ``datetime_cast_time_sql()``, ``datetime_trunc_sql()``,
 ``datetime_extract_sql()``, and ``date_interval_sql()`` methods now return
 only the SQL to perform the operation instead of SQL and a list of
 parameters.

* Third-party database backends should add a ``DatabaseWrapper.display_name``
 attribute with the name of the database that your backend works with. Django
 may use it in various messages, such as in system checks.

* The first argument of ``SchemaEditor._alter_column_type_sql()`` is now
 ``model`` rather than ``table``.

* The first argument of ``SchemaEditor._create_index_name()`` is now
 ``table_name`` rather than ``model``.

* To enable ``FOR UPDATE OF`` support, set
 ``DatabaseFeatures.has_select_for_update_of = True``. If the database
 requires that the arguments to ``OF`` be columns rather than tables, set
 ``DatabaseFeatures.select_for_update_of_column = True``.

* To enable support for :class:`~django.db.models.expressions.Window`
 expressions, set ``DatabaseFeatures.supports_over_clause`` to ``True``. You
 may need to customize the ``DatabaseOperations.window_start_rows_start_end()``
 and/or ``window_start_range_start_end()`` methods.

* Third-party database backends should add a
 ``DatabaseOperations.cast_char_field_without_max_length`` attribute with the
 database data type that will be used in the
 :class:`~django.db.models.functions.Cast` function for a ``CharField`` if the
 ``max_length`` argument isn&#39;t provided.

* The first argument of ``DatabaseCreation._clone_test_db()`` and
 ``get_test_db_clone_settings()`` is now ``suffix`` rather
 than ``number`` (in case you want to rename the signatures in your backend
 for consistency). ``django.test`` also now passes those values as strings
 rather than as integers.

* Third-party database backends should add a
 ``DatabaseIntrospection.get_sequences()`` method based on the stub in
 ``BaseDatabaseIntrospection``.

Dropped support for Oracle 11.2
-------------------------------

The end of upstream support for Oracle 11.2 is Dec. 2020. Django 1.11 will be
supported until April 2020 which almost reaches this date. Django 2.0
officially supports Oracle 12.1+.

Default MySQL isolation level is read committed
-----------------------------------------------

MySQL&#39;s default isolation level, repeatable read, may cause data loss in
typical Django usage. To prevent that and for consistency with other databases,
the default isolation level is now read committed. You can use the
:setting:`DATABASES` setting to :ref:`use a different isolation level
&lt;mysql-isolation-level&gt;`, if needed.

:attr:`AbstractUser.last_name &lt;django.contrib.auth.models.User.last_name&gt;` ``max_length`` increased to 150
----------------------------------------------------------------------------------------------------------

A migration for :attr:`django.contrib.auth.models.User.last_name` is included.
If you have a custom user model inheriting from ``AbstractUser``, you&#39;ll need
to generate and apply a database migration for your user model.

If you want to preserve the 30 character limit for last names, use a custom
form::

   from django.contrib.auth.forms import UserChangeForm

   class MyUserChangeForm(UserChangeForm):
       last_name = forms.CharField(max_length=30, required=False)

If you wish to keep this restriction in the admin when editing users, set
``UserAdmin.form`` to use this form::

   from django.contrib.auth.admin import UserAdmin
   from django.contrib.auth.models import User

   class MyUserAdmin(UserAdmin):
       form = MyUserChangeForm

   admin.site.unregister(User)
   admin.site.register(User, MyUserAdmin)

``QuerySet.reverse()`` and ``last()`` are prohibited after slicing
------------------------------------------------------------------

Calling ``QuerySet.reverse()`` or ``last()`` on a sliced queryset leads to
unexpected results due to the slice being applied after reordering. This is
now prohibited, e.g.::

   &gt;&gt;&gt; Model.objects.all()[:2].reverse()
   Traceback (most recent call last):
   ...
   TypeError: Cannot reverse a query once a slice has been taken.

Form fields no longer accept optional arguments as positional arguments
-----------------------------------------------------------------------

To help prevent runtime errors due to incorrect ordering of form field
arguments, optional arguments of built-in form fields are no longer accepted
as positional arguments. For example::

   forms.IntegerField(25, 10)

raises an exception and should be replaced with::

   forms.IntegerField(max_value=25, min_value=10)

``call_command()`` validates the options it receives
----------------------------------------------------

``call_command()`` now validates that the argument parser of the command being
called defines all of the options passed to ``call_command()``.

For custom management commands that use options not created using
``parser.add_argument()``, add a ``stealth_options`` attribute on the command::

   class MyCommand(BaseCommand):
       stealth_options = (&#39;option_name&#39;, ...)

Indexes no longer accept positional arguments
---------------------------------------------

For example::

   models.Index([&#39;headline&#39;, &#39;-pub_date&#39;], &#39;index_name&#39;)

raises an exception and should be replaced with::

   models.Index(fields=[&#39;headline&#39;, &#39;-pub_date&#39;], name=&#39;index_name&#39;)

Foreign key constraints are now enabled on SQLite
-------------------------------------------------

This will appear as a backwards-incompatible change (``IntegrityError:
FOREIGN KEY constraint failed``) if attempting to save an existing model
instance that&#39;s violating a foreign key constraint.

Foreign keys are now created with ``DEFERRABLE INITIALLY DEFERRED`` instead of
``DEFERRABLE IMMEDIATE``. Thus, tables may need to be rebuilt to recreate
foreign keys with the new definition, particularly if you&#39;re using a pattern
like this::

   from django.db import transaction

   with transaction.atomic():
       Book.objects.create(author_id=1)
       Author.objects.create(id=1)

If you don&#39;t recreate the foreign key as ``DEFERRED``, the first ``create()``
would fail now that foreign key constraints are enforced.

Backup your database first! After upgrading to Django 2.0, you can then
rebuild tables using a script similar to this::

   from django.apps import apps
   from django.db import connection

   for app in apps.get_app_configs():
       for model in app.get_models(include_auto_created=True):
           if model._meta.managed and not (model._meta.proxy or model._meta.swapped):
               for base in model.__bases__:
                   if hasattr(base, &#39;_meta&#39;):
                       base._meta.local_many_to_many = []
               model._meta.local_many_to_many = []
               with connection.schema_editor() as editor:
                   editor._remake_table(model)

This script hasn&#39;t received extensive testing and needs adaption for various
cases such as multiple databases. Feel free to contribute improvements.

In addition, because of a table alteration limitation of SQLite, it&#39;s prohibited
to perform :class:`~django.db.migrations.operations.RenameModel` and
:class:`~django.db.migrations.operations.RenameField` operations on models or
fields referenced by other models in a transaction. In order to allow migrations
containing these operations to be applied, you must set the
``Migration.atomic`` attribute to ``False``.

Miscellaneous
-------------

* The ``SessionAuthenticationMiddleware`` class is removed. It provided no
 functionality since session authentication is unconditionally enabled in
 Django 1.10.

* The default HTTP error handlers (``handler404``, etc.) are now callables
 instead of dotted Python path strings. Django favors callable references
 since they provide better performance and debugging experience.

* :class:`~django.views.generic.base.RedirectView` no longer silences
 ``NoReverseMatch`` if the ``pattern_name`` doesn&#39;t exist.

* When :setting:`USE_L10N` is off, :class:`~django.forms.FloatField` and
 :class:`~django.forms.DecimalField` now respect :setting:`DECIMAL_SEPARATOR`
 and :setting:`THOUSAND_SEPARATOR` during validation. For example, with the
 settings::

    USE_L10N = False
    USE_THOUSAND_SEPARATOR = True
    DECIMAL_SEPARATOR = &#39;,&#39;
    THOUSAND_SEPARATOR = &#39;.&#39;

 an input of ``&quot;1.345&quot;`` is now converted to ``1345`` instead of ``1.345``.

* Subclasses of :class:`~django.contrib.auth.models.AbstractBaseUser` are no
 longer required to implement ``get_short_name()`` and ``get_full_name()``.
 (The base implementations that raise ``NotImplementedError`` are removed.)
 ``django.contrib.admin`` uses these methods if implemented but doesn&#39;t
 require them. Third-party apps that use these methods may want to adopt a
 similar approach.

* The ``FIRST_DAY_OF_WEEK`` and ``NUMBER_GROUPING`` format settings are now
 kept as integers in JavaScript and JSON i18n view outputs.

* :meth:`~django.test.TransactionTestCase.assertNumQueries` now ignores
 connection configuration queries. Previously, if a test opened a new database
 connection, those queries could be included as part of the
 ``assertNumQueries()`` count.

* The default size of the Oracle test tablespace is increased from 20M to 50M
 and the default autoextend size is increased from 10M to 25M.

* To improve performance when streaming large result sets from the database,
 :meth:`.QuerySet.iterator` now fetches 2000 rows at a time instead of 100.
 The old behavior can be restored using the ``chunk_size`` parameter. For
 example::

     Book.objects.iterator(chunk_size=100)

* Providing unknown package names in the ``packages`` argument of the
 :class:`~django.views.i18n.JavaScriptCatalog` view now raises ``ValueError``
 instead of passing silently.

* A model instance&#39;s primary key now appears in the default ``Model.__str__()``
 method, e.g. ``Question object (1)``.

* ``makemigrations`` now detects changes to the model field ``limit_choices_to``
 option. Add this to your existing migrations or accept an auto-generated
 migration for fields that use it.

* Performing queries that require :ref:`automatic spatial transformations
 &lt;automatic-spatial-transformations&gt;` now raises ``NotImplementedError``
 on MySQL instead of silently using non-transformed geometries.

* ``django.core.exceptions.DjangoRuntimeWarning`` is removed. It was only used
 in the cache backend as an intermediate class in ``CacheKeyWarning``&#39;s
 inheritance of ``RuntimeWarning``.

* Renamed ``BaseExpression._output_field`` to ``output_field``. You may need
 to update custom expressions.

* In older versions, forms and formsets combine their ``Media`` with widget
 ``Media`` by concatenating the two. The combining now tries to :ref:`preserve
 the relative order of elements in each list &lt;form-media-asset-order&gt;`.
 ``MediaOrderConflictWarning`` is issued if the order can&#39;t be preserved.

* ``django.contrib.gis.gdal.OGRException`` is removed. It&#39;s been an alias for
 ``GDALException`` since Django 1.8.

* Support for GEOS 3.3.x is dropped.

* The way data is selected for ``GeometryField`` is changed to improve
 performance, and in raw SQL queries, those fields must now be wrapped in
 ``connection.ops.select``. See the :ref:`Raw queries note&lt;gis-raw-sql&gt;` in
 the GIS tutorial for an example.

.. _deprecated-features-2.0:

Features deprecated in 2.0
==========================

``context`` argument of ``Field.from_db_value()`` and ``Expression.convert_value()``
------------------------------------------------------------------------------------

The ``context`` argument of ``Field.from_db_value()`` and
``Expression.convert_value()`` is unused as it&#39;s always an empty dictionary.
The signature of both methods is now::

   (self, value, expression, connection)

instead of::

   (self, value, expression, connection, context)

Support for the old signature in custom fields and expressions remains until
Django 3.0.

Miscellaneous
-------------

* The ``django.db.backends.postgresql_psycopg2`` module is deprecated in favor
 of ``django.db.backends.postgresql``. It&#39;s been an alias since Django 1.9.
 This only affects code that imports from the module directly. The
 ``DATABASES`` setting can still use
 ``&#39;django.db.backends.postgresql_psycopg2&#39;``, though you can simplify that by
 using the ``&#39;django.db.backends.postgresql&#39;`` name added in Django 1.9.

* ``django.shortcuts.render_to_response()`` is deprecated in favor of
 :func:`django.shortcuts.render`. ``render()`` takes the same arguments
 except that it also requires a ``request``.

* The ``DEFAULT_CONTENT_TYPE`` setting is deprecated. It doesn&#39;t interact well
 well with third-party apps and is obsolete since HTML5 has mostly superseded
 XHTML.

* ``HttpRequest.xreadlines()`` is deprecated in favor of iterating over the
 request.

* The ``field_name`` keyword argument to :meth:`.QuerySet.earliest` and
 :meth:`.QuerySet.latest` is deprecated in favor of passing the field
 names as arguments. Write ``.earliest(&#39;pub_date&#39;)`` instead of
 ``.earliest(field_name=&#39;pub_date&#39;)``.

.. _removed-features-2.0:

Features removed in 2.0
=======================

These features have reached the end of their deprecation cycle and are removed
in Django 2.0.

See :ref:`deprecated-features-1.9` for details on these changes, including how
to remove usage of these features.

* The ``weak`` argument to ``django.dispatch.signals.Signal.disconnect()`` is
 removed.

* ``django.db.backends.base.BaseDatabaseOperations.check_aggregate_support()``
 is removed.

* The ``django.forms.extras`` package is removed.

* The ``assignment_tag`` helper is removed.

* The ``host`` argument to ``SimpleTestCase.assertsRedirects()`` is removed.
 The compatibility layer which allows absolute URLs to be considered equal to
 relative ones when the path is identical is also removed.

* ``Field.rel`` and ``Field.remote_field.to`` are removed.

* The ``on_delete`` argument for ``ForeignKey`` and ``OneToOneField`` is now
 required in models and migrations. Consider squashing migrations so that you
 have less of them to update.

* ``django.db.models.fields.add_lazy_relation()`` is removed.

* When time zone support is enabled, database backends that don&#39;t support time
 zones no longer convert aware datetimes to naive values in UTC anymore when
 such values are passed as parameters to SQL queries executed outside of the
 ORM, e.g. with ``cursor.execute()``.

* ``django.contrib.auth.tests.utils.skipIfCustomUser()`` is removed.

* The ``GeoManager`` and ``GeoQuerySet`` classes are removed.

* The ``django.contrib.gis.geoip`` module is removed.

* The ``supports_recursion`` check for template loaders is removed from:

 * ``django.template.engine.Engine.find_template()``
 * ``django.template.loader_tags.ExtendsNode.find_template()``
 * ``django.template.loaders.base.Loader.supports_recursion()``
 * ``django.template.loaders.cached.Loader.supports_recursion()``

* The ``load_template`` and ``load_template_sources`` template loader methods
 are removed.

* The ``template_dirs`` argument for template loaders is removed:

 * ``django.template.loaders.base.Loader.get_template()``
 * ``django.template.loaders.cached.Loader.cache_key()``
 * ``django.template.loaders.cached.Loader.get_template()``
 * ``django.template.loaders.cached.Loader.get_template_sources()``
 * ``django.template.loaders.filesystem.Loader.get_template_sources()``

* ``django.template.loaders.base.Loader.__call__()`` is removed.

* Support for custom error views that don&#39;t accept an ``exception`` parameter
 is removed.

* The ``mime_type`` attribute of ``django.utils.feedgenerator.Atom1Feed`` and
 ``django.utils.feedgenerator.RssFeed`` is removed.

* The ``app_name`` argument to ``include()`` is removed.

* Support for passing a 3-tuple (including ``admin.site.urls``) as the first
 argument to ``include()`` is removed.

* Support for setting a URL instance namespace without an application namespace
 is removed.

* ``Field._get_val_from_obj()`` is removed.

* ``django.template.loaders.eggs.Loader`` is removed.

* The ``current_app`` parameter to the ``contrib.auth`` function-based views is
 removed.

* The ``callable_obj`` keyword argument to
 ``SimpleTestCase.assertRaisesMessage()`` is removed.

* Support for the ``allow_tags`` attribute on ``ModelAdmin`` methods is
 removed.

* The ``enclosure`` keyword argument to ``SyndicationFeed.add_item()`` is
 removed.

* The ``django.template.loader.LoaderOrigin`` and
 ``django.template.base.StringOrigin`` aliases for
 ``django.template.base.Origin`` are removed.

See :ref:`deprecated-features-1.10` for details on these changes.

* The ``makemigrations --exit`` option is removed.

* Support for direct assignment to a reverse foreign key or many-to-many
 relation is removed.

* The ``get_srid()`` and ``set_srid()`` methods of
 ``django.contrib.gis.geos.GEOSGeometry`` are removed.

* The ``get_x()``, ``set_x()``, ``get_y()``, ``set_y()``, ``get_z()``, and
 ``set_z()`` methods of ``django.contrib.gis.geos.Point`` are removed.

* The ``get_coords()`` and ``set_coords()`` methods of
 ``django.contrib.gis.geos.Point`` are removed.

* The ``cascaded_union`` property of ``django.contrib.gis.geos.MultiPolygon``
 is removed.

* ``django.utils.functional.allow_lazy()`` is removed.

* The ``shell --plain`` option is removed.

* The ``django.core.urlresolvers`` module is removed in favor of its new
 location, ``django.urls``.

* ``CommaSeparatedIntegerField`` is removed, except for support in historical
 migrations.

* The template ``Context.has_key()`` method is removed.

* Support for the ``django.core.files.storage.Storage.accessed_time()``,
 ``created_time()``, and ``modified_time()`` methods is removed.

* Support for query lookups using the model name when
 ``Meta.default_related_name`` is set is removed.

* The MySQL ``__search`` lookup is removed.

* The shim for supporting custom related manager classes without a
 ``_apply_rel_filters()`` method is removed.

* Using ``User.is_authenticated()`` and ``User.is_anonymous()`` as methods
 rather than properties is no longer supported.

* The ``Model._meta.virtual_fields`` attribute is removed.

* The keyword arguments ``virtual_only`` in ``Field.contribute_to_class()`` and
 ``virtual`` in ``Model._meta.add_field()`` are removed.

* The ``javascript_catalog()`` and ``json_catalog()`` views are removed.

* ``django.contrib.gis.utils.precision_wkt()`` is removed.

* In multi-table inheritance, implicit promotion of a ``OneToOneField`` to a
 ``parent_link`` is removed.

* Support for ``Widget._format_value()`` is removed.

* ``FileField`` methods ``get_directory_name()`` and ``get_filename()`` are
 removed.

* The ``mark_for_escaping()`` function and the classes it uses: ``EscapeData``,
 ``EscapeBytes``, ``EscapeText``, ``EscapeString``, and ``EscapeUnicode`` are
 removed.

* The ``escape`` filter now uses ``django.utils.html.conditional_escape()``.

* ``Manager.use_for_related_fields`` is removed.

* Model ``Manager`` inheritance follows MRO inheritance rules. The requirement
 to use ``Meta.manager_inheritance_from_future`` to opt-in to the behavior is
 removed.

* Support for old-style middleware using ``settings.MIDDLEWARE_CLASSES`` is
 removed.

===========================

### 1.11.8

===========================

*December 2, 2017*

Django 1.11.8 fixes several bugs in 1.11.7.

Bugfixes
========

* Reallowed, following a regression in Django 1.10, ``AuthenticationForm`` to
 raise the inactive user error when using ``ModelBackend`` (:ticket:`28645`).

* Added support for ``QuerySet.values()`` and ``values_list()`` for
 ``union()``, ``difference()``, and ``intersection()`` queries
 (:ticket:`28781`).

* Fixed incorrect index name truncation when using a namespaced ``db_table``
 (:ticket:`28792`).

* Made ``QuerySet.iterator()`` use server-side cursors on PostgreSQL after
 ``values()`` and ``values_list()`` (:ticket:`28817`).

* Fixed crash on SQLite and MySQL when ordering by a filtered subquery that
 uses ``nulls_first`` or ``nulls_last`` (:ticket:`28848`).

* Made query lookups for ``CICharField``, ``CIEmailField``, and ``CITextField``
 use a ``citext`` cast (:ticket:`28702`).

* Fixed a regression in caching of a ``GenericForeignKey`` when the referenced
 model instance uses multi-table inheritance (:ticket:`28856`).

* Fixed &quot;Cannot change column &#39;x&#39;: used in a foreign key constraint&quot; crash on
 MySQL with a sequence of ``AlterField`` and/or ``RenameField`` operations in
 a migration (:ticket:`28305`).

===========================

### 1.11.7

===========================

*November 1, 2017*

Django 1.11.7 fixes several bugs in 1.11.6.

Bugfixes
========

* Prevented ``cache.get_or_set()`` from caching ``None`` if the ``default``
 argument is a callable that returns ``None`` (:ticket:`28601`).

* Fixed the Basque ``DATE_FORMAT`` string (:ticket:`28710`).

* Made ``QuerySet.reverse()`` affect ``nulls_first`` and ``nulls_last``
 (:ticket:`28722`).

* Fixed unquoted table names in ``Subquery`` SQL when using ``OuterRef``
 (:ticket:`28689`).

===========================

### 1.11.6

===========================

*October 5, 2017*

Django 1.11.6 fixes several bugs in 1.11.5.

Bugfixes
========

* Made the ``CharField`` form field convert whitespace-only values to the
 ``empty_value`` when ``strip`` is enabled (:ticket:`28555`).

* Fixed crash when using the name of a model&#39;s autogenerated primary key
 (``id``) in an ``Index``&#39;s ``fields`` (:ticket:`28597`).

* Fixed a regression in Django 1.9 where a custom view error handler such as
 ``handler404`` that accesses ``csrf_token`` could cause CSRF verification
 failures on other pages (:ticket:`28488`).

===========================

### 1.11.5

===========================

*September 5, 2017*

Django 1.11.5 fixes a security issue and several bugs in 1.11.4.

CVE-2017-12794: Possible XSS in traceback section of technical 500 debug page
=============================================================================

In older versions, HTML autoescaping was disabled in a portion of the template
for the technical 500 debug page. Given the right circumstances, this allowed
a cross-site scripting attack. This vulnerability shouldn&#39;t affect most
production sites since you shouldn&#39;t run with ``DEBUG = True`` (which makes
this page accessible) in your production settings.

Bugfixes
========

* Fixed GEOS version parsing if the version has a commit hash at the end (new
 in GEOS 3.6.2) (:ticket:`28441`).

* Added compatibility for ``cx_Oracle`` 6 (:ticket:`28498`).

* Fixed select widget rendering when option values are tuples (:ticket:`28502`).

* Django 1.11 inadvertently changed the sequence and trigger naming scheme on
 Oracle. This causes errors on INSERTs for some tables if
 ``&#39;use_returning_into&#39;: False`` is in the ``OPTIONS`` part of ``DATABASES``.
 The pre-1.11 naming scheme is now restored. Unfortunately, it necessarily
 requires an update to Oracle tables created with Django 1.11.[1-4]. Use the
 upgrade script in :ticket:`28451` comment 8 to update sequence and trigger
 names to use the pre-1.11 naming scheme.

* Added POST request support to ``LogoutView``, for equivalence with the
 function-based ``logout()`` view (:ticket:`28513`).

* Omitted ``pages_per_range`` from ``BrinIndex.deconstruct()`` if it&#39;s ``None``
 (:ticket:`25809`).

* Fixed a regression where ``SelectDateWidget`` localized the years in the
 select box (:ticket:`28530`).

* Fixed a regression in 1.11.4 where ``runserver`` crashed with non-Unicode
 system encodings on Python 2 + Windows (:ticket:`28487`).

* Fixed a regression in Django 1.10 where changes to a ``ManyToManyField``
 weren&#39;t logged in the admin change history (:ticket:`27998`) and prevented
 ``ManyToManyField`` initial data in model forms from being affected by
 subsequent model changes (:ticket:`28543`).

* Fixed non-deterministic results or an ``AssertionError`` crash in some
 queries with multiple joins (:ticket:`26522`).

* Fixed a regression in ``contrib.auth``&#39;s ``login()`` and ``logout()`` views
 where they ignored positional arguments (:ticket:`28550`).

===========================

### 1.11.4

===========================

*August 1, 2017*

Django 1.11.4 fixes several bugs in 1.11.3.

Bugfixes
========

* Fixed a regression in 1.11.3 on Python 2 where non-ASCII ``format`` values
 for date/time widgets results in an empty ``value`` in the widget&#39;s HTML
 (:ticket:`28355`).

* Fixed ``QuerySet.union()`` and ``difference()`` when combining with
 a queryset raising ``EmptyResultSet`` (:ticket:`28378`).

* Fixed a regression in pickling of ``LazyObject`` on Python 2 when the wrapped
 object doesn&#39;t have ``__reduce__()`` (:ticket:`28389`).

* Fixed crash in ``runserver``&#39;s ``autoreload`` with Python 2 on Windows with
 non-``str`` environment variables (:ticket:`28174`).

* Corrected ``Field.has_changed()`` to return ``False`` for disabled form
 fields: ``BooleanField``, ``MultipleChoiceField``, ``MultiValueField``,
 ``FileField``, ``ModelChoiceField``, and ``ModelMultipleChoiceField``.

* Fixed ``QuerySet.count()`` for ``union()``, ``difference()``, and
 ``intersection()`` queries. (:ticket:`28399`).

* Fixed ``ClearableFileInput`` rendering as a subwidget of ``MultiWidget``
 (:ticket:`28414`). Custom ``clearable_file_input.html`` widget templates
 will need to adapt for the fact that context values
 ``checkbox_name``, ``checkbox_id``, ``is_initial``, ``input_text``,
 ``initial_text``, and ``clear_checkbox_label`` are now attributes of
 ``widget`` rather than appearing in the top-level context.

* Fixed queryset crash when using a ``GenericRelation`` to a proxy model
 (:ticket:`28418`).

===========================

### 1.11.3

===========================

*July 1, 2017*

Django 1.11.3 fixes several bugs in 1.11.2.

Bugfixes
========

* Removed an incorrect deprecation warning about a missing ``renderer``
 argument if a ``Widget.render()`` method accepts ``**kwargs``
 (:ticket:`28265`).

* Fixed a regression causing ``Model.__init__()`` to crash if a field has an
 instance only descriptor (:ticket:`28269`).

* Fixed an incorrect ``DisallowedModelAdminLookup`` exception when using
 a nested reverse relation in ``list_filter`` (:ticket:`28262`).

* Fixed admin&#39;s ``FieldListFilter.get_queryset()`` crash on invalid input
 (:ticket:`28202`).

* Fixed invalid HTML for a required ``AdminFileWidget`` (:ticket:`28278`).

* Fixed model initialization to set the name of class-based model indexes
 for models that only inherit ``models.Model`` (:ticket:`28282`).

* Fixed crash in admin&#39;s inlines when a model has an inherited non-editable
 primary key (:ticket:`27967`).

* Fixed ``QuerySet.union()``, ``intersection()``, and ``difference()`` when
 combining with an ``EmptyQuerySet`` (:ticket:`28293`).

* Prevented ``Paginator``’s unordered object list warning from evaluating a
 ``QuerySet`` (:ticket:`28284`).

* Fixed the value of ``redirect_field_name`` in ``LoginView``’s template
 context. It&#39;s now an empty string (as it is for the original function-based
 ``login()`` view) if the corresponding parameter isn&#39;t sent in a request (in
 particular, when the login page is accessed directly) (:ticket:`28229`).

* Prevented attribute values in the ``django/forms/widgets/attrs.html``
 template from being localized so that numeric attributes (e.g. ``max`` and
 ``min``) of ``NumberInput`` work correctly (:ticket:`28303`).

* Removed casting of the option value to a string in the template context of
 the ``CheckboxSelectMultiple``, ``NullBooleanSelect``, ``RadioSelect``,
 ``SelectMultiple``, and ``Select`` widgets (:ticket:`28176`). In Django
 1.11.1, casting was added in Python to avoid localization of numeric values
 in Django templates, but this made some use cases more difficult. Casting is
 now done in the template using the ``|stringformat:&#39;s&#39;`` filter.

* Prevented a primary key alteration from adding a foreign key constraint if
 ``db_constraint=False`` (:ticket:`28298`).

* Fixed ``UnboundLocalError`` crash in ``RenameField`` with nonexistent field
 (:ticket:`28350`).

* Fixed a regression preventing a model field&#39;s ``limit_choices_to`` from being
 evaluated when a ``ModelForm`` is instantiated (:ticket:`28345`).

===========================

### 1.11.2

===========================

*June 1, 2017*

Django 1.11.2 adds a minor feature and fixes several bugs in 1.11.1. Also, the
latest string translations from Transifex are incorporated.

Minor feature
=============

The new ``LiveServerTestCase.port`` attribute reallows the use case of binding
to a specific port following the :ref:`bind to port zero
&lt;liveservertestcase-port-zero-change&gt;` change in Django 1.11.

Bugfixes
========

* Added detection for GDAL 2.1 and 2.0, and removed detection for unsupported
 versions 1.7 and 1.8 (:ticket:`28181`).

* Changed ``contrib.gis`` to raise ``ImproperlyConfigured`` rather than
 ``GDALException`` if ``gdal`` isn&#39;t installed, to allow third-party apps to
 catch that exception (:ticket:`28178`).

* Fixed ``django.utils.http.is_safe_url()`` crash on invalid IPv6 URLs
 (:ticket:`28142`).

* Fixed regression causing pickling of model fields to crash (:ticket:`28188`).

* Fixed ``django.contrib.auth.authenticate()`` when multiple authentication
 backends don&#39;t accept a positional ``request`` argument (:ticket:`28207`).

* Fixed introspection of index field ordering on PostgreSQL (:ticket:`28197`).

* Fixed a regression where ``Model._state.adding`` wasn&#39;t set correctly on
 multi-table inheritance parent models after saving a child model
 (:ticket:`28210`).

* Allowed ``DjangoJSONEncoder`` to serialize
 ``django.utils.deprecation.CallableBool`` (:ticket:`28230`).

* Relaxed the validation added in Django 1.11 of the fields in the ``defaults``
 argument of ``QuerySet.get_or_create()`` and ``update_or_create()`` to
 reallow settable model properties (:ticket:`28222`).

* Fixed ``MultipleObjectMixin.paginate_queryset()`` crash on Python 2 if the
 ``InvalidPage`` message contains non-ASCII (:ticket:`28204`).

* Prevented ``Subquery`` from adding an unnecessary ``CAST`` which resulted in
 invalid SQL (:ticket:`28199`).

* Corrected detection of GDAL 2.1 on Windows (:ticket:`28181`).

* Made date-based generic views return a 404 rather than crash when given an
 out of range date (:ticket:`28209`).

* Fixed a regression where ``file_move_safe()`` crashed when moving files to a
 CIFS mount (:ticket:`28170`).

* Moved the ``ImageField`` file extension validation added in Django 1.11 from
 the model field to the form field to reallow the use case of storing images
 without an extension (:ticket:`28242`).

===========================

### 1.11.1

===========================

*May 6, 2017*

Django 1.11.1 adds a minor feature and fixes several bugs in 1.11.

Allowed disabling server-side cursors on PostgreSQL
===================================================

The change in Django 1.11 to make :meth:`.QuerySet.iterator()` use server-side
cursors on PostgreSQL prevents running Django with `pgBouncer` in transaction
pooling mode. To reallow that, use the :setting:`DISABLE_SERVER_SIDE_CURSORS
&lt;DATABASE-DISABLE_SERVER_SIDE_CURSORS&gt;` setting in :setting:`DATABASES`.

See :ref:`transaction-pooling-server-side-cursors` for more discussion.

Bugfixes
========

* Made migrations respect ``Index``’s ``name`` argument. If you created a
 named index with Django 1.11, ``makemigrations`` will create a migration to
 recreate the index with the correct name (:ticket:`28051`).

* Fixed a crash when using a ``__icontains`` lookup on a ``ArrayField``
 (:ticket:`28038`).

* Fixed a crash when using a two-tuple in ``EmailMessage``’s ``attachments``
 argument (:ticket:`28042`).

* Fixed ``QuerySet.filter()`` crash when it references the name of a
 ``OneToOneField`` primary key (:ticket:`28047`).

* Fixed empty POST data table appearing instead of &quot;No POST data&quot; in HTML debug
 page (:ticket:`28079`).

* Restored ``BoundField``\s without any ``choices`` evaluating to ``True``
 (:ticket:`28058`).

* Prevented ``SessionBase.cycle_key()`` from losing session data if
 ``_session_cache`` isn&#39;t populated (:ticket:`28066`).

* Fixed layout of ``ReadOnlyPasswordHashWidget`` (used in the admin&#39;s user
 change page) (:ticket:`28097`).

* Allowed prefetch calls on managers with custom ``ModelIterable`` subclasses
 (:ticket:`28096`).

* Fixed change password link in the ``contrib.auth`` admin for ``el``,
 ``es_MX``, and ``pt`` translations (:ticket:`28100`).

* Restored the output of the ``class`` attribute in the ``&lt;ul&gt;`` of widgets
 that use the ``multiple_input.html`` template. This fixes
 ``ModelAdmin.radio_fields`` with ``admin.HORIZONTAL`` (:ticket:`28059`).

* Fixed crash in ``BaseGeometryWidget.subwidgets()`` (:ticket:`28039`).

* Fixed exception reraising in ORM query execution when ``cursor.execute()``
 fails and the subsequent ``cursor.close()`` also fails (:ticket:`28091`).

* Fixed a regression where ``CheckboxSelectMultiple``, ``NullBooleanSelect``,
 ``RadioSelect``, ``SelectMultiple``, and ``Select`` localized option values
 (:ticket:`28075`).

* Corrected the stack level of unordered queryset pagination warnings
 (:ticket:`28109`).

* Fixed a regression causing incorrect queries for ``__in`` subquery lookups
 when models use ``ForeignKey.to_field`` (:ticket:`28101`).

* Fixed crash when overriding the template of
 ``django.views.static.directory_index()`` (:ticket:`28122`).

* Fixed a regression in formset ``min_num`` validation with unchanged forms
 that have initial data (:ticket:`28130`).

* Prepared for ``cx_Oracle`` 6.0 support (:ticket:`28138`).

* Updated the ``contrib.postgres`` ``SplitArrayWidget`` to use template-based
 widget rendering (:ticket:`28040`).

* Fixed crash in ``BaseGeometryWidget.get_context()`` when overriding existing
 ``attrs`` (:ticket:`28105`).

* Prevented ``AddIndex`` and ``RemoveIndex`` from mutating model state
 (:ticket:`28043`).

* Prevented migrations from dropping database indexes from ``Meta.indexes``
 when changing ``Field.db_index`` to ``False`` (:ticket:`28052`).

* Fixed a regression in choice ordering in form fields with grouped and
 non-grouped options (:ticket:`28157`).

* Fixed crash in  ``BaseInlineFormSet._construct_form()`` when using
 ``save_as_new`` (:ticket:`28159`).

* Fixed a regression where ``Model._state.db`` wasn&#39;t set correctly on
 multi-table inheritance parent models after saving a child model
 (:ticket:`28166`).

* Corrected the return type of ``ArrayField(CITextField())`` values retrieved
 from the database (:ticket:`28161`).

* Fixed ``QuerySet.prefetch_related()`` crash when fetching relations in nested
 ``Prefetch`` objects (:ticket:`27554`).

* Prevented hiding GDAL errors if it&#39;s not installed when using ``contrib.gis``
 (:ticket:`28160`). (It&#39;s a required dependency as of Django 1.11.)

* Fixed a regression causing ``__in`` lookups on a foreign key to fail when
 using the foreign key&#39;s parent model as the lookup value (:ticket:`28175`).

=========================

### 1.11

=========================

*April 4, 2017*

Welcome to Django 1.11!

These release notes cover the :ref:`new features &lt;whats-new-1.11&gt;`, as well as
some :ref:`backwards incompatible changes &lt;backwards-incompatible-1.11&gt;` you&#39;ll
want to be aware of when upgrading from Django 1.10 or older versions. We&#39;ve
:ref:`begun the deprecation process for some features
&lt;deprecated-features-1.11&gt;`.

See the :doc:`/howto/upgrade-version` guide if you&#39;re updating an existing
project.

Django 1.11 is designated as a :term:`long-term support release`. It will
receive security updates for at least three years after its release. Support
for the previous LTS, Django 1.8, will end in April 2018.

Python compatibility
====================

Django 1.11 requires Python 2.7, 3.4, 3.5, or 3.6. Django 1.11 is the first
release to support Python 3.6. We **highly recommend** and only officially
support the latest release of each series.

The Django 1.11.x series is the last to support Python 2. The next major
release, Django 2.0, will only support Python 3.4+.

Deprecating warnings are no longer loud by default
==================================================

Unlike older versions of Django, Django&#39;s own deprecation warnings are no
longer displayed by default. This is consistent with Python&#39;s default behavior.

This change allows third-party apps to support both Django 1.11 LTS and Django
1.8 LTS without having to add code to avoid deprecation warnings.

Following the release of Django 2.0, we suggest that third-party app authors
drop support for all versions of Django prior to 1.11. At that time, you should
be able run your package&#39;s tests using ``python -Wd`` so that deprecation
warnings do appear. After making the deprecation warning fixes, your app should
be compatible with Django 2.0.

.. _whats-new-1.11:

What&#39;s new in Django 1.11
=========================

Class-based model indexes
-------------------------

The new :mod:`django.db.models.indexes` module contains classes which ease
creating database indexes. Indexes are added to models using the
:attr:`Meta.indexes &lt;django.db.models.Options.indexes&gt;` option.

The :class:`~django.db.models.Index` class creates a b-tree index, as if you
used :attr:`~django.db.models.Field.db_index` on the model field or
:attr:`~django.db.models.Options.index_together` on the model ``Meta`` class.
It can be subclassed to support different index types, such as
:class:`~django.contrib.postgres.indexes.GinIndex`. It also allows defining the
order (ASC/DESC) for the columns of the index.

Template-based widget rendering
-------------------------------

To ease customizing widgets, form widget rendering is now done using the
template system rather than in Python. See :doc:`/ref/forms/renderers`.

You may need to adjust any custom widgets that you&#39;ve written for a few
:ref:`backwards incompatible changes &lt;template-widget-incompatibilities-1-11&gt;`.

``Subquery`` expressions
------------------------

The new :class:`~django.db.models.Subquery` and
:class:`~django.db.models.Exists` database expressions allow creating
explicit subqueries. Subqueries may refer to fields from the outer queryset
using the :class:`~django.db.models.OuterRef` class.

Minor features
--------------

:mod:`django.contrib.admin`
  • :attr:.ModelAdmin.date_hierarchy can now reference fields across relations.

  • The new :meth:ModelAdmin.get_exclude() &lt;django.contrib.admin.ModelAdmin.get_exclude&gt; hook allows specifying the exclude fields based on the request or model instance.

  • The popup_response.html template can now be overridden per app, per model, or by setting the :attr:.ModelAdmin.popup_response_template attribute.

:mod:django.contrib.auth


* The default iteration count for the PBKDF2 password hasher is increased by
 20%.

* The :class:`~django.contrib.auth.views.LoginView` and
 :class:`~django.contrib.auth.views.LogoutView` class-based views supersede the
 deprecated ``login()`` and ``logout()`` function-based views.

* The :class:`~django.contrib.auth.views.PasswordChangeView`,
 :class:`~django.contrib.auth.views.PasswordChangeDoneView`,
 :class:`~django.contrib.auth.views.PasswordResetView`,
 :class:`~django.contrib.auth.views.PasswordResetDoneView`,
 :class:`~django.contrib.auth.views.PasswordResetConfirmView`, and
 :class:`~django.contrib.auth.views.PasswordResetCompleteView` class-based
 views supersede the deprecated ``password_change()``,
 ``password_change_done()``, ``password_reset()``, ``password_reset_done()``,
 ``password_reset_confirm()``, and ``password_reset_complete()`` function-based
 views.

* The new ``post_reset_login`` attribute for
 :class:`~django.contrib.auth.views.PasswordResetConfirmView` allows
 automatically logging in a user after a successful password reset.
 If you have multiple ``AUTHENTICATION_BACKENDS`` configured, use the
 ``post_reset_login_backend`` attribute to choose which one to use.

* To avoid the possibility of leaking a password reset token via the HTTP
 Referer header (for example, if the reset page includes a reference to CSS or
 JavaScript hosted on another domain), the
 :class:`~django.contrib.auth.views.PasswordResetConfirmView` (but not the
 deprecated ``password_reset_confirm()`` function-based view) stores the token
 in a session and redirects to itself to present the password change form to
 the user without the token in the URL.

* :func:`~django.contrib.auth.update_session_auth_hash` now rotates the session
 key to allow a password change to invalidate stolen session cookies.

* The new ``success_url_allowed_hosts`` attribute for
 :class:`~django.contrib.auth.views.LoginView` and
 :class:`~django.contrib.auth.views.LogoutView` allows specifying a set of
 hosts that are safe for redirecting after login and logout.

* Added password validators ``help_text`` to
 :class:`~django.contrib.auth.forms.UserCreationForm`.

* The ``HttpRequest`` is now passed to :func:`~django.contrib.auth.authenticate`
 which in turn passes it to the authentication backend if it accepts a
 ``request`` argument.

* The :func:`~django.contrib.auth.signals.user_login_failed` signal now
 receives a ``request`` argument.

* :class:`~django.contrib.auth.forms.PasswordResetForm` supports custom user
 models that use an email field named something other than ``&#39;email&#39;``.
 Set :attr:`CustomUser.EMAIL_FIELD
 &lt;django.contrib.auth.models.CustomUser.EMAIL_FIELD&gt;` to the name of the field.

* :func:`~django.contrib.auth.get_user_model` can now be called at import time,
 even in modules that define models.

:mod:`django.contrib.contenttypes`
  • When stale content types are detected in the :djadmin:remove_stale_contenttypes command, there's now a list of related objects such as auth.Permission\s that will also be deleted. Previously, only the content types were listed (and this prompt was after migrate rather than in a separate command).

:mod:django.contrib.gis


* The new :meth:`.GEOSGeometry.from_gml` and :meth:`.OGRGeometry.from_gml`
 methods allow creating geometries from GML.

* Added support for the :lookup:`dwithin` lookup on SpatiaLite.

* The :class:`~django.contrib.gis.db.models.functions.Area` function,
 :class:`~django.contrib.gis.db.models.functions.Distance` function, and
 distance lookups now work with geodetic coordinates on SpatiaLite.

* The OpenLayers-based form widgets now use ``OpenLayers.js`` from
 ``https://cdnjs.cloudflare.com`` which is more suitable for production use
 than the the old ``http://openlayers.org`` source. They are also updated to
 use OpenLayers 3.

* PostGIS migrations can now change field dimensions.

* Added the ability to pass the `size`, `shape`, and `offset` parameter when
 creating :class:`~django.contrib.gis.gdal.GDALRaster` objects.

* Added SpatiaLite support for the
 :class:`~django.contrib.gis.db.models.functions.IsValid` function,
 :class:`~django.contrib.gis.db.models.functions.MakeValid` function, and
 :lookup:`isvalid` lookup.

* Added Oracle support for the
 :class:`~django.contrib.gis.db.models.functions.AsGML` function,
 :class:`~django.contrib.gis.db.models.functions.BoundingCircle` function,
 :class:`~django.contrib.gis.db.models.functions.IsValid` function, and
 :lookup:`isvalid` lookup.

:mod:`django.contrib.postgres`
  • The new distinct argument for :class:~django.contrib.postgres.aggregates.StringAgg determines if concatenated values will be distinct.

  • The new :class:~django.contrib.postgres.indexes.GinIndex and :class:~django.contrib.postgres.indexes.BrinIndex classes allow creating GIN and BRIN indexes in the database.

  • :class:~django.contrib.postgres.fields.JSONField accepts a new encoder parameter to specify a custom class to encode data types not supported by the standard encoder.

  • The new :class:~django.contrib.postgres.fields.CIText mixin and :class:~django.contrib.postgres.operations.CITextExtension migration operation allow using PostgreSQL's citext extension for case-insensitive lookups. Three fields are provided: :class:.CICharField, :class:.CIEmailField, and :class:.CITextField.

  • The new :class:~django.contrib.postgres.aggregates.JSONBAgg allows aggregating values as a JSON array.

  • The :class:~django.contrib.postgres.fields.HStoreField (model field) and :class:~django.contrib.postgres.forms.HStoreField (form field) allow storing null values.

Cache


* Memcached backends now pass the contents of :setting:`OPTIONS &lt;CACHES-OPTIONS&gt;`
 as keyword arguments to the client constructors, allowing for more advanced
 control of client behavior. See the :ref:`cache arguments &lt;cache_arguments&gt;`
 documentation for examples.

* Memcached backends now allow defining multiple servers as a comma-delimited
 string in :setting:`LOCATION &lt;CACHES-LOCATION&gt;`, for convenience with
 third-party services that use such strings in environment variables.

CSRF
  • Added the :setting:CSRF_USE_SESSIONS setting to allow storing the CSRF token in the user's session rather than in a cookie.

Database backends


* Added the ``skip_locked`` argument to :meth:`.QuerySet.select_for_update()`
 on PostgreSQL 9.5+ and Oracle to execute queries with
 ``FOR UPDATE SKIP LOCKED``.

* Added the :setting:`TEST[&#39;TEMPLATE&#39;] &lt;TEST_TEMPLATE&gt;` setting to let
 PostgreSQL users specify a template for creating the test database.

* :meth:`.QuerySet.iterator()` now uses :ref:`server-side cursors
 &lt;psycopg2:server-side-cursors&gt;` on PostgreSQL. This feature transfers some of
 the worker memory load (used to hold query results) to the database and might
 increase database memory usage.

* Added MySQL support for the ``&#39;isolation_level&#39;`` option in
 :setting:`OPTIONS` to allow specifying the :ref:`transaction isolation level
 &lt;mysql-isolation-level&gt;`. To avoid possible data loss, it&#39;s recommended to
 switch from MySQL&#39;s default level, repeatable read, to read committed.

* Added support for ``cx_Oracle`` 5.3.

Email
  • Added the :setting:EMAIL_USE_LOCALTIME setting to allow sending SMTP date headers in the local time zone rather than in UTC.

  • EmailMessage.attach() and attach_file() now fall back to MIME type application/octet-stream when binary content that can't be decoded as UTF-8 is specified for a text/* attachment.

File Storage


* To make it wrappable by :class:`io.TextIOWrapper`,
 :class:`~django.core.files.File` now has the ``readable()``, ``writable()``,
 and ``seekable()`` methods.

Forms
  • The new :attr:CharField.empty_value &lt;django.forms.CharField.empty_value&gt; attribute allows specifying the Python value to use to represent "empty".

  • The new :meth:Form.get_initial_for_field() &lt;django.forms.Form.get_initial_for_field&gt; method returns initial data for a form field.

Internationalization


* Number formatting and the :setting:`NUMBER_GROUPING` setting support
 non-uniform digit grouping.

Management Commands
  • The new :option:loaddata --exclude option allows excluding models and apps while loading data from fixtures.

  • The new :option:diffsettings --default option allows specifying a settings module other than Django's default settings to compare against.

  • app_label\s arguments now limit the :option:showmigrations --plan output.

Migrations


* Added support for serialization of ``uuid.UUID`` objects.

Models
  • Added support for callable values in the defaults argument of :meth:QuerySet.update_or_create() &lt;django.db.models.query.QuerySet.update_or_create&gt; and :meth:~django.db.models.query.QuerySet.get_or_create.

  • :class:~django.db.models.ImageField now has a default :data:~django.core.validators.validate_image_file_extension validator. (This validator moved to the form field in :doc:Django 1.11.2 &lt;1.11.2&gt;.)

  • Added support for time truncation to :class:~django.db.models.functions.Trunc functions.

  • Added the :class:~django.db.models.functions.ExtractWeek function to extract the week from :class:~django.db.models.DateField and :class:~django.db.models.DateTimeField and exposed it through the :lookup:week lookup.

  • Added the :class:~django.db.models.functions.TruncTime function to truncate :class:~django.db.models.DateTimeField to its time component and exposed it through the :lookup:time lookup.

  • Added support for expressions in :meth:.QuerySet.values and :meth:~.QuerySet.values_list.

  • Added support for query expressions on lookups that take multiple arguments, such as range.

  • You can now use the unique=True option with

pyup-bot commented 6 years ago

Closing this in favor of #325