December 4, 2023
Welcome to Django 5.0!
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 4.2 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.
Django 5.0 supports Python 3.10, 3.11, and 3.12. We highly recommend and only officially support the latest release of each series.
The Django 4.2.x series is the last to support Python 3.8 and 3.9.
Following the release of Django 5.0, we suggest that third-party app authors
drop support for all versions of Django prior to 4.2. At that time, you should
be able to run your package’s tests using python -Wd so that deprecation
warnings appear. After making the deprecation warning fixes, your app should be
compatible with Django 5.0.
Facet counts are now shown for applied filters in the admin changelist when
toggled on via the UI. This behavior can be changed via the new
ModelAdmin.show_facets attribute. For more information see
Facets.
Django 5.0 introduces the concept of a field group, and field group templates. This simplifies rendering of the related elements of a Django form field such as its label, widget, help text, and errors.
For example, the template below:
<form>
...
<div>
{{ form.name.label_tag }}
{% if form.name.help_text %}
<div class="helptext" id="{{ form.name.auto_id }}_helptext">
{{ form.name.help_text|safe }}
</div>
{% endif %}
{{ form.name.errors }}
{{ form.name }}
<div class="row">
<div class="col">
{{ form.email.label_tag }}
{% if form.email.help_text %}
<div class="helptext" id="{{ form.email.auto_id }}_helptext">
{{ form.email.help_text|safe }}
</div>
{% endif %}
{{ form.email.errors }}
{{ form.email }}
</div>
<div class="col">
{{ form.password.label_tag }}
{% if form.password.help_text %}
<div class="helptext" id="{{ form.password.auto_id }}_helptext">
{{ form.password.help_text|safe }}
</div>
{% endif %}
{{ form.password.errors }}
{{ form.password }}
</div>
</div>
</div>
...
</form>
Can now be simplified to:
<form>
...
<div>
{{ form.name.as_field_group }}
<div class="row">
<div class="col">{{ form.email.as_field_group }}</div>
<div class="col">{{ form.password.as_field_group }}</div>
</div>
</div>
...
</form>
as_field_group() renders fields with the
"django/forms/field.html" template by default and can be customized on a
per-project, per-field, or per-request basis. See
Reusable field group templates.
The new Field.db_default parameter
sets a database-computed default value. For example:
from django.db import models
from django.db.models.functions import Now, Pi
class MyModel(models.Model):
age = models.IntegerField(db_default=18)
created = models.DateTimeField(db_default=Now())
circumference = models.FloatField(db_default=2 * Pi())
The new GeneratedField allows creation of database
generated columns. This field can be used on all supported database backends
to create a field that is always computed from other fields. For example:
from django.db import models
from django.db.models import F
class Square(models.Model):
side = models.IntegerField()
area = models.GeneratedField(
expression=F("side") * F("side"),
output_field=models.BigIntegerField(),
db_persist=True,
)
Field.choices (for model fields) and ChoiceField.choices
(for form fields) allow for more flexibility when declaring their values. In
previous versions of Django, choices should either be a list of 2-tuples,
or an Enumeration types subclass, but the latter required
accessing the .choices attribute to provide the values in the expected
form:
from django.db import models
Medal = models.TextChoices("Medal", "GOLD SILVER BRONZE")
SPORT_CHOICES = [
("Martial Arts", [("judo", "Judo"), ("karate", "Karate")]),
("Racket", [("badminton", "Badminton"), ("tennis", "Tennis")]),
("unknown", "Unknown"),
]
class Winner(models.Model):
name = models.CharField(...)
medal = models.CharField(..., choices=Medal.choices)
sport = models.CharField(..., choices=SPORT_CHOICES)
Django 5.0 adds support for accepting a mapping or a callable instead of an
iterable, and also no longer requires .choices to be used directly to
expand enumeration types:
from django.db import models
Medal = models.TextChoices("Medal", "GOLD SILVER BRONZE")
SPORT_CHOICES = { # Using a mapping instead of a list of 2-tuples.
"Martial Arts": {"judo": "Judo", "karate": "Karate"},
"Racket": {"badminton": "Badminton", "tennis": "Tennis"},
"unknown": "Unknown",
}
def get_scores():
return [(i, str(i)) for i in range(10)]
class Winner(models.Model):
name = models.CharField(...)
medal = models.CharField(..., choices=Medal) # Using `.choices` not required.
sport = models.CharField(..., choices=SPORT_CHOICES)
score = models.IntegerField(choices=get_scores) # A callable is allowed.
Under the hood the provided choices are normalized into a list of 2-tuples
as the canonical form whenever the choices value is updated. For more
information, please check the model field reference on choices.
django.contrib.admin¶AdminSite.get_log_entries() method allows customizing the
queryset for the site’s listed log entries.django.contrib.admin.AllValuesFieldListFilter,
ChoicesFieldListFilter, RelatedFieldListFilter, and
RelatedOnlyFieldListFilter admin filters now handle multi-valued query
parameters.XRegExp is upgraded from version 3.2.0 to 5.1.1.AdminSite.get_model_admin() method returns an admin class for
the given model class.ModelAdmin.list_display now support boolean
attribute.django.contrib.auth¶a prefix: django.contrib.auth.aauthenticate(),
aget_user(),
alogin(), alogout(),
and aupdate_session_auth_hash().AuthenticationMiddleware now adds an HttpRequest.auser()
asynchronous method that returns the currently logged-in user.django.contrib.auth.hashers.acheck_password() asynchronous
function and AbstractBaseUser.acheck_password() method allow
asynchronous checking of user passwords.django.contrib.contenttypes¶QuerySet.prefetch_related() now supports prefetching
GenericForeignKey with
non-homogeneous set of results.django.contrib.gis¶ClosestPoint()
function returns a 2-dimensional point on the geometry that is closest to
another geometry.filter
argument.GEOSGeometry.equals_identical() method allows point-wise
equivalence checking of geometries.django.contrib.messages¶MessagesTestMixin.assertMessages() assertion method allows
testing messages added to a
response.django.contrib.postgres¶violation_error_code attribute of
ExclusionConstraint allows
customizing the code of ValidationError raised during
model validation.http.disconnect events are now handled. This allows views to
perform any necessary cleanup if a client disconnects before the response is
generated. See Handling disconnects for more details.cache_control()never_cache()no_append_slash()csrf_exempt()csrf_protect()ensure_csrf_cookie()requires_csrf_token()sensitive_variables()sensitive_post_parameters()gzip_page()condition()conditional_page()etag()last_modified()require_http_methods()require_GET()require_POST()require_safe()vary_on_cookie()vary_on_headers()xframe_options_deny()xframe_options_sameorigin()xframe_options_exempt()sensitive_variables() and
sensitive_post_parameters() can now be
used with asynchronous functions.File.open() now passes all positional (*args) and keyword
arguments (**kwargs) to Python’s built-in open().assume_scheme argument for
URLField allows specifying a default URL scheme.aria-describedby HTML attribute to enable
screen readers to associate form fields with their help text.aria-invalid="true" HTML attribute.functools.cache() or
functools.lru_cache() is now supported without the need to write a
custom serializer.create_defaults argument of QuerySet.update_or_create()
and QuerySet.aupdate_or_create() methods allows specifying a different
field values for the create operation.violation_error_code attribute of
BaseConstraint,
CheckConstraint, and
UniqueConstraint allows customizing the code
of ValidationError raised during
model validation.Model.save() now allows specifying a tuple of parent classes that must
be forced to be inserted.QuerySet.bulk_create() and QuerySet.abulk_create() methods now
set the primary key on each model instance when the update_conflicts
parameter is enabled (if the database supports it).UniqueConstraint.nulls_distinct attribute allows customizing
the treatment of NULL values on PostgreSQL 15+.aget_object_or_404() and
aget_list_or_404() asynchronous shortcuts allow
asynchronous getting objects.aprefetch_related_objects() function allows
asynchronous prefetching of model instances.QuerySet.aiterator() now supports previous calls to
prefetch_related().UUIDField is now created as UUID column rather than
CHAR(32) column. See the migration guide above for more details on
Migrating existing UUIDField on MariaDB 10.7+.cx_Oracle is deprecated as of this release and will be removed in Django
6.0.django.core.paginator.Paginator.error_messages argument
allows customizing the error messages raised by Paginator.page().Signal.asend() and Signal.asend_robust() methods allow
asynchronous signal dispatch. Signal receivers may be synchronous or
asynchronous, and will be automatically adapted to the correct calling style.Client and AsyncClient now
provide asynchronous methods, using an a prefix:
asession(), alogin(),
aforce_login(), and
alogout().AsyncClient now supports the follow parameter.test --durations option allows showing the duration of the
slowest tests on Python 3.12+.offset argument of
StepValueValidator allows specifying an
offset for valid values.This section describes changes that may be needed in third-party database backends.
DatabaseFeatures.supports_expression_defaults should be set to False
if the database doesn’t support using database functions as defaults.DatabaseFeatures.supports_default_keyword_in_insert should be set to
False if the database doesn’t support the DEFAULT keyword in
INSERT queries.DatabaseFeatures.supports_default_keyword_in_bulk_insert should be set to
False if the database doesn’t support the DEFAULT keyword in bulk
INSERT queries.django.contrib.gis¶django.contrib.sitemaps¶django.contrib.sitemaps.ping_google() function and the
ping_google management command are removed as the Google
Sitemaps ping endpoint is deprecated and will be removed in January 2024.django.contrib.sitemaps.SitemapNotFound exception class is removed.Support for pre-releases of MySQL 8.0.x series is removed. Django 5.0 supports MySQL 8.0.11 and higher.
create_defaults__exact may now be required with QuerySet.update_or_create()¶QuerySet.update_or_create() now supports the parameter
create_defaults. As a consequence, any models that have a field named
create_defaults that are used with an update_or_create() should specify
the field in the lookup with create_defaults__exact.
UUIDField on MariaDB 10.7+¶On MariaDB 10.7+, UUIDField is now created as UUID column rather than
CHAR(32) column. As a consequence, any UUIDField created in
Django < 5.0 should be replaced with a UUIDField subclass backed by
CHAR(32):
class Char32UUIDField(models.UUIDField):
def db_type(self, connection):
return "char(32)"
def get_db_prep_value(self, value, connection, prepared=False):
value = super().get_db_prep_value(value, connection, prepared)
if value is not None:
value = value.hex
return value
For example:
class MyModel(models.Model):
uuid = models.UUIDField(primary_key=True, default=uuid.uuid4)
Should become:
class Char32UUIDField(models.UUIDField):
...
class MyModel(models.Model):
uuid = Char32UUIDField(primary_key=True, default=uuid.uuid4)
Running the makemigrations command will generate a migration
containing a no-op AlterField operation.
instance argument of the undocumented
BaseModelFormSet.save_existing() method is renamed to obj.django.contrib.admin.helpers.checkbox is removed.sqlite3.Query.annotation_select_mask attribute is changed from a
set of strings to an ordered list of strings.ImageField.update_dimension_fields() is no longer called on the
post_init signal if width_field and height_field are not set.Now database function now uses
LOCALTIMESTAMP instead of CURRENT_TIMESTAMP on Oracle.AdminSite.site_header is now rendered in a <div> tag instead of
<h1>. Screen reader users rely on heading elements for navigation within
a page. Having two <h1> elements was confusing and the site header wasn’t
helpful as it is repeated on all pages.<main> and <header> tag instead of
<div>.XOR operator, ^ as
the exclusive or (XOR) operator now returns rows that are matched by an
odd number of operands rather than exactly one operand. This is consistent
with the behavior of MySQL, MariaDB, and Python.asgiref is increased from 3.6.0 to
3.7.0.selenium is increased from 3.8.0 to
4.8.0.AlreadyRegistered and NotRegistered exceptions are moved from
django.contrib.admin.sites to django.contrib.admin.exceptions.cx_Oracle < 8.3 is removed.RuntimeWarning.BadRequest is raised for non-UTF-8 encoded
requests with the application/x-www-form-urlencoded content type.
See RFC 1866 for more details.colorama is increased to 0.4.6.docutils is increased to 0.19.DjangoDivFormRenderer and Jinja2DivFormRenderer transitional form
renderers are deprecated.name and violation_error_message to
BaseConstraint is deprecated in favor of
keyword-only arguments.request is added to the signature of ModelAdmin.lookup_allowed().
Support for ModelAdmin subclasses that do not accept this argument is
deprecated.get_joining_columns() method of ForeignObject and
ForeignObjectRel is deprecated. Starting with Django 6.0,
django.db.models.sql.datastructures.Join will no longer fallback to
get_joining_columns(). Subclasses should implement
get_joining_fields() instead.ForeignObject.get_reverse_joining_columns() method is deprecated.forms.URLField will change from "http" to
"https" in Django 6.0. Set FORMS_URLFIELD_ASSUME_HTTPS
transitional setting to True to opt into assuming "https" during the
Django 5.x release cycle.FORMS_URLFIELD_ASSUME_HTTPS transitional setting is deprecated.format_html() without passing args or kwargs will be
removed.cx_Oracle is deprecated in favor of oracledb 1.3.2+ Python
driver.DatabaseOperations.field_cast_sql() is deprecated in favor of
DatabaseOperations.lookup_cast(). Starting with Django 6.0,
BuiltinLookup.process_lhs() will no longer call field_cast_sql().
Third-party database backends should implement lookup_cast() instead.django.db.models.enums.ChoicesMeta metaclass is renamed to
ChoicesType.Prefetch.get_current_queryset() method is deprecated.get_prefetch_queryset() method of related managers and descriptors
is deprecated. Starting with Django 6.0, get_prefetcher() and
prefetch_related_objects() will no longer fallback to
get_prefetch_queryset(). Subclasses should implement
get_prefetch_querysets() instead.These features have reached the end of their deprecation cycle and are removed in Django 5.0.
See Features deprecated in 4.0 for details on these changes, including how to remove usage of these features.
SERIALIZE test setting is removed.django.utils.baseconv module is removed.django.utils.datetime_safe module is removed.USE_TZ setting is changed from False to
True.'http' to 'https'.extra_tests argument for DiscoverRunner.build_suite() and
DiscoverRunner.run_tests() is removed.django.contrib.postgres.aggregates.ArrayAgg, JSONBAgg, and
StringAgg aggregates no longer return [], [], and '',
respectively, when there are no rows.USE_L10N setting is removed.USE_DEPRECATED_PYTZ transitional setting is removed.pytz timezones is removed.is_dst argument is removed from:QuerySet.datetimes()django.utils.timezone.make_aware()django.db.models.functions.Trunc()django.db.models.functions.TruncSecond()django.db.models.functions.TruncMinute()django.db.models.functions.TruncHour()django.db.models.functions.TruncDay()django.db.models.functions.TruncWeek()django.db.models.functions.TruncMonth()django.db.models.functions.TruncQuarter()django.db.models.functions.TruncYear()django.contrib.gis.admin.GeoModelAdmin and OSMGeoAdmin classes
are removed.BaseForm._html_output() method is removed.str, rather than a SafeString, when rendering
an ErrorDict and ErrorList is removed.See Features deprecated in 4.1 for details on these changes, including how to remove usage of these features.
SitemapIndexItem.__str__() method is removed.CSRF_COOKIE_MASKED transitional setting is removed.name argument of django.utils.functional.cached_property() is
removed.opclasses argument of
django.contrib.postgres.constraints.ExclusionConstraint is removed.errors=None to
SimpleTestCase.assertFormError() and assertFormsetError() is removed.django.contrib.sessions.serializers.PickleSerializer is removed.QuerySet.iterator() on a queryset that prefetches related
objects without providing the chunk_size argument is no longer allowed.created=True is required in the signature of
RemoteUserBackend.configure_user() subclasses.GET requests in the
django.contrib.auth.views.LogoutView and
django.contrib.auth.views.logout_then_login() is removed.django.utils.timezone.utc alias to datetime.timezone.utc is
removed.SimpleTestCase.assertFormError() and assertFormSetError() is no
longer allowed.django.contrib.gis.admin.OpenLayersWidget is removed.django.contrib.auth.hashers.CryptPasswordHasher is removed."django/forms/default.html" and
"django/forms/formsets/default.html" templates are removed.nulls_first=False or nulls_last=False to Expression.asc()
and Expression.desc() methods, and the OrderBy expression is no
longer allowed.Jan 24, 2024