5.0.txt 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797
  1. ============================================
  2. Django 5.0 release notes - UNDER DEVELOPMENT
  3. ============================================
  4. *Expected December 2023*
  5. Welcome to Django 5.0!
  6. These release notes cover the :ref:`new features <whats-new-5.0>`, as well as
  7. some :ref:`backwards incompatible changes <backwards-incompatible-5.0>` you'll
  8. want to be aware of when upgrading from Django 4.2 or earlier. We've
  9. :ref:`begun the deprecation process for some features
  10. <deprecated-features-5.0>`.
  11. See the :doc:`/howto/upgrade-version` guide if you're updating an existing
  12. project.
  13. Python compatibility
  14. ====================
  15. Django 5.0 supports Python 3.10, 3.11, and 3.12. We **highly recommend** and
  16. only officially support the latest release of each series.
  17. The Django 4.2.x series is the last to support Python 3.8 and 3.9.
  18. Third-party library support for older version of Django
  19. =======================================================
  20. Following the release of Django 5.0, we suggest that third-party app authors
  21. drop support for all versions of Django prior to 4.2. At that time, you should
  22. be able to run your package's tests using ``python -Wd`` so that deprecation
  23. warnings appear. After making the deprecation warning fixes, your app should be
  24. compatible with Django 5.0.
  25. .. _whats-new-5.0:
  26. What's new in Django 5.0
  27. ========================
  28. Facet filters in the admin
  29. --------------------------
  30. Facet counts are now shown for applied filters in the admin changelist when
  31. toggled on via the UI. This behavior can be changed via the new
  32. :attr:`.ModelAdmin.show_facets` attribute. For more information see
  33. :ref:`facet-filters`.
  34. Simplified templates for form field rendering
  35. ---------------------------------------------
  36. Django 5.0 introduces the concept of a field group, and field group templates.
  37. This simplifies rendering of the related elements of a Django form field such
  38. as its label, widget, help text, and errors.
  39. For example, the template below:
  40. .. code-block:: html+django
  41. <form>
  42. ...
  43. <div>
  44. {{ form.name.label_tag }}
  45. {% if form.name.help_text %}
  46. <div class="helptext" id="{{ form.name.id_for_label }}_helptext">
  47. {{ form.name.help_text|safe }}
  48. </div>
  49. {% endif %}
  50. {{ form.name.errors }}
  51. {{ form.name }}
  52. <div class="row">
  53. <div class="col">
  54. {{ form.email.label_tag }}
  55. {% if form.email.help_text %}
  56. <div class="helptext" id="{{ form.email.id_for_label }}_helptext">
  57. {{ form.email.help_text|safe }}
  58. </div>
  59. {% endif %}
  60. {{ form.email.errors }}
  61. {{ form.email }}
  62. </div>
  63. <div class="col">
  64. {{ form.password.label_tag }}
  65. {% if form.password.help_text %}
  66. <div class="helptext" id="{{ form.password.id_for_label }}_helptext">
  67. {{ form.password.help_text|safe }}
  68. </div>
  69. {% endif %}
  70. {{ form.password.errors }}
  71. {{ form.password }}
  72. </div>
  73. </div>
  74. </div>
  75. ...
  76. </form>
  77. Can now be simplified to:
  78. .. code-block:: html+django
  79. <form>
  80. ...
  81. <div>
  82. {{ form.name.as_field_group }}
  83. <div class="row">
  84. <div class="col">{{ form.email.as_field_group }}</div>
  85. <div class="col">{{ form.password.as_field_group }}</div>
  86. </div>
  87. </div>
  88. ...
  89. </form>
  90. :meth:`~django.forms.BoundField.as_field_group` renders fields with the
  91. ``"django/forms/field.html"`` template by default and can be customized on a
  92. per-project, per-field, or per-request basis. See
  93. :ref:`reusable-field-group-templates`.
  94. Database-computed default values
  95. --------------------------------
  96. The new :attr:`Field.db_default <django.db.models.Field.db_default>` parameter
  97. sets a database-computed default value. For example::
  98. from django.db import models
  99. from django.db.models.functions import Now, Pi
  100. class MyModel(models.Model):
  101. age = models.IntegerField(db_default=18)
  102. created = models.DateTimeField(db_default=Now())
  103. circumference = models.FloatField(db_default=2 * Pi())
  104. Database generated model field
  105. ------------------------------
  106. The new :class:`~django.db.models.GeneratedField` allows creation of database
  107. generated columns. This field can be used on all supported database backends
  108. to create a field that is always computed from other fields.
  109. More options for declaring field choices
  110. ----------------------------------------
  111. :attr:`.Field.choices` *(for model fields)* and :attr:`.ChoiceField.choices`
  112. *(for form fields)* allow for more flexibility when declaring their values. In
  113. previous versions of Django, ``choices`` should either be a list of 2-tuples,
  114. or an :ref:`field-choices-enum-types` subclass, but the latter required
  115. accessing the ``.choices`` attribute to provide the values in the expected
  116. form::
  117. from django.db import models
  118. Medal = models.TextChoices("Medal", "GOLD SILVER BRONZE")
  119. SPORT_CHOICES = [
  120. ("Martial Arts", [("judo", "Judo"), ("karate", "Karate")]),
  121. ("Racket", [("badminton", "Badminton"), ("tennis", "Tennis")]),
  122. ("unknown", "Unknown"),
  123. ]
  124. class Winners(models.Model):
  125. name = models.CharField(...)
  126. medal = models.CharField(..., choices=Medal.choices)
  127. sport = models.CharField(..., choices=SPORT_CHOICES)
  128. Django 5.0 supports providing a mapping instead of an iterable, and also no
  129. longer requires ``.choices`` to be used directly to expand :ref:`enumeration
  130. types <field-choices-enum-types>`::
  131. from django.db import models
  132. Medal = models.TextChoices("Medal", "GOLD SILVER BRONZE")
  133. SPORT_CHOICES = { # Using a mapping instead of a list of 2-tuples.
  134. "Martial Arts": {"judo": "Judo", "karate": "Karate"},
  135. "Racket": {"badminton": "Badminton", "tennis": "Tennis"},
  136. "unknown": "Unknown",
  137. }
  138. class Winners(models.Model):
  139. name = models.CharField(...)
  140. medal = models.CharField(..., choices=Medal) # Using `.choices` not required.
  141. sport = models.CharField(..., choices=SPORT_CHOICES)
  142. Under the hood the provided ``choices`` are normalized into a list of 2-tuples
  143. as the canonical form whenever the ``choices`` value is updated.
  144. Minor features
  145. --------------
  146. :mod:`django.contrib.admin`
  147. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  148. * The new :meth:`.AdminSite.get_log_entries` method allows customizing the
  149. queryset for the site's listed log entries.
  150. * The ``django.contrib.admin.AllValuesFieldListFilter``,
  151. ``ChoicesFieldListFilter``, ``RelatedFieldListFilter``, and
  152. ``RelatedOnlyFieldListFilter`` admin filters now handle multi-valued query
  153. parameters.
  154. * ``XRegExp`` is upgraded from version 3.2.0 to 5.1.1.
  155. * The new :meth:`.AdminSite.get_model_admin` method returns an admin class for
  156. the given model class.
  157. :mod:`django.contrib.admindocs`
  158. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  159. * ...
  160. :mod:`django.contrib.auth`
  161. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  162. * The default iteration count for the PBKDF2 password hasher is increased from
  163. 600,000 to 720,000.
  164. * The new asynchronous functions are now provided, using an
  165. ``a`` prefix: :func:`django.contrib.auth.aauthenticate`,
  166. :func:`~.django.contrib.auth.aget_user`,
  167. :func:`~.django.contrib.auth.alogin`, :func:`~.django.contrib.auth.alogout`,
  168. and :func:`~.django.contrib.auth.aupdate_session_auth_hash`.
  169. * ``AuthenticationMiddleware`` now adds an :meth:`.HttpRequest.auser`
  170. asynchronous method that returns the currently logged-in user.
  171. * The new :func:`django.contrib.auth.hashers.acheck_password` asynchronous
  172. function and :meth:`.AbstractBaseUser.acheck_password` method allow
  173. asynchronous checking of user passwords.
  174. :mod:`django.contrib.contenttypes`
  175. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  176. * ...
  177. :mod:`django.contrib.gis`
  178. ~~~~~~~~~~~~~~~~~~~~~~~~~
  179. * The new
  180. :class:`ClosestPoint() <django.contrib.gis.db.models.functions.ClosestPoint>`
  181. function returns a 2-dimensional point on the geometry that is closest to
  182. another geometry.
  183. * :ref:`GIS aggregates <gis-aggregation-functions>` now support the ``filter``
  184. argument.
  185. * Added support for GDAL 3.7.
  186. * Added support for GEOS 3.12.
  187. * The new :meth:`.GEOSGeometry.equals_identical` method allows point-wise
  188. equivalence checking of geometries.
  189. :mod:`django.contrib.messages`
  190. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  191. * The new :meth:`.MessagesTestMixin.assertMessages` assertion method allows
  192. testing :mod:`~django.contrib.messages` added to a
  193. :class:`response <django.http.HttpResponse>`.
  194. :mod:`django.contrib.postgres`
  195. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  196. * The new :attr:`~.ExclusionConstraint.violation_error_code` attribute of
  197. :class:`~django.contrib.postgres.constraints.ExclusionConstraint` allows
  198. customizing the ``code`` of ``ValidationError`` raised during
  199. :ref:`model validation <validating-objects>`.
  200. :mod:`django.contrib.redirects`
  201. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  202. * ...
  203. :mod:`django.contrib.sessions`
  204. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  205. * ...
  206. :mod:`django.contrib.sitemaps`
  207. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  208. * ...
  209. :mod:`django.contrib.sites`
  210. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  211. * ...
  212. :mod:`django.contrib.staticfiles`
  213. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  214. * ...
  215. :mod:`django.contrib.syndication`
  216. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  217. * ...
  218. Asynchronous views
  219. ~~~~~~~~~~~~~~~~~~
  220. * Under ASGI, ``http.disconnect`` events are now handled. This allows views to
  221. perform any necessary cleanup if a client disconnects before the response is
  222. generated. See :ref:`async-handling-disconnect` for more details.
  223. Cache
  224. ~~~~~
  225. * ...
  226. CSRF
  227. ~~~~
  228. * ...
  229. Decorators
  230. ~~~~~~~~~~
  231. * The following decorators now support wrapping asynchronous view functions:
  232. * :func:`~django.views.decorators.cache.cache_control`
  233. * :func:`~django.views.decorators.cache.never_cache`
  234. * :func:`~django.views.decorators.common.no_append_slash`
  235. * :func:`~django.views.decorators.csrf.csrf_exempt`
  236. * :func:`~django.views.decorators.debug.sensitive_variables`
  237. * :func:`~django.views.decorators.debug.sensitive_post_parameters`
  238. * :func:`~django.views.decorators.http.condition`
  239. * :func:`~django.views.decorators.http.etag`
  240. * :func:`~django.views.decorators.http.last_modified`
  241. * :func:`~django.views.decorators.http.require_http_methods`
  242. * :func:`~django.views.decorators.http.require_GET`
  243. * :func:`~django.views.decorators.http.require_POST`
  244. * :func:`~django.views.decorators.http.require_safe`
  245. * :func:`~django.views.decorators.vary.vary_on_cookie`
  246. * :func:`~django.views.decorators.vary.vary_on_headers`
  247. * ``xframe_options_deny()``
  248. * ``xframe_options_sameorigin()``
  249. * ``xframe_options_exempt()``
  250. Email
  251. ~~~~~
  252. * ...
  253. Error Reporting
  254. ~~~~~~~~~~~~~~~
  255. * :func:`~django.views.decorators.debug.sensitive_variables` and
  256. :func:`~django.views.decorators.debug.sensitive_post_parameters` can now be
  257. used with asynchronous functions.
  258. File Storage
  259. ~~~~~~~~~~~~
  260. * :meth:`.File.open` now passes all positional (``*args``) and keyword
  261. arguments (``**kwargs``) to Python's built-in :func:`python:open`.
  262. File Uploads
  263. ~~~~~~~~~~~~
  264. * ...
  265. Forms
  266. ~~~~~
  267. * The new ``assume_scheme`` argument for :class:`~django.forms.URLField` allows
  268. specifying a default URL scheme.
  269. * In order to improve accessibility and enable screen readers to associate form
  270. fields with their help text, the form field now includes the
  271. ``aria-describedby`` HTML attribute.
  272. * In order to improve accessibility, the invalid form field now includes the
  273. ``aria-invalid="true"`` HTML attribute.
  274. Generic Views
  275. ~~~~~~~~~~~~~
  276. * ...
  277. Internationalization
  278. ~~~~~~~~~~~~~~~~~~~~
  279. * Added support and translations for the Uyghur language.
  280. Logging
  281. ~~~~~~~
  282. * ...
  283. Management Commands
  284. ~~~~~~~~~~~~~~~~~~~
  285. * ...
  286. Migrations
  287. ~~~~~~~~~~
  288. * ...
  289. Models
  290. ~~~~~~
  291. * The new ``create_defaults`` argument of :meth:`.QuerySet.update_or_create`
  292. and :meth:`.QuerySet.aupdate_or_create` methods allows specifying a different
  293. field values for the create operation.
  294. * The new ``violation_error_code`` attribute of
  295. :class:`~django.db.models.BaseConstraint`,
  296. :class:`~django.db.models.CheckConstraint`, and
  297. :class:`~django.db.models.UniqueConstraint` allows customizing the ``code``
  298. of ``ValidationError`` raised during
  299. :ref:`model validation <validating-objects>`.
  300. * The :ref:`force_insert <ref-models-force-insert>` argument of
  301. :meth:`.Model.save` now allows specifying a tuple of parent classes that must
  302. be forced to be inserted.
  303. * :meth:`.QuerySet.bulk_create` and :meth:`.QuerySet.abulk_create` methods now
  304. set the primary key on each model instance when the ``update_conflicts``
  305. parameter is enabled (if the database supports it).
  306. * The new :attr:`.UniqueConstraint.nulls_distinct` attribute allows customizing
  307. the treatment of ``NULL`` values on PostgreSQL 15+.
  308. * The new :func:`~django.shortcuts.aget_object_or_404` and
  309. :func:`~django.shortcuts.aget_list_or_404` asynchronous shortcuts allow
  310. asynchronous getting objects.
  311. * The new :func:`~django.db.models.aprefetch_related_objects` function allows
  312. asynchronous prefetching of model instances.
  313. * :meth:`.QuerySet.aiterator` now supports previous calls to
  314. ``prefetch_related()``.
  315. * On MariaDB 10.7+, ``UUIDField`` is now created as ``UUID`` column rather than
  316. ``CHAR(32)`` column. See the migration guide above for more details on
  317. :ref:`migrating-uuidfield`.
  318. * Django now supports `oracledb`_ version 1.3.2 or higher. Support for
  319. ``cx_Oracle`` is deprecated as of this release and will be removed in Django
  320. 6.0.
  321. Pagination
  322. ~~~~~~~~~~
  323. * The new :attr:`django.core.paginator.Paginator.error_messages` argument
  324. allows customizing the error messages raised by :meth:`.Paginator.page`.
  325. Requests and Responses
  326. ~~~~~~~~~~~~~~~~~~~~~~
  327. * ...
  328. Security
  329. ~~~~~~~~
  330. * ...
  331. Serialization
  332. ~~~~~~~~~~~~~
  333. * ...
  334. Signals
  335. ~~~~~~~
  336. * The new :meth:`.Signal.asend` and :meth:`.Signal.asend_robust` methods allow
  337. asynchronous signal dispatch. Signal receivers may be synchronous or
  338. asynchronous, and will be automatically adapted to the correct calling style.
  339. Templates
  340. ~~~~~~~~~
  341. * The new :tfilter:`escapeseq` template filter applies :tfilter:`escape` to
  342. each element of a sequence.
  343. Tests
  344. ~~~~~
  345. * :class:`~django.test.Client` and :class:`~django.test.AsyncClient` now
  346. provide asynchronous methods, using an ``a`` prefix:
  347. :meth:`~django.test.Client.asession`, :meth:`~django.test.Client.alogin`,
  348. :meth:`~django.test.Client.aforce_login`, and
  349. :meth:`~django.test.Client.alogout`.
  350. * :class:`~django.test.AsyncClient` now supports the ``follow`` parameter.
  351. * The new :option:`test --durations` option allows showing the duration of the
  352. slowest tests on Python 3.12+.
  353. URLs
  354. ~~~~
  355. * ...
  356. Utilities
  357. ~~~~~~~~~
  358. * ...
  359. Validators
  360. ~~~~~~~~~~
  361. * The new ``offset`` argument of
  362. :class:`~django.core.validators.StepValueValidator` allows specifying an
  363. offset for valid values.
  364. .. _backwards-incompatible-5.0:
  365. Backwards incompatible changes in 5.0
  366. =====================================
  367. Database backend API
  368. --------------------
  369. This section describes changes that may be needed in third-party database
  370. backends.
  371. * ``DatabaseFeatures.supports_expression_defaults`` should be set to ``False``
  372. if the database doesn't support using database functions as defaults.
  373. * ``DatabaseFeatures.supports_default_keyword_in_insert`` should be set to
  374. ``False`` if the database doesn't support the ``DEFAULT`` keyword in
  375. ``INSERT`` queries.
  376. * ``DatabaseFeatures.supports_default_keyword_in_bulk insert`` should be set to
  377. ``False`` if the database doesn't support the ``DEFAULT`` keyword in bulk
  378. ``INSERT`` queries.
  379. Dropped support for MySQL < 8.0.11
  380. ----------------------------------
  381. Support for pre-releases of MySQL 8.0.x series is removed. Django 5.0 supports
  382. MySQL 8.0.11 and higher.
  383. :mod:`django.contrib.gis`
  384. -------------------------
  385. * Support for GDAL 2.2 and 2.3 is removed.
  386. * Support for GEOS 3.6 and 3.7 is removed.
  387. :mod:`django.contrib.sitemaps`
  388. ------------------------------
  389. * The ``django.contrib.sitemaps.ping_google()`` function and the
  390. ``ping_google`` management command are removed as the Google
  391. Sitemaps ping endpoint is deprecated and will be removed in January 2024.
  392. * The ``django.contrib.sitemaps.SitemapNotFound`` exception class is removed.
  393. Using ``create_defaults__exact`` may now be required with ``QuerySet.update_or_create()``
  394. -----------------------------------------------------------------------------------------
  395. :meth:`.QuerySet.update_or_create` now supports the parameter
  396. ``create_defaults``. As a consequence, any models that have a field named
  397. ``create_defaults`` that are used with an ``update_or_create()`` should specify
  398. the field in the lookup with ``create_defaults__exact``.
  399. .. _migrating-uuidfield:
  400. Migrating existing ``UUIDField`` on MariaDB 10.7+
  401. -------------------------------------------------
  402. On MariaDB 10.7+, ``UUIDField`` is now created as ``UUID`` column rather than
  403. ``CHAR(32)`` column. As a consequence, any ``UUIDField`` created in
  404. Django < 5.0 should be replaced with a ``UUIDField`` subclass backed by
  405. ``CHAR(32)``::
  406. class Char32UUIDField(models.UUIDField):
  407. def db_type(self, connection):
  408. return "char(32)"
  409. For example::
  410. class MyModel(models.Model):
  411. uuid = models.UUIDField(primary_key=True, default=uuid.uuid4)
  412. Should become::
  413. class Char32UUIDField(models.UUIDField):
  414. def db_type(self, connection):
  415. return "char(32)"
  416. class MyModel(models.Model):
  417. uuid = Char32UUIDField(primary_key=True, default=uuid.uuid4)
  418. Running the :djadmin:`makemigrations` command will generate a migration
  419. containing a no-op ``AlterField`` operation.
  420. Miscellaneous
  421. -------------
  422. * The ``instance`` argument of the undocumented
  423. ``BaseModelFormSet.save_existing()`` method is renamed to ``obj``.
  424. * The undocumented ``django.contrib.admin.helpers.checkbox`` is removed.
  425. * Integer fields are now validated as 64-bit integers on SQLite to match the
  426. behavior of ``sqlite3``.
  427. * The undocumented ``Query.annotation_select_mask`` attribute is changed from a
  428. set of strings to an ordered list of strings.
  429. * ``ImageField.update_dimension_fields()`` is no longer called on the
  430. ``post_init`` signal if ``width_field`` and ``height_field`` are not set.
  431. * :class:`~django.db.models.functions.Now` database function now uses
  432. ``LOCALTIMESTAMP`` instead of ``CURRENT_TIMESTAMP`` on Oracle.
  433. * :attr:`.AdminSite.site_header` is now rendered in a ``<div>`` tag instead of
  434. ``<h1>``. Screen reader users rely on heading elements for navigation within
  435. a page. Having two ``<h1>`` elements was confusing and the site header wasn't
  436. helpful as it is repeated on all pages.
  437. * On databases without native support for the SQL ``XOR`` operator, ``^`` as
  438. the exclusive or (``XOR``) operator now returns rows that are matched by an
  439. odd number of operands rather than exactly one operand. This is consistent
  440. with the behavior of MySQL, MariaDB, and Python.
  441. * The minimum supported version of ``asgiref`` is increased from 3.6.0 to
  442. 3.7.0.
  443. * The minimum supported version of ``selenium`` is increased from 3.8.0 to
  444. 4.8.0.
  445. * The ``AlreadyRegistered`` and ``NotRegistered`` exceptions are moved from
  446. ``django.contrib.admin.sites`` to ``django.contrib.admin.exceptions``.
  447. * The minimum supported version of SQLite is increased from 3.21.0 to 3.27.0.
  448. * Support for ``cx_Oracle`` < 8.3 is removed.
  449. * Executing SQL queries before the app registry has been fully populated now
  450. raises :exc:`RuntimeWarning`.
  451. * :exc:`~django.core.exceptions.BadRequest` is raised for non-UTF-8 encoded
  452. requests with the :mimetype:`application/x-www-form-urlencoded` content type.
  453. See :rfc:`1866` for more details.
  454. * The minimum supported version of ``colorama`` is increased to 0.4.6.
  455. * The minimum supported version of ``docutils`` is increased to 0.19.
  456. .. _deprecated-features-5.0:
  457. Features deprecated in 5.0
  458. ==========================
  459. Miscellaneous
  460. -------------
  461. * The ``DjangoDivFormRenderer`` and ``Jinja2DivFormRenderer`` transitional form
  462. renderers are deprecated.
  463. * Passing positional arguments ``name`` and ``violation_error_message`` to
  464. :class:`~django.db.models.BaseConstraint` is deprecated in favor of
  465. keyword-only arguments.
  466. * ``request`` is added to the signature of :meth:`.ModelAdmin.lookup_allowed`.
  467. Support for ``ModelAdmin`` subclasses that do not accept this argument is
  468. deprecated.
  469. * The ``get_joining_columns()`` method of ``ForeignObject`` and
  470. ``ForeignObjectRel`` is deprecated. Starting with Django 6.0,
  471. ``django.db.models.sql.datastructures.Join`` will no longer fallback to
  472. ``get_joining_columns()``. Subclasses should implement
  473. ``get_joining_fields()`` instead.
  474. * The ``ForeignObject.get_reverse_joining_columns()`` method is deprecated.
  475. * The default scheme for ``forms.URLField`` will change from ``"http"`` to
  476. ``"https"`` in Django 6.0.
  477. * Support for calling ``format_html()`` without passing args or kwargs will be
  478. removed.
  479. * Support for ``cx_Oracle`` is deprecated in favor of `oracledb`_ 1.3.2+ Python
  480. driver.
  481. * ``DatabaseOperations.field_cast_sql()`` is deprecated in favor of
  482. ``DatabaseOperations.lookup_cast()``. Starting with Django 6.0,
  483. ``BuiltinLookup.process_lhs()`` will no longer call ``field_cast_sql()``.
  484. Third-party database backends should implement ``lookup_cast()`` instead.
  485. * The ``django.db.models.enums.ChoicesMeta`` metaclass is renamed to
  486. ``ChoicesType``.
  487. .. _`oracledb`: https://oracle.github.io/python-oracledb/
  488. Features removed in 5.0
  489. =======================
  490. These features have reached the end of their deprecation cycle and are removed
  491. in Django 5.0.
  492. See :ref:`deprecated-features-4.0` for details on these changes, including how
  493. to remove usage of these features.
  494. * The ``SERIALIZE`` test setting is removed.
  495. * The undocumented ``django.utils.baseconv`` module is removed.
  496. * The undocumented ``django.utils.datetime_safe`` module is removed.
  497. * The default value of the ``USE_TZ`` setting is changed from ``False`` to
  498. ``True``.
  499. * The default sitemap protocol for sitemaps built outside the context of a
  500. request is changed from ``'http'`` to ``'https'``.
  501. * The ``extra_tests`` argument for ``DiscoverRunner.build_suite()`` and
  502. ``DiscoverRunner.run_tests()`` is removed.
  503. * The ``django.contrib.postgres.aggregates.ArrayAgg``, ``JSONBAgg``, and
  504. ``StringAgg`` aggregates no longer return ``[]``, ``[]``, and ``''``,
  505. respectively, when there are no rows.
  506. * The ``USE_L10N`` setting is removed.
  507. * The ``USE_DEPRECATED_PYTZ`` transitional setting is removed.
  508. * Support for ``pytz`` timezones is removed.
  509. * The ``is_dst`` argument is removed from:
  510. * ``QuerySet.datetimes()``
  511. * ``django.utils.timezone.make_aware()``
  512. * ``django.db.models.functions.Trunc()``
  513. * ``django.db.models.functions.TruncSecond()``
  514. * ``django.db.models.functions.TruncMinute()``
  515. * ``django.db.models.functions.TruncHour()``
  516. * ``django.db.models.functions.TruncDay()``
  517. * ``django.db.models.functions.TruncWeek()``
  518. * ``django.db.models.functions.TruncMonth()``
  519. * ``django.db.models.functions.TruncQuarter()``
  520. * ``django.db.models.functions.TruncYear()``
  521. * The ``django.contrib.gis.admin.GeoModelAdmin`` and ``OSMGeoAdmin`` classes
  522. are removed.
  523. * The undocumented ``BaseForm._html_output()`` method is removed.
  524. * The ability to return a ``str``, rather than a ``SafeString``, when rendering
  525. an ``ErrorDict`` and ``ErrorList`` is removed.
  526. See :ref:`deprecated-features-4.1` for details on these changes, including how
  527. to remove usage of these features.
  528. * The ``SitemapIndexItem.__str__()`` method is removed.
  529. * The ``CSRF_COOKIE_MASKED`` transitional setting is removed.
  530. * The ``name`` argument of ``django.utils.functional.cached_property()`` is
  531. removed.
  532. * The ``opclasses`` argument of
  533. ``django.contrib.postgres.constraints.ExclusionConstraint`` is removed.
  534. * The undocumented ability to pass ``errors=None`` to
  535. ``SimpleTestCase.assertFormError()`` and ``assertFormsetError()`` is removed.
  536. * ``django.contrib.sessions.serializers.PickleSerializer`` is removed.
  537. * The usage of ``QuerySet.iterator()`` on a queryset that prefetches related
  538. objects without providing the ``chunk_size`` argument is no longer allowed.
  539. * Passing unsaved model instances to related filters is no longer allowed.
  540. * ``created=True`` is required in the signature of
  541. ``RemoteUserBackend.configure_user()`` subclasses.
  542. * Support for logging out via ``GET`` requests in the
  543. ``django.contrib.auth.views.LogoutView`` and
  544. ``django.contrib.auth.views.logout_then_login()`` is removed.
  545. * The ``django.utils.timezone.utc`` alias to ``datetime.timezone.utc`` is
  546. removed.
  547. * Passing a response object and a form/formset name to
  548. ``SimpleTestCase.assertFormError()`` and ``assertFormSetError()`` is no
  549. longer allowed.
  550. * The ``django.contrib.gis.admin.OpenLayersWidget`` is removed.
  551. + The ``django.contrib.auth.hashers.CryptPasswordHasher`` is removed.
  552. * The ``"django/forms/default.html"`` and
  553. ``"django/forms/formsets/default.html"`` templates are removed.
  554. * The default form and formset rendering style is changed to the div-based.
  555. * Passing ``nulls_first=False`` or ``nulls_last=False`` to ``Expression.asc()``
  556. and ``Expression.desc()`` methods, and the ``OrderBy`` expression is no
  557. longer allowed.