3.2.txt 31 KB

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