1
0
mirror of https://github.com/django/django.git synced 2025-01-03 06:55:47 +00:00

Fixed #34609 -- Deprecated calling format_html() without arguments.

This commit is contained in:
devilsautumn 2023-06-06 14:26:53 +05:30 committed by Mariusz Felisiak
parent 4f6a51dfe6
commit 094b0bea2c
5 changed files with 30 additions and 0 deletions

View File

@ -3,9 +3,11 @@
import html
import json
import re
import warnings
from html.parser import HTMLParser
from urllib.parse import parse_qsl, quote, unquote, urlencode, urlsplit, urlunsplit
from django.utils.deprecation import RemovedInDjango60Warning
from django.utils.encoding import punycode
from django.utils.functional import Promise, keep_lazy, keep_lazy_text
from django.utils.http import RFC3986_GENDELIMS, RFC3986_SUBDELIMS
@ -100,6 +102,13 @@ def format_html(format_string, *args, **kwargs):
and call mark_safe() on the result. This function should be used instead
of str.format or % interpolation to build up small HTML fragments.
"""
if not (args or kwargs):
# RemovedInDjango60Warning: when the deprecation ends, replace with:
# raise ValueError("args or kwargs must be provided.")
warnings.warn(
"Calling format_html() without passing args or kwargs is deprecated.",
RemovedInDjango60Warning,
)
args_safe = map(conditional_escape, args)
kwargs_safe = {k: conditional_escape(v) for (k, v) in kwargs.items()}
return mark_safe(format_string.format(*args_safe, **kwargs_safe))

View File

@ -35,6 +35,9 @@ details on these changes.
* The default scheme for ``forms.URLField`` will change from ``"http"`` to
``"https"``.
* Support for calling ``format_html()`` without passing args or kwargs will be
removed.
.. _deprecation-removed-in-5.1:
5.1

View File

@ -651,6 +651,11 @@ escaping HTML.
through :func:`conditional_escape` which (ultimately) calls
:func:`~django.utils.encoding.force_str` on the values.
.. deprecated:: 5.0
Support for calling ``format_html()`` without passing args or kwargs is
deprecated.
.. function:: format_html_join(sep, format_string, args_generator)
A wrapper of :func:`format_html`, for the common case of a group of

View File

@ -454,6 +454,9 @@ Miscellaneous
* The default scheme for ``forms.URLField`` will change from ``"http"`` to
``"https"`` in Django 6.0.
* Support for calling ``format_html()`` without passing args or kwargs will be
removed.
Features removed in 5.0
=======================

View File

@ -3,6 +3,7 @@ from datetime import datetime
from django.core.serializers.json import DjangoJSONEncoder
from django.test import SimpleTestCase
from django.utils.deprecation import RemovedInDjango60Warning
from django.utils.functional import lazystr
from django.utils.html import (
conditional_escape,
@ -65,6 +66,15 @@ class TestUtilsHtml(SimpleTestCase):
"&lt; Dangerous &gt; <b>safe</b> &lt; dangerous again <i>safe again</i>",
)
def test_format_html_no_params(self):
msg = "Calling format_html() without passing args or kwargs is deprecated."
# RemovedInDjango60Warning: when the deprecation ends, replace with:
# msg = "args or kwargs must be provided."
# with self.assertRaisesMessage(ValueError, msg):
with self.assertWarnsMessage(RemovedInDjango60Warning, msg):
name = "Adam"
self.assertEqual(format_html(f"<i>{name}</i>"), "<i>Adam</i>")
def test_linebreaks(self):
items = (
("para1\n\npara2\r\rpara3", "<p>para1</p>\n\n<p>para2</p>\n\n<p>para3</p>"),