3.2.txt 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833
  1. ============================================
  2. Django 3.2 release notes - UNDER DEVELOPMENT
  3. ============================================
  4. *Expected April 2021*
  5. Welcome to Django 3.2!
  6. These release notes cover the :ref:`new features <whats-new-3.2>`, as well as
  7. some :ref:`backwards incompatible changes <backwards-incompatible-3.2>` you'll
  8. want to be aware of when upgrading from Django 3.1 or earlier. We've
  9. :ref:`begun the deprecation process for some features
  10. <deprecated-features-3.2>`.
  11. See the :doc:`/howto/upgrade-version` guide if you're updating an existing
  12. project.
  13. Django 3.2 is designated as a :term:`long-term support release
  14. <Long-term support release>`. It will receive security updates for at least
  15. three years after its release. Support for the previous LTS, Django 2.2, will
  16. end in April 2022.
  17. Python compatibility
  18. ====================
  19. Django 3.2 supports Python 3.6, 3.7, 3.8, and 3.9. We **highly recommend** and
  20. only officially support the latest release of each series.
  21. .. _whats-new-3.2:
  22. What's new in Django 3.2
  23. ========================
  24. Automatic :class:`~django.apps.AppConfig` discovery
  25. ---------------------------------------------------
  26. Most pluggable applications define an :class:`~django.apps.AppConfig` subclass
  27. in an ``apps.py`` submodule. Many define a ``default_app_config`` variable
  28. pointing to this class in their ``__init__.py``.
  29. When the ``apps.py`` submodule exists and defines a single
  30. :class:`~django.apps.AppConfig` subclass, Django now uses that configuration
  31. automatically, so you can remove ``default_app_config``.
  32. ``default_app_config`` made it possible to declare only the application's path
  33. in :setting:`INSTALLED_APPS` (e.g. ``'django.contrib.admin'``) rather than the
  34. app config's path (e.g. ``'django.contrib.admin.apps.AdminConfig'``). It was
  35. introduced for backwards-compatibility with the former style, with the intent
  36. to switch the ecosystem to the latter, but the switch didn't happen.
  37. With automatic ``AppConfig`` discovery, ``default_app_config`` is no longer
  38. needed. As a consequence, it's deprecated.
  39. See :ref:`configuring-applications-ref` for full details.
  40. Customizing type of auto-created primary keys
  41. ---------------------------------------------
  42. When defining a model, if no field in a model is defined with
  43. :attr:`primary_key=True <django.db.models.Field.primary_key>` an implicit
  44. primary key is added. The type of this implicit primary key can now be
  45. controlled via the :setting:`DEFAULT_AUTO_FIELD` setting and
  46. :attr:`AppConfig.default_auto_field <django.apps.AppConfig.default_auto_field>`
  47. attribute. No more needing to override primary keys in all models.
  48. Maintaining the historical behavior, the default value for
  49. :setting:`DEFAULT_AUTO_FIELD` is :class:`~django.db.models.AutoField`. Starting
  50. with 3.2 new projects are generated with :setting:`DEFAULT_AUTO_FIELD` set to
  51. :class:`~django.db.models.BigAutoField`. Also, new apps are generated with
  52. :attr:`AppConfig.default_auto_field <django.apps.AppConfig.default_auto_field>`
  53. set to :class:`~django.db.models.BigAutoField`. In a future Django release the
  54. default value of :setting:`DEFAULT_AUTO_FIELD` will be changed to
  55. :class:`~django.db.models.BigAutoField`.
  56. To avoid unwanted migrations in the future, either explicitly set
  57. :setting:`DEFAULT_AUTO_FIELD` to :class:`~django.db.models.AutoField`::
  58. DEFAULT_AUTO_FIELD = 'django.db.models.AutoField'
  59. or configure it on a per-app basis::
  60. from django.apps import AppConfig
  61. class MyAppConfig(AppConfig):
  62. default_auto_field = 'django.db.models.AutoField'
  63. name = 'my_app'
  64. or on a per-model basis::
  65. from django.db import models
  66. class MyModel(models.Model):
  67. id = models.AutoField(primary_key=True)
  68. In anticipation of the changing default, a system check will provide a warning
  69. if you do not have an explicit setting for :setting:`DEFAULT_AUTO_FIELD`.
  70. .. _new_functional_indexes:
  71. Functional indexes
  72. ------------------
  73. The new :attr:`*expressions <django.db.models.Index.expressions>` positional
  74. argument of :class:`Index() <django.db.models.Index>` enables creating
  75. functional indexes on expressions and database functions. For example::
  76. from django.db import models
  77. from django.db.models import F, Index, Value
  78. from django.db.models.functions import Lower, Upper
  79. class MyModel(models.Model):
  80. first_name = models.CharField(max_length=255)
  81. last_name = models.CharField(max_length=255)
  82. height = models.IntegerField()
  83. weight = models.IntegerField()
  84. class Meta:
  85. indexes = [
  86. Index(
  87. Lower('first_name'),
  88. Upper('last_name').desc(),
  89. name='first_last_name_idx',
  90. ),
  91. Index(
  92. F('height') / (F('weight') + Value(5)),
  93. name='calc_idx',
  94. ),
  95. ]
  96. Functional indexes are added to models using the
  97. :attr:`Meta.indexes <django.db.models.Options.indexes>` option.
  98. ``pymemcache`` support
  99. ----------------------
  100. The new ``django.core.cache.backends.memcached.PyMemcacheCache`` cache backend
  101. allows using the pymemcache_ library for memcached. ``pymemcache`` 3.4.0 or
  102. higher is required. For more details, see the :doc:`documentation on caching in
  103. Django </topics/cache>`.
  104. .. _pymemcache: https://pypi.org/project/pymemcache/
  105. New decorators for the admin site
  106. ---------------------------------
  107. The new :func:`~django.contrib.admin.display` decorator allows for easily
  108. adding options to custom display functions that can be used with
  109. :attr:`~django.contrib.admin.ModelAdmin.list_display` or
  110. :attr:`~django.contrib.admin.ModelAdmin.readonly_fields`.
  111. Likewise, the new :func:`~django.contrib.admin.action` decorator allows for
  112. easily adding options to action functions that can be used with
  113. :attr:`~django.contrib.admin.ModelAdmin.actions`.
  114. Using the ``@display`` decorator has the advantage that it is now
  115. possible to use the ``@property`` decorator when needing to specify attributes
  116. on the custom method. Prior to this it was necessary to use the ``property()``
  117. function instead after assigning the required attributes to the method.
  118. Using decorators has the advantage that these options are more discoverable as
  119. they can be suggested by completion utilities in code editors. They are merely
  120. a convenience and still set the same attributes on the functions under the
  121. hood.
  122. Minor features
  123. --------------
  124. :mod:`django.contrib.admin`
  125. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  126. * :attr:`.ModelAdmin.search_fields` now allows searching against quoted phrases
  127. with spaces.
  128. * Read-only related fields are now rendered as navigable links if target models
  129. are registered in the admin.
  130. * The admin now supports theming. See :ref:`admin-theming` for more details.
  131. * :attr:`.ModelAdmin.autocomplete_fields` now respects
  132. :attr:`ForeignKey.to_field <django.db.models.ForeignKey.to_field>` and
  133. :attr:`ForeignKey.limit_choices_to
  134. <django.db.models.ForeignKey.limit_choices_to>` when searching a related
  135. model.
  136. * The admin now installs a final catch-all view that redirects unauthenticated
  137. users to the login page, regardless or whether the URLs is otherwise valid.
  138. This protects against a potential model enumeration privacy issue.
  139. Although not recommended, you may set the new
  140. :attr:`.AdminSite.final_catch_all_view` to ``False`` to disable the
  141. catch-all view.
  142. :mod:`django.contrib.admindocs`
  143. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  144. * ...
  145. :mod:`django.contrib.auth`
  146. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  147. * The default iteration count for the PBKDF2 password hasher is increased from
  148. 216,000 to 260,000.
  149. * The default variant for the Argon2 password hasher is changed to Argon2id.
  150. ``memory_cost`` and ``parallelism`` are increased to 102,400 and 8
  151. respectively to match the ``argon2-cffi`` defaults.
  152. Increasing the ``memory_cost`` pushes the required memory from 512 KB to 100
  153. MB. This is still rather conservative but can lead to problems in memory
  154. constrained environments. If this is the case, the existing hasher can be
  155. subclassed to override the defaults.
  156. :mod:`django.contrib.contenttypes`
  157. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  158. * The new ``absolute_max`` argument for
  159. :func:`~django.contrib.contenttypes.forms.generic_inlineformset_factory`
  160. allows customizing the maximum number of forms that can be instantiated when
  161. supplying ``POST`` data. See :ref:`formsets-absolute-max` for more details.
  162. * The new ``can_delete_extra`` argument for
  163. :func:`~django.contrib.contenttypes.forms.generic_inlineformset_factory`
  164. allows removal of the option to delete extra forms. See
  165. :attr:`~.BaseFormSet.can_delete_extra` for more information.
  166. :mod:`django.contrib.gis`
  167. ~~~~~~~~~~~~~~~~~~~~~~~~~
  168. * The :meth:`.GDALRaster.transform` method now supports
  169. :class:`~django.contrib.gis.gdal.SpatialReference`.
  170. * The :class:`~django.contrib.gis.gdal.DataSource` class now supports
  171. :class:`pathlib.Path`.
  172. * The :class:`~django.contrib.gis.utils.LayerMapping` class now supports
  173. :class:`pathlib.Path`.
  174. :mod:`django.contrib.messages`
  175. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  176. * ...
  177. :mod:`django.contrib.postgres`
  178. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  179. * The new :attr:`.ExclusionConstraint.include` attribute allows creating
  180. covering exclusion constraints on PostgreSQL 12+.
  181. * The new :attr:`.ExclusionConstraint.opclasses` attribute allows setting
  182. PostgreSQL operator classes.
  183. * The new :attr:`.JSONBAgg.ordering` attribute determines the ordering of the
  184. aggregated elements.
  185. * The new :attr:`.JSONBAgg.distinct` attribute determines if aggregated values
  186. will be distinct.
  187. * The :class:`~django.contrib.postgres.operations.CreateExtension` operation
  188. now checks that the extension already exists in the database and skips the
  189. migration if so.
  190. * The new :class:`~django.contrib.postgres.operations.CreateCollation` and
  191. :class:`~django.contrib.postgres.operations.RemoveCollation` operations
  192. allow creating and dropping collations on PostgreSQL. See
  193. :ref:`manage-postgresql-collations` for more details.
  194. * Lookups for :class:`~django.contrib.postgres.fields.ArrayField` now allow
  195. (non-nested) arrays containing expressions as right-hand sides.
  196. * The new :class:`OpClass() <django.contrib.postgres.indexes.OpClass>`
  197. expression allows creating functional indexes on expressions with a custom
  198. operator class. See :ref:`new_functional_indexes` for more details.
  199. :mod:`django.contrib.redirects`
  200. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  201. * ...
  202. :mod:`django.contrib.sessions`
  203. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  204. * ...
  205. :mod:`django.contrib.sitemaps`
  206. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  207. * The new :class:`~django.contrib.sitemaps.Sitemap` attributes
  208. :attr:`~django.contrib.sitemaps.Sitemap.alternates`,
  209. :attr:`~django.contrib.sitemaps.Sitemap.languages` and
  210. :attr:`~django.contrib.sitemaps.Sitemap.x_default` allow
  211. generating sitemap *alternates* to localized versions of your pages.
  212. :mod:`django.contrib.sites`
  213. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  214. * ...
  215. :mod:`django.contrib.staticfiles`
  216. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  217. * ...
  218. :mod:`django.contrib.syndication`
  219. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  220. * The new ``item_comments`` hook allows specifying a comments URL per feed
  221. item.
  222. Cache
  223. ~~~~~
  224. * ...
  225. CSRF
  226. ~~~~
  227. * ...
  228. Database backends
  229. ~~~~~~~~~~~~~~~~~
  230. * Third-party database backends can now skip or mark as expected failures
  231. tests in Django's test suite using the new
  232. ``DatabaseFeatures.django_test_skips`` and
  233. ``django_test_expected_failures`` attributes.
  234. Decorators
  235. ~~~~~~~~~~
  236. * The new :func:`~django.views.decorators.common.no_append_slash` decorator
  237. allows individual views to be excluded from :setting:`APPEND_SLASH` URL
  238. normalization.
  239. Email
  240. ~~~~~
  241. * ...
  242. Error Reporting
  243. ~~~~~~~~~~~~~~~
  244. * Custom :class:`~django.views.debug.ExceptionReporter` subclasses can now set
  245. the :attr:`~django.views.debug.ExceptionReporter.html_template_path` and
  246. :attr:`~django.views.debug.ExceptionReporter.text_template_path` class
  247. attributes to override the templates used to render exception reports.
  248. File Storage
  249. ~~~~~~~~~~~~
  250. * ...
  251. File Uploads
  252. ~~~~~~~~~~~~
  253. * The new :meth:`FileUploadHandler.upload_interrupted()
  254. <django.core.files.uploadhandler.FileUploadHandler.upload_interrupted>`
  255. callback allows handling interrupted uploads.
  256. Forms
  257. ~~~~~
  258. * The new ``absolute_max`` argument for :func:`.formset_factory`,
  259. :func:`.inlineformset_factory`, and :func:`.modelformset_factory` allows
  260. customizing the maximum number of forms that can be instantiated when
  261. supplying ``POST`` data. See :ref:`formsets-absolute-max` for more details.
  262. * The new ``can_delete_extra`` argument for :func:`.formset_factory`,
  263. :func:`.inlineformset_factory`, and :func:`.modelformset_factory` allows
  264. removal of the option to delete extra forms. See
  265. :attr:`~.BaseFormSet.can_delete_extra` for more information.
  266. * :class:`~django.forms.formsets.BaseFormSet` now reports a user facing error,
  267. rather than raising an exception, when the management form is missing or has
  268. been tampered with. To customize this error message, pass the
  269. ``error_messages`` argument with the key ``'missing_management_form'`` when
  270. instantiating the formset.
  271. Generic Views
  272. ~~~~~~~~~~~~~
  273. * The ``week_format`` attributes of
  274. :class:`~django.views.generic.dates.WeekMixin` and
  275. :class:`~django.views.generic.dates.WeekArchiveView` now support the
  276. ``'%V'`` ISO 8601 week format.
  277. Internationalization
  278. ~~~~~~~~~~~~~~~~~~~~
  279. * ...
  280. Logging
  281. ~~~~~~~
  282. * ...
  283. Management Commands
  284. ~~~~~~~~~~~~~~~~~~~
  285. * :djadmin:`loaddata` now supports fixtures stored in XZ archives (``.xz``) and
  286. LZMA archives (``.lzma``).
  287. * :djadmin:`dumpdata` now can compress data in the ``bz2``, ``gz``, ``lzma``,
  288. or ``xz`` formats.
  289. * :djadmin:`makemigrations` can now be called without an active database
  290. connection. In that case, check for a consistent migration history is
  291. skipped.
  292. * :attr:`.BaseCommand.requires_system_checks` now supports specifying a list of
  293. tags. System checks registered in the chosen tags will be checked for errors
  294. prior to executing the command. In previous versions, either all or none
  295. of the system checks were performed.
  296. * Support for colored terminal output on Windows is updated. Various modern
  297. terminal environments are automatically detected, and the options for
  298. enabling support in other cases are improved. See :ref:`syntax-coloring` for
  299. more details.
  300. Migrations
  301. ~~~~~~~~~~
  302. * The new ``Operation.migration_name_fragment`` property allows providing a
  303. filename fragment that will be used to name a migration containing only that
  304. operation.
  305. * Migrations now support serialization of pure and concrete path objects from
  306. :mod:`pathlib`, and :class:`os.PathLike` instances.
  307. Models
  308. ~~~~~~
  309. * The new ``no_key`` parameter for :meth:`.QuerySet.select_for_update()`,
  310. supported on PostgreSQL, allows acquiring weaker locks that don't block the
  311. creation of rows that reference locked rows through a foreign key.
  312. * :class:`When() <django.db.models.expressions.When>` expression now allows
  313. using the ``condition`` argument with ``lookups``.
  314. * The new :attr:`.Index.include` and :attr:`.UniqueConstraint.include`
  315. attributes allow creating covering indexes and covering unique constraints on
  316. PostgreSQL 11+.
  317. * The new :attr:`.UniqueConstraint.opclasses` attribute allows setting
  318. PostgreSQL operator classes.
  319. * The :meth:`.QuerySet.update` method now respects the ``order_by()`` clause on
  320. MySQL and MariaDB.
  321. * :class:`FilteredRelation() <django.db.models.FilteredRelation>` now supports
  322. nested relations.
  323. * The ``of`` argument of :meth:`.QuerySet.select_for_update()` is now allowed
  324. on MySQL 8.0.1+.
  325. * :class:`Value() <django.db.models.Value>` expression now
  326. automatically resolves its ``output_field`` to the appropriate
  327. :class:`Field <django.db.models.Field>` subclass based on the type of
  328. its provided ``value`` for :py:class:`bool`, :py:class:`bytes`,
  329. :py:class:`float`, :py:class:`int`, :py:class:`str`,
  330. :py:class:`datetime.date`, :py:class:`datetime.datetime`,
  331. :py:class:`datetime.time`, :py:class:`datetime.timedelta`,
  332. :py:class:`decimal.Decimal`, and :py:class:`uuid.UUID` instances. As a
  333. consequence, resolving an ``output_field`` for database functions and
  334. combined expressions may now crash with mixed types when using ``Value()``.
  335. You will need to explicitly set the ``output_field`` in such cases.
  336. * The new :meth:`.QuerySet.alias` method allows creating reusable aliases for
  337. expressions that don't need to be selected but are used for filtering,
  338. ordering, or as a part of complex expressions.
  339. * The new :class:`~django.db.models.functions.Collate` function allows
  340. filtering and ordering by specified database collations.
  341. * The ``field_name`` argument of :meth:`.QuerySet.in_bulk()` now accepts
  342. distinct fields if there's only one field specified in
  343. :meth:`.QuerySet.distinct`.
  344. * The new ``tzinfo`` parameter of the
  345. :class:`~django.db.models.functions.TruncDate` and
  346. :class:`~django.db.models.functions.TruncTime` database functions allows
  347. truncating datetimes in a specific timezone.
  348. * The new ``db_collation`` argument for
  349. :attr:`CharField <django.db.models.CharField.db_collation>` and
  350. :attr:`TextField <django.db.models.TextField.db_collation>` allows setting a
  351. database collation for the field.
  352. * Added the :class:`~django.db.models.functions.Random` database function.
  353. * :ref:`aggregation-functions`, :class:`F() <django.db.models.F>`,
  354. :class:`OuterRef() <django.db.models.OuterRef>`, and other expressions now
  355. allow using transforms. See :ref:`using-transforms-in-expressions` for
  356. details.
  357. * The new ``durable`` argument for :func:`~django.db.transaction.atomic`
  358. guarantees that changes made in the atomic block will be committed if the
  359. block exits without errors. A nested atomic block marked as durable will
  360. raise a ``RuntimeError``.
  361. * Added the :class:`~django.db.models.functions.JSONObject` database function.
  362. Pagination
  363. ~~~~~~~~~~
  364. * The new :meth:`django.core.paginator.Paginator.get_elided_page_range` method
  365. allows generating a page range with some of the values elided. If there are a
  366. large number of pages, this can be helpful for generating a reasonable number
  367. of page links in a template.
  368. Requests and Responses
  369. ~~~~~~~~~~~~~~~~~~~~~~
  370. * Response headers are now stored in :attr:`.HttpResponse.headers`. This can be
  371. used instead of the original dict-like interface of ``HttpResponse`` objects.
  372. Both interfaces will continue to be supported. See
  373. :ref:`setting-header-fields` for details.
  374. * The new ``headers`` parameter of :class:`~django.http.HttpResponse`,
  375. :class:`~django.template.response.SimpleTemplateResponse`, and
  376. :class:`~django.template.response.TemplateResponse` allows setting response
  377. :attr:`~django.http.HttpResponse.headers` on instantiation.
  378. Security
  379. ~~~~~~~~
  380. * The :setting:`SECRET_KEY` setting is now checked for a valid value upon first
  381. access, rather than when settings are first loaded. This enables running
  382. management commands that do not rely on the ``SECRET_KEY`` without needing to
  383. provide a value. As a consequence of this, calling
  384. :func:`~django.conf.settings.configure` without providing a valid
  385. ``SECRET_KEY``, and then going on to access ``settings.SECRET_KEY`` will now
  386. raise an :exc:`~django.core.exceptions.ImproperlyConfigured` exception.
  387. * The new ``Signer.sign_object()`` and ``Signer.unsign_object()`` methods allow
  388. signing complex data structures. See :ref:`signing-complex-data` for more
  389. details.
  390. Also, :func:`signing.dumps() <django.core.signing.dumps>` and
  391. :func:`~django.core.signing.loads` become shortcuts for
  392. :meth:`.TimestampSigner.sign_object` and
  393. :meth:`~.TimestampSigner.unsign_object`.
  394. Serialization
  395. ~~~~~~~~~~~~~
  396. * The new :ref:`JSONL <serialization-formats-jsonl>` serializer allows using
  397. the JSON Lines format with :djadmin:`dumpdata` and :djadmin:`loaddata`. This
  398. can be useful for populating large databases because data is loaded line by
  399. line into memory, rather than being loaded all at once.
  400. Signals
  401. ~~~~~~~
  402. * :meth:`Signal.send_robust() <django.dispatch.Signal.send_robust>` now logs
  403. exceptions.
  404. Templates
  405. ~~~~~~~~~
  406. * :tfilter:`floatformat` template filter now allows using the ``g`` suffix to
  407. force grouping by the :setting:`THOUSAND_SEPARATOR` for the active locale.
  408. * Templates cached with :ref:`Cached template loaders<template-loaders>` are
  409. now correctly reloaded in development.
  410. Tests
  411. ~~~~~
  412. * Objects assigned to class attributes in :meth:`.TestCase.setUpTestData` are
  413. now isolated for each test method. Such objects are now required to support
  414. creating deep copies with :py:func:`copy.deepcopy`. Assigning objects which
  415. don't support ``deepcopy()`` is deprecated and will be removed in Django 4.1.
  416. * :class:`~django.test.runner.DiscoverRunner` now enables
  417. :py:mod:`faulthandler` by default. This can be disabled by using the
  418. :option:`test --no-faulthandler` option.
  419. * :class:`~django.test.runner.DiscoverRunner` and the
  420. :djadmin:`test` management command can now track timings, including database
  421. setup and total run time. This can be enabled by using the :option:`test
  422. --timing` option.
  423. * :class:`~django.test.Client` now preserves the request query string when
  424. following 307 and 308 redirects.
  425. * The new :meth:`.TestCase.captureOnCommitCallbacks` method captures callback
  426. functions passed to :func:`transaction.on_commit()
  427. <django.db.transaction.on_commit>` in a list. This allows you to test such
  428. callbacks without using the slower :class:`.TransactionTestCase`.
  429. * :meth:`.TransactionTestCase.assertQuerysetEqual` now supports direct
  430. comparison against another queryset rather than being restricted to
  431. comparison against a list of string representations of objects when using the
  432. default value for the ``transform`` argument.
  433. URLs
  434. ~~~~
  435. * ...
  436. Utilities
  437. ~~~~~~~~~
  438. * The new ``depth`` parameter of ``django.utils.timesince.timesince()`` and
  439. ``django.utils.timesince.timeuntil()`` functions allows specifying the number
  440. of adjacent time units to return.
  441. Validators
  442. ~~~~~~~~~~
  443. * Built-in validators now include the provided value in the ``params`` argument
  444. of a raised :exc:`~django.core.exceptions.ValidationError`. This allows
  445. custom error messages to use the ``%(value)s`` placeholder.
  446. * The :class:`.ValidationError` equality operator now ignores ``messages`` and
  447. ``params`` ordering.
  448. .. _backwards-incompatible-3.2:
  449. Backwards incompatible changes in 3.2
  450. =====================================
  451. Database backend API
  452. --------------------
  453. This section describes changes that may be needed in third-party database
  454. backends.
  455. * The new ``DatabaseFeatures.introspected_field_types`` property replaces these
  456. features:
  457. * ``can_introspect_autofield``
  458. * ``can_introspect_big_integer_field``
  459. * ``can_introspect_binary_field``
  460. * ``can_introspect_decimal_field``
  461. * ``can_introspect_duration_field``
  462. * ``can_introspect_ip_address_field``
  463. * ``can_introspect_positive_integer_field``
  464. * ``can_introspect_small_integer_field``
  465. * ``can_introspect_time_field``
  466. * ``introspected_big_auto_field_type``
  467. * ``introspected_small_auto_field_type``
  468. * ``introspected_boolean_field_type``
  469. * To enable support for covering indexes (:attr:`.Index.include`) and covering
  470. unique constraints (:attr:`.UniqueConstraint.include`), set
  471. ``DatabaseFeatures.supports_covering_indexes`` to ``True``.
  472. * Third-party database backends must implement support for column database
  473. collations on ``CharField``\s and ``TextField``\s or set
  474. ``DatabaseFeatures.supports_collation_on_charfield`` and
  475. ``DatabaseFeatures.supports_collation_on_textfield`` to ``False``. If
  476. non-deterministic collations are not supported, set
  477. ``supports_non_deterministic_collations`` to ``False``.
  478. * ``DatabaseOperations.random_function_sql()`` is removed in favor of the new
  479. :class:`~django.db.models.functions.Random` database function.
  480. * ``DatabaseOperations.date_trunc_sql()`` and
  481. ``DatabaseOperations.time_trunc_sql()`` now take the optional ``tzname``
  482. argument in order to truncate in a specific timezone.
  483. * ``DatabaseClient.runshell()`` now gets arguments and an optional dictionary
  484. with environment variables to the underlying command-line client from
  485. ``DatabaseClient.settings_to_cmd_args_env()`` method. Third-party database
  486. backends must implement ``DatabaseClient.settings_to_cmd_args_env()`` or
  487. override ``DatabaseClient.runshell()``.
  488. :mod:`django.contrib.admin`
  489. ---------------------------
  490. * Pagination links in the admin are now 1-indexed instead of 0-indexed, i.e.
  491. the query string for the first page is ``?p=1`` instead of ``?p=0``.
  492. * The new admin catch-all view will break URL patterns routed after the admin
  493. URLs and matching the admin URL prefix. You can either adjust your URL
  494. ordering or, if necessary, set :attr:`AdminSite.final_catch_all_view
  495. <django.contrib.admin.AdminSite.final_catch_all_view>` to ``False``,
  496. disabling the catch-all view. See :ref:`whats-new-3.2` for more details.
  497. :mod:`django.contrib.gis`
  498. -------------------------
  499. * Support for PostGIS 2.2 is removed.
  500. * The Oracle backend now clones polygons (and geometry collections containing
  501. polygons) before reorienting them and saving them to the database. They are
  502. no longer mutated in place. You might notice this if you use the polygons
  503. after a model is saved.
  504. Dropped support for PostgreSQL 9.5
  505. ----------------------------------
  506. Upstream support for PostgreSQL 9.5 ends in February 2021. Django 3.2 supports
  507. PostgreSQL 9.6 and higher.
  508. Dropped support for MySQL 5.6
  509. -----------------------------
  510. The end of upstream support for MySQL 5.6 is April 2021. Django 3.2 supports
  511. MySQL 5.7 and higher.
  512. Miscellaneous
  513. -------------
  514. * The undocumented ``SpatiaLiteOperations.proj4_version()`` method is renamed
  515. to ``proj_version()``.
  516. * Minified JavaScript files are no longer included with the admin. If you
  517. require these files to be minified, consider using a third party app or
  518. external build tool. The minified vendored JavaScript files packaged with the
  519. admin (e.g. :ref:`jquery.min.js <contrib-admin-jquery>`) are still included.
  520. * :attr:`.ModelAdmin.prepopulated_fields` no longer strips English stop words,
  521. such as ``'a'`` or ``'an'``.
  522. * :func:`~django.utils.text.slugify` now removes leading and trailing dashes
  523. and underscores.
  524. * The :tfilter:`intcomma` and :tfilter:`intword` template filters no longer
  525. depend on the :setting:`USE_L10N` setting.
  526. * Support for ``argon2-cffi`` < 19.1.0 is removed.
  527. * The cache keys no longer includes the language when internationalization is
  528. disabled (``USE_I18N = False``) and localization is enabled
  529. (``USE_L10N = True``). After upgrading to Django 3.2 in such configurations,
  530. the first request to any previously cached value will be a cache miss.
  531. * ``ForeignKey.validate()`` now uses
  532. :attr:`~django.db.models.Model._base_manager` rather than
  533. :attr:`~django.db.models.Model._default_manager` to check that related
  534. instances exist.
  535. * When an application defines an :class:`~django.apps.AppConfig` subclass in
  536. an ``apps.py`` submodule, Django now uses this configuration automatically,
  537. even if it isn't enabled with ``default_app_config``. Set ``default = False``
  538. in the :class:`~django.apps.AppConfig` subclass if you need to prevent this
  539. behavior. See :ref:`whats-new-3.2` for more details.
  540. * Instantiating an abstract model now raises ``TypeError``.
  541. * Keyword arguments to :func:`~django.test.utils.setup_databases` are now
  542. keyword-only.
  543. * The undocumented ``django.utils.http.limited_parse_qsl()`` function is
  544. removed. Please use :func:`urllib.parse.parse_qsl` instead.
  545. * ``django.test.utils.TestContextDecorator`` now uses
  546. :py:meth:`~unittest.TestCase.addCleanup` so that cleanups registered in the
  547. :py:meth:`~unittest.TestCase.setUp` method are called before
  548. ``TestContextDecorator.disable()``.
  549. * ``SessionMiddleware`` now raises a
  550. :exc:`~django.contrib.sessions.exceptions.SessionInterrupted` exception
  551. instead of :exc:`~django.core.exceptions.SuspiciousOperation` when a session
  552. is destroyed in a concurrent request.
  553. * The :class:`django.db.models.Field` equality operator now correctly
  554. distinguishes inherited field instances across models. Additionally, the
  555. ordering of such fields is now defined.
  556. * The undocumented ``django.core.files.locks.lock()`` function now returns
  557. ``False`` if the file cannot be locked, instead of raising
  558. :exc:`BlockingIOError`.
  559. * The password reset mechanism now invalidates tokens when the user email is
  560. changed.
  561. * :djadmin:`makemessages` command no longer processes invalid locales specified
  562. using :option:`makemessages --locale` option, when they contain hyphens
  563. (``'-'``).
  564. * The ``django.contrib.auth.forms.ReadOnlyPasswordHashField`` form field is now
  565. :attr:`~django.forms.Field.disabled` by default. Therefore
  566. ``UserChangeForm.clean_password()`` is no longer required to return the
  567. initial value.
  568. * The ``cache.get_many()``, ``get_or_set()``, ``has_key()``, ``incr()``,
  569. ``decr()``, ``incr_version()``, and ``decr_version()`` cache operations now
  570. correctly handle ``None`` stored in the cache, in the same way as any other
  571. value, instead of behaving as though the key didn't exist.
  572. Due to a ``python-memcached`` limitation, the previous behavior is kept for
  573. the deprecated ``MemcachedCache`` backend.
  574. * The minimum supported version of SQLite is increased from 3.8.3 to 3.9.0.
  575. * :class:`~django.contrib.messages.storage.cookie.CookieStorage` now stores
  576. messages in the :rfc:`6265` compliant format. Support for cookies that use
  577. the old format remains until Django 4.1.
  578. .. _deprecated-features-3.2:
  579. Features deprecated in 3.2
  580. ==========================
  581. Miscellaneous
  582. -------------
  583. * Assigning objects which don't support creating deep copies with
  584. :py:func:`copy.deepcopy` to class attributes in
  585. :meth:`.TestCase.setUpTestData` is deprecated.
  586. * Using a boolean value in :attr:`.BaseCommand.requires_system_checks` is
  587. deprecated. Use ``'__all__'`` instead of ``True``, and ``[]`` (an empty list)
  588. instead of ``False``.
  589. * The ``whitelist`` argument and ``domain_whitelist`` attribute of
  590. :class:`~django.core.validators.EmailValidator` are deprecated. Use
  591. ``allowlist`` instead of ``whitelist``, and ``domain_allowlist`` instead of
  592. ``domain_whitelist``. You may need to rename ``whitelist`` in existing
  593. migrations.
  594. * The ``default_app_config`` application configuration variable is deprecated,
  595. due to the now automatic ``AppConfig`` discovery. See :ref:`whats-new-3.2`
  596. for more details.
  597. * Automatically calling ``repr()`` on a queryset in
  598. ``TransactionTestCase.assertQuerysetEqual()``, when compared to string
  599. values, is deprecated. If you need the previous behavior, explicitly set
  600. ``transform`` to ``repr``.
  601. * The ``django.core.cache.backends.memcached.MemcachedCache`` backend is
  602. deprecated as ``python-memcached`` has some problems and seems to be
  603. unmaintained. Use ``django.core.cache.backends.memcached.PyMemcacheCache``
  604. or ``django.core.cache.backends.memcached.PyLibMCCache`` instead.
  605. * The format of messages used by
  606. ``django.contrib.messages.storage.cookie.CookieStorage`` is different from
  607. the format generated by older versions of Django. Support for the old format
  608. remains until Django 4.1.