Django 5.1 release notes - UNDER DEVELOPMENT¶
Expected August 2024
Welcome to Django 5.1!
These release notes cover the new features, as well as some backwards incompatible changes you’ll want to be aware of when upgrading from Django 5.0 or earlier. We’ve begun the deprecation process for some features.
See the How to upgrade Django to a newer 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.
What’s new in Django 5.1¶
Minor features¶
django.contrib.admin
¶
ModelAdmin.list_display
now supports using__
lookups to list fields from related models.
django.contrib.auth
¶
- The default iteration count for the PBKDF2 password hasher is increased from 720,000 to 870,000.
BaseUserCreationForm
andAdminPasswordChangeForm
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.login_required()
,permission_required()
, anduser_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 theReadOnlyPasswordHashField
’s help text, improving the overall accessibility of theUserChangeForm
.
django.contrib.gis
¶
BoundingCircle
is now supported on SpatiaLite 5.1+.Collect
is now supported on MySQL 8.0.24+.GeoIP2
now allows querying usingipaddress.IPv4Address
oripaddress.IPv6Address
objects.GeoIP2.country()
now exposes thecontinent_code
,continent_name
, andis_in_european_union
values.GeoIP2.city()
now exposes theaccuracy_radius
andregion_name
values. In addition thedma_code
andregion
values are now exposed asmetro_code
andregion_code
, but the previous keys are also retained for backward compatibility.Area
now supports theha
unit.- The new
OGRGeometry.is_3d
attribute allows checking if a geometry has aZ
coordinate dimension. - The new
OGRGeometry.set_3d()
method allows addition and removal of theZ
coordinate dimension. OGRGeometry
,Point
,LineString
,Polygon
, andGeometryCollection
and its subclasses now support measured geometries via the newOGRGeometry.is_measured
andm
properties, and theOGRGeometry.set_measured()
method.OGRGeometry.centroid
is now available on all supported geometry types.FromWKB()
andFromWKT()
functions now support the optionalsrid
argument (except for Oracle where it is ignored).
django.contrib.postgres
¶
BTreeIndex
now supports thededuplicate_items
parameter.
django.contrib.sessions
¶
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 sessions logger.django.contrib.sessions.backends.base.SessionBase
and all built-in session engines now provide async API. The new asynchronous methods all havea
prefixed names, e.g.aget()
,akeys()
, oracycle_key()
.
Asynchronous views¶
- …
Cache¶
- …
CSRF¶
- …
Database backends¶
"init_command"
option is now supported inOPTIONS
on SQLite to allow specifying pragma options to set upon connection."pool"
option is now supported inOPTIONS
on PostgreSQL to allow using 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¶
makemigrations
command now displays meaningful symbols for each operation to highlightoperation categories
.
Migrations¶
- The new
Operation.category
attribute allows specifying anoperation category
used by themakemigrations
to display a meaningful symbol for the operation.
Models¶
QuerySet.explain()
now supports thegeneric_plan
option on PostgreSQL 16+.RowRange
now accepts positive integers for thestart
argument and negative integers for theend
argument.- The new
exclusion
argument ofRowRange
andValueRange
allows excluding rows, groups, and ties from the window frames. QuerySet.order_by()
now supports ordering by annotation transforms such asJSONObject
keys andArrayAgg
indices.F()
andOuterRef()
expressions that outputCharField
,EmailField
,SlugField
,URLField
,TextField
, orArrayField
can now be sliced.- The new
from_queryset
argument ofModel.refresh_from_db()
andModel.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
"transaction_mode"
option is now supported inOPTIONS
on SQLite to allow specifying the Transactions behavior.
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 theTemplate
instance. Such data may be used, for example, by the template loader, or other template clients. - The new
{% query_string %}
template tag allows changing aQueryDict
instance for use in links, for example, to generate a link to the next page while keeping any filtering options in place. - Template engines now implement a
check()
method that is already registered with the check framework.
Tests¶
assertContains()
,assertNotContains()
, andassertInHTML()
assertions now add haystacks to assertion error messages.The
RequestFactory
,AsyncRequestFactory
,Client
, andAsyncClient
classes now support thequery_params
parameter, which accepts a dictionary of query string keys and values. This allows setting query strings on any HTTP methods more easily.self.client.post("/items/1", query_params={"action": "delete"}) await self.async_client.post("/items/1", query_params={"action": "delete"})
The new
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
SimpleTestCase
.
URLs¶
- …
Utilities¶
- …
Validators¶
- …
Backwards incompatible changes in 5.1¶
Database backend API¶
This section describes changes that may be needed in third-party database backends.
- …
django.contrib.gis
¶
- Support for PostGIS 2.5 is removed.
- Support for PROJ < 6 is removed.
- Support for GDAL 2.4 is removed.
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
<nav>
tag instead of a<div>
. - In order to improve accessibility, the admin’s footer is now rendered in
a
<footer>
tag instead of a<div>
, and also moved below the<div id="main">
element. SimpleTestCase.assertURLEqual()
andassertInHTML()
now add": "
to themsg_prefix
. This is consistent with the behavior of other assertions.django.utils.text.Truncator
used bytruncatechars_html
andtruncatewords_html
template filters now useshtml.parser.HTMLParser
subclasses. This results in a more robust and faster operation, but there may be small differences in the output.- The undocumented
django.urls.converters.get_converter()
function is removed.
Features deprecated in 5.1¶
Miscellaneous¶
- The
ModelAdmin.log_deletion()
andLogEntryManager.log_action()
methods are deprecated. Subclasses should implementModelAdmin.log_deletions()
andLogEntryManager.log_actions()
instead. - The undocumented
django.utils.itercompat.is_iterable()
function and thedjango.utils.itercompat
module are deprecated. Useisinstance(..., collections.abc.Iterable)
instead. - The
django.contrib.gis.geoip2.GeoIP2.coords()
method is deprecated. Usedjango.contrib.gis.geoip2.GeoIP2.lon_lat()
instead. - The
django.contrib.gis.geoip2.GeoIP2.open()
method is deprecated. Use theGeoIP2
constructor instead. - Passing positional arguments to
Model.save()
andModel.asave()
is deprecated in favor of keyword-only arguments. - Setting
django.contrib.gis.gdal.OGRGeometry.coord_dim
is deprecated. Useset_3d()
instead. - Overriding existing converters with
django.urls.register_converter()
is deprecated. - The
check
keyword argument ofCheckConstraint
is deprecated in favor ofcondition
.
Features removed in 5.1¶
These features have reached the end of their deprecation cycle and are removed in Django 5.1.
See Features deprecated in 4.2 for details on these changes, including how to remove usage of these features.
- The
BaseUserManager.make_random_password()
method is removed. - The model’s
Meta.index_together
option is removed. - The
length_is
template filter is removed. - The
django.contrib.auth.hashers.SHA1PasswordHasher
,django.contrib.auth.hashers.UnsaltedSHA1PasswordHasher
, anddjango.contrib.auth.hashers.UnsaltedMD5PasswordHasher
are removed. - The model
django.contrib.postgres.fields.CICharField
,django.contrib.postgres.fields.CIEmailField
, anddjango.contrib.postgres.fields.CITextField
are removed, except for support in historical migrations. - The
django.contrib.postgres.fields.CIText
mixin is removed. - The
map_width
andmap_height
attributes ofBaseGeometryWidget
are removed. - The
SimpleTestCase.assertFormsetError()
method is removed. - The
TransactionTestCase.assertQuerysetEqual()
method is removed. - Support for passing encoded JSON string literals to
JSONField
and associated lookups and expressions is removed. - Support for passing positional arguments to
Signer
andTimestampSigner
is removed. - The
DEFAULT_FILE_STORAGE
andSTATICFILES_STORAGE
settings is removed. - The
django.core.files.storage.get_storage_class()
function is removed.