diff options
| author | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2023-11-28 20:04:21 +0100 |
|---|---|---|
| committer | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2023-11-28 20:08:10 +0100 |
| commit | 92af3d4d235448446e53e982275315bedcc4c204 (patch) | |
| tree | b0859a9cdebea2a3c6c242a55dfb333ba5cba4b4 /docs | |
| parent | 432bfa26151f1330dddf1635358a3b60a5947b9f (diff) | |
[5.0.x] Refs #34380 -- Added FORMS_URLFIELD_ASSUME_HTTPS transitional setting.
This allows early adoption of the new default "https".
Backport of a4931cd75a1780923b02e43475ba5447df3adb31 from main.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/internals/deprecation.txt | 2 | ||||
| -rw-r--r-- | docs/ref/forms/fields.txt | 4 | ||||
| -rw-r--r-- | docs/ref/settings.txt | 15 | ||||
| -rw-r--r-- | docs/releases/5.0.txt | 6 |
4 files changed, 25 insertions, 2 deletions
diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index 632c1e219d..38ce061db8 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -53,6 +53,8 @@ details on these changes. * ``get_prefetcher()`` and ``prefetch_related_objects()`` will no longer fallback to ``get_prefetch_queryset()``. +* The ``FORMS_URLFIELD_ASSUME_HTTPS`` transitional setting will be removed. + .. _deprecation-removed-in-5.1: 5.1 diff --git a/docs/ref/forms/fields.txt b/docs/ref/forms/fields.txt index 6eca7234fc..9ccd69823a 100644 --- a/docs/ref/forms/fields.txt +++ b/docs/ref/forms/fields.txt @@ -1154,7 +1154,9 @@ For each field, we describe the default widget used if you don't specify .. deprecated:: 5.0 The default value for ``assume_scheme`` will change from ``"http"`` to - ``"https"`` in Django 6.0. + ``"https"`` in Django 6.0. Set :setting:`FORMS_URLFIELD_ASSUME_HTTPS` + transitional setting to ``True`` to opt into using ``"https"`` during + the Django 5.x release cycle. ``UUIDField`` ------------- diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt index f81314f1ff..28d72e356e 100644 --- a/docs/ref/settings.txt +++ b/docs/ref/settings.txt @@ -1693,6 +1693,20 @@ renderers are: * ``'``:class:`django.forms.renderers.Jinja2`\ ``'`` * ``'``:class:`django.forms.renderers.TemplatesSetting`\ ``'`` +.. setting:: FORMS_URLFIELD_ASSUME_HTTPS + +``FORMS_URLFIELD_ASSUME_HTTPS`` +------------------------------- + +.. versionadded:: 5.0 +.. deprecated:: 5.0 + +Default: ``False`` + +Set this transitional setting to ``True`` to opt into using ``"https"`` as the +new default value of :attr:`URLField.assume_scheme +<django.forms.URLField.assume_scheme>` during the Django 5.x release cycle. + .. setting:: FORMAT_MODULE_PATH ``FORMAT_MODULE_PATH`` @@ -3677,6 +3691,7 @@ File uploads Forms ----- * :setting:`FORM_RENDERER` +* :setting:`FORMS_URLFIELD_ASSUME_HTTPS` Globalization (``i18n``/``l10n``) --------------------------------- diff --git a/docs/releases/5.0.txt b/docs/releases/5.0.txt index b74a0f00c7..ebddec38e6 100644 --- a/docs/releases/5.0.txt +++ b/docs/releases/5.0.txt @@ -612,7 +612,11 @@ Miscellaneous * The ``ForeignObject.get_reverse_joining_columns()`` method is deprecated. * The default scheme for ``forms.URLField`` will change from ``"http"`` to - ``"https"`` in Django 6.0. + ``"https"`` in Django 6.0. Set :setting:`FORMS_URLFIELD_ASSUME_HTTPS` + transitional setting to ``True`` to opt into assuming ``"https"`` during the + Django 5.x release cycle. + +* ``FORMS_URLFIELD_ASSUME_HTTPS`` transitional setting is deprecated. * Support for calling ``format_html()`` without passing args or kwargs will be removed. |