1
0
mirror of https://github.com/django/django.git synced 2025-10-26 15:16:09 +00:00

Documented utils.html.escape and conditional_escape

This commit is contained in:
Luke Plant
2012-06-30 16:41:51 +01:00
parent cf731a543e
commit f33e150369
2 changed files with 29 additions and 7 deletions

View File

@@ -31,11 +31,11 @@ hard_coded_bullets_re = re.compile(r'((?:<p>(?:%s).*?[a-zA-Z].*?</p>\s*)+)' % '|
trailing_empty_content_re = re.compile(r'(?:<p>(?:&nbsp;|\s|<br \/>)*?</p>\s*)+\Z')
del x # Temporary variable
def escape(html):
def escape(text):
"""
Returns the given HTML with ampersands, quotes and angle brackets encoded.
Returns the given text with ampersands, quotes and angle brackets encoded for use in HTML.
"""
return mark_safe(force_unicode(html).replace('&', '&amp;').replace('<', '&lt;').replace('>', '&gt;').replace('"', '&quot;').replace("'", '&#39;'))
return mark_safe(force_unicode(text).replace('&', '&amp;').replace('<', '&lt;').replace('>', '&gt;').replace('"', '&quot;').replace("'", '&#39;'))
escape = allow_lazy(escape, unicode)
_base_js_escapes = (
@@ -63,14 +63,14 @@ def escapejs(value):
return value
escapejs = allow_lazy(escapejs, unicode)
def conditional_escape(html):
def conditional_escape(text):
"""
Similar to escape(), except that it doesn't operate on pre-escaped strings.
"""
if isinstance(html, SafeData):
return html
if isinstance(text, SafeData):
return text
else:
return escape(html)
return escape(text)
def linebreaks(value, autoescape=False):
"""Converts newlines into <p> and <br />s."""