5.0.txt 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815
  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 Winner(models.Model):
  125. name = models.CharField(...)
  126. medal = models.CharField(..., choices=Medal.choices)
  127. sport = models.CharField(..., choices=SPORT_CHOICES)
  128. Django 5.0 adds support for accepting a mapping or a callable instead of an
  129. iterable, and also no longer requires ``.choices`` to be used directly to
  130. expand :ref:`enumeration 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. def get_scores():
  139. return [(i, str(i)) for i in range(10)]
  140. class Winner(models.Model):
  141. name = models.CharField(...)
  142. medal = models.CharField(..., choices=Medal) # Using `.choices` not required.
  143. sport = models.CharField(..., choices=SPORT_CHOICES)
  144. score = models.IntegerField(choices=get_scores) # A callable is allowed.
  145. Under the hood the provided ``choices`` are normalized into a list of 2-tuples
  146. as the canonical form whenever the ``choices`` value is updated. For more
  147. information, please check the :ref:`model field reference on choices
  148. <field-choices>`.
  149. Minor features
  150. --------------
  151. :mod:`django.contrib.admin`
  152. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  153. * The new :meth:`.AdminSite.get_log_entries` method allows customizing the
  154. queryset for the site's listed log entries.
  155. * The ``django.contrib.admin.AllValuesFieldListFilter``,
  156. ``ChoicesFieldListFilter``, ``RelatedFieldListFilter``, and
  157. ``RelatedOnlyFieldListFilter`` admin filters now handle multi-valued query
  158. parameters.
  159. * ``XRegExp`` is upgraded from version 3.2.0 to 5.1.1.
  160. * The new :meth:`.AdminSite.get_model_admin` method returns an admin class for
  161. the given model class.
  162. :mod:`django.contrib.admindocs`
  163. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  164. * ...
  165. :mod:`django.contrib.auth`
  166. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  167. * The default iteration count for the PBKDF2 password hasher is increased from
  168. 600,000 to 720,000.
  169. * The new asynchronous functions are now provided, using an
  170. ``a`` prefix: :func:`django.contrib.auth.aauthenticate`,
  171. :func:`~.django.contrib.auth.aget_user`,
  172. :func:`~.django.contrib.auth.alogin`, :func:`~.django.contrib.auth.alogout`,
  173. and :func:`~.django.contrib.auth.aupdate_session_auth_hash`.
  174. * ``AuthenticationMiddleware`` now adds an :meth:`.HttpRequest.auser`
  175. asynchronous method that returns the currently logged-in user.
  176. * The new :func:`django.contrib.auth.hashers.acheck_password` asynchronous
  177. function and :meth:`.AbstractBaseUser.acheck_password` method allow
  178. asynchronous checking of user passwords.
  179. :mod:`django.contrib.contenttypes`
  180. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  181. * ...
  182. :mod:`django.contrib.gis`
  183. ~~~~~~~~~~~~~~~~~~~~~~~~~
  184. * The new
  185. :class:`ClosestPoint() <django.contrib.gis.db.models.functions.ClosestPoint>`
  186. function returns a 2-dimensional point on the geometry that is closest to
  187. another geometry.
  188. * :ref:`GIS aggregates <gis-aggregation-functions>` now support the ``filter``
  189. argument.
  190. * Added support for GDAL 3.7.
  191. * Added support for GEOS 3.12.
  192. * The new :meth:`.GEOSGeometry.equals_identical` method allows point-wise
  193. equivalence checking of geometries.
  194. :mod:`django.contrib.messages`
  195. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  196. * The new :meth:`.MessagesTestMixin.assertMessages` assertion method allows
  197. testing :mod:`~django.contrib.messages` added to a
  198. :class:`response <django.http.HttpResponse>`.
  199. :mod:`django.contrib.postgres`
  200. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  201. * The new :attr:`~.ExclusionConstraint.violation_error_code` attribute of
  202. :class:`~django.contrib.postgres.constraints.ExclusionConstraint` allows
  203. customizing the ``code`` of ``ValidationError`` raised during
  204. :ref:`model validation <validating-objects>`.
  205. :mod:`django.contrib.redirects`
  206. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  207. * ...
  208. :mod:`django.contrib.sessions`
  209. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  210. * ...
  211. :mod:`django.contrib.sitemaps`
  212. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  213. * ...
  214. :mod:`django.contrib.sites`
  215. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  216. * ...
  217. :mod:`django.contrib.staticfiles`
  218. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  219. * ...
  220. :mod:`django.contrib.syndication`
  221. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  222. * ...
  223. Asynchronous views
  224. ~~~~~~~~~~~~~~~~~~
  225. * Under ASGI, ``http.disconnect`` events are now handled. This allows views to
  226. perform any necessary cleanup if a client disconnects before the response is
  227. generated. See :ref:`async-handling-disconnect` for more details.
  228. Cache
  229. ~~~~~
  230. * ...
  231. CSRF
  232. ~~~~
  233. * ...
  234. Decorators
  235. ~~~~~~~~~~
  236. * The following decorators now support wrapping asynchronous view functions:
  237. * :func:`~django.views.decorators.cache.cache_control`
  238. * :func:`~django.views.decorators.cache.never_cache`
  239. * :func:`~django.views.decorators.common.no_append_slash`
  240. * :func:`~django.views.decorators.csrf.csrf_exempt`
  241. * :func:`~django.views.decorators.csrf.csrf_protect`
  242. * :func:`~django.views.decorators.csrf.ensure_csrf_cookie`
  243. * :func:`~django.views.decorators.csrf.requires_csrf_token`
  244. * :func:`~django.views.decorators.debug.sensitive_variables`
  245. * :func:`~django.views.decorators.debug.sensitive_post_parameters`
  246. * :func:`~django.views.decorators.gzip.gzip_page`
  247. * :func:`~django.views.decorators.http.condition`
  248. * ``conditional_page()``
  249. * :func:`~django.views.decorators.http.etag`
  250. * :func:`~django.views.decorators.http.last_modified`
  251. * :func:`~django.views.decorators.http.require_http_methods`
  252. * :func:`~django.views.decorators.http.require_GET`
  253. * :func:`~django.views.decorators.http.require_POST`
  254. * :func:`~django.views.decorators.http.require_safe`
  255. * :func:`~django.views.decorators.vary.vary_on_cookie`
  256. * :func:`~django.views.decorators.vary.vary_on_headers`
  257. * ``xframe_options_deny()``
  258. * ``xframe_options_sameorigin()``
  259. * ``xframe_options_exempt()``
  260. Email
  261. ~~~~~
  262. * ...
  263. Error Reporting
  264. ~~~~~~~~~~~~~~~
  265. * :func:`~django.views.decorators.debug.sensitive_variables` and
  266. :func:`~django.views.decorators.debug.sensitive_post_parameters` can now be
  267. used with asynchronous functions.
  268. File Storage
  269. ~~~~~~~~~~~~
  270. * :meth:`.File.open` now passes all positional (``*args``) and keyword
  271. arguments (``**kwargs``) to Python's built-in :func:`python:open`.
  272. File Uploads
  273. ~~~~~~~~~~~~
  274. * ...
  275. Forms
  276. ~~~~~
  277. * The new ``assume_scheme`` argument for :class:`~django.forms.URLField` allows
  278. specifying a default URL scheme.
  279. * In order to improve accessibility and enable screen readers to associate form
  280. fields with their help text, the form field now includes the
  281. ``aria-describedby`` HTML attribute.
  282. * In order to improve accessibility, the invalid form field now includes the
  283. ``aria-invalid="true"`` HTML attribute.
  284. Generic Views
  285. ~~~~~~~~~~~~~
  286. * ...
  287. Internationalization
  288. ~~~~~~~~~~~~~~~~~~~~
  289. * Added support and translations for the Uyghur language.
  290. Logging
  291. ~~~~~~~
  292. * ...
  293. Management Commands
  294. ~~~~~~~~~~~~~~~~~~~
  295. * ...
  296. Migrations
  297. ~~~~~~~~~~
  298. * Serialization of functions decorated with :func:`functools.cache` or
  299. :func:`functools.lru_cache` is now supported without the need to write a
  300. custom serializer.
  301. Models
  302. ~~~~~~
  303. * The new ``create_defaults`` argument of :meth:`.QuerySet.update_or_create`
  304. and :meth:`.QuerySet.aupdate_or_create` methods allows specifying a different
  305. field values for the create operation.
  306. * The new ``violation_error_code`` attribute of
  307. :class:`~django.db.models.BaseConstraint`,
  308. :class:`~django.db.models.CheckConstraint`, and
  309. :class:`~django.db.models.UniqueConstraint` allows customizing the ``code``
  310. of ``ValidationError`` raised during
  311. :ref:`model validation <validating-objects>`.
  312. * The :ref:`force_insert <ref-models-force-insert>` argument of
  313. :meth:`.Model.save` now allows specifying a tuple of parent classes that must
  314. be forced to be inserted.
  315. * :meth:`.QuerySet.bulk_create` and :meth:`.QuerySet.abulk_create` methods now
  316. set the primary key on each model instance when the ``update_conflicts``
  317. parameter is enabled (if the database supports it).
  318. * The new :attr:`.UniqueConstraint.nulls_distinct` attribute allows customizing
  319. the treatment of ``NULL`` values on PostgreSQL 15+.
  320. * The new :func:`~django.shortcuts.aget_object_or_404` and
  321. :func:`~django.shortcuts.aget_list_or_404` asynchronous shortcuts allow
  322. asynchronous getting objects.
  323. * The new :func:`~django.db.models.aprefetch_related_objects` function allows
  324. asynchronous prefetching of model instances.
  325. * :meth:`.QuerySet.aiterator` now supports previous calls to
  326. ``prefetch_related()``.
  327. * On MariaDB 10.7+, ``UUIDField`` is now created as ``UUID`` column rather than
  328. ``CHAR(32)`` column. See the migration guide above for more details on
  329. :ref:`migrating-uuidfield`.
  330. * Django now supports `oracledb`_ version 1.3.2 or higher. Support for
  331. ``cx_Oracle`` is deprecated as of this release and will be removed in Django
  332. 6.0.
  333. Pagination
  334. ~~~~~~~~~~
  335. * The new :attr:`django.core.paginator.Paginator.error_messages` argument
  336. allows customizing the error messages raised by :meth:`.Paginator.page`.
  337. Requests and Responses
  338. ~~~~~~~~~~~~~~~~~~~~~~
  339. * ...
  340. Security
  341. ~~~~~~~~
  342. * ...
  343. Serialization
  344. ~~~~~~~~~~~~~
  345. * ...
  346. Signals
  347. ~~~~~~~
  348. * The new :meth:`.Signal.asend` and :meth:`.Signal.asend_robust` methods allow
  349. asynchronous signal dispatch. Signal receivers may be synchronous or
  350. asynchronous, and will be automatically adapted to the correct calling style.
  351. Templates
  352. ~~~~~~~~~
  353. * The new :tfilter:`escapeseq` template filter applies :tfilter:`escape` to
  354. each element of a sequence.
  355. Tests
  356. ~~~~~
  357. * :class:`~django.test.Client` and :class:`~django.test.AsyncClient` now
  358. provide asynchronous methods, using an ``a`` prefix:
  359. :meth:`~django.test.Client.asession`, :meth:`~django.test.Client.alogin`,
  360. :meth:`~django.test.Client.aforce_login`, and
  361. :meth:`~django.test.Client.alogout`.
  362. * :class:`~django.test.AsyncClient` now supports the ``follow`` parameter.
  363. * The new :option:`test --durations` option allows showing the duration of the
  364. slowest tests on Python 3.12+.
  365. URLs
  366. ~~~~
  367. * ...
  368. Utilities
  369. ~~~~~~~~~
  370. * ...
  371. Validators
  372. ~~~~~~~~~~
  373. * The new ``offset`` argument of
  374. :class:`~django.core.validators.StepValueValidator` allows specifying an
  375. offset for valid values.
  376. .. _backwards-incompatible-5.0:
  377. Backwards incompatible changes in 5.0
  378. =====================================
  379. Database backend API
  380. --------------------
  381. This section describes changes that may be needed in third-party database
  382. backends.
  383. * ``DatabaseFeatures.supports_expression_defaults`` should be set to ``False``
  384. if the database doesn't support using database functions as defaults.
  385. * ``DatabaseFeatures.supports_default_keyword_in_insert`` should be set to
  386. ``False`` if the database doesn't support the ``DEFAULT`` keyword in
  387. ``INSERT`` queries.
  388. * ``DatabaseFeatures.supports_default_keyword_in_bulk insert`` should be set to
  389. ``False`` if the database doesn't support the ``DEFAULT`` keyword in bulk
  390. ``INSERT`` queries.
  391. Dropped support for MySQL < 8.0.11
  392. ----------------------------------
  393. Support for pre-releases of MySQL 8.0.x series is removed. Django 5.0 supports
  394. MySQL 8.0.11 and higher.
  395. :mod:`django.contrib.gis`
  396. -------------------------
  397. * Support for GDAL 2.2 and 2.3 is removed.
  398. * Support for GEOS 3.6 and 3.7 is removed.
  399. :mod:`django.contrib.sitemaps`
  400. ------------------------------
  401. * The ``django.contrib.sitemaps.ping_google()`` function and the
  402. ``ping_google`` management command are removed as the Google
  403. Sitemaps ping endpoint is deprecated and will be removed in January 2024.
  404. * The ``django.contrib.sitemaps.SitemapNotFound`` exception class is removed.
  405. Using ``create_defaults__exact`` may now be required with ``QuerySet.update_or_create()``
  406. -----------------------------------------------------------------------------------------
  407. :meth:`.QuerySet.update_or_create` now supports the parameter
  408. ``create_defaults``. As a consequence, any models that have a field named
  409. ``create_defaults`` that are used with an ``update_or_create()`` should specify
  410. the field in the lookup with ``create_defaults__exact``.
  411. .. _migrating-uuidfield:
  412. Migrating existing ``UUIDField`` on MariaDB 10.7+
  413. -------------------------------------------------
  414. On MariaDB 10.7+, ``UUIDField`` is now created as ``UUID`` column rather than
  415. ``CHAR(32)`` column. As a consequence, any ``UUIDField`` created in
  416. Django < 5.0 should be replaced with a ``UUIDField`` subclass backed by
  417. ``CHAR(32)``::
  418. class Char32UUIDField(models.UUIDField):
  419. def db_type(self, connection):
  420. return "char(32)"
  421. For example::
  422. class MyModel(models.Model):
  423. uuid = models.UUIDField(primary_key=True, default=uuid.uuid4)
  424. Should become::
  425. class Char32UUIDField(models.UUIDField):
  426. def db_type(self, connection):
  427. return "char(32)"
  428. class MyModel(models.Model):
  429. uuid = Char32UUIDField(primary_key=True, default=uuid.uuid4)
  430. Running the :djadmin:`makemigrations` command will generate a migration
  431. containing a no-op ``AlterField`` operation.
  432. Miscellaneous
  433. -------------
  434. * The ``instance`` argument of the undocumented
  435. ``BaseModelFormSet.save_existing()`` method is renamed to ``obj``.
  436. * The undocumented ``django.contrib.admin.helpers.checkbox`` is removed.
  437. * Integer fields are now validated as 64-bit integers on SQLite to match the
  438. behavior of ``sqlite3``.
  439. * The undocumented ``Query.annotation_select_mask`` attribute is changed from a
  440. set of strings to an ordered list of strings.
  441. * ``ImageField.update_dimension_fields()`` is no longer called on the
  442. ``post_init`` signal if ``width_field`` and ``height_field`` are not set.
  443. * :class:`~django.db.models.functions.Now` database function now uses
  444. ``LOCALTIMESTAMP`` instead of ``CURRENT_TIMESTAMP`` on Oracle.
  445. * :attr:`.AdminSite.site_header` is now rendered in a ``<div>`` tag instead of
  446. ``<h1>``. Screen reader users rely on heading elements for navigation within
  447. a page. Having two ``<h1>`` elements was confusing and the site header wasn't
  448. helpful as it is repeated on all pages.
  449. * In order to improve accessibility, the admin's main content area and header
  450. content area are now rendered in a ``<main>`` and ``<header>`` tag instead of
  451. ``<div>``.
  452. * On databases without native support for the SQL ``XOR`` operator, ``^`` as
  453. the exclusive or (``XOR``) operator now returns rows that are matched by an
  454. odd number of operands rather than exactly one operand. This is consistent
  455. with the behavior of MySQL, MariaDB, and Python.
  456. * The minimum supported version of ``asgiref`` is increased from 3.6.0 to
  457. 3.7.0.
  458. * The minimum supported version of ``selenium`` is increased from 3.8.0 to
  459. 4.8.0.
  460. * The ``AlreadyRegistered`` and ``NotRegistered`` exceptions are moved from
  461. ``django.contrib.admin.sites`` to ``django.contrib.admin.exceptions``.
  462. * The minimum supported version of SQLite is increased from 3.21.0 to 3.27.0.
  463. * Support for ``cx_Oracle`` < 8.3 is removed.
  464. * Executing SQL queries before the app registry has been fully populated now
  465. raises :exc:`RuntimeWarning`.
  466. * :exc:`~django.core.exceptions.BadRequest` is raised for non-UTF-8 encoded
  467. requests with the :mimetype:`application/x-www-form-urlencoded` content type.
  468. See :rfc:`1866` for more details.
  469. * The minimum supported version of ``colorama`` is increased to 0.4.6.
  470. * The minimum supported version of ``docutils`` is increased to 0.19.
  471. .. _deprecated-features-5.0:
  472. Features deprecated in 5.0
  473. ==========================
  474. Miscellaneous
  475. -------------
  476. * The ``DjangoDivFormRenderer`` and ``Jinja2DivFormRenderer`` transitional form
  477. renderers are deprecated.
  478. * Passing positional arguments ``name`` and ``violation_error_message`` to
  479. :class:`~django.db.models.BaseConstraint` is deprecated in favor of
  480. keyword-only arguments.
  481. * ``request`` is added to the signature of :meth:`.ModelAdmin.lookup_allowed`.
  482. Support for ``ModelAdmin`` subclasses that do not accept this argument is
  483. deprecated.
  484. * The ``get_joining_columns()`` method of ``ForeignObject`` and
  485. ``ForeignObjectRel`` is deprecated. Starting with Django 6.0,
  486. ``django.db.models.sql.datastructures.Join`` will no longer fallback to
  487. ``get_joining_columns()``. Subclasses should implement
  488. ``get_joining_fields()`` instead.
  489. * The ``ForeignObject.get_reverse_joining_columns()`` method is deprecated.
  490. * The default scheme for ``forms.URLField`` will change from ``"http"`` to
  491. ``"https"`` in Django 6.0.
  492. * Support for calling ``format_html()`` without passing args or kwargs will be
  493. removed.
  494. * Support for ``cx_Oracle`` is deprecated in favor of `oracledb`_ 1.3.2+ Python
  495. driver.
  496. * ``DatabaseOperations.field_cast_sql()`` is deprecated in favor of
  497. ``DatabaseOperations.lookup_cast()``. Starting with Django 6.0,
  498. ``BuiltinLookup.process_lhs()`` will no longer call ``field_cast_sql()``.
  499. Third-party database backends should implement ``lookup_cast()`` instead.
  500. * The ``django.db.models.enums.ChoicesMeta`` metaclass is renamed to
  501. ``ChoicesType``.
  502. .. _`oracledb`: https://oracle.github.io/python-oracledb/
  503. Features removed in 5.0
  504. =======================
  505. These features have reached the end of their deprecation cycle and are removed
  506. in Django 5.0.
  507. See :ref:`deprecated-features-4.0` for details on these changes, including how
  508. to remove usage of these features.
  509. * The ``SERIALIZE`` test setting is removed.
  510. * The undocumented ``django.utils.baseconv`` module is removed.
  511. * The undocumented ``django.utils.datetime_safe`` module is removed.
  512. * The default value of the ``USE_TZ`` setting is changed from ``False`` to
  513. ``True``.
  514. * The default sitemap protocol for sitemaps built outside the context of a
  515. request is changed from ``'http'`` to ``'https'``.
  516. * The ``extra_tests`` argument for ``DiscoverRunner.build_suite()`` and
  517. ``DiscoverRunner.run_tests()`` is removed.
  518. * The ``django.contrib.postgres.aggregates.ArrayAgg``, ``JSONBAgg``, and
  519. ``StringAgg`` aggregates no longer return ``[]``, ``[]``, and ``''``,
  520. respectively, when there are no rows.
  521. * The ``USE_L10N`` setting is removed.
  522. * The ``USE_DEPRECATED_PYTZ`` transitional setting is removed.
  523. * Support for ``pytz`` timezones is removed.
  524. * The ``is_dst`` argument is removed from:
  525. * ``QuerySet.datetimes()``
  526. * ``django.utils.timezone.make_aware()``
  527. * ``django.db.models.functions.Trunc()``
  528. * ``django.db.models.functions.TruncSecond()``
  529. * ``django.db.models.functions.TruncMinute()``
  530. * ``django.db.models.functions.TruncHour()``
  531. * ``django.db.models.functions.TruncDay()``
  532. * ``django.db.models.functions.TruncWeek()``
  533. * ``django.db.models.functions.TruncMonth()``
  534. * ``django.db.models.functions.TruncQuarter()``
  535. * ``django.db.models.functions.TruncYear()``
  536. * The ``django.contrib.gis.admin.GeoModelAdmin`` and ``OSMGeoAdmin`` classes
  537. are removed.
  538. * The undocumented ``BaseForm._html_output()`` method is removed.
  539. * The ability to return a ``str``, rather than a ``SafeString``, when rendering
  540. an ``ErrorDict`` and ``ErrorList`` is removed.
  541. See :ref:`deprecated-features-4.1` for details on these changes, including how
  542. to remove usage of these features.
  543. * The ``SitemapIndexItem.__str__()`` method is removed.
  544. * The ``CSRF_COOKIE_MASKED`` transitional setting is removed.
  545. * The ``name`` argument of ``django.utils.functional.cached_property()`` is
  546. removed.
  547. * The ``opclasses`` argument of
  548. ``django.contrib.postgres.constraints.ExclusionConstraint`` is removed.
  549. * The undocumented ability to pass ``errors=None`` to
  550. ``SimpleTestCase.assertFormError()`` and ``assertFormsetError()`` is removed.
  551. * ``django.contrib.sessions.serializers.PickleSerializer`` is removed.
  552. * The usage of ``QuerySet.iterator()`` on a queryset that prefetches related
  553. objects without providing the ``chunk_size`` argument is no longer allowed.
  554. * Passing unsaved model instances to related filters is no longer allowed.
  555. * ``created=True`` is required in the signature of
  556. ``RemoteUserBackend.configure_user()`` subclasses.
  557. * Support for logging out via ``GET`` requests in the
  558. ``django.contrib.auth.views.LogoutView`` and
  559. ``django.contrib.auth.views.logout_then_login()`` is removed.
  560. * The ``django.utils.timezone.utc`` alias to ``datetime.timezone.utc`` is
  561. removed.
  562. * Passing a response object and a form/formset name to
  563. ``SimpleTestCase.assertFormError()`` and ``assertFormSetError()`` is no
  564. longer allowed.
  565. * The ``django.contrib.gis.admin.OpenLayersWidget`` is removed.
  566. + The ``django.contrib.auth.hashers.CryptPasswordHasher`` is removed.
  567. * The ``"django/forms/default.html"`` and
  568. ``"django/forms/formsets/default.html"`` templates are removed.
  569. * The default form and formset rendering style is changed to the div-based.
  570. * Passing ``nulls_first=False`` or ``nulls_last=False`` to ``Expression.asc()``
  571. and ``Expression.desc()`` methods, and the ``OrderBy`` expression is no
  572. longer allowed.