{"title":"Django 5.1 release notes","version":"dev","locale":"en","docname":"releases/5.1","url":"/en/dev/releases/5.1/","canonical":"https://djangodocs.dev/en/dev/releases/5.1/","summary":"Welcome to Django 5.1! These release notes cover the new features, as well as some backwards incompatible changes you should be aware of when upgrading from…","html":"

Django 5.1 release notesLink to this heading#

\n

August 7, 2024

\n

Welcome to Django 5.1!

\n

These release notes cover the new features, as well as\nsome backwards incompatible changes you\nshould be aware of when upgrading from Django 5.0 or earlier. We’ve\nbegun the deprecation process for some features.

\n

See the How to upgrade Django to a newer version guide if you’re updating an existing\nproject.

\n
\n

Python compatibilityLink to this heading#

\n

Django 5.1 supports Python 3.10, 3.11, 3.12, and 3.13 (as of 5.1.3). We\nhighly recommend and only officially support the latest release of each\nseries.

\n
\n
\n

What’s new in Django 5.1Link to this heading#

\n
\n

{% querystring %} template tagLink to this heading#

\n

Django 5.1 introduces the {% querystring %} template\ntag, simplifying the modification of query parameters in URLs, making it easier\nto generate links that maintain existing query parameters while adding or\nchanging specific ones.

\n

For instance, navigating pagination and query strings in templates can be\ncumbersome. Consider this template fragment that dynamically generates a URL\nfor navigating to the next page within a paginated view:

\n
Django template
{# Linebreaks added for readability, this should be one, long line. #}\n<a href="?{% for key, values in request.GET.iterlists %}\n  {% if key != "page" %}\n    {% for value in values %}\n      {{ key }}={{ value }}&amp;\n    {% endfor %}\n  {% endif %}\n{% endfor %}page={{ page.next_page_number }}">Next page</a>\n
\n

When switching to using this new template tag, the above magically becomes:

\n
Django template
<a href="{% querystring page=page.next_page_number %}">Next page</a>\n
\n
\n
\n

PostgreSQL Connection PoolsLink to this heading#

\n

Django 5.1 also introduces connection pool support for\nPostgreSQL. As the time to establish a new connection can be relatively long,\nkeeping connections open can reduce latency.

\n

To use a connection pool with psycopg, you can set the "pool" option\ninside OPTIONS to be a dict to be passed to\nConnectionPool, or to True to use the\nConnectionPool defaults:

\n
Code
DATABASES = {\n    "default": {\n        "ENGINE": "django.db.backends.postgresql",\n        # ...\n        "OPTIONS": {\n            "pool": {\n                "min_size": 2,\n                "max_size": 4,\n                "timeout": 10,\n            }\n        },\n    },\n}\n
\n
\n
\n

Middleware to require authentication by defaultLink to this heading#

\n

The new LoginRequiredMiddleware\nredirects all unauthenticated requests to a login page. Views can allow\nunauthenticated requests by using the new\nlogin_not_required() decorator.

\n

LoginRequiredMiddleware respects the login_url and\nredirect_field_name values set via the\nlogin_required() decorator, but does not\nsupport setting login_url or redirect_field_name via the\nLoginRequiredMixin.

\n

To enable this, add\n"django.contrib.auth.middleware.LoginRequiredMiddleware" to your\nMIDDLEWARE setting.

\n
\n
\n

Minor featuresLink to this heading#

\n
\n

django.contrib.adminLink to this heading#

\n\n
\n
\n

django.contrib.authLink to this heading#

\n
    \n

  • The default iteration count for the PBKDF2 password hasher is increased from\n720,000 to 870,000.

    • \n

  • The default parallelism of the ScryptPasswordHasher is increased from\n1 to 5, to follow OWASP recommendations.

    • \n

  • The new AdminUserCreationForm and\nthe existing AdminPasswordChangeForm now\nsupport disabling password-based authentication by setting an unusable\npassword on form save. This is now available in the admin when visiting the\nuser creation and password change pages.

    • \n

  • login_required(),\npermission_required(), and\nuser_passes_test() decorators now\nsupport wrapping asynchronous view functions.

    • \n

  • ReadOnlyPasswordHashWidget now includes a button to reset the user’s\npassword, which replaces the link previously embedded in the\nReadOnlyPasswordHashField’s help text, improving the overall\naccessibility of the\nUserChangeForm.

    • \n
\n
\n
\n

django.contrib.gisLink to this heading#

\n\n
\n
\n

django.contrib.postgresLink to this heading#

\n
    \n

  • BTreeIndex now supports the\ndeduplicate_items parameter.

    • \n
\n
\n
\n

django.contrib.sessionsLink to this heading#

\n\n
\n
\n

Database backendsLink to this heading#

\n\n
\n
\n

Error ReportingLink to this heading#

\n
    \n

  • In order to improve accessibility, the technical 404 and 500 error pages now\nuse HTML landmark elements for the header, footer, and main content areas.

    • \n
\n
\n
\n

File StorageLink to this heading#

\n\n
\n
\n

FormsLink to this heading#

\n
    \n

  • In order to improve accessibility and enable screen readers to associate\nfieldsets with their help text, the form fieldset now includes the\naria-describedby HTML attribute.

    • \n
\n
\n
\n

Management CommandsLink to this heading#

\n\n
\n
\n

MigrationsLink to this heading#

\n\n
\n
\n

ModelsLink to this heading#

\n\n
\n
\n

TemplatesLink to this heading#

\n
    \n

  • Custom tags may now set extra data on the Parser object that will later\nbe made available on the Template instance. Such data may be used, for\nexample, by the template loader, or other template clients.

    • \n

  • Template engines now implement a check() method\nthat is already registered with the check framework.

    • \n
\n
\n
\n

TestsLink to this heading#

\n
    \n

  • assertContains(),\nassertNotContains(), and\nassertInHTML() assertions now add haystacks\nto assertion error messages.

    • \n

  • The RequestFactory,\nAsyncRequestFactory, Client, and\nAsyncClient classes now support the query_params\nparameter, which accepts a dictionary of query string keys and values. This\nallows setting query strings on any HTTP methods more easily.

    \n
    Python
    self.client.post("/items/1", query_params={"action": "delete"})\nawait self.async_client.post("/items/1", query_params={"action": "delete"})\n
    \n
    • \n

  • The new SimpleTestCase.assertNotInHTML() assertion allows testing that\nan HTML fragment is not contained in the given HTML haystack.

    • \n

  • In order to enforce test isolation, database connections inside threads are\nno longer allowed in SimpleTestCase.

    • \n
\n
\n
\n

ValidatorsLink to this heading#

\n\n
\n
\n
\n
\n

Backwards incompatible changes in 5.1Link to this heading#

\n
\n

django.contrib.gisLink to this heading#

\n\n
\n
\n

Dropped support for MariaDB 10.4Link to this heading#

\n

Upstream support for MariaDB 10.4 ends in June 2024. Django 5.1 supports\nMariaDB 10.5 and higher.

\n
\n
\n

Dropped support for PostgreSQL 12Link to this heading#

\n

Upstream support for PostgreSQL 12 ends in November 2024. Django 5.1 supports\nPostgreSQL 13 and higher.

\n
\n
\n

MiscellaneousLink to this heading#

\n\n
\n
\n
\n

Features deprecated in 5.1Link to this heading#

\n
\n

MiscellaneousLink to this heading#

\n\n
\n
\n
\n

Features removed in 5.1Link to this heading#

\n

These features have reached the end of their deprecation cycle and are removed\nin Django 5.1.

\n

See Features deprecated in 4.2 for details on these changes, including how\nto remove usage of these features.

\n\n
","rootId":"django-5-1-release-notes","toc":[{"title":"Python compatibility","anchor":"python-compatibility","children":[]},{"title":"What’s new in Django 5.1","anchor":"what-s-new-in-django-5-1","children":[{"title":"{% querystring %} template tag","anchor":"querystring-template-tag","children":[]},{"title":"PostgreSQL Connection Pools","anchor":"postgresql-connection-pools","children":[]},{"title":"Middleware to require authentication by default","anchor":"middleware-to-require-authentication-by-default","children":[]},{"title":"Minor features","anchor":"minor-features","children":[{"title":"django.contrib.admin","anchor":"django-contrib-admin","children":[]},{"title":"django.contrib.auth","anchor":"django-contrib-auth","children":[]},{"title":"django.contrib.gis","anchor":"django-contrib-gis","children":[]},{"title":"django.contrib.postgres","anchor":"django-contrib-postgres","children":[]},{"title":"django.contrib.sessions","anchor":"django-contrib-sessions","children":[]},{"title":"Database backends","anchor":"database-backends","children":[]},{"title":"Error Reporting","anchor":"error-reporting","children":[]},{"title":"File Storage","anchor":"file-storage","children":[]},{"title":"Forms","anchor":"forms","children":[]},{"title":"Management Commands","anchor":"management-commands","children":[]},{"title":"Migrations","anchor":"migrations","children":[]},{"title":"Models","anchor":"models","children":[]},{"title":"Templates","anchor":"templates","children":[]},{"title":"Tests","anchor":"tests","children":[]},{"title":"Validators","anchor":"validators","children":[]}]}]},{"title":"Backwards incompatible changes in 5.1","anchor":"backwards-incompatible-changes-in-5-1","children":[{"title":"django.contrib.gis","anchor":"id1","children":[]},{"title":"Dropped support for MariaDB 10.4","anchor":"dropped-support-for-mariadb-10-4","children":[]},{"title":"Dropped support for PostgreSQL 12","anchor":"dropped-support-for-postgresql-12","children":[]},{"title":"Miscellaneous","anchor":"miscellaneous","children":[]}]},{"title":"Features deprecated in 5.1","anchor":"features-deprecated-in-5-1","children":[{"title":"Miscellaneous","anchor":"id2","children":[]}]},{"title":"Features removed in 5.1","anchor":"features-removed-in-5-1","children":[]}],"breadcrumbs":[{"docname":"releases/index","title":"Release notes","url":"/en/dev/releases/"}],"prev":{"docname":"releases/5.1.1","title":"Django 5.1.1 release notes","url":"/en/dev/releases/5.1.1/"},"next":{"docname":"releases/5.0.14","title":"Django 5.0.14 release notes","url":"/en/dev/releases/5.0.14/"},"formats":{"html":"/en/dev/releases/5.1/","markdown":"/en/dev/releases/5.1.md","json":"/en/dev/releases/5.1.json"},"source":"https://github.com/django/django/blob/main/docs/releases/5.1.txt","official":"https://docs.djangoproject.com/en/dev/releases/5.1/","inVersions":["dev","6.1","6.0","5.2","5.1"],"inLocales":["en"]}