diff options
Diffstat (limited to 'django/utils')
| -rw-r--r-- | django/utils/html.py | 7 | ||||
| -rw-r--r-- | django/utils/safestring.py | 8 |
2 files changed, 11 insertions, 4 deletions
diff --git a/django/utils/html.py b/django/utils/html.py index 3c03210c11..a596662d22 100644 --- a/django/utils/html.py +++ b/django/utils/html.py @@ -44,6 +44,10 @@ def escape(text): """ Returns the given text with ampersands, quotes and angle brackets encoded for use in HTML. + + This function always escapes its input, even if it's already escaped and + marked as such. This may result in double-escaping. If this is a concern, + use conditional_escape() instead. """ return mark_safe(force_text(text).replace('&', '&').replace('<', '<') .replace('>', '>').replace('"', '"').replace("'", ''')) @@ -76,6 +80,9 @@ escapejs = allow_lazy(escapejs, six.text_type, SafeText) def conditional_escape(text): """ Similar to escape(), except that it doesn't operate on pre-escaped strings. + + This function relies on the __html__ convention used both by Django's + SafeData class and by third-party libraries like markupsafe. """ if hasattr(text, '__html__'): return text.__html__() diff --git a/django/utils/safestring.py b/django/utils/safestring.py index 50b0c03686..ab4d8149c9 100644 --- a/django/utils/safestring.py +++ b/django/utils/safestring.py @@ -36,9 +36,9 @@ else: class SafeData(object): def __html__(self): """ - Returns the html representation of a string. + Returns the html representation of a string for interoperability. - Allows interoperability with other template engines. + This allows other template engines to understand Django's SafeData. """ return self @@ -121,7 +121,7 @@ def mark_safe(s): Can be called multiple times on a single string. """ - if isinstance(s, SafeData): + if hasattr(s, '__html__'): return s if isinstance(s, bytes) or (isinstance(s, Promise) and s._delegate_bytes): return SafeBytes(s) @@ -138,7 +138,7 @@ def mark_for_escaping(s): Can be called multiple times on a single string (the resulting escaping is only applied once). """ - if isinstance(s, (SafeData, EscapeData)): + if hasattr(s, '__html__') or isinstance(s, EscapeData): return s if isinstance(s, bytes) or (isinstance(s, Promise) and s._delegate_bytes): return EscapeBytes(s) |