<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>django.utils.html — Django 1.8.19 documentation</title>
<link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '1.8.19',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="top" title="Django 1.8.19 documentation" href="../../../contents.html" />
<link rel="up" title="django" href="../../django.html" />
<script type="text/javascript" src="../../../templatebuiltins.js"></script>
<script type="text/javascript">
(function($) {
if (!django_template_builtins) {
// templatebuiltins.js missing, do nothing.
return;
}
$(document).ready(function() {
// Hyperlink Django template tags and filters
var base = "../../../ref/templates/builtins.html";
if (base == "#") {
// Special case for builtins.html itself
base = "";
}
// Tags are keywords, class '.k'
$("div.highlight\\-html\\+django span.k").each(function(i, elem) {
var tagname = $(elem).text();
if ($.inArray(tagname, django_template_builtins.ttags) != -1) {
var fragment = tagname.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + tagname + "</a>");
}
});
// Filters are functions, class '.nf'
$("div.highlight\\-html\\+django span.nf").each(function(i, elem) {
var filtername = $(elem).text();
if ($.inArray(filtername, django_template_builtins.tfilters) != -1) {
var fragment = filtername.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + filtername + "</a>");
}
});
});
})(jQuery);
</script>
</head>
<body role="document">
<div class="document">
<div id="custom-doc" class="yui-t6">
<div id="hd">
<h1><a href="../../../index.html">Django 1.8.19 documentation</a></h1>
<div id="global-nav">
<a title="Home page" href="../../../index.html">Home</a> |
<a title="Table of contents" href="../../../contents.html">Table of contents</a> |
<a title="Global index" href="../../../genindex.html">Index</a> |
<a title="Module index" href="../../../py-modindex.html">Modules</a>
</div>
<div class="nav">
<a href="../../index.html" title="Module code" accesskey="U">up</a></div>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<div class="yui-g" id="_modules-django-utils-html">
<h1>Source code for django.utils.html</h1><div class="highlight"><pre>
<span></span><span class="sd">"""HTML utilities suitable for global use."""</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">unicode_literals</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">warnings</span>
<span class="kn">from</span> <span class="nn">django.utils</span> <span class="k">import</span> <span class="n">six</span>
<span class="kn">from</span> <span class="nn">django.utils.deprecation</span> <span class="k">import</span> <span class="n">RemovedInDjango110Warning</span>
<span class="kn">from</span> <span class="nn">django.utils.encoding</span> <span class="k">import</span> <span class="n">force_str</span><span class="p">,</span> <span class="n">force_text</span>
<span class="kn">from</span> <span class="nn">django.utils.functional</span> <span class="k">import</span> <span class="n">allow_lazy</span>
<span class="kn">from</span> <span class="nn">django.utils.http</span> <span class="k">import</span> <span class="n">RFC3986_GENDELIMS</span><span class="p">,</span> <span class="n">RFC3986_SUBDELIMS</span>
<span class="kn">from</span> <span class="nn">django.utils.safestring</span> <span class="k">import</span> <span class="n">SafeData</span><span class="p">,</span> <span class="n">SafeText</span><span class="p">,</span> <span class="n">mark_safe</span>
<span class="kn">from</span> <span class="nn">django.utils.six.moves.urllib.parse</span> <span class="k">import</span> <span class="p">(</span>
<span class="n">parse_qsl</span><span class="p">,</span> <span class="n">quote</span><span class="p">,</span> <span class="n">unquote</span><span class="p">,</span> <span class="n">urlencode</span><span class="p">,</span> <span class="n">urlsplit</span><span class="p">,</span> <span class="n">urlunsplit</span><span class="p">,</span>
<span class="p">)</span>
<span class="kn">from</span> <span class="nn">django.utils.text</span> <span class="k">import</span> <span class="n">normalize_newlines</span>
<span class="kn">from</span> <span class="nn">.html_parser</span> <span class="k">import</span> <span class="n">HTMLParseError</span><span class="p">,</span> <span class="n">HTMLParser</span>
<span class="c1"># Configuration for urlize() function.</span>
<span class="n">TRAILING_PUNCTUATION</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'.'</span><span class="p">,</span> <span class="s1">','</span><span class="p">,</span> <span class="s1">':'</span><span class="p">,</span> <span class="s1">';'</span><span class="p">,</span> <span class="s1">'.)'</span><span class="p">,</span> <span class="s1">'"'</span><span class="p">,</span> <span class="s1">'</span><span class="se">\'</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'!'</span><span class="p">]</span>
<span class="n">WRAPPING_PUNCTUATION</span> <span class="o">=</span> <span class="p">[(</span><span class="s1">'('</span><span class="p">,</span> <span class="s1">')'</span><span class="p">),</span> <span class="p">(</span><span class="s1">'<'</span><span class="p">,</span> <span class="s1">'>'</span><span class="p">),</span> <span class="p">(</span><span class="s1">'['</span><span class="p">,</span> <span class="s1">']'</span><span class="p">),</span> <span class="p">(</span><span class="s1">'&lt;'</span><span class="p">,</span> <span class="s1">'&gt;'</span><span class="p">),</span> <span class="p">(</span><span class="s1">'"'</span><span class="p">,</span> <span class="s1">'"'</span><span class="p">),</span> <span class="p">(</span><span class="s1">'</span><span class="se">\'</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'</span><span class="se">\'</span><span class="s1">'</span><span class="p">)]</span>
<span class="c1"># List of possible strings used for bullets in bulleted lists.</span>
<span class="n">DOTS</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'&middot;'</span><span class="p">,</span> <span class="s1">'*'</span><span class="p">,</span> <span class="s1">'</span><span class="se">\u2022</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'&#149;'</span><span class="p">,</span> <span class="s1">'&bull;'</span><span class="p">,</span> <span class="s1">'&#8226;'</span><span class="p">]</span>
<span class="n">unencoded_ampersands_re</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s1">r'&(?!(\w+|#\d+);)'</span><span class="p">)</span>
<span class="n">word_split_re</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s1">r'(\s+)'</span><span class="p">)</span>
<span class="n">simple_url_re</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s1">r'^https?://\[?\w'</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">IGNORECASE</span><span class="p">)</span>
<span class="n">simple_url_2_re</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s1">r'^www\.|^(?!http)\w[^@]+\.(com|edu|gov|int|mil|net|org)($|/.*)$'</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">IGNORECASE</span><span class="p">)</span>
<span class="n">link_target_attribute_re</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s1">r'(<a [^>]*?)target=[^\s>]+'</span><span class="p">)</span>
<span class="n">html_gunk_re</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span>
<span class="s1">r'(?:<br clear="all">|<i><\/i>|<b><\/b>|<em><\/em>|<strong><\/strong>|'</span>
<span class="s1">'<\/?smallcaps>|<\/?uppercase>)'</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">IGNORECASE</span><span class="p">)</span>
<span class="n">hard_coded_bullets_re</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span>
<span class="s1">r'((?:<p>(?:</span><span class="si">%s</span><span class="s1">).*?[a-zA-Z].*?</p>\s*)+)'</span> <span class="o">%</span> <span class="s1">'|'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">re</span><span class="o">.</span><span class="n">escape</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">DOTS</span><span class="p">),</span> <span class="n">re</span><span class="o">.</span><span class="n">DOTALL</span><span class="p">)</span>
<span class="n">trailing_empty_content_re</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s1">r'(?:<p>(?:&nbsp;|\s|<br \/>)*?</p>\s*)+\Z'</span><span class="p">)</span>
<div class="viewcode-block" id="escape"><a class="viewcode-back" href="../../../ref/utils.html#django.utils.html.escape">[docs]</a><span class="k">def</span> <span class="nf">escape</span><span class="p">(</span><span class="n">text</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns the given text with ampersands, quotes and angle brackets encoded</span>
<span class="sd"> for use in HTML.</span>
<span class="sd"> This function always escapes its input, even if it's already escaped and</span>
<span class="sd"> marked as such. This may result in double-escaping. If this is a concern,</span>
<span class="sd"> use conditional_escape() instead.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">mark_safe</span><span class="p">(</span><span class="n">force_text</span><span class="p">(</span><span class="n">text</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'&'</span><span class="p">,</span> <span class="s1">'&amp;'</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'<'</span><span class="p">,</span> <span class="s1">'&lt;'</span><span class="p">)</span>
<span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'>'</span><span class="p">,</span> <span class="s1">'&gt;'</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'"'</span><span class="p">,</span> <span class="s1">'&quot;'</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"'"</span><span class="p">,</span> <span class="s1">'&#39;'</span><span class="p">))</span></div>
<span class="n">escape</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">escape</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">text_type</span><span class="p">,</span> <span class="n">SafeText</span><span class="p">)</span>
<span class="n">_js_escapes</span> <span class="o">=</span> <span class="p">{</span>
<span class="nb">ord</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">):</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">u005C'</span><span class="p">,</span>
<span class="nb">ord</span><span class="p">(</span><span class="s1">'</span><span class="se">\'</span><span class="s1">'</span><span class="p">):</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">u0027'</span><span class="p">,</span>
<span class="nb">ord</span><span class="p">(</span><span class="s1">'"'</span><span class="p">):</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">u0022'</span><span class="p">,</span>
<span class="nb">ord</span><span class="p">(</span><span class="s1">'>'</span><span class="p">):</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">u003E'</span><span class="p">,</span>
<span class="nb">ord</span><span class="p">(</span><span class="s1">'<'</span><span class="p">):</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">u003C'</span><span class="p">,</span>
<span class="nb">ord</span><span class="p">(</span><span class="s1">'&'</span><span class="p">):</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">u0026'</span><span class="p">,</span>
<span class="nb">ord</span><span class="p">(</span><span class="s1">'='</span><span class="p">):</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">u003D'</span><span class="p">,</span>
<span class="nb">ord</span><span class="p">(</span><span class="s1">'-'</span><span class="p">):</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">u002D'</span><span class="p">,</span>
<span class="nb">ord</span><span class="p">(</span><span class="s1">';'</span><span class="p">):</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">u003B'</span><span class="p">,</span>
<span class="nb">ord</span><span class="p">(</span><span class="s1">'</span><span class="se">\u2028</span><span class="s1">'</span><span class="p">):</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">u2028'</span><span class="p">,</span>
<span class="nb">ord</span><span class="p">(</span><span class="s1">'</span><span class="se">\u2029</span><span class="s1">'</span><span class="p">):</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">u2029'</span>
<span class="p">}</span>
<span class="c1"># Escape every ASCII character with a value less than 32.</span>
<span class="n">_js_escapes</span><span class="o">.</span><span class="n">update</span><span class="p">((</span><span class="nb">ord</span><span class="p">(</span><span class="s1">'</span><span class="si">%c</span><span class="s1">'</span> <span class="o">%</span> <span class="n">z</span><span class="p">),</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">u</span><span class="si">%04X</span><span class="s1">'</span> <span class="o">%</span> <span class="n">z</span><span class="p">)</span> <span class="k">for</span> <span class="n">z</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">32</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">escapejs</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="sd">"""Hex encodes characters for use in JavaScript strings."""</span>
<span class="k">return</span> <span class="n">mark_safe</span><span class="p">(</span><span class="n">force_text</span><span class="p">(</span><span class="n">value</span><span class="p">)</span><span class="o">.</span><span class="n">translate</span><span class="p">(</span><span class="n">_js_escapes</span><span class="p">))</span>
<span class="n">escapejs</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">escapejs</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">text_type</span><span class="p">,</span> <span class="n">SafeText</span><span class="p">)</span>
<div class="viewcode-block" id="conditional_escape"><a class="viewcode-back" href="../../../ref/utils.html#django.utils.html.conditional_escape">[docs]</a><span class="k">def</span> <span class="nf">conditional_escape</span><span class="p">(</span><span class="n">text</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Similar to escape(), except that it doesn't operate on pre-escaped strings.</span>
<span class="sd"> This function relies on the __html__ convention used both by Django's</span>
<span class="sd"> SafeData class and by third-party libraries like markupsafe.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="s1">'__html__'</span><span class="p">):</span>
<span class="k">return</span> <span class="n">text</span><span class="o">.</span><span class="n">__html__</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">escape</span><span class="p">(</span><span class="n">text</span><span class="p">)</span></div>
<div class="viewcode-block" id="format_html"><a class="viewcode-back" href="../../../ref/utils.html#django.utils.html.format_html">[docs]</a><span class="k">def</span> <span class="nf">format_html</span><span class="p">(</span><span class="n">format_string</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Similar to str.format, but passes all arguments through conditional_escape,</span>
<span class="sd"> and calls 'mark_safe' on the result. This function should be used instead</span>
<span class="sd"> of str.format or % interpolation to build up small HTML fragments.</span>
<span class="sd"> """</span>
<span class="n">args_safe</span> <span class="o">=</span> <span class="nb">map</span><span class="p">(</span><span class="n">conditional_escape</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
<span class="n">kwargs_safe</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="n">conditional_escape</span><span class="p">(</span><span class="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span> <span class="ow">in</span> <span class="n">six</span><span class="o">.</span><span class="n">iteritems</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)}</span>
<span class="k">return</span> <span class="n">mark_safe</span><span class="p">(</span><span class="n">format_string</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">*</span><span class="n">args_safe</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs_safe</span><span class="p">))</span></div>
<div class="viewcode-block" id="format_html_join"><a class="viewcode-back" href="../../../ref/utils.html#django.utils.html.format_html_join">[docs]</a><span class="k">def</span> <span class="nf">format_html_join</span><span class="p">(</span><span class="n">sep</span><span class="p">,</span> <span class="n">format_string</span><span class="p">,</span> <span class="n">args_generator</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A wrapper of format_html, for the common case of a group of arguments that</span>
<span class="sd"> need to be formatted using the same format string, and then joined using</span>
<span class="sd"> 'sep'. 'sep' is also passed through conditional_escape.</span>
<span class="sd"> 'args_generator' should be an iterator that returns the sequence of 'args'</span>
<span class="sd"> that will be passed to format_html.</span>
<span class="sd"> Example:</span>
<span class="sd"> format_html_join('\n', "<li>{} {}</li>", ((u.first_name, u.last_name)</span>
<span class="sd"> for u in users))</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">mark_safe</span><span class="p">(</span><span class="n">conditional_escape</span><span class="p">(</span><span class="n">sep</span><span class="p">)</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
<span class="n">format_html</span><span class="p">(</span><span class="n">format_string</span><span class="p">,</span> <span class="o">*</span><span class="nb">tuple</span><span class="p">(</span><span class="n">args</span><span class="p">))</span>
<span class="k">for</span> <span class="n">args</span> <span class="ow">in</span> <span class="n">args_generator</span><span class="p">))</span></div>
<span class="k">def</span> <span class="nf">linebreaks</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">autoescape</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""Converts newlines into <p> and <br />s."""</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">normalize_newlines</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="n">paras</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">{2,}'</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="k">if</span> <span class="n">autoescape</span><span class="p">:</span>
<span class="n">paras</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'<p></span><span class="si">%s</span><span class="s1"></p>'</span> <span class="o">%</span> <span class="n">escape</span><span class="p">(</span><span class="n">p</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'<br />'</span><span class="p">)</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">paras</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">paras</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'<p></span><span class="si">%s</span><span class="s1"></p>'</span> <span class="o">%</span> <span class="n">p</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'<br />'</span><span class="p">)</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">paras</span><span class="p">]</span>
<span class="k">return</span> <span class="s1">'</span><span class="se">\n\n</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">paras</span><span class="p">)</span>
<span class="n">linebreaks</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">linebreaks</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">text_type</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">MLStripper</span><span class="p">(</span><span class="n">HTMLParser</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># The strict parameter was added in Python 3.2 with a default of True.</span>
<span class="c1"># The default changed to False in Python 3.3 and was deprecated.</span>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[:</span><span class="mi">2</span><span class="p">]</span> <span class="o">==</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">2</span><span class="p">):</span>
<span class="n">HTMLParser</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">strict</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">HTMLParser</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fed</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">def</span> <span class="nf">handle_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">d</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fed</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">d</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">handle_entityref</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fed</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'&</span><span class="si">%s</span><span class="s1">;'</span> <span class="o">%</span> <span class="n">name</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">handle_charref</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fed</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'&#</span><span class="si">%s</span><span class="s1">;'</span> <span class="o">%</span> <span class="n">name</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">get_data</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">fed</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_strip_once</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Internal tag stripping utility used by strip_tags.</span>
<span class="sd"> """</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">MLStripper</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">s</span><span class="o">.</span><span class="n">feed</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">except</span> <span class="n">HTMLParseError</span><span class="p">:</span>
<span class="k">return</span> <span class="n">value</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">s</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">except</span> <span class="p">(</span><span class="n">HTMLParseError</span><span class="p">,</span> <span class="ne">UnboundLocalError</span><span class="p">):</span>
<span class="c1"># UnboundLocalError because of http://bugs.python.org/issue17802</span>
<span class="c1"># on Python 3.2, triggered by strict=False mode of HTMLParser</span>
<span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">get_data</span><span class="p">()</span> <span class="o">+</span> <span class="n">s</span><span class="o">.</span><span class="n">rawdata</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">get_data</span><span class="p">()</span>
<div class="viewcode-block" id="strip_tags"><a class="viewcode-back" href="../../../ref/utils.html#django.utils.html.strip_tags">[docs]</a><span class="k">def</span> <span class="nf">strip_tags</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="sd">"""Returns the given HTML with all tags stripped."""</span>
<span class="c1"># Note: in typical case this loop executes _strip_once once. Loop condition</span>
<span class="c1"># is redundant, but helps to reduce number of executions of _strip_once.</span>
<span class="k">while</span> <span class="s1">'<'</span> <span class="ow">in</span> <span class="n">value</span> <span class="ow">and</span> <span class="s1">'>'</span> <span class="ow">in</span> <span class="n">value</span><span class="p">:</span>
<span class="n">new_value</span> <span class="o">=</span> <span class="n">_strip_once</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">new_value</span><span class="p">)</span> <span class="o">>=</span> <span class="nb">len</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="c1"># _strip_once was not able to detect more tags or length increased</span>
<span class="c1"># due to http://bugs.python.org/issue20288</span>
<span class="c1"># (affects Python 2 < 2.7.7 and Python 3 < 3.3.5)</span>
<span class="k">break</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">new_value</span>
<span class="k">return</span> <span class="n">value</span></div>
<span class="n">strip_tags</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">strip_tags</span><span class="p">)</span>
<div class="viewcode-block" id="remove_tags"><a class="viewcode-back" href="../../../ref/utils.html#django.utils.html.remove_tags">[docs]</a><span class="k">def</span> <span class="nf">remove_tags</span><span class="p">(</span><span class="n">html</span><span class="p">,</span> <span class="n">tags</span><span class="p">):</span>
<span class="sd">"""Returns the given HTML with given tags removed."""</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
<span class="s2">"django.utils.html.remove_tags() and the removetags template filter "</span>
<span class="s2">"are deprecated. Consider using the bleach library instead."</span><span class="p">,</span>
<span class="n">RemovedInDjango110Warning</span><span class="p">,</span> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">3</span>
<span class="p">)</span>
<span class="n">tags</span> <span class="o">=</span> <span class="p">[</span><span class="n">re</span><span class="o">.</span><span class="n">escape</span><span class="p">(</span><span class="n">tag</span><span class="p">)</span> <span class="k">for</span> <span class="n">tag</span> <span class="ow">in</span> <span class="n">tags</span><span class="o">.</span><span class="n">split</span><span class="p">()]</span>
<span class="n">tags_re</span> <span class="o">=</span> <span class="s1">'(</span><span class="si">%s</span><span class="s1">)'</span> <span class="o">%</span> <span class="s1">'|'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">tags</span><span class="p">)</span>
<span class="n">starttag_re</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s1">r'<</span><span class="si">%s</span><span class="s1">(/?>|(\s+[^>]*>))'</span> <span class="o">%</span> <span class="n">tags_re</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">U</span><span class="p">)</span>
<span class="n">endtag_re</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s1">'</</span><span class="si">%s</span><span class="s1">>'</span> <span class="o">%</span> <span class="n">tags_re</span><span class="p">)</span>
<span class="n">html</span> <span class="o">=</span> <span class="n">starttag_re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s1">''</span><span class="p">,</span> <span class="n">html</span><span class="p">)</span>
<span class="n">html</span> <span class="o">=</span> <span class="n">endtag_re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s1">''</span><span class="p">,</span> <span class="n">html</span><span class="p">)</span>
<span class="k">return</span> <span class="n">html</span></div>
<span class="n">remove_tags</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">remove_tags</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">text_type</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">strip_spaces_between_tags</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="sd">"""Returns the given HTML with spaces between tags removed."""</span>
<span class="k">return</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s1">r'>\s+<'</span><span class="p">,</span> <span class="s1">'><'</span><span class="p">,</span> <span class="n">force_text</span><span class="p">(</span><span class="n">value</span><span class="p">))</span>
<span class="n">strip_spaces_between_tags</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">strip_spaces_between_tags</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">text_type</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">strip_entities</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="sd">"""Returns the given HTML with all entities (&something;) stripped."""</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
<span class="s2">"django.utils.html.strip_entities() is deprecated."</span><span class="p">,</span>
<span class="n">RemovedInDjango110Warning</span><span class="p">,</span> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">2</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s1">r'&(?:\w+|#\d+);'</span><span class="p">,</span> <span class="s1">''</span><span class="p">,</span> <span class="n">force_text</span><span class="p">(</span><span class="n">value</span><span class="p">))</span>
<span class="n">strip_entities</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">strip_entities</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">text_type</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">smart_urlquote</span><span class="p">(</span><span class="n">url</span><span class="p">):</span>
<span class="s2">"Quotes a URL if it isn't already quoted."</span>
<span class="k">def</span> <span class="nf">unquote_quote</span><span class="p">(</span><span class="n">segment</span><span class="p">):</span>
<span class="n">segment</span> <span class="o">=</span> <span class="n">unquote</span><span class="p">(</span><span class="n">force_str</span><span class="p">(</span><span class="n">segment</span><span class="p">))</span>
<span class="c1"># Tilde is part of RFC3986 Unreserved Characters</span>
<span class="c1"># http://tools.ietf.org/html/rfc3986#section-2.3</span>
<span class="c1"># See also http://bugs.python.org/issue16285</span>
<span class="n">segment</span> <span class="o">=</span> <span class="n">quote</span><span class="p">(</span><span class="n">segment</span><span class="p">,</span> <span class="n">safe</span><span class="o">=</span><span class="n">RFC3986_SUBDELIMS</span> <span class="o">+</span> <span class="n">RFC3986_GENDELIMS</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="s1">'~'</span><span class="p">))</span>
<span class="k">return</span> <span class="n">force_text</span><span class="p">(</span><span class="n">segment</span><span class="p">)</span>
<span class="c1"># Handle IDN before quoting.</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">scheme</span><span class="p">,</span> <span class="n">netloc</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">query</span><span class="p">,</span> <span class="n">fragment</span> <span class="o">=</span> <span class="n">urlsplit</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="c1"># invalid IPv6 URL (normally square brackets in hostname part).</span>
<span class="k">return</span> <span class="n">unquote_quote</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">netloc</span> <span class="o">=</span> <span class="n">netloc</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'idna'</span><span class="p">)</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'ascii'</span><span class="p">)</span> <span class="c1"># IDN -> ACE</span>
<span class="k">except</span> <span class="ne">UnicodeError</span><span class="p">:</span> <span class="c1"># invalid domain part</span>
<span class="k">return</span> <span class="n">unquote_quote</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
<span class="k">if</span> <span class="n">query</span><span class="p">:</span>
<span class="c1"># Separately unquoting key/value, so as to not mix querystring separators</span>
<span class="c1"># included in query values. See #22267.</span>
<span class="n">query_parts</span> <span class="o">=</span> <span class="p">[(</span><span class="n">unquote</span><span class="p">(</span><span class="n">force_str</span><span class="p">(</span><span class="n">q</span><span class="p">[</span><span class="mi">0</span><span class="p">])),</span> <span class="n">unquote</span><span class="p">(</span><span class="n">force_str</span><span class="p">(</span><span class="n">q</span><span class="p">[</span><span class="mi">1</span><span class="p">])))</span>
<span class="k">for</span> <span class="n">q</span> <span class="ow">in</span> <span class="n">parse_qsl</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">keep_blank_values</span><span class="o">=</span><span class="kc">True</span><span class="p">)]</span>
<span class="c1"># urlencode will take care of quoting</span>
<span class="n">query</span> <span class="o">=</span> <span class="n">urlencode</span><span class="p">(</span><span class="n">query_parts</span><span class="p">)</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">unquote_quote</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
<span class="n">fragment</span> <span class="o">=</span> <span class="n">unquote_quote</span><span class="p">(</span><span class="n">fragment</span><span class="p">)</span>
<span class="k">return</span> <span class="n">urlunsplit</span><span class="p">((</span><span class="n">scheme</span><span class="p">,</span> <span class="n">netloc</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">query</span><span class="p">,</span> <span class="n">fragment</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">urlize</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">trim_url_limit</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">nofollow</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">autoescape</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Converts any URLs in text into clickable links.</span>
<span class="sd"> Works on http://, https://, www. links, and also on links ending in one of</span>
<span class="sd"> the original seven gTLDs (.com, .edu, .gov, .int, .mil, .net, and .org).</span>
<span class="sd"> Links can have trailing punctuation (periods, commas, close-parens) and</span>
<span class="sd"> leading punctuation (opening parens) and it'll still do the right thing.</span>
<span class="sd"> If trim_url_limit is not None, the URLs in the link text longer than this</span>
<span class="sd"> limit will be truncated to trim_url_limit-3 characters and appended with</span>
<span class="sd"> an ellipsis.</span>
<span class="sd"> If nofollow is True, the links will get a rel="nofollow" attribute.</span>
<span class="sd"> If autoescape is True, the link text and URLs will be autoescaped.</span>
<span class="sd"> """</span>
<span class="n">safe_input</span> <span class="o">=</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">SafeData</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">trim_url</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</span><span class="n">trim_url_limit</span><span class="p">):</span>
<span class="k">if</span> <span class="n">limit</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="o"><=</span> <span class="n">limit</span><span class="p">:</span>
<span class="k">return</span> <span class="n">x</span>
<span class="k">return</span> <span class="s1">'</span><span class="si">%s</span><span class="s1">...'</span> <span class="o">%</span> <span class="n">x</span><span class="p">[:</span><span class="nb">max</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">limit</span> <span class="o">-</span> <span class="mi">3</span><span class="p">)]</span>
<span class="k">def</span> <span class="nf">unescape</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">trail</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> If input URL is HTML-escaped, unescape it so as we can safely feed it to</span>
<span class="sd"> smart_urlquote. For example:</span>
<span class="sd"> http://example.com?x=1&amp;y=&lt;2&gt; => http://example.com?x=1&y=<2></span>
<span class="sd"> """</span>
<span class="n">unescaped</span> <span class="o">=</span> <span class="p">(</span><span class="n">text</span> <span class="o">+</span> <span class="n">trail</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span>
<span class="s1">'&amp;'</span><span class="p">,</span> <span class="s1">'&'</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'&lt;'</span><span class="p">,</span> <span class="s1">'<'</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span>
<span class="s1">'&gt;'</span><span class="p">,</span> <span class="s1">'>'</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'&quot;'</span><span class="p">,</span> <span class="s1">'"'</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'&#39;'</span><span class="p">,</span> <span class="s2">"'"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">trail</span> <span class="ow">and</span> <span class="n">unescaped</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="n">trail</span><span class="p">):</span>
<span class="c1"># Remove trail for unescaped if it was not consumed by unescape</span>
<span class="n">unescaped</span> <span class="o">=</span> <span class="n">unescaped</span><span class="p">[:</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="n">trail</span><span class="p">)]</span>
<span class="k">elif</span> <span class="n">trail</span> <span class="o">==</span> <span class="s1">';'</span><span class="p">:</span>
<span class="c1"># Trail was consumed by unescape (as end-of-entity marker), move it to text</span>
<span class="n">text</span> <span class="o">+=</span> <span class="n">trail</span>
<span class="n">trail</span> <span class="o">=</span> <span class="s1">''</span>
<span class="k">return</span> <span class="n">text</span><span class="p">,</span> <span class="n">unescaped</span><span class="p">,</span> <span class="n">trail</span>
<span class="k">def</span> <span class="nf">is_email_simple</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="sd">"""Return True if value looks like an email address."""</span>
<span class="c1"># An @ must be in the middle of the value.</span>
<span class="k">if</span> <span class="s1">'@'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">value</span> <span class="ow">or</span> <span class="n">value</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'@'</span><span class="p">)</span> <span class="ow">or</span> <span class="n">value</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">'@'</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">p1</span><span class="p">,</span> <span class="n">p2</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'@'</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="c1"># value contains more than one @.</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="c1"># Dot must be in p2 (e.g. example.com)</span>
<span class="k">if</span> <span class="s1">'.'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">p2</span> <span class="ow">or</span> <span class="n">p2</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'.'</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="n">words</span> <span class="o">=</span> <span class="n">word_split_re</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">force_text</span><span class="p">(</span><span class="n">text</span><span class="p">))</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">word</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">words</span><span class="p">):</span>
<span class="k">if</span> <span class="s1">'.'</span> <span class="ow">in</span> <span class="n">word</span> <span class="ow">or</span> <span class="s1">'@'</span> <span class="ow">in</span> <span class="n">word</span> <span class="ow">or</span> <span class="s1">':'</span> <span class="ow">in</span> <span class="n">word</span><span class="p">:</span>
<span class="c1"># Deal with punctuation.</span>
<span class="n">lead</span><span class="p">,</span> <span class="n">middle</span><span class="p">,</span> <span class="n">trail</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> <span class="n">word</span><span class="p">,</span> <span class="s1">''</span>
<span class="k">for</span> <span class="n">punctuation</span> <span class="ow">in</span> <span class="n">TRAILING_PUNCTUATION</span><span class="p">:</span>
<span class="k">if</span> <span class="n">middle</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="n">punctuation</span><span class="p">):</span>
<span class="n">middle</span> <span class="o">=</span> <span class="n">middle</span><span class="p">[:</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="n">punctuation</span><span class="p">)]</span>
<span class="n">trail</span> <span class="o">=</span> <span class="n">punctuation</span> <span class="o">+</span> <span class="n">trail</span>
<span class="k">for</span> <span class="n">opening</span><span class="p">,</span> <span class="n">closing</span> <span class="ow">in</span> <span class="n">WRAPPING_PUNCTUATION</span><span class="p">:</span>
<span class="k">if</span> <span class="n">middle</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">opening</span><span class="p">):</span>
<span class="n">middle</span> <span class="o">=</span> <span class="n">middle</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">opening</span><span class="p">):]</span>
<span class="n">lead</span> <span class="o">=</span> <span class="n">lead</span> <span class="o">+</span> <span class="n">opening</span>
<span class="c1"># Keep parentheses at the end only if they're balanced.</span>
<span class="k">if</span> <span class="p">(</span><span class="n">middle</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="n">closing</span><span class="p">)</span>
<span class="ow">and</span> <span class="n">middle</span><span class="o">.</span><span class="n">count</span><span class="p">(</span><span class="n">closing</span><span class="p">)</span> <span class="o">==</span> <span class="n">middle</span><span class="o">.</span><span class="n">count</span><span class="p">(</span><span class="n">opening</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span><span class="p">):</span>
<span class="n">middle</span> <span class="o">=</span> <span class="n">middle</span><span class="p">[:</span><span class="o">-</span><span class="nb">len</span><span class="p">(</span><span class="n">closing</span><span class="p">)]</span>
<span class="n">trail</span> <span class="o">=</span> <span class="n">closing</span> <span class="o">+</span> <span class="n">trail</span>
<span class="c1"># Make URL we want to point to.</span>
<span class="n">url</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">nofollow_attr</span> <span class="o">=</span> <span class="s1">' rel="nofollow"'</span> <span class="k">if</span> <span class="n">nofollow</span> <span class="k">else</span> <span class="s1">''</span>
<span class="k">if</span> <span class="n">simple_url_re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">middle</span><span class="p">):</span>
<span class="n">middle</span><span class="p">,</span> <span class="n">middle_unescaped</span><span class="p">,</span> <span class="n">trail</span> <span class="o">=</span> <span class="n">unescape</span><span class="p">(</span><span class="n">middle</span><span class="p">,</span> <span class="n">trail</span><span class="p">)</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">smart_urlquote</span><span class="p">(</span><span class="n">middle_unescaped</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">simple_url_2_re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">middle</span><span class="p">):</span>
<span class="n">middle</span><span class="p">,</span> <span class="n">middle_unescaped</span><span class="p">,</span> <span class="n">trail</span> <span class="o">=</span> <span class="n">unescape</span><span class="p">(</span><span class="n">middle</span><span class="p">,</span> <span class="n">trail</span><span class="p">)</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">smart_urlquote</span><span class="p">(</span><span class="s1">'http://</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">middle_unescaped</span><span class="p">)</span>
<span class="k">elif</span> <span class="s1">':'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">middle</span> <span class="ow">and</span> <span class="n">is_email_simple</span><span class="p">(</span><span class="n">middle</span><span class="p">):</span>
<span class="n">local</span><span class="p">,</span> <span class="n">domain</span> <span class="o">=</span> <span class="n">middle</span><span class="o">.</span><span class="n">rsplit</span><span class="p">(</span><span class="s1">'@'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">domain</span> <span class="o">=</span> <span class="n">domain</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'idna'</span><span class="p">)</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'ascii'</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">UnicodeError</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">url</span> <span class="o">=</span> <span class="s1">'mailto:</span><span class="si">%s</span><span class="s1">@</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">local</span><span class="p">,</span> <span class="n">domain</span><span class="p">)</span>
<span class="n">nofollow_attr</span> <span class="o">=</span> <span class="s1">''</span>
<span class="c1"># Make link.</span>
<span class="k">if</span> <span class="n">url</span><span class="p">:</span>
<span class="n">trimmed</span> <span class="o">=</span> <span class="n">trim_url</span><span class="p">(</span><span class="n">middle</span><span class="p">)</span>
<span class="k">if</span> <span class="n">autoescape</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">safe_input</span><span class="p">:</span>
<span class="n">lead</span><span class="p">,</span> <span class="n">trail</span> <span class="o">=</span> <span class="n">escape</span><span class="p">(</span><span class="n">lead</span><span class="p">),</span> <span class="n">escape</span><span class="p">(</span><span class="n">trail</span><span class="p">)</span>
<span class="n">trimmed</span> <span class="o">=</span> <span class="n">escape</span><span class="p">(</span><span class="n">trimmed</span><span class="p">)</span>
<span class="n">middle</span> <span class="o">=</span> <span class="s1">'<a href="</span><span class="si">%s</span><span class="s1">"</span><span class="si">%s</span><span class="s1">></span><span class="si">%s</span><span class="s1"></a>'</span> <span class="o">%</span> <span class="p">(</span><span class="n">escape</span><span class="p">(</span><span class="n">url</span><span class="p">),</span> <span class="n">nofollow_attr</span><span class="p">,</span> <span class="n">trimmed</span><span class="p">)</span>
<span class="n">words</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">mark_safe</span><span class="p">(</span><span class="s1">'</span><span class="si">%s%s%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">lead</span><span class="p">,</span> <span class="n">middle</span><span class="p">,</span> <span class="n">trail</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="n">safe_input</span><span class="p">:</span>
<span class="n">words</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">mark_safe</span><span class="p">(</span><span class="n">word</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">autoescape</span><span class="p">:</span>
<span class="n">words</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">escape</span><span class="p">(</span><span class="n">word</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">safe_input</span><span class="p">:</span>
<span class="n">words</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">mark_safe</span><span class="p">(</span><span class="n">word</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">autoescape</span><span class="p">:</span>
<span class="n">words</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">escape</span><span class="p">(</span><span class="n">word</span><span class="p">)</span>
<span class="k">return</span> <span class="s1">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">words</span><span class="p">)</span>
<span class="n">urlize</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">urlize</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">text_type</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">avoid_wrapping</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Avoid text wrapping in the middle of a phrase by adding non-breaking</span>
<span class="sd"> spaces where there previously were normal spaces.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">value</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">" "</span><span class="p">,</span> <span class="s2">"</span><span class="se">\xa0</span><span class="s2">"</span><span class="p">)</span>
<div class="viewcode-block" id="html_safe"><a class="viewcode-back" href="../../../ref/utils.html#django.utils.html.html_safe">[docs]</a><span class="k">def</span> <span class="nf">html_safe</span><span class="p">(</span><span class="n">klass</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A decorator that defines the __html__ method. This helps non-Django</span>
<span class="sd"> templates to detect classes whose __str__ methods return SafeText.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="s1">'__html__'</span> <span class="ow">in</span> <span class="n">klass</span><span class="o">.</span><span class="n">__dict__</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s2">"can't apply @html_safe to </span><span class="si">%s</span><span class="s2"> because it defines "</span>
<span class="s2">"__html__()."</span> <span class="o">%</span> <span class="n">klass</span><span class="o">.</span><span class="n">__name__</span>
<span class="p">)</span>
<span class="k">if</span> <span class="n">six</span><span class="o">.</span><span class="n">PY2</span><span class="p">:</span>
<span class="k">if</span> <span class="s1">'__unicode__'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">klass</span><span class="o">.</span><span class="n">__dict__</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s2">"can't apply @html_safe to </span><span class="si">%s</span><span class="s2"> because it doesn't "</span>
<span class="s2">"define __unicode__()."</span> <span class="o">%</span> <span class="n">klass</span><span class="o">.</span><span class="n">__name__</span>
<span class="p">)</span>
<span class="n">klass_unicode</span> <span class="o">=</span> <span class="n">klass</span><span class="o">.</span><span class="n">__unicode__</span>
<span class="n">klass</span><span class="o">.</span><span class="n">__unicode__</span> <span class="o">=</span> <span class="k">lambda</span> <span class="bp">self</span><span class="p">:</span> <span class="n">mark_safe</span><span class="p">(</span><span class="n">klass_unicode</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span>
<span class="n">klass</span><span class="o">.</span><span class="n">__html__</span> <span class="o">=</span> <span class="k">lambda</span> <span class="bp">self</span><span class="p">:</span> <span class="n">unicode</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="c1"># NOQA: unicode undefined on PY3</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="s1">'__str__'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">klass</span><span class="o">.</span><span class="n">__dict__</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s2">"can't apply @html_safe to </span><span class="si">%s</span><span class="s2"> because it doesn't "</span>
<span class="s2">"define __str__()."</span> <span class="o">%</span> <span class="n">klass</span><span class="o">.</span><span class="n">__name__</span>
<span class="p">)</span>
<span class="n">klass_str</span> <span class="o">=</span> <span class="n">klass</span><span class="o">.</span><span class="n">__str__</span>
<span class="n">klass</span><span class="o">.</span><span class="n">__str__</span> <span class="o">=</span> <span class="k">lambda</span> <span class="bp">self</span><span class="p">:</span> <span class="n">mark_safe</span><span class="p">(</span><span class="n">klass_str</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span>
<span class="n">klass</span><span class="o">.</span><span class="n">__html__</span> <span class="o">=</span> <span class="k">lambda</span> <span class="bp">self</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="k">return</span> <span class="n">klass</span></div>
</pre></div>
</div>
</div>
</div>
<div class="yui-b" id="sidebar">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3>Browse</h3>
<ul>
</ul>
<h3>You are here:</h3>
<ul>
<li>
<a href="../../../index.html">Django 1.8.19 documentation</a>
<ul><li><a href="../../index.html">Module code</a>
<ul><li><a href="../../django.html">django</a>
<ul><li>django.utils.html</li></ul>
</li></ul></li></ul>
</li>
</ul>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../../../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<h3>Last update:</h3>
<p class="topless">Mar 10, 2018</p>
</div>
</div>
<div id="ft">
<div class="nav">
<a href="../../index.html" title="Module code" accesskey="U">up</a></div>
</div>
</div>
<div class="clearer"></div>
</div>
</body>
</html>
distrib
>
Mageia
>
6
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
65530c6176058f9b54858c3b4f6385e6
>
files
>
152
