Catatan terbitan Django 5.1Link to this heading
August 7, 2024
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 Django 5.0 or earlier. We've begun the deprecation process for some features.
Lihat panduan Bagaimana meningkatkan Django ke versi terbaru jika anda sedang memperbaharui proyek yang ada.
Kesesuaian PythonLink to this heading
Django 5.1 supports Python 3.10, 3.11, 3.12, and 3.13 (as of 5.1.3). We highly recommend and only officially support the latest release of each series.
What's new in Django 5.1Link to this heading
{% querystring %} template tagLink to this heading
Django 5.1 introduces the {% querystring %} template
tag, simplifying the modification of query parameters in URLs, making it easier
to generate links that maintain existing query parameters while adding or
changing specific ones.
For instance, navigating pagination and query strings in templates can be cumbersome. Consider this template fragment that dynamically generates a URL for navigating to the next page within a paginated view:
{# Linebreaks added for readability, this should be one, long line. #}
<a href="?{% for key, values in request.GET.iterlists %}
{% if key != "page" %}
{% for value in values %}
{{ key }}={{ value }}&
{% endfor %}
{% endif %}
{% endfor %}page={{ page.next_page_number }}">Next page</a>
When switching to using this new template tag, the above magically becomes:
<a href="{% querystring page=page.next_page_number %}">Next page</a>
PostgreSQL Connection PoolsLink to this heading
Django 5.1 also introduces connection pool support for PostgreSQL. As the time to establish a new connection can be relatively long, keeping connections open can reduce latency.
To use a connection pool with psycopg, you can set the "pool" option
inside OPTIONS to be a dict to be passed to
ConnectionPool, or to True to use the
ConnectionPool defaults:
DATABASES = {
"default": {
"ENGINE": "django.db.backends.postgresql",
# ...
"OPTIONS": {
"pool": {
"min_size": 2,
"max_size": 4,
"timeout": 10,
}
},
},
}
Middleware to require authentication by defaultLink to this heading
The new LoginRequiredMiddleware
redirects all unauthenticated requests to a login page. Views can allow
unauthenticated requests by using the new
login_not_required() decorator.
LoginRequiredMiddleware respects the login_url and
redirect_field_name values set via the
login_required() decorator, but does not
support setting login_url or redirect_field_name via the
LoginRequiredMixin.
To enable this, add
"django.contrib.auth.middleware.LoginRequiredMiddleware" to your
MIDDLEWARE setting.
Fitur kecilLink to this heading
django.contrib.adminLink to this heading
ModelAdmin.list_displaynow supports using__lookups to list fields from related models.
django.contrib.authLink to this heading
The default iteration count for the PBKDF2 password hasher is increased from 720,000 to 870,000.
The default
parallelismof theScryptPasswordHasheris increased from 1 to 5, to follow OWASP recommendations.The new
AdminUserCreationFormand the existingAdminPasswordChangeFormnow 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.ReadOnlyPasswordHashWidgetnow 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.gisLink to this heading
BoundingCircleis now supported on SpatiaLite 5.1+.Collectis now supported on MySQL 8.0.24+.GeoIP2now allows querying usingipaddress.IPv4Addressoripaddress.IPv6Addressobjects.GeoIP2.country()now exposes thecontinent_code,continent_name, andis_in_european_unionvalues.GeoIP2.city()now exposes theaccuracy_radiusandregion_namevalues. In addition, thedma_codeandregionvalues are now exposed asmetro_codeandregion_code, but the previous keys are also retained for backward compatibility.Areanow supports thehaunit.The new
OGRGeometry.is_3dattribute allows checking if a geometry has aZcoordinate dimension.The new
OGRGeometry.set_3d()method allows addition and removal of theZcoordinate dimension.OGRGeometry,Point,LineString,Polygon, andGeometryCollectionand its subclasses now support measured geometries via the newOGRGeometry.is_measuredandmproperties, and theOGRGeometry.set_measured()method.OGRGeometry.centroidis now available on all supported geometry types.FromWKB()andFromWKT()functions now support the optionalsridargument (except for Oracle where it is ignored).
django.contrib.postgresLink to this heading
BTreeIndexnow supports thededuplicate_itemsparameter.
django.contrib.sessionsLink to this heading
django.contrib.sessions.backends.cached_db.SessionStorenow 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.SessionBaseand all built-in session engines now provide async API. The new asynchronous methods all haveaprefixed names, e.g.aget(),akeys(), oracycle_key().
Backend basisdataLink to this heading
"init_command"option is now supported inOPTIONSon SQLite to allow specifying pragma options to set upon connection."transaction_mode"option is now supported inOPTIONSon SQLite to allow specifying the Transactions behavior."pool"option is now supported inOPTIONSon PostgreSQL to allow using connection pools.
Error ReportingLink to this heading
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.
Penyimpanan BerkasLink to this heading
The
allow_overwriteparameter ofFileSystemStoragenow allows saving new files over existing ones.
FormulirLink to this heading
In order to improve accessibility and enable screen readers to associate fieldsets with their help text, the form fieldset now includes the
aria-describedbyHTML attribute.
Pengelolaan perintahLink to this heading
Perintah
makemigrationssekarang menampilkan simbol yang bermakna untuk setiap operasi guna menyorotioperation categories.
PerpindahanLink to this heading
Atribut
Operation.categoryyang baru memungkinkan untuk menentukankategori operasiyang digunakan olehmakemigrationsuntuk menampilkan simbol yang bermakna untuk operasi tersebut.
ModelLink to this heading
QuerySet.explain()now supports thegeneric_planoption on PostgreSQL 16+.RowRangenow accepts positive integers for thestartargument and negative integers for theendargument.The new
exclusionargument ofRowRangeandValueRangeallows excluding rows, groups, and ties from the window frames.QuerySet.order_by()now supports ordering by annotation transforms such asJSONObjectkeys andArrayAggindices.F()andOuterRef()expressions that outputCharField,EmailField,SlugField,URLField,TextField, orArrayFieldcan now be sliced.The new
from_querysetargument 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
Expression.constraint_validation_compatibleattribute allows specifying that the expression should be ignored during a constraint validation.
TemplatLink to this heading
Custom tags may now set extra data on the
Parserobject that will later be made available on theTemplateinstance. Such data may be used, for example, by the template loader, or other template clients.Template engines now implement a
check()method that is already registered with the check framework.
PengujianLink to this heading
assertContains(),assertNotContains(), andassertInHTML()assertions now add haystacks to assertion error messages.The
RequestFactory,AsyncRequestFactory,Client, andAsyncClientclasses now support thequery_paramsparameter, 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.
PengesahLink to this heading
The new
DomainNameValidatorvalidates domain names, including internationalized domain names. The newvalidate_domain_name()function returns an instance ofDomainNameValidator.
Backwards incompatible changes in 5.1Link to this heading
django.contrib.gisLink to this heading
Support for PostGIS 2.5 is removed.
Support for PROJ < 6 is removed.
Support for GDAL 2.4 is removed.
GeoIP2no 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.4Link to this heading
Upstream support for MariaDB 10.4 ends in June 2024. Django 5.1 supports MariaDB 10.5 and higher.
Dropped support for PostgreSQL 12Link to this heading
Upstream support for PostgreSQL 12 ends in November 2024. Django 5.1 supports PostgreSQL 13 and higher.
Bermacam-macamLink to this heading
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.In order to improve accessibility, the expandable widget used for
ModelAdmin.fieldsetsandInlineModelAdmin.fieldsets, when the fieldset has a name and use thecollapseclass, now includes<details>and<summary>elements.The JavaScript file
collapse.jsis removed since it is no longer needed in the Django admin site.SimpleTestCase.assertURLEqual()andassertInHTML()now add": "to themsg_prefix. This is consistent with the behavior of other assertions.django.utils.text.Truncatorused bytruncatechars_htmlandtruncatewords_htmltemplate filters now useshtml.parser.HTMLParsersubclasses. 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.The minimum supported version of SQLite is increased from 3.27.0 to 3.31.0.
FileFieldnow raises aFieldErrorwhen saving a file without aname.ImageField.update_dimension_fields(force=True)is no longer called after saving the image to storage. If your storage backend resizes images, thewidth_fieldandheight_fieldwill not match the width and height of the image.The minimum supported version of
asgirefis increased from 3.7.0 to 3.8.1.To improve performance, the
delete_selectedadmin action now usesQuerySet.bulk_create()when creating multipleLogEntryobjects. As a result,pre_saveandpost_savesignals forLogEntryare not sent when multiple objects are deleted via this admin action.
Features deprecated in 5.1Link to this heading
Bermacam-macamLink to this heading
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.itercompatmodule 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 theGeoIP2constructor instead.Passing positional arguments to
Model.save()andModel.asave()is deprecated in favor of keyword-only arguments.Setting
django.contrib.gis.gdal.OGRGeometry.coord_dimis deprecated. Useset_3d()instead.Overriding existing converters with
django.urls.register_converter()is deprecated.The
checkkeyword argument ofCheckConstraintis deprecated in favor ofcondition.The undocumented
OS_OPEN_FLAGSproperty ofFileSystemStorageis deprecated. To allow overwriting files in storage, set the newallow_overwriteoption toTrueinstead.The
get_cache_name()method ofFieldCacheMixinis deprecated in favor of thecache_namecached property.
Features removed in 5.1Link to this heading
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_togetheroption is removed.The
length_istemplate filter is removed.The
django.contrib.auth.hashers.SHA1PasswordHasher,django.contrib.auth.hashers.UnsaltedSHA1PasswordHasher, anddjango.contrib.auth.hashers.UnsaltedMD5PasswordHasherare removed.The model
django.contrib.postgres.fields.CICharField,django.contrib.postgres.fields.CIEmailField, anddjango.contrib.postgres.fields.CITextFieldare removed, except for support in historical migrations.The
django.contrib.postgres.fields.CITextmixin is removed.The
map_widthandmap_heightattributes ofBaseGeometryWidgetare removed.The
SimpleTestCase.assertFormsetError()method is removed.The
TransactionTestCase.assertQuerysetEqual()method is removed.Support for passing encoded JSON string literals to
JSONFieldand associated lookups and expressions is removed.Support for passing positional arguments to
SignerandTimestampSigneris removed.The
DEFAULT_FILE_STORAGEandSTATICFILES_STORAGEsettings is removed.The
django.core.files.storage.get_storage_class()function is removed.