4.1.txt 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801
  1. ============================================
  2. Django 4.1 release notes - UNDER DEVELOPMENT
  3. ============================================
  4. *Expected August 2022*
  5. Welcome to Django 4.1!
  6. These release notes cover the :ref:`new features <whats-new-4.1>`, as well as
  7. some :ref:`backwards incompatible changes <backwards-incompatible-4.1>` you'll
  8. want to be aware of when upgrading from Django 4.0 or earlier. We've
  9. :ref:`begun the deprecation process for some features
  10. <deprecated-features-4.1>`.
  11. See the :doc:`/howto/upgrade-version` guide if you're updating an existing
  12. project.
  13. Python compatibility
  14. ====================
  15. Django 4.1 supports Python 3.8, 3.9, and 3.10. We **highly recommend** and only
  16. officially support the latest release of each series.
  17. .. _whats-new-4.1:
  18. What's new in Django 4.1
  19. ========================
  20. Asynchronous handlers for class-based views
  21. -------------------------------------------
  22. View subclasses may now define async HTTP method handlers::
  23. import asyncio
  24. from django.http import HttpResponse
  25. from django.views import View
  26. class AsyncView(View):
  27. async def get(self, request, *args, **kwargs):
  28. # Perform view logic using await.
  29. await asyncio.sleep(1)
  30. return HttpResponse("Hello async world!")
  31. See :ref:`async-class-based-views` for more details.
  32. Asynchronous ORM interface
  33. --------------------------
  34. ``QuerySet`` now provides an asynchronous interface for all data access
  35. operations. These are named as-per the existing synchronous operations but with
  36. an ``a`` prefix, for example ``acreate()``, ``aget()``, and so on.
  37. The new interface allows you to write asynchronous code without needing to wrap
  38. ORM operations in ``sync_to_async()``::
  39. async for author in Author.objects.filter(name__startswith="A"):
  40. book = await author.books.afirst()
  41. Note that, at this stage, the underlying database operations remain
  42. synchronous, with contributions ongoing to push asynchronous support down into
  43. the SQL compiler, and integrate asynchronous database drivers. The new
  44. asynchronous queryset interface currently encapsulates the necessary
  45. ``sync_to_async()`` operations for you, and will allow your code to take
  46. advantage of developments in the ORM's asynchronous support as it evolves.
  47. See :ref:`async-queries` for details and limitations.
  48. Validation of Constraints
  49. -------------------------
  50. :class:`Check <django.db.models.CheckConstraint>`,
  51. :class:`unique <django.db.models.UniqueConstraint>`, and :class:`exclusion
  52. <django.contrib.postgres.constraints.ExclusionConstraint>` constraints defined
  53. in the :attr:`Meta.constraints <django.db.models.Options.constraints>` option
  54. are now checked during :ref:`model validation <validating-objects>`.
  55. Form rendering accessibility
  56. ----------------------------
  57. In order to aid users with screen readers, and other assistive technology, new
  58. ``<div>`` based form templates are available from this release. These provide
  59. more accessible navigation than the older templates, and are able to correctly
  60. group related controls, such as radio-lists, into fieldsets.
  61. The new templates are recommended, and will become the default form rendering
  62. style when outputting a form, like ``{{ form }}`` in a template, from Django
  63. 5.0.
  64. In order to ease adopting the new output style, the default form and formset
  65. templates are now configurable at the project level via the
  66. :setting:`FORM_RENDERER` setting.
  67. See :ref:`the Forms section (below)<forms-4.1>` for full details.
  68. .. _csrf-cookie-masked-usage:
  69. ``CSRF_COOKIE_MASKED`` setting
  70. ------------------------------
  71. The new :setting:`CSRF_COOKIE_MASKED` transitional setting allows specifying
  72. whether to mask the CSRF cookie.
  73. :class:`~django.middleware.csrf.CsrfViewMiddleware` no longer masks the CSRF
  74. cookie like it does the CSRF token in the DOM. If you are upgrading multiple
  75. instances of the same project to Django 4.1, you should set
  76. :setting:`CSRF_COOKIE_MASKED` to ``True`` during the transition, in
  77. order to allow compatibility with the older versions of Django. Once the
  78. transition to 4.1 is complete you can stop overriding
  79. :setting:`CSRF_COOKIE_MASKED`.
  80. This setting is deprecated as of this release and will be removed in Django
  81. 5.0.
  82. Minor features
  83. --------------
  84. :mod:`django.contrib.admin`
  85. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  86. * The admin :ref:`dark mode CSS variables <admin-theming>` are now applied in a
  87. separate stylesheet and template block.
  88. * :ref:`modeladmin-list-filters` providing custom ``FieldListFilter``
  89. subclasses can now control the query string value separator when filtering
  90. for multiple values using the ``__in`` lookup.
  91. * The admin :meth:`history view <django.contrib.admin.ModelAdmin.history_view>`
  92. is now paginated.
  93. * Related widget wrappers now have a link to object's change form.
  94. * The :meth:`.AdminSite.get_app_list` method now allows changing the order of
  95. apps and models on the admin index page.
  96. :mod:`django.contrib.admindocs`
  97. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  98. * ...
  99. :mod:`django.contrib.auth`
  100. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  101. * The default iteration count for the PBKDF2 password hasher is increased from
  102. 320,000 to 390,000.
  103. * The :meth:`.RemoteUserBackend.configure_user` method now allows synchronizing
  104. user attributes with attributes in a remote system such as an LDAP directory.
  105. :mod:`django.contrib.contenttypes`
  106. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  107. * ...
  108. :mod:`django.contrib.gis`
  109. ~~~~~~~~~~~~~~~~~~~~~~~~~
  110. * The new :meth:`.GEOSGeometry.make_valid()` method allows converting invalid
  111. geometries to valid ones.
  112. * The new ``clone`` argument for :meth:`.GEOSGeometry.normalize` allows
  113. creating a normalized clone of the geometry.
  114. :mod:`django.contrib.messages`
  115. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  116. * ...
  117. :mod:`django.contrib.postgres`
  118. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  119. * The new :class:`BitXor() <django.contrib.postgres.aggregates.BitXor>`
  120. aggregate function returns an ``int`` of the bitwise ``XOR`` of all non-null
  121. input values.
  122. * :class:`~django.contrib.postgres.indexes.SpGistIndex` now supports covering
  123. indexes on PostgreSQL 14+.
  124. * :class:`~django.contrib.postgres.constraints.ExclusionConstraint` now
  125. supports covering exclusion constraints using SP-GiST indexes on PostgreSQL
  126. 14+.
  127. * The new ``default_bounds`` attribute of :attr:`DateTimeRangeField
  128. <django.contrib.postgres.fields.DateTimeRangeField.default_bounds>` and
  129. :attr:`DecimalRangeField
  130. <django.contrib.postgres.fields.DecimalRangeField.default_bounds>` allows
  131. specifying bounds for list and tuple inputs.
  132. * :class:`~django.contrib.postgres.constraints.ExclusionConstraint` now allows
  133. specifying operator classes with the
  134. :class:`OpClass() <django.contrib.postgres.indexes.OpClass>` expression.
  135. :mod:`django.contrib.redirects`
  136. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  137. * ...
  138. :mod:`django.contrib.sessions`
  139. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  140. * ...
  141. :mod:`django.contrib.sitemaps`
  142. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  143. * The default sitemap index template ``<sitemapindex>`` now includes the
  144. ``<lastmod>`` timestamp where available, through the new
  145. :meth:`~django.contrib.sitemaps.Sitemap.get_latest_lastmod` method. Custom
  146. sitemap index templates should be updated for the adjusted :ref:`context
  147. variables <sitemap-index-context-variables>`.
  148. :mod:`django.contrib.sites`
  149. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  150. * ...
  151. :mod:`django.contrib.staticfiles`
  152. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  153. * :class:`~django.contrib.staticfiles.storage.ManifestStaticFilesStorage` now
  154. replaces paths to CSS source map references with their hashed counterparts.
  155. :mod:`django.contrib.syndication`
  156. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  157. * ...
  158. Cache
  159. ~~~~~
  160. * ...
  161. CSRF
  162. ~~~~
  163. * ...
  164. Database backends
  165. ~~~~~~~~~~~~~~~~~
  166. * Third-party database backends can now specify the minimum required version of
  167. the database using the ``DatabaseFeatures.minimum_database_version``
  168. attribute which is a tuple (e.g. ``(10, 0)`` means "10.0"). If a minimum
  169. version is specified, backends must also implement
  170. ``DatabaseWrapper.get_database_version()``, which returns a tuple of the
  171. current database version. The backend's
  172. ``DatabaseWrapper.init_connection_state()`` method must call ``super()`` in
  173. order for the check to run.
  174. Decorators
  175. ~~~~~~~~~~
  176. * ...
  177. Email
  178. ~~~~~
  179. * ...
  180. Error Reporting
  181. ~~~~~~~~~~~~~~~
  182. * ...
  183. File Storage
  184. ~~~~~~~~~~~~
  185. * ...
  186. File Uploads
  187. ~~~~~~~~~~~~
  188. * ...
  189. .. _forms-4.1:
  190. Forms
  191. ~~~~~
  192. * The default template used to render forms when cast to a string, e.g. in
  193. templates as ``{{ form }}``, is now configurable at the project-level by
  194. setting :attr:`~django.forms.renderers.BaseRenderer.form_template_name` on
  195. the class provided for :setting:`FORM_RENDERER`.
  196. :attr:`.Form.template_name` is now a property deferring to the renderer, but
  197. may be overridden with a string value to specify the template name per-form
  198. class.
  199. Similarly, the default template used to render formsets can be specified via
  200. the matching
  201. :attr:`~django.forms.renderers.BaseRenderer.formset_template_name` renderer
  202. attribute.
  203. * The new ``div.html`` form template, referencing
  204. :attr:`.Form.template_name_div` attribute, and matching :meth:`.Form.as_div`
  205. method, render forms using HTML ``<div>`` elements.
  206. This new output style is recommended over the existing
  207. :meth:`~.Form.as_table`, :meth:`~.Form.as_p` and :meth:`~.Form.as_ul` styles,
  208. as the template implements ``<fieldset>`` and ``<legend>`` to group related
  209. inputs and is easier for screen reader users to navigate.
  210. The div-based output will become the default rendering style from Django 5.0.
  211. * In order to smooth adoption of the new ``<div>`` output style, two
  212. transitional form renderer classes are available:
  213. :class:`django.forms.renderers.DjangoDivFormRenderer` and
  214. :class:`django.forms.renderers.Jinja2DivFormRenderer`, for the Django and
  215. Jinja2 template backends respectively.
  216. You can apply one of these via the :setting:`FORM_RENDERER` setting. For
  217. example::
  218. FORM_RENDERER = "django.forms.renderers.DjangoDivFormRenderer"
  219. Once the ``<div>`` output style is the default, from Django 5.0, these
  220. transitional renderers will be deprecated, for removal in Django 6.0. The
  221. ``FORM_RENDERER`` declaration can be removed at that time.
  222. * If the new ``<div>`` output style is not appropriate for your project, you should
  223. define a renderer subclass specifying
  224. :attr:`~django.forms.renderers.BaseRenderer.form_template_name` and
  225. :attr:`~django.forms.renderers.BaseRenderer.formset_template_name` for your
  226. required style, and set :setting:`FORM_RENDERER` accordingly.
  227. For example, for the ``<p>`` output style used by :meth:`~.Form.as_p`, you
  228. would define a form renderer setting ``form_template_name`` to
  229. ``"django/forms/p.html"`` and ``formset_template_name`` to
  230. ``"django/forms/formsets/p.html"``.
  231. * The new :meth:`~django.forms.BoundField.legend_tag` allows rendering field
  232. labels in ``<legend>`` tags via the new ``tag`` argument of
  233. :meth:`~django.forms.BoundField.label_tag`.
  234. * The new ``edit_only`` argument for :func:`.modelformset_factory` and
  235. :func:`.inlineformset_factory` allows preventing new objects creation.
  236. * The ``js`` and ``css`` class attributes of :doc:`Media </topics/forms/media>`
  237. now allow using hashable objects, not only path strings, as long as those
  238. objects implement the ``__html__()`` method (typically when decorated with
  239. the :func:`~django.utils.html.html_safe` decorator).
  240. * The new :attr:`.BoundField.use_fieldset` and :attr:`.Widget.use_fieldset`
  241. attributes help to identify widgets where its inputs should be grouped in a
  242. ``<fieldset>`` with a ``<legend>``.
  243. * The :ref:`formsets-error-messages` argument for
  244. :class:`~django.forms.formsets.BaseFormSet` now allows customizing
  245. error messages for invalid number of forms by passing ``'too_few_forms'``
  246. and ``'too_many_forms'`` keys.
  247. * :class:`~django.forms.IntegerField`, :class:`~django.forms.FloatField`, and
  248. :class:`~django.forms.DecimalField` now optionally accept a ``step_size``
  249. argument. This is used to set the ``step`` HTML attribute, and is validated
  250. on form submission.
  251. Generic Views
  252. ~~~~~~~~~~~~~
  253. * ...
  254. Internationalization
  255. ~~~~~~~~~~~~~~~~~~~~
  256. * The :func:`~django.conf.urls.i18n.i18n_patterns` function now supports
  257. languages with both scripts and regions.
  258. Logging
  259. ~~~~~~~
  260. * ...
  261. Management Commands
  262. ~~~~~~~~~~~~~~~~~~~
  263. * :option:`makemigrations --no-input` now logs default answers and reasons why
  264. migrations cannot be created.
  265. * The new :option:`makemigrations --scriptable` option diverts log output and
  266. input prompts to ``stderr``, writing only paths of generated migration files
  267. to ``stdout``.
  268. * The new :option:`migrate --prune` option allows deleting nonexistent
  269. migrations from the ``django_migrations`` table.
  270. * Python files created by :djadmin:`startproject`, :djadmin:`startapp`,
  271. :djadmin:`optimizemigration`, :djadmin:`makemigrations`, and
  272. :djadmin:`squashmigrations` are now formatted using the ``black`` command if
  273. it is present on your ``PATH``.
  274. * The new :djadmin:`optimizemigration` command allows optimizing operations for
  275. a migration.
  276. Migrations
  277. ~~~~~~~~~~
  278. * The new :class:`~django.db.migrations.operations.RenameIndex` operation
  279. allows renaming indexes defined in the
  280. :attr:`Meta.indexes <django.db.models.Options.indexes>` or
  281. :attr:`~django.db.models.Options.index_together` options.
  282. * The migrations autodetector now generates
  283. :class:`~django.db.migrations.operations.RenameIndex` operations instead of
  284. ``RemoveIndex`` and ``AddIndex``, when renaming indexes defined in the
  285. :attr:`Meta.indexes <django.db.models.Options.indexes>`.
  286. * The migrations autodetector now generates
  287. :class:`~django.db.migrations.operations.RenameIndex` operations instead of
  288. ``AlterIndexTogether`` and ``AddIndex``, when moving indexes defined in the
  289. :attr:`Meta.index_together <django.db.models.Options.index_together>` to the
  290. :attr:`Meta.indexes <django.db.models.Options.indexes>`.
  291. Models
  292. ~~~~~~
  293. * The ``order_by`` argument of the
  294. :class:`~django.db.models.expressions.Window` expression now accepts string
  295. references to fields and transforms.
  296. * The new :setting:`CONN_HEALTH_CHECKS` setting allows enabling health checks
  297. for :ref:`persistent database connections <persistent-database-connections>`
  298. in order to reduce the number of failed requests, e.g. after database server
  299. restart.
  300. * :meth:`.QuerySet.bulk_create` now supports updating fields when a row
  301. insertion fails uniqueness constraints. This is supported on MariaDB, MySQL,
  302. PostgreSQL, and SQLite 3.24+.
  303. * :meth:`.QuerySet.iterator` now supports prefetching related objects as long
  304. as the ``chunk_size`` argument is provided. In older versions, no prefetching
  305. was done.
  306. * :class:`~django.db.models.Q` objects and querysets can now be combined using
  307. ``^`` as the exclusive or (``XOR``) operator. ``XOR`` is natively supported
  308. on MariaDB and MySQL. For databases that do not support ``XOR``, the query
  309. will be converted to an equivalent using ``AND``, ``OR``, and ``NOT``.
  310. * The new :ref:`Field.non_db_attrs <custom-field-non_db_attrs>` attribute
  311. allows customizing attributes of fields that don't affect a column
  312. definition.
  313. * On PostgreSQL, ``AutoField``, ``BigAutoField``, and ``SmallAutoField`` are
  314. now created as identity columns rather than serial columns with sequences.
  315. Requests and Responses
  316. ~~~~~~~~~~~~~~~~~~~~~~
  317. * :meth:`.HttpResponse.set_cookie` now supports :class:`~datetime.timedelta`
  318. objects for the ``max_age`` argument.
  319. Security
  320. ~~~~~~~~
  321. * The new :setting:`SECRET_KEY_FALLBACKS` setting allows providing a list of
  322. values for secret key rotation.
  323. * The :setting:`SECURE_PROXY_SSL_HEADER` setting now supports a comma-separated
  324. list of protocols in the header value.
  325. Serialization
  326. ~~~~~~~~~~~~~
  327. * ...
  328. Signals
  329. ~~~~~~~
  330. * The :data:`~django.db.models.signals.pre_delete` and
  331. :data:`~django.db.models.signals.post_delete` signals now dispatch the
  332. ``origin`` of the deletion.
  333. .. _templates-4.1:
  334. Templates
  335. ~~~~~~~~~
  336. * :tfilter:`json_script` template filter now allows wrapping in a ``<script>``
  337. tag without the HTML ``id`` attribute.
  338. * The :class:`cached template loader <django.template.loaders.cached.Loader>`
  339. is now enabled in development, when :setting:`DEBUG` is ``True``, and
  340. :setting:`OPTIONS['loaders'] <TEMPLATES-OPTIONS>` isn't specified. You may
  341. specify ``OPTIONS['loaders']`` to override this, if necessary.
  342. Tests
  343. ~~~~~
  344. * The :class:`.DiscoverRunner` now supports running tests in parallel on
  345. macOS, Windows, and any other systems where the default
  346. :mod:`multiprocessing` start method is ``spawn``.
  347. * A nested atomic block marked as durable in :class:`django.test.TestCase` now
  348. raises a ``RuntimeError``, the same as outside of tests.
  349. * :meth:`.SimpleTestCase.assertFormError` and
  350. :meth:`~.SimpleTestCase.assertFormsetError` now support passing a
  351. form/formset object directly.
  352. URLs
  353. ~~~~
  354. * The new :attr:`.ResolverMatch.captured_kwargs` attribute stores the captured
  355. keyword arguments, as parsed from the URL.
  356. * The new :attr:`.ResolverMatch.extra_kwargs` attribute stores the additional
  357. keyword arguments passed to the view function.
  358. Utilities
  359. ~~~~~~~~~
  360. * ``SimpleLazyObject`` now supports addition operations.
  361. * :func:`~django.utils.safestring.mark_safe` now preserves lazy objects.
  362. Validators
  363. ~~~~~~~~~~
  364. * The new :class:`~django.core.validators.StepValueValidator` checks if a value
  365. is an integral multiple of a given step size. This new validator is used for
  366. the new ``step_size`` argument added to form fields representing numeric
  367. values.
  368. .. _backwards-incompatible-4.1:
  369. Backwards incompatible changes in 4.1
  370. =====================================
  371. Database backend API
  372. --------------------
  373. This section describes changes that may be needed in third-party database
  374. backends.
  375. * ``BaseDatabaseFeatures.has_case_insensitive_like`` is changed from ``True``
  376. to ``False`` to reflect the behavior of most databases.
  377. * ``DatabaseIntrospection.get_key_columns()`` is removed. Use
  378. ``DatabaseIntrospection.get_relations()`` instead.
  379. * ``DatabaseOperations.ignore_conflicts_suffix_sql()`` method is replaced by
  380. ``DatabaseOperations.on_conflict_suffix_sql()`` that accepts the ``fields``,
  381. ``on_conflict``, ``update_fields``, and ``unique_fields`` arguments.
  382. * The ``ignore_conflicts`` argument of the
  383. ``DatabaseOperations.insert_statement()`` method is replaced by
  384. ``on_conflict`` that accepts ``django.db.models.constants.OnConflict``.
  385. :mod:`django.contrib.gis`
  386. -------------------------
  387. * Support for GDAL 2.1 is removed.
  388. * Support for PostGIS 2.4 is removed.
  389. Dropped support for PostgreSQL 10
  390. ---------------------------------
  391. Upstream support for PostgreSQL 10 ends in November 2022. Django 4.1 supports
  392. PostgreSQL 11 and higher.
  393. Dropped support for MariaDB 10.2
  394. --------------------------------
  395. Upstream support for MariaDB 10.2 ends in May 2022. Django 4.1 supports MariaDB
  396. 10.3 and higher.
  397. Admin changelist searches spanning multi-valued relationships changes
  398. ---------------------------------------------------------------------
  399. Admin changelist searches using multiple search terms are now applied in a
  400. single call to ``filter()``, rather than in sequential ``filter()`` calls.
  401. For multi-valued relationships, this means that rows from the related model
  402. must match all terms rather than any term. For example, if ``search_fields``
  403. is set to ``['child__name', 'child__age']``, and a user searches for
  404. ``'Jamal 17'``, parent rows will be returned only if there is a relationship to
  405. some 17-year-old child named Jamal, rather than also returning parents who
  406. merely have a younger or older child named Jamal in addition to some other
  407. 17-year-old.
  408. See the :ref:`spanning-multi-valued-relationships` topic for more discussion of
  409. this difference. In Django 4.0 and earlier,
  410. :meth:`~django.contrib.admin.ModelAdmin.get_search_results` followed the
  411. second example query, but this undocumented behavior led to queries with
  412. excessive joins.
  413. Reverse foreign key changes for unsaved model instances
  414. -------------------------------------------------------
  415. In order to unify the behavior with many-to-many relations for unsaved model
  416. instances, a reverse foreign key now raises ``ValueError`` when calling
  417. :class:`related managers <django.db.models.fields.related.RelatedManager>` for
  418. unsaved objects.
  419. Miscellaneous
  420. -------------
  421. * Related managers for :class:`~django.db.models.ForeignKey`,
  422. :class:`~django.db.models.ManyToManyField`, and
  423. :class:`~django.contrib.contenttypes.fields.GenericRelation` are now cached
  424. on the :class:`~django.db.models.Model` instance to which they belong.
  425. * The Django test runner now returns a non-zero error code for unexpected
  426. successes from tests marked with :py:func:`unittest.expectedFailure`.
  427. * :class:`~django.middleware.csrf.CsrfViewMiddleware` no longer masks the CSRF
  428. cookie like it does the CSRF token in the DOM.
  429. * :class:`~django.middleware.csrf.CsrfViewMiddleware` now uses
  430. ``request.META['CSRF_COOKIE']`` for storing the unmasked CSRF secret rather
  431. than a masked version. This is an undocumented, private API.
  432. * The :attr:`.ModelAdmin.actions` and
  433. :attr:`~django.contrib.admin.ModelAdmin.inlines` attributes now default to an
  434. empty tuple rather than an empty list to discourage unintended mutation.
  435. * The ``type="text/css"`` attribute is no longer included in ``<link>`` tags
  436. for CSS :doc:`form media </topics/forms/media>`.
  437. * ``formset:added`` and ``formset:removed`` JavaScript events are now pure
  438. JavaScript events and don't depend on jQuery. See
  439. :ref:`admin-javascript-inline-form-events` for more details on the change.
  440. * The ``exc_info`` argument of the undocumented
  441. ``django.utils.log.log_response()`` function is replaced by ``exception``.
  442. * The ``size`` argument of the undocumented
  443. ``django.views.static.was_modified_since()`` function is removed.
  444. * The admin log out UI now uses ``POST`` requests.
  445. * The undocumented ``InlineAdminFormSet.non_form_errors`` property is replaced
  446. by the ``non_form_errors()`` method. This is consistent with ``BaseFormSet``.
  447. * As per :ref:`above<templates-4.1>`, the cached template loader is now
  448. enabled in development. You may specify ``OPTIONS['loaders']`` to override
  449. this, if necessary.
  450. * The undocumented ``django.contrib.auth.views.SuccessURLAllowedHostsMixin``
  451. mixin is replaced by ``RedirectURLMixin``.
  452. * :class:`~django.db.models.BaseConstraint` subclasses must implement
  453. :meth:`~django.db.models.BaseConstraint.validate` method to allow those
  454. constraints to be used for validation.
  455. * The undocumented ``URLResolver._is_callback()``,
  456. ``URLResolver._callback_strs``, and ``URLPattern.lookup_str()`` are
  457. moved to ``django.contrib.admindocs.utils``.
  458. .. _deprecated-features-4.1:
  459. Features deprecated in 4.1
  460. ==========================
  461. Log out via GET
  462. ---------------
  463. Logging out via ``GET`` requests to the :py:class:`built-in logout view
  464. <django.contrib.auth.views.LogoutView>` is deprecated. Use ``POST`` requests
  465. instead.
  466. If you want to retain the user experience of an HTML link, you can use a form
  467. that is styled to appear as a link:
  468. .. code-block:: html
  469. <form id="logout-form" method="post" action="{% url 'admin:logout' %}">
  470. {% csrf_token %}
  471. <button type="submit">{% translate "Log out" %}</button>
  472. </form>
  473. .. code-block:: css
  474. #logout-form {
  475. display: inline;
  476. }
  477. #logout-form button {
  478. background: none;
  479. border: none;
  480. cursor: pointer;
  481. padding: 0;
  482. text-decoration: underline;
  483. }
  484. Miscellaneous
  485. -------------
  486. * The context for sitemap index templates of a flat list of URLs is deprecated.
  487. Custom sitemap index templates should be updated for the adjusted
  488. :ref:`context variables <sitemap-index-context-variables>`, expecting a list
  489. of objects with ``location`` and optional ``lastmod`` attributes.
  490. * ``CSRF_COOKIE_MASKED`` transitional setting is deprecated.
  491. * The ``name`` argument of :func:`django.utils.functional.cached_property` is
  492. deprecated as it's unnecessary as of Python 3.6.
  493. * The ``opclasses`` argument of
  494. ``django.contrib.postgres.constraints.ExclusionConstraint`` is deprecated in
  495. favor of using :class:`OpClass() <django.contrib.postgres.indexes.OpClass>`
  496. in :attr:`.ExclusionConstraint.expressions`. To use it, you need to add
  497. ``'django.contrib.postgres'`` in your :setting:`INSTALLED_APPS`.
  498. After making this change, :djadmin:`makemigrations` will generate a new
  499. migration with two operations: ``RemoveConstraint`` and ``AddConstraint``.
  500. Since this change has no effect on the database schema,
  501. the :class:`~django.db.migrations.operations.SeparateDatabaseAndState`
  502. operation can be used to only update the migration state without running any
  503. SQL. Move the generated operations into the ``state_operations`` argument of
  504. :class:`~django.db.migrations.operations.SeparateDatabaseAndState`. For
  505. example::
  506. class Migration(migrations.Migration):
  507. ...
  508. operations = [
  509. migrations.SeparateDatabaseAndState(
  510. database_operations=[],
  511. state_operations=[
  512. migrations.RemoveConstraint(
  513. ...
  514. ),
  515. migrations.AddConstraint(
  516. ...
  517. ),
  518. ],
  519. ),
  520. ]
  521. * The undocumented ability to pass ``errors=None`` to
  522. :meth:`.SimpleTestCase.assertFormError` and
  523. :meth:`~.SimpleTestCase.assertFormsetError` is deprecated. Use ``errors=[]``
  524. instead.
  525. * ``django.contrib.sessions.serializers.PickleSerializer`` is deprecated due to
  526. the risk of remote code execution.
  527. * The usage of ``QuerySet.iterator()`` on a queryset that prefetches related
  528. objects without providing the ``chunk_size`` argument is deprecated. In older
  529. versions, no prefetching was done. Providing a value for ``chunk_size``
  530. signifies that the additional query per chunk needed to prefetch is desired.
  531. * Passing unsaved model instances to related filters is deprecated. In Django
  532. 5.0, the exception will be raised.
  533. * ``created=True`` is added to the signature of
  534. :meth:`.RemoteUserBackend.configure_user`. Support for ``RemoteUserBackend``
  535. subclasses that do not accept this argument is deprecated.
  536. * The :data:`django.utils.timezone.utc` alias to :attr:`datetime.timezone.utc`
  537. is deprecated. Use :attr:`datetime.timezone.utc` directly.
  538. * Passing a response object and a form/formset name to
  539. ``SimpleTestCase.assertFormError()`` and ``assertFormsetError()`` is
  540. deprecated. Use::
  541. assertFormError(response.context['form_name'], …)
  542. assertFormsetError(response.context['formset_name'], …)
  543. or pass the form/formset object directly instead.
  544. * The undocumented ``django.contrib.gis.admin.OpenLayersWidget`` is deprecated.
  545. * ``django.contrib.auth.hashers.CryptPasswordHasher`` is deprecated.
  546. * The ability to pass ``nulls_first=False`` or ``nulls_last=False`` to
  547. ``Expression.asc()`` and ``Expression.desc()`` methods, and the ``OrderBy``
  548. expression is deprecated. Use ``None`` instead.
  549. * The ``"django/forms/default.html"`` and
  550. ``"django/forms/formsets/default.html"`` templates which are a proxy to the
  551. table-based templates are deprecated. Use the specific template instead.
  552. Features removed in 4.1
  553. =======================
  554. These features have reached the end of their deprecation cycle and are removed
  555. in Django 4.1.
  556. See :ref:`deprecated-features-3.2` for details on these changes, including how
  557. to remove usage of these features.
  558. * Support for assigning objects which don't support creating deep copies with
  559. ``copy.deepcopy()`` to class attributes in ``TestCase.setUpTestData()`` is
  560. removed.
  561. * Support for using a boolean value in
  562. :attr:`.BaseCommand.requires_system_checks` is removed.
  563. * The ``whitelist`` argument and ``domain_whitelist`` attribute of
  564. ``django.core.validators.EmailValidator`` are removed.
  565. * The ``default_app_config`` application configuration variable is removed.
  566. * ``TransactionTestCase.assertQuerysetEqual()`` no longer calls ``repr()`` on a
  567. queryset when compared to string values.
  568. * The ``django.core.cache.backends.memcached.MemcachedCache`` backend is
  569. removed.
  570. * Support for the pre-Django 3.2 format of messages used by
  571. ``django.contrib.messages.storage.cookie.CookieStorage`` is removed.