<!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.text — 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-text">
<h1>Source code for django.utils.text</h1><div class="highlight"><pre>
<span></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">unicodedata</span>
<span class="kn">import</span> <span class="nn">warnings</span>
<span class="kn">from</span> <span class="nn">gzip</span> <span class="k">import</span> <span class="n">GzipFile</span>
<span class="kn">from</span> <span class="nn">io</span> <span class="k">import</span> <span class="n">BytesIO</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">RemovedInDjango19Warning</span>
<span class="kn">from</span> <span class="nn">django.utils.encoding</span> <span class="k">import</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">SimpleLazyObject</span><span class="p">,</span> <span class="n">allow_lazy</span>
<span class="kn">from</span> <span class="nn">django.utils.safestring</span> <span class="k">import</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</span> <span class="k">import</span> <span class="n">html_entities</span>
<span class="kn">from</span> <span class="nn">django.utils.translation</span> <span class="k">import</span> <span class="n">pgettext</span><span class="p">,</span> <span class="n">ugettext</span> <span class="k">as</span> <span class="n">_</span><span class="p">,</span> <span class="n">ugettext_lazy</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="c1"># Import force_unicode even though this module doesn't use it, because some</span>
<span class="c1"># people rely on it being here.</span>
<span class="kn">from</span> <span class="nn">django.utils.encoding</span> <span class="k">import</span> <span class="n">force_unicode</span> <span class="c1"># NOQA</span>
<span class="c1"># Capitalizes the first letter of a string.</span>
<span class="n">capfirst</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span> <span class="ow">and</span> <span class="n">force_text</span><span class="p">(</span><span class="n">x</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="o">+</span> <span class="n">force_text</span><span class="p">(</span><span class="n">x</span><span class="p">)[</span><span class="mi">1</span><span class="p">:]</span>
<span class="n">capfirst</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">capfirst</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="c1"># Set up regular expressions</span>
<span class="n">re_words</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[-\w]*|&.*?;)+)'</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">U</span> <span class="o">|</span> <span class="n">re</span><span class="o">.</span><span class="n">S</span><span class="p">)</span>
<span class="n">re_chars</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="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">U</span> <span class="o">|</span> <span class="n">re</span><span class="o">.</span><span class="n">S</span><span class="p">)</span>
<span class="n">re_tag</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+?)(?:(\s*/)|\s.*?)?>'</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">S</span><span class="p">)</span>
<span class="n">re_newlines</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'\r\n|\r'</span><span class="p">)</span> <span class="c1"># Used in normalize_newlines</span>
<span class="n">re_camel_case</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-z])[A-Z])|([A-Z](?![A-Z]|$)))'</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">wrap</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">width</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A word-wrap function that preserves existing line breaks. Expects that</span>
<span class="sd"> existing line breaks are posix newlines.</span>
<span class="sd"> All white space is preserved except added line breaks consume the space on</span>
<span class="sd"> which they break the line.</span>
<span class="sd"> Long words are not wrapped, so the output text may have lines longer than</span>
<span class="sd"> ``width``.</span>
<span class="sd"> """</span>
<span class="n">text</span> <span class="o">=</span> <span class="n">force_text</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_generator</span><span class="p">():</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">text</span><span class="o">.</span><span class="n">splitlines</span><span class="p">(</span><span class="kc">True</span><span class="p">):</span> <span class="c1"># True keeps trailing linebreaks</span>
<span class="n">max_width</span> <span class="o">=</span> <span class="nb">min</span><span class="p">((</span><span class="n">line</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span> <span class="ow">and</span> <span class="n">width</span> <span class="o">+</span> <span class="mi">1</span> <span class="ow">or</span> <span class="n">width</span><span class="p">),</span> <span class="n">width</span><span class="p">)</span>
<span class="k">while</span> <span class="nb">len</span><span class="p">(</span><span class="n">line</span><span class="p">)</span> <span class="o">></span> <span class="n">max_width</span><span class="p">:</span>
<span class="n">space</span> <span class="o">=</span> <span class="n">line</span><span class="p">[:</span><span class="n">max_width</span> <span class="o">+</span> <span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">rfind</span><span class="p">(</span><span class="s1">' '</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">space</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">space</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">' '</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">space</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">line</span>
<span class="n">line</span> <span class="o">=</span> <span class="s1">''</span>
<span class="k">break</span>
<span class="k">yield</span> <span class="s1">'</span><span class="si">%s</span><span class="se">\n</span><span class="s1">'</span> <span class="o">%</span> <span class="n">line</span><span class="p">[:</span><span class="n">space</span> <span class="o">-</span> <span class="mi">1</span><span class="p">]</span>
<span class="n">line</span> <span class="o">=</span> <span class="n">line</span><span class="p">[</span><span class="n">space</span><span class="p">:]</span>
<span class="n">max_width</span> <span class="o">=</span> <span class="nb">min</span><span class="p">((</span><span class="n">line</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span> <span class="ow">and</span> <span class="n">width</span> <span class="o">+</span> <span class="mi">1</span> <span class="ow">or</span> <span class="n">width</span><span class="p">),</span> <span class="n">width</span><span class="p">)</span>
<span class="k">if</span> <span class="n">line</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">line</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">_generator</span><span class="p">())</span>
<span class="n">wrap</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">wrap</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">Truncator</span><span class="p">(</span><span class="n">SimpleLazyObject</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> An object used to truncate text, either by characters or words.</span>
<span class="sd"> """</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="n">text</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">Truncator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="k">lambda</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">def</span> <span class="nf">add_truncation_text</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">text</span><span class="p">,</span> <span class="n">truncate</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">if</span> <span class="n">truncate</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">truncate</span> <span class="o">=</span> <span class="n">pgettext</span><span class="p">(</span>
<span class="s1">'String to return when truncating text'</span><span class="p">,</span>
<span class="s1">'</span><span class="si">%(truncated_text)s</span><span class="s1">...'</span><span class="p">)</span>
<span class="n">truncate</span> <span class="o">=</span> <span class="n">force_text</span><span class="p">(</span><span class="n">truncate</span><span class="p">)</span>
<span class="k">if</span> <span class="s1">'</span><span class="si">%(truncated_text)s</span><span class="s1">'</span> <span class="ow">in</span> <span class="n">truncate</span><span class="p">:</span>
<span class="k">return</span> <span class="n">truncate</span> <span class="o">%</span> <span class="p">{</span><span class="s1">'truncated_text'</span><span class="p">:</span> <span class="n">text</span><span class="p">}</span>
<span class="c1"># The truncation text didn't contain the %(truncated_text)s string</span>
<span class="c1"># replacement argument so just append it to the text.</span>
<span class="k">if</span> <span class="n">text</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="n">truncate</span><span class="p">):</span>
<span class="c1"># But don't append the truncation text if the current text already</span>
<span class="c1"># ends in this.</span>
<span class="k">return</span> <span class="n">text</span>
<span class="k">return</span> <span class="s1">'</span><span class="si">%s%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">truncate</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">chars</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">num</span><span class="p">,</span> <span class="n">truncate</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">html</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns the text truncated to be no longer than the specified number</span>
<span class="sd"> of characters.</span>
<span class="sd"> Takes an optional argument of what should be used to notify that the</span>
<span class="sd"> string has been truncated, defaulting to a translatable string of an</span>
<span class="sd"> ellipsis (...).</span>
<span class="sd"> """</span>
<span class="n">length</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">num</span><span class="p">)</span>
<span class="n">text</span> <span class="o">=</span> <span class="n">unicodedata</span><span class="o">.</span><span class="n">normalize</span><span class="p">(</span><span class="s1">'NFC'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_wrapped</span><span class="p">)</span>
<span class="c1"># Calculate the length to truncate to (max length - end_text length)</span>
<span class="n">truncate_len</span> <span class="o">=</span> <span class="n">length</span>
<span class="k">for</span> <span class="n">char</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">add_truncation_text</span><span class="p">(</span><span class="s1">''</span><span class="p">,</span> <span class="n">truncate</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">unicodedata</span><span class="o">.</span><span class="n">combining</span><span class="p">(</span><span class="n">char</span><span class="p">):</span>
<span class="n">truncate_len</span> <span class="o">-=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">truncate_len</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">break</span>
<span class="k">if</span> <span class="n">html</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_truncate_html</span><span class="p">(</span><span class="n">length</span><span class="p">,</span> <span class="n">truncate</span><span class="p">,</span> <span class="n">text</span><span class="p">,</span> <span class="n">truncate_len</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_text_chars</span><span class="p">(</span><span class="n">length</span><span class="p">,</span> <span class="n">truncate</span><span class="p">,</span> <span class="n">text</span><span class="p">,</span> <span class="n">truncate_len</span><span class="p">)</span>
<span class="n">chars</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">chars</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_text_chars</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">length</span><span class="p">,</span> <span class="n">truncate</span><span class="p">,</span> <span class="n">text</span><span class="p">,</span> <span class="n">truncate_len</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Truncates a string after a certain number of chars.</span>
<span class="sd"> """</span>
<span class="n">s_len</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">end_index</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">char</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">text</span><span class="p">):</span>
<span class="k">if</span> <span class="n">unicodedata</span><span class="o">.</span><span class="n">combining</span><span class="p">(</span><span class="n">char</span><span class="p">):</span>
<span class="c1"># Don't consider combining characters</span>
<span class="c1"># as adding to the string length</span>
<span class="k">continue</span>
<span class="n">s_len</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">end_index</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">s_len</span> <span class="o">></span> <span class="n">truncate_len</span><span class="p">:</span>
<span class="n">end_index</span> <span class="o">=</span> <span class="n">i</span>
<span class="k">if</span> <span class="n">s_len</span> <span class="o">></span> <span class="n">length</span><span class="p">:</span>
<span class="c1"># Return the truncated string</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">add_truncation_text</span><span class="p">(</span><span class="n">text</span><span class="p">[:</span><span class="n">end_index</span> <span class="ow">or</span> <span class="mi">0</span><span class="p">],</span>
<span class="n">truncate</span><span class="p">)</span>
<span class="c1"># Return the original string since no truncation was necessary</span>
<span class="k">return</span> <span class="n">text</span>
<span class="k">def</span> <span class="nf">words</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">num</span><span class="p">,</span> <span class="n">truncate</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">html</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Truncates a string after a certain number of words. Takes an optional</span>
<span class="sd"> argument of what should be used to notify that the string has been</span>
<span class="sd"> truncated, defaulting to ellipsis (...).</span>
<span class="sd"> """</span>
<span class="n">length</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">num</span><span class="p">)</span>
<span class="k">if</span> <span class="n">html</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_truncate_html</span><span class="p">(</span><span class="n">length</span><span class="p">,</span> <span class="n">truncate</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_wrapped</span><span class="p">,</span> <span class="n">length</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_text_words</span><span class="p">(</span><span class="n">length</span><span class="p">,</span> <span class="n">truncate</span><span class="p">)</span>
<span class="n">words</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">words</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_text_words</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">length</span><span class="p">,</span> <span class="n">truncate</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Truncates a string after a certain number of words.</span>
<span class="sd"> Newlines in the string will be stripped.</span>
<span class="sd"> """</span>
<span class="n">words</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_wrapped</span><span class="o">.</span><span class="n">split</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">words</span><span class="p">)</span> <span class="o">></span> <span class="n">length</span><span class="p">:</span>
<span class="n">words</span> <span class="o">=</span> <span class="n">words</span><span class="p">[:</span><span class="n">length</span><span class="p">]</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">add_truncation_text</span><span class="p">(</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">truncate</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="k">def</span> <span class="nf">_truncate_html</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">length</span><span class="p">,</span> <span class="n">truncate</span><span class="p">,</span> <span class="n">text</span><span class="p">,</span> <span class="n">truncate_len</span><span class="p">,</span> <span class="n">words</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Truncates HTML to a certain number of chars (not counting tags and</span>
<span class="sd"> comments), or, if words is True, then to a certain number of words.</span>
<span class="sd"> Closes opened tags if they were correctly closed in the given HTML.</span>
<span class="sd"> Newlines in the HTML are preserved.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">words</span> <span class="ow">and</span> <span class="n">length</span> <span class="o"><=</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="s1">''</span>
<span class="n">html4_singlets</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">'br'</span><span class="p">,</span> <span class="s1">'col'</span><span class="p">,</span> <span class="s1">'link'</span><span class="p">,</span> <span class="s1">'base'</span><span class="p">,</span> <span class="s1">'img'</span><span class="p">,</span>
<span class="s1">'param'</span><span class="p">,</span> <span class="s1">'area'</span><span class="p">,</span> <span class="s1">'hr'</span><span class="p">,</span> <span class="s1">'input'</span>
<span class="p">)</span>
<span class="c1"># Count non-HTML chars/words and keep note of open tags</span>
<span class="n">pos</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">end_text_pos</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">current_len</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">open_tags</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">regex</span> <span class="o">=</span> <span class="n">re_words</span> <span class="k">if</span> <span class="n">words</span> <span class="k">else</span> <span class="n">re_chars</span>
<span class="k">while</span> <span class="n">current_len</span> <span class="o"><=</span> <span class="n">length</span><span class="p">:</span>
<span class="n">m</span> <span class="o">=</span> <span class="n">regex</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">pos</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">m</span><span class="p">:</span>
<span class="c1"># Checked through whole string</span>
<span class="k">break</span>
<span class="n">pos</span> <span class="o">=</span> <span class="n">m</span><span class="o">.</span><span class="n">end</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="k">if</span> <span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">):</span>
<span class="c1"># It's an actual non-HTML word or char</span>
<span class="n">current_len</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">current_len</span> <span class="o">==</span> <span class="n">truncate_len</span><span class="p">:</span>
<span class="n">end_text_pos</span> <span class="o">=</span> <span class="n">pos</span>
<span class="k">continue</span>
<span class="c1"># Check for tag</span>
<span class="n">tag</span> <span class="o">=</span> <span class="n">re_tag</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">0</span><span class="p">))</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">tag</span> <span class="ow">or</span> <span class="n">current_len</span> <span class="o">>=</span> <span class="n">truncate_len</span><span class="p">:</span>
<span class="c1"># Don't worry about non tags or tags after our truncate point</span>
<span class="k">continue</span>
<span class="n">closing_tag</span><span class="p">,</span> <span class="n">tagname</span><span class="p">,</span> <span class="n">self_closing</span> <span class="o">=</span> <span class="n">tag</span><span class="o">.</span><span class="n">groups</span><span class="p">()</span>
<span class="c1"># Element names are always case-insensitive</span>
<span class="n">tagname</span> <span class="o">=</span> <span class="n">tagname</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="k">if</span> <span class="n">self_closing</span> <span class="ow">or</span> <span class="n">tagname</span> <span class="ow">in</span> <span class="n">html4_singlets</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">elif</span> <span class="n">closing_tag</span><span class="p">:</span>
<span class="c1"># Check for match in open tags list</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">i</span> <span class="o">=</span> <span class="n">open_tags</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="n">tagname</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># SGML: An end tag closes, back to the matching start tag,</span>
<span class="c1"># all unclosed intervening start tags with omitted end tags</span>
<span class="n">open_tags</span> <span class="o">=</span> <span class="n">open_tags</span><span class="p">[</span><span class="n">i</span> <span class="o">+</span> <span class="mi">1</span><span class="p">:]</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Add it to the start of the open tags list</span>
<span class="n">open_tags</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">tagname</span><span class="p">)</span>
<span class="k">if</span> <span class="n">current_len</span> <span class="o"><=</span> <span class="n">length</span><span class="p">:</span>
<span class="k">return</span> <span class="n">text</span>
<span class="n">out</span> <span class="o">=</span> <span class="n">text</span><span class="p">[:</span><span class="n">end_text_pos</span><span class="p">]</span>
<span class="n">truncate_text</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">add_truncation_text</span><span class="p">(</span><span class="s1">''</span><span class="p">,</span> <span class="n">truncate</span><span class="p">)</span>
<span class="k">if</span> <span class="n">truncate_text</span><span class="p">:</span>
<span class="n">out</span> <span class="o">+=</span> <span class="n">truncate_text</span>
<span class="c1"># Close any tags still open</span>
<span class="k">for</span> <span class="n">tag</span> <span class="ow">in</span> <span class="n">open_tags</span><span class="p">:</span>
<span class="n">out</span> <span class="o">+=</span> <span class="s1">'</</span><span class="si">%s</span><span class="s1">>'</span> <span class="o">%</span> <span class="n">tag</span>
<span class="c1"># Return string</span>
<span class="k">return</span> <span class="n">out</span>
<span class="k">def</span> <span class="nf">get_valid_filename</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns the given string converted to a string that can be used for a clean</span>
<span class="sd"> filename. Specifically, leading and trailing spaces are removed; other</span>
<span class="sd"> spaces are converted to underscores; and anything that is not a unicode</span>
<span class="sd"> alphanumeric, dash, underscore, or dot, is removed.</span>
<span class="sd"> >>> get_valid_filename("john's portrait in 2004.jpg")</span>
<span class="sd"> 'johns_portrait_in_2004.jpg'</span>
<span class="sd"> """</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">force_text</span><span class="p">(</span><span class="n">s</span><span class="p">)</span><span class="o">.</span><span class="n">strip</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">'_'</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'(?u)[^-\w.]'</span><span class="p">,</span> <span class="s1">''</span><span class="p">,</span> <span class="n">s</span><span class="p">)</span>
<span class="n">get_valid_filename</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">get_valid_filename</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">get_text_list</span><span class="p">(</span><span class="n">list_</span><span class="p">,</span> <span class="n">last_word</span><span class="o">=</span><span class="n">ugettext_lazy</span><span class="p">(</span><span class="s1">'or'</span><span class="p">)):</span>
<span class="sd">"""</span>
<span class="sd"> >>> get_text_list(['a', 'b', 'c', 'd'])</span>
<span class="sd"> 'a, b, c or d'</span>
<span class="sd"> >>> get_text_list(['a', 'b', 'c'], 'and')</span>
<span class="sd"> 'a, b and c'</span>
<span class="sd"> >>> get_text_list(['a', 'b'], 'and')</span>
<span class="sd"> 'a and b'</span>
<span class="sd"> >>> get_text_list(['a'])</span>
<span class="sd"> 'a'</span>
<span class="sd"> >>> get_text_list([])</span>
<span class="sd"> ''</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">list_</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="s1">''</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">list_</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">return</span> <span class="n">force_text</span><span class="p">(</span><span class="n">list_</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">return</span> <span class="s1">'</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">'</span> <span class="o">%</span> <span class="p">(</span>
<span class="c1"># Translators: This string is used as a separator between list elements</span>
<span class="n">_</span><span class="p">(</span><span class="s1">', '</span><span class="p">)</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">force_text</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">list_</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]),</span>
<span class="n">force_text</span><span class="p">(</span><span class="n">last_word</span><span class="p">),</span> <span class="n">force_text</span><span class="p">(</span><span class="n">list_</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]))</span>
<span class="n">get_text_list</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">get_text_list</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">normalize_newlines</span><span class="p">(</span><span class="n">text</span><span class="p">):</span>
<span class="sd">"""Normalizes CRLF and CR newlines to just LF."""</span>
<span class="n">text</span> <span class="o">=</span> <span class="n">force_text</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
<span class="k">return</span> <span class="n">re_newlines</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="n">text</span><span class="p">)</span>
<span class="n">normalize_newlines</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">normalize_newlines</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">phone2numeric</span><span class="p">(</span><span class="n">phone</span><span class="p">):</span>
<span class="sd">"""Converts a phone number with letters into its numeric equivalent."""</span>
<span class="n">char2number</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'a'</span><span class="p">:</span> <span class="s1">'2'</span><span class="p">,</span> <span class="s1">'b'</span><span class="p">:</span> <span class="s1">'2'</span><span class="p">,</span> <span class="s1">'c'</span><span class="p">:</span> <span class="s1">'2'</span><span class="p">,</span> <span class="s1">'d'</span><span class="p">:</span> <span class="s1">'3'</span><span class="p">,</span> <span class="s1">'e'</span><span class="p">:</span> <span class="s1">'3'</span><span class="p">,</span> <span class="s1">'f'</span><span class="p">:</span> <span class="s1">'3'</span><span class="p">,</span>
<span class="s1">'g'</span><span class="p">:</span> <span class="s1">'4'</span><span class="p">,</span> <span class="s1">'h'</span><span class="p">:</span> <span class="s1">'4'</span><span class="p">,</span> <span class="s1">'i'</span><span class="p">:</span> <span class="s1">'4'</span><span class="p">,</span> <span class="s1">'j'</span><span class="p">:</span> <span class="s1">'5'</span><span class="p">,</span> <span class="s1">'k'</span><span class="p">:</span> <span class="s1">'5'</span><span class="p">,</span> <span class="s1">'l'</span><span class="p">:</span> <span class="s1">'5'</span><span class="p">,</span> <span class="s1">'m'</span><span class="p">:</span> <span class="s1">'6'</span><span class="p">,</span>
<span class="s1">'n'</span><span class="p">:</span> <span class="s1">'6'</span><span class="p">,</span> <span class="s1">'o'</span><span class="p">:</span> <span class="s1">'6'</span><span class="p">,</span> <span class="s1">'p'</span><span class="p">:</span> <span class="s1">'7'</span><span class="p">,</span> <span class="s1">'q'</span><span class="p">:</span> <span class="s1">'7'</span><span class="p">,</span> <span class="s1">'r'</span><span class="p">:</span> <span class="s1">'7'</span><span class="p">,</span> <span class="s1">'s'</span><span class="p">:</span> <span class="s1">'7'</span><span class="p">,</span> <span class="s1">'t'</span><span class="p">:</span> <span class="s1">'8'</span><span class="p">,</span>
<span class="s1">'u'</span><span class="p">:</span> <span class="s1">'8'</span><span class="p">,</span> <span class="s1">'v'</span><span class="p">:</span> <span class="s1">'8'</span><span class="p">,</span> <span class="s1">'w'</span><span class="p">:</span> <span class="s1">'9'</span><span class="p">,</span> <span class="s1">'x'</span><span class="p">:</span> <span class="s1">'9'</span><span class="p">,</span> <span class="s1">'y'</span><span class="p">:</span> <span class="s1">'9'</span><span class="p">,</span> <span class="s1">'z'</span><span class="p">:</span> <span class="s1">'9'</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">char2number</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="n">c</span><span class="p">)</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">phone</span><span class="o">.</span><span class="n">lower</span><span class="p">())</span>
<span class="n">phone2numeric</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">phone2numeric</span><span class="p">)</span>
<span class="c1"># From http://www.xhaus.com/alan/python/httpcomp.html#gzip</span>
<span class="c1"># Used with permission.</span>
<span class="k">def</span> <span class="nf">compress_string</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="n">zbuf</span> <span class="o">=</span> <span class="n">BytesIO</span><span class="p">()</span>
<span class="n">zfile</span> <span class="o">=</span> <span class="n">GzipFile</span><span class="p">(</span><span class="n">mode</span><span class="o">=</span><span class="s1">'wb'</span><span class="p">,</span> <span class="n">compresslevel</span><span class="o">=</span><span class="mi">6</span><span class="p">,</span> <span class="n">fileobj</span><span class="o">=</span><span class="n">zbuf</span><span class="p">)</span>
<span class="n">zfile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="n">zfile</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">return</span> <span class="n">zbuf</span><span class="o">.</span><span class="n">getvalue</span><span class="p">()</span>
<span class="k">class</span> <span class="nc">StreamingBuffer</span><span class="p">(</span><span class="nb">object</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="bp">self</span><span class="o">.</span><span class="n">vals</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">val</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">vals</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">val</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">read</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">vals</span><span class="p">:</span>
<span class="k">return</span> <span class="n">b</span><span class="s1">''</span>
<span class="n">ret</span> <span class="o">=</span> <span class="n">b</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">vals</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">vals</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">return</span> <span class="n">ret</span>
<span class="k">def</span> <span class="nf">flush</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span>
<span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span>
<span class="c1"># Like compress_string, but for iterators of strings.</span>
<span class="k">def</span> <span class="nf">compress_sequence</span><span class="p">(</span><span class="n">sequence</span><span class="p">):</span>
<span class="n">buf</span> <span class="o">=</span> <span class="n">StreamingBuffer</span><span class="p">()</span>
<span class="n">zfile</span> <span class="o">=</span> <span class="n">GzipFile</span><span class="p">(</span><span class="n">mode</span><span class="o">=</span><span class="s1">'wb'</span><span class="p">,</span> <span class="n">compresslevel</span><span class="o">=</span><span class="mi">6</span><span class="p">,</span> <span class="n">fileobj</span><span class="o">=</span><span class="n">buf</span><span class="p">)</span>
<span class="c1"># Output headers...</span>
<span class="k">yield</span> <span class="n">buf</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
<span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">sequence</span><span class="p">:</span>
<span class="n">zfile</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">item</span><span class="p">)</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">buf</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
<span class="k">if</span> <span class="n">data</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">data</span>
<span class="n">zfile</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">yield</span> <span class="n">buf</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
<span class="n">ustring_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="s2">"([</span><span class="se">\u0080</span><span class="s2">-</span><span class="se">\uffff</span><span class="s2">])"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">javascript_quote</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">quote_double_quotes</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="n">msg</span> <span class="o">=</span> <span class="p">(</span>
<span class="s2">"django.utils.text.javascript_quote() is deprecated. "</span>
<span class="s2">"Use django.utils.html.escapejs() instead."</span>
<span class="p">)</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">RemovedInDjango19Warning</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">def</span> <span class="nf">fix</span><span class="p">(</span><span class="n">match</span><span class="p">):</span>
<span class="k">return</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">u</span><span class="si">%04x</span><span class="s2">"</span> <span class="o">%</span> <span class="nb">ord</span><span class="p">(</span><span class="n">match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span>
<span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="o">==</span> <span class="nb">bytes</span><span class="p">:</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">type</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="o">!=</span> <span class="n">six</span><span class="o">.</span><span class="n">text_type</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">replace</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="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\r</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">r'</span><span class="p">)</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</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">'</span><span class="se">\\</span><span class="s1">n'</span><span class="p">)</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\t</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">t'</span><span class="p">)</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</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">\\</span><span class="s2">'"</span><span class="p">)</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</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">'<</span><span class="se">\\</span><span class="s1">/'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">quote_double_quotes</span><span class="p">:</span>
<span class="n">s</span> <span class="o">=</span> <span class="n">s</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="k">return</span> <span class="n">ustring_re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="n">fix</span><span class="p">,</span> <span class="n">s</span><span class="p">)</span>
<span class="n">javascript_quote</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">javascript_quote</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="c1"># Expression to match some_token and some_token="with spaces" (and similarly</span>
<span class="c1"># for single-quoted strings).</span>
<span class="n">smart_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="s2">r"""</span>
<span class="s2"> ((?:</span>
<span class="s2"> [^\s'"]*</span>
<span class="s2"> (?:</span>
<span class="s2"> (?:"(?:[^"\\]|\\.)*" | '(?:[^'\\]|\\.)*')</span>
<span class="s2"> [^\s'"]*</span>
<span class="s2"> )+</span>
<span class="s2"> ) | \S+)</span>
<span class="s2">"""</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">VERBOSE</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">smart_split</span><span class="p">(</span><span class="n">text</span><span class="p">):</span>
<span class="sd">r"""</span>
<span class="sd"> Generator that splits a string by spaces, leaving quoted phrases together.</span>
<span class="sd"> Supports both single and double quotes, and supports escaping quotes with</span>
<span class="sd"> backslashes. In the output, strings will keep their initial and trailing</span>
<span class="sd"> quote marks and escaped quotes will remain escaped (the results can then</span>
<span class="sd"> be further processed with unescape_string_literal()).</span>
<span class="sd"> >>> list(smart_split(r'This is "a person\'s" test.'))</span>
<span class="sd"> ['This', 'is', '"a person\\\'s"', 'test.']</span>
<span class="sd"> >>> list(smart_split(r"Another 'person\'s' test."))</span>
<span class="sd"> ['Another', "'person\\'s'", 'test.']</span>
<span class="sd"> >>> list(smart_split(r'A "\"funky\" style" test.'))</span>
<span class="sd"> ['A', '"\\"funky\\" style"', 'test.']</span>
<span class="sd"> """</span>
<span class="n">text</span> <span class="o">=</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">bit</span> <span class="ow">in</span> <span class="n">smart_split_re</span><span class="o">.</span><span class="n">finditer</span><span class="p">(</span><span class="n">text</span><span class="p">):</span>
<span class="k">yield</span> <span class="n">bit</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_replace_entity</span><span class="p">(</span><span class="n">match</span><span class="p">):</span>
<span class="n">text</span> <span class="o">=</span> <span class="n">match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="k">if</span> <span class="n">text</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s1">'#'</span><span class="p">:</span>
<span class="n">text</span> <span class="o">=</span> <span class="n">text</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="k">if</span> <span class="n">text</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="s1">'xX'</span><span class="p">:</span>
<span class="n">c</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">text</span><span class="p">[</span><span class="mi">1</span><span class="p">:],</span> <span class="mi">16</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">c</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
<span class="k">return</span> <span class="n">six</span><span class="o">.</span><span class="n">unichr</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">return</span> <span class="n">match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="n">six</span><span class="o">.</span><span class="n">unichr</span><span class="p">(</span><span class="n">html_entities</span><span class="o">.</span><span class="n">name2codepoint</span><span class="p">[</span><span class="n">text</span><span class="p">])</span>
<span class="k">except</span> <span class="p">(</span><span class="ne">ValueError</span><span class="p">,</span> <span class="ne">KeyError</span><span class="p">):</span>
<span class="k">return</span> <span class="n">match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="n">_entity_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="s2">r"&(#?[xX]?(?:[0-9a-fA-F]+|\w{1,8}));"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">unescape_entities</span><span class="p">(</span><span class="n">text</span><span class="p">):</span>
<span class="k">return</span> <span class="n">_entity_re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="n">_replace_entity</span><span class="p">,</span> <span class="n">text</span><span class="p">)</span>
<span class="n">unescape_entities</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">unescape_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">unescape_string_literal</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="sd">r"""</span>
<span class="sd"> Convert quoted string literals to unquoted strings with escaped quotes and</span>
<span class="sd"> backslashes unquoted::</span>
<span class="sd"> >>> unescape_string_literal('"abc"')</span>
<span class="sd"> 'abc'</span>
<span class="sd"> >>> unescape_string_literal("'abc'")</span>
<span class="sd"> 'abc'</span>
<span class="sd"> >>> unescape_string_literal('"a \"bc\""')</span>
<span class="sd"> 'a "bc"'</span>
<span class="sd"> >>> unescape_string_literal("'\'ab\' c'")</span>
<span class="sd"> "'ab' c"</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">s</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">not</span> <span class="ow">in</span> <span class="s2">"</span><span class="se">\"</span><span class="s2">'"</span> <span class="ow">or</span> <span class="n">s</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">!=</span> <span class="n">s</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Not a string literal: </span><span class="si">%r</span><span class="s2">"</span> <span class="o">%</span> <span class="n">s</span><span class="p">)</span>
<span class="n">quote</span> <span class="o">=</span> <span class="n">s</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">return</span> <span class="n">s</span><span class="p">[</span><span class="mi">1</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">r'\</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">quote</span><span class="p">,</span> <span class="n">quote</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">r'</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="n">unescape_string_literal</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">unescape_string_literal</span><span class="p">)</span>
<div class="viewcode-block" id="slugify"><a class="viewcode-back" href="../../../ref/utils.html#django.utils.text.slugify">[docs]</a><span class="k">def</span> <span class="nf">slugify</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Converts to ASCII. Converts spaces to hyphens. Removes characters that</span>
<span class="sd"> aren't alphanumerics, underscores, or hyphens. Converts to lowercase.</span>
<span class="sd"> Also strips leading and trailing whitespace.</span>
<span class="sd"> """</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">force_text</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">unicodedata</span><span class="o">.</span><span class="n">normalize</span><span class="p">(</span><span class="s1">'NFKD'</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'ascii'</span><span class="p">,</span> <span class="s1">'ignore'</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="n">value</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s1">'[^\w\s-]'</span><span class="p">,</span> <span class="s1">''</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="k">return</span> <span class="n">mark_safe</span><span class="p">(</span><span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s1">'[-\s]+'</span><span class="p">,</span> <span class="s1">'-'</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span></div>
<span class="n">slugify</span> <span class="o">=</span> <span class="n">allow_lazy</span><span class="p">(</span><span class="n">slugify</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="k">def</span> <span class="nf">camel_case_to_spaces</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Splits CamelCase and converts to lower case. Also strips leading and</span>
<span class="sd"> trailing whitespace.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">re_camel_case</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s1">r' \1'</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
</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.text</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>
