============================================ Django 5.1 release notes - UNDER DEVELOPMENT ============================================ *Expected August 2024* Welcome to Django 5.1! These release notes cover the :ref:`new features `, as well as some :ref:`backwards incompatible changes ` you'll want to be aware of when upgrading from Django 5.0 or earlier. We've :ref:`begun the deprecation process for some features `. See the :doc:`/howto/upgrade-version` guide if you're updating an existing project. Python compatibility ==================== Django 5.1 supports Python 3.10, 3.11, and 3.12. We **highly recommend** and only officially support the latest release of each series. .. _whats-new-5.1: What's new in Django 5.1 ======================== Minor features -------------- :mod:`django.contrib.admin` ~~~~~~~~~~~~~~~~~~~~~~~~~~~ * :attr:`.ModelAdmin.list_display` now supports using ``__`` lookups to list fields from related models. :mod:`django.contrib.admindocs` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * ... :mod:`django.contrib.auth` ~~~~~~~~~~~~~~~~~~~~~~~~~~ * The default iteration count for the PBKDF2 password hasher is increased from 720,000 to 870,000. * :class:`~django.contrib.auth.forms.BaseUserCreationForm` and :class:`~django.contrib.auth.forms.AdminPasswordChangeForm` now support disabling password-based authentication by setting an unusable password on form save. This is now available in the admin when visiting the user creation and password change pages. * :func:`~.django.contrib.auth.decorators.login_required`, :func:`~.django.contrib.auth.decorators.permission_required`, and :func:`~.django.contrib.auth.decorators.user_passes_test` decorators now support wrapping asynchronous view functions. * ``ReadOnlyPasswordHashWidget`` now includes a button to reset the user's password, which replaces the link previously embedded in the ``ReadOnlyPasswordHashField``'s help text, improving the overall accessibility of the :class:`~django.contrib.auth.forms.UserChangeForm`. :mod:`django.contrib.contenttypes` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * ... :mod:`django.contrib.gis` ~~~~~~~~~~~~~~~~~~~~~~~~~ * :class:`~django.contrib.gis.db.models.functions.BoundingCircle` is now supported on SpatiaLite 5.1+. * :class:`~django.contrib.gis.db.models.Collect` is now supported on MySQL 8.0.24+. * :class:`~django.contrib.gis.geoip2.GeoIP2` now allows querying using :class:`ipaddress.IPv4Address` or :class:`ipaddress.IPv6Address` objects. * :meth:`.GeoIP2.country` now exposes the ``continent_code``, ``continent_name``, and ``is_in_european_union`` values. * :meth:`.GeoIP2.city` now exposes the ``accuracy_radius`` and ``region_name`` values. In addition the ``dma_code`` and ``region`` values are now exposed as ``metro_code`` and ``region_code``, but the previous keys are also retained for backward compatibility. * :class:`~django.contrib.gis.measure.Area` now supports the ``ha`` unit. * The new :attr:`.OGRGeometry.is_3d` attribute allows checking if a geometry has a ``Z`` coordinate dimension. * The new :meth:`.OGRGeometry.set_3d` method allows addition and removal of the ``Z`` coordinate dimension. * :class:`~django.contrib.gis.gdal.OGRGeometry`, :class:`~django.contrib.gis.gdal.Point`, :class:`~django.contrib.gis.gdal.LineString`, :class:`~django.contrib.gis.gdal.Polygon`, and :class:`~django.contrib.gis.gdal.GeometryCollection` and its subclasses now support measured geometries via the new :attr:`.OGRGeometry.is_measured` and ``m`` properties, and the :meth:`.OGRGeometry.set_measured` method. * :attr:`.OGRGeometry.centroid` is now available on all supported geometry types. * :class:`FromWKB() ` and :class:`FromWKT() ` functions now support the optional ``srid`` argument (except for Oracle where it is ignored). :mod:`django.contrib.messages` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * ... :mod:`django.contrib.postgres` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * :class:`~django.contrib.postgres.indexes.BTreeIndex` now supports the ``deduplicate_items`` parameter. :mod:`django.contrib.redirects` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * ... :mod:`django.contrib.sessions` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * :class:`django.contrib.sessions.backends.cached_db.SessionStore` now handles exceptions when storing session information in the cache, logging proper error messages with their traceback via the newly added :ref:`sessions logger `. * :class:`django.contrib.sessions.backends.base.SessionBase` and all built-in session engines now provide async API. The new asynchronous methods all have ``a`` prefixed names, e.g. ``aget()``, ``akeys()``, or ``acycle_key()``. :mod:`django.contrib.sitemaps` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * ... :mod:`django.contrib.sites` ~~~~~~~~~~~~~~~~~~~~~~~~~~~ * ... :mod:`django.contrib.staticfiles` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * ... :mod:`django.contrib.syndication` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * ... Asynchronous views ~~~~~~~~~~~~~~~~~~ * ... Cache ~~~~~ * ... CSRF ~~~~ * ... Database backends ~~~~~~~~~~~~~~~~~ * ``"init_command"`` option is now supported in :setting:`OPTIONS` on SQLite to allow specifying :ref:`pragma options ` to set upon connection. * ``"transaction_mode"`` option is now supported in :setting:`OPTIONS` on SQLite to allow specifying the :ref:`sqlite-transaction-behavior`. * ``"pool"`` option is now supported in :setting:`OPTIONS` on PostgreSQL to allow using :ref:`connection pools `. Decorators ~~~~~~~~~~ * ... Email ~~~~~ * ... Error Reporting ~~~~~~~~~~~~~~~ * In order to improve accessibility, the technical 404 and 500 error pages now use HTML landmark elements for the header, footer, and main content areas. File Storage ~~~~~~~~~~~~ * ... File Uploads ~~~~~~~~~~~~ * ... Forms ~~~~~ * In order to improve accessibility and enable screen readers to associate fieldsets with their help text, the form fieldset now includes the ``aria-describedby`` HTML attribute. Generic Views ~~~~~~~~~~~~~ * ... Internationalization ~~~~~~~~~~~~~~~~~~~~ * ... Logging ~~~~~~~ * ... Management Commands ~~~~~~~~~~~~~~~~~~~ * :djadmin:`makemigrations` command now displays meaningful symbols for each operation to highlight :class:`operation categories `. Migrations ~~~~~~~~~~ * The new ``Operation.category`` attribute allows specifying an :class:`operation category ` used by the :djadmin:`makemigrations` to display a meaningful symbol for the operation. Models ~~~~~~ * :meth:`.QuerySet.explain` now supports the ``generic_plan`` option on PostgreSQL 16+. * :class:`~django.db.models.expressions.RowRange` now accepts positive integers for the ``start`` argument and negative integers for the ``end`` argument. * The new ``exclusion`` argument of :class:`~django.db.models.expressions.RowRange` and :class:`~django.db.models.expressions.ValueRange` allows excluding rows, groups, and ties from the window frames. * :meth:`.QuerySet.order_by` now supports ordering by annotation transforms such as ``JSONObject`` keys and ``ArrayAgg`` indices. * :class:`F() ` and :class:`OuterRef() ` expressions that output :class:`~django.db.models.CharField`, :class:`~django.db.models.EmailField`, :class:`~django.db.models.SlugField`, :class:`~django.db.models.URLField`, :class:`~django.db.models.TextField`, or :class:`~django.contrib.postgres.fields.ArrayField` can now be :ref:`sliced `. * The new ``from_queryset`` argument of :meth:`.Model.refresh_from_db` and :meth:`.Model.arefresh_from_db` allows customizing the queryset used to reload a model's value. This can be used to lock the row before reloading or to select related objects. * The new :attr:`.Expression.constraint_validation_compatible` attribute allows specifying that the expression should be ignored during a constraint validation. Requests and Responses ~~~~~~~~~~~~~~~~~~~~~~ * ... Security ~~~~~~~~ * ... Serialization ~~~~~~~~~~~~~ * ... Signals ~~~~~~~ * ... Templates ~~~~~~~~~ * Custom tags may now set extra data on the ``Parser`` object that will later be made available on the ``Template`` instance. Such data may be used, for example, by the template loader, or other template clients. * The new :ttag:`{% query_string %} ` template tag allows changing a :class:`~django.http.QueryDict` instance for use in links, for example, to generate a link to the next page while keeping any filtering options in place. * :ref:`Template engines ` now implement a ``check()`` method that is already registered with the check framework. Tests ~~~~~ * :meth:`~django.test.SimpleTestCase.assertContains`, :meth:`~django.test.SimpleTestCase.assertNotContains`, and :meth:`~django.test.SimpleTestCase.assertInHTML` assertions now add haystacks to assertion error messages. * The :class:`~django.test.RequestFactory`, :class:`~django.test.AsyncRequestFactory`, :class:`~django.test.Client`, and :class:`~django.test.AsyncClient` classes now support the ``query_params`` parameter, which accepts a dictionary of query string keys and values. This allows setting query strings on any HTTP methods more easily. .. code-block:: python self.client.post("/items/1", query_params={"action": "delete"}) await self.async_client.post("/items/1", query_params={"action": "delete"}) * The new :meth:`.SimpleTestCase.assertNotInHTML` assertion allows testing that an HTML fragment is not contained in the given HTML haystack. * In order to enforce test isolation, database connections inside threads are no longer allowed in :class:`~django.test.SimpleTestCase`. URLs ~~~~ * ... Utilities ~~~~~~~~~ * ... Validators ~~~~~~~~~~ * ... .. _backwards-incompatible-5.1: Backwards incompatible changes in 5.1 ===================================== Database backend API -------------------- This section describes changes that may be needed in third-party database backends. * ... :mod:`django.contrib.gis` ------------------------- * Support for PostGIS 2.5 is removed. * Support for PROJ < 6 is removed. * Support for GDAL 2.4 is removed. * :class:`~django.contrib.gis.geoip2.GeoIP2` no longer opens both city and country databases when a directory path is provided, preferring the city database, if it is available. The country database is a subset of the city database and both are not typically needed. If you require use of the country database when in the same directory as the city database, explicitly pass the country database path to the constructor. Dropped support for MariaDB 10.4 -------------------------------- Upstream support for MariaDB 10.4 ends in June 2024. Django 5.1 supports MariaDB 10.5 and higher. Dropped support for PostgreSQL 12 --------------------------------- Upstream support for PostgreSQL 12 ends in November 2024. Django 5.1 supports PostgreSQL 13 and higher. Miscellaneous ------------- * In order to improve accessibility, the admin's changelist filter is now rendered in a ``