<!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.http.response — 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-http-response">
<h1>Source code for django.http.response</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">datetime</span>
<span class="kn">import</span> <span class="nn">json</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">time</span>
<span class="kn">from</span> <span class="nn">email.header</span> <span class="k">import</span> <span class="n">Header</span>
<span class="kn">from</span> <span class="nn">django.conf</span> <span class="k">import</span> <span class="n">settings</span>
<span class="kn">from</span> <span class="nn">django.core</span> <span class="k">import</span> <span class="n">signals</span><span class="p">,</span> <span class="n">signing</span>
<span class="kn">from</span> <span class="nn">django.core.exceptions</span> <span class="k">import</span> <span class="n">DisallowedRedirect</span>
<span class="kn">from</span> <span class="nn">django.core.serializers.json</span> <span class="k">import</span> <span class="n">DjangoJSONEncoder</span>
<span class="kn">from</span> <span class="nn">django.http.cookie</span> <span class="k">import</span> <span class="n">SimpleCookie</span>
<span class="kn">from</span> <span class="nn">django.utils</span> <span class="k">import</span> <span class="n">six</span><span class="p">,</span> <span class="n">timezone</span>
<span class="kn">from</span> <span class="nn">django.utils.encoding</span> <span class="k">import</span> <span class="p">(</span>
<span class="n">force_bytes</span><span class="p">,</span> <span class="n">force_str</span><span class="p">,</span> <span class="n">force_text</span><span class="p">,</span> <span class="n">iri_to_uri</span><span class="p">,</span>
<span class="p">)</span>
<span class="kn">from</span> <span class="nn">django.utils.http</span> <span class="k">import</span> <span class="n">cookie_date</span>
<span class="kn">from</span> <span class="nn">django.utils.six.moves</span> <span class="k">import</span> <span class="nb">map</span>
<span class="kn">from</span> <span class="nn">django.utils.six.moves.urllib.parse</span> <span class="k">import</span> <span class="n">urlparse</span>
<span class="c1"># See http://www.iana.org/assignments/http-status-codes</span>
<span class="n">REASON_PHRASES</span> <span class="o">=</span> <span class="p">{</span>
<span class="mi">100</span><span class="p">:</span> <span class="s1">'CONTINUE'</span><span class="p">,</span>
<span class="mi">101</span><span class="p">:</span> <span class="s1">'SWITCHING PROTOCOLS'</span><span class="p">,</span>
<span class="mi">102</span><span class="p">:</span> <span class="s1">'PROCESSING'</span><span class="p">,</span>
<span class="mi">200</span><span class="p">:</span> <span class="s1">'OK'</span><span class="p">,</span>
<span class="mi">201</span><span class="p">:</span> <span class="s1">'CREATED'</span><span class="p">,</span>
<span class="mi">202</span><span class="p">:</span> <span class="s1">'ACCEPTED'</span><span class="p">,</span>
<span class="mi">203</span><span class="p">:</span> <span class="s1">'NON-AUTHORITATIVE INFORMATION'</span><span class="p">,</span>
<span class="mi">204</span><span class="p">:</span> <span class="s1">'NO CONTENT'</span><span class="p">,</span>
<span class="mi">205</span><span class="p">:</span> <span class="s1">'RESET CONTENT'</span><span class="p">,</span>
<span class="mi">206</span><span class="p">:</span> <span class="s1">'PARTIAL CONTENT'</span><span class="p">,</span>
<span class="mi">207</span><span class="p">:</span> <span class="s1">'MULTI-STATUS'</span><span class="p">,</span>
<span class="mi">208</span><span class="p">:</span> <span class="s1">'ALREADY REPORTED'</span><span class="p">,</span>
<span class="mi">226</span><span class="p">:</span> <span class="s1">'IM USED'</span><span class="p">,</span>
<span class="mi">300</span><span class="p">:</span> <span class="s1">'MULTIPLE CHOICES'</span><span class="p">,</span>
<span class="mi">301</span><span class="p">:</span> <span class="s1">'MOVED PERMANENTLY'</span><span class="p">,</span>
<span class="mi">302</span><span class="p">:</span> <span class="s1">'FOUND'</span><span class="p">,</span>
<span class="mi">303</span><span class="p">:</span> <span class="s1">'SEE OTHER'</span><span class="p">,</span>
<span class="mi">304</span><span class="p">:</span> <span class="s1">'NOT MODIFIED'</span><span class="p">,</span>
<span class="mi">305</span><span class="p">:</span> <span class="s1">'USE PROXY'</span><span class="p">,</span>
<span class="mi">306</span><span class="p">:</span> <span class="s1">'RESERVED'</span><span class="p">,</span>
<span class="mi">307</span><span class="p">:</span> <span class="s1">'TEMPORARY REDIRECT'</span><span class="p">,</span>
<span class="mi">308</span><span class="p">:</span> <span class="s1">'PERMANENT REDIRECT'</span><span class="p">,</span>
<span class="mi">400</span><span class="p">:</span> <span class="s1">'BAD REQUEST'</span><span class="p">,</span>
<span class="mi">401</span><span class="p">:</span> <span class="s1">'UNAUTHORIZED'</span><span class="p">,</span>
<span class="mi">402</span><span class="p">:</span> <span class="s1">'PAYMENT REQUIRED'</span><span class="p">,</span>
<span class="mi">403</span><span class="p">:</span> <span class="s1">'FORBIDDEN'</span><span class="p">,</span>
<span class="mi">404</span><span class="p">:</span> <span class="s1">'NOT FOUND'</span><span class="p">,</span>
<span class="mi">405</span><span class="p">:</span> <span class="s1">'METHOD NOT ALLOWED'</span><span class="p">,</span>
<span class="mi">406</span><span class="p">:</span> <span class="s1">'NOT ACCEPTABLE'</span><span class="p">,</span>
<span class="mi">407</span><span class="p">:</span> <span class="s1">'PROXY AUTHENTICATION REQUIRED'</span><span class="p">,</span>
<span class="mi">408</span><span class="p">:</span> <span class="s1">'REQUEST TIMEOUT'</span><span class="p">,</span>
<span class="mi">409</span><span class="p">:</span> <span class="s1">'CONFLICT'</span><span class="p">,</span>
<span class="mi">410</span><span class="p">:</span> <span class="s1">'GONE'</span><span class="p">,</span>
<span class="mi">411</span><span class="p">:</span> <span class="s1">'LENGTH REQUIRED'</span><span class="p">,</span>
<span class="mi">412</span><span class="p">:</span> <span class="s1">'PRECONDITION FAILED'</span><span class="p">,</span>
<span class="mi">413</span><span class="p">:</span> <span class="s1">'REQUEST ENTITY TOO LARGE'</span><span class="p">,</span>
<span class="mi">414</span><span class="p">:</span> <span class="s1">'REQUEST-URI TOO LONG'</span><span class="p">,</span>
<span class="mi">415</span><span class="p">:</span> <span class="s1">'UNSUPPORTED MEDIA TYPE'</span><span class="p">,</span>
<span class="mi">416</span><span class="p">:</span> <span class="s1">'REQUESTED RANGE NOT SATISFIABLE'</span><span class="p">,</span>
<span class="mi">417</span><span class="p">:</span> <span class="s1">'EXPECTATION FAILED'</span><span class="p">,</span>
<span class="mi">418</span><span class="p">:</span> <span class="s2">"I'M A TEAPOT"</span><span class="p">,</span>
<span class="mi">422</span><span class="p">:</span> <span class="s1">'UNPROCESSABLE ENTITY'</span><span class="p">,</span>
<span class="mi">423</span><span class="p">:</span> <span class="s1">'LOCKED'</span><span class="p">,</span>
<span class="mi">424</span><span class="p">:</span> <span class="s1">'FAILED DEPENDENCY'</span><span class="p">,</span>
<span class="mi">426</span><span class="p">:</span> <span class="s1">'UPGRADE REQUIRED'</span><span class="p">,</span>
<span class="mi">428</span><span class="p">:</span> <span class="s1">'PRECONDITION REQUIRED'</span><span class="p">,</span>
<span class="mi">429</span><span class="p">:</span> <span class="s1">'TOO MANY REQUESTS'</span><span class="p">,</span>
<span class="mi">431</span><span class="p">:</span> <span class="s1">'REQUEST HEADER FIELDS TOO LARGE'</span><span class="p">,</span>
<span class="mi">500</span><span class="p">:</span> <span class="s1">'INTERNAL SERVER ERROR'</span><span class="p">,</span>
<span class="mi">501</span><span class="p">:</span> <span class="s1">'NOT IMPLEMENTED'</span><span class="p">,</span>
<span class="mi">502</span><span class="p">:</span> <span class="s1">'BAD GATEWAY'</span><span class="p">,</span>
<span class="mi">503</span><span class="p">:</span> <span class="s1">'SERVICE UNAVAILABLE'</span><span class="p">,</span>
<span class="mi">504</span><span class="p">:</span> <span class="s1">'GATEWAY TIMEOUT'</span><span class="p">,</span>
<span class="mi">505</span><span class="p">:</span> <span class="s1">'HTTP VERSION NOT SUPPORTED'</span><span class="p">,</span>
<span class="mi">506</span><span class="p">:</span> <span class="s1">'VARIANT ALSO NEGOTIATES'</span><span class="p">,</span>
<span class="mi">507</span><span class="p">:</span> <span class="s1">'INSUFFICIENT STORAGE'</span><span class="p">,</span>
<span class="mi">508</span><span class="p">:</span> <span class="s1">'LOOP DETECTED'</span><span class="p">,</span>
<span class="mi">510</span><span class="p">:</span> <span class="s1">'NOT EXTENDED'</span><span class="p">,</span>
<span class="mi">511</span><span class="p">:</span> <span class="s1">'NETWORK AUTHENTICATION REQUIRED'</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">_charset_from_content_type_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*charset=(?P<charset>[^\s;]+)'</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">I</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">BadHeaderError</span><span class="p">(</span><span class="ne">ValueError</span><span class="p">):</span>
<span class="k">pass</span>
<span class="k">class</span> <span class="nc">HttpResponseBase</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">Iterator</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> An HTTP response base class with dictionary-accessed headers.</span>
<span class="sd"> This class doesn't handle content. It should not be used directly.</span>
<span class="sd"> Use the HttpResponse and StreamingHttpResponse subclasses instead.</span>
<span class="sd"> """</span>
<span class="n">status_code</span> <span class="o">=</span> <span class="mi">200</span>
<span class="n">reason_phrase</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># Use default reason phrase for status code.</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">content_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">status</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">reason</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">charset</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="c1"># _headers is a mapping of the lower-case name to the original case of</span>
<span class="c1"># the header (required for working with legacy systems) and the header</span>
<span class="c1"># value. Both the name of the header and its value are ASCII strings.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_headers</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_closable_objects</span> <span class="o">=</span> <span class="p">[]</span>
<span class="c1"># This parameter is set by the handler. It's necessary to preserve the</span>
<span class="c1"># historical behavior of request_finished.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_handler_class</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cookies</span> <span class="o">=</span> <span class="n">SimpleCookie</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">closed</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">if</span> <span class="n">status</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">status_code</span> <span class="o">=</span> <span class="n">status</span>
<span class="k">if</span> <span class="n">reason</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">reason_phrase</span> <span class="o">=</span> <span class="n">reason</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">reason_phrase</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">reason_phrase</span> <span class="o">=</span> <span class="n">REASON_PHRASES</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
<span class="s1">'UNKNOWN STATUS CODE'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_charset</span> <span class="o">=</span> <span class="n">charset</span>
<span class="k">if</span> <span class="n">content_type</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">content_type</span> <span class="o">=</span> <span class="s1">'</span><span class="si">%s</span><span class="s1">; charset=</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">settings</span><span class="o">.</span><span class="n">DEFAULT_CONTENT_TYPE</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">charset</span><span class="p">)</span>
<span class="bp">self</span><span class="p">[</span><span class="s1">'Content-Type'</span><span class="p">]</span> <span class="o">=</span> <span class="n">content_type</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">charset</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_charset</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_charset</span>
<span class="n">content_type</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'Content-Type'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span>
<span class="n">matched</span> <span class="o">=</span> <span class="n">_charset_from_content_type_re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">content_type</span><span class="p">)</span>
<span class="k">if</span> <span class="n">matched</span><span class="p">:</span>
<span class="c1"># Extract the charset and strip its double quotes</span>
<span class="k">return</span> <span class="n">matched</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s1">'charset'</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">settings</span><span class="o">.</span><span class="n">DEFAULT_CHARSET</span>
<span class="nd">@charset</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">charset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_charset</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">def</span> <span class="nf">serialize_headers</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""HTTP headers as a bytestring."""</span>
<span class="k">def</span> <span class="nf">to_bytes</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="n">encoding</span><span class="p">):</span>
<span class="k">return</span> <span class="n">val</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">val</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">)</span> <span class="k">else</span> <span class="n">val</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">encoding</span><span class="p">)</span>
<span class="n">headers</span> <span class="o">=</span> <span class="p">[</span>
<span class="p">(</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="n">to_bytes</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="s1">'ascii'</span><span class="p">),</span> <span class="n">to_bytes</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="s1">'latin-1'</span><span class="p">)]))</span>
<span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_headers</span><span class="o">.</span><span class="n">values</span><span class="p">()</span>
<span class="p">]</span>
<span class="k">return</span> <span class="n">b</span><span class="s1">'</span><span class="se">\r\n</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">headers</span><span class="p">)</span>
<span class="k">if</span> <span class="n">six</span><span class="o">.</span><span class="n">PY3</span><span class="p">:</span>
<span class="n">__bytes__</span> <span class="o">=</span> <span class="n">serialize_headers</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">__str__</span> <span class="o">=</span> <span class="n">serialize_headers</span>
<span class="k">def</span> <span class="nf">_convert_to_charset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">charset</span><span class="p">,</span> <span class="n">mime_encode</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""Converts headers key/value to ascii/latin-1 native strings.</span>
<span class="sd"> `charset` must be 'ascii' or 'latin-1'. If `mime_encode` is True and</span>
<span class="sd"> `value` can't be represented in the given charset, MIME-encoding</span>
<span class="sd"> is applied.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="p">(</span><span class="nb">bytes</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">value</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">if</span> <span class="p">((</span><span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">)</span> <span class="ow">and</span> <span class="p">(</span><span class="n">b</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span> <span class="ow">in</span> <span class="n">value</span> <span class="ow">or</span> <span class="n">b</span><span class="s1">'</span><span class="se">\r</span><span class="s1">'</span> <span class="ow">in</span> <span class="n">value</span><span class="p">))</span> <span class="ow">or</span>
<span class="nb">isinstance</span><span class="p">(</span><span class="n">value</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="ow">and</span> <span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span> <span class="ow">in</span> <span class="n">value</span> <span class="ow">or</span> <span class="s1">'</span><span class="se">\r</span><span class="s1">'</span> <span class="ow">in</span> <span class="n">value</span><span class="p">)):</span>
<span class="k">raise</span> <span class="n">BadHeaderError</span><span class="p">(</span><span class="s2">"Header values can't contain newlines (got </span><span class="si">%r</span><span class="s2">)"</span> <span class="o">%</span> <span class="n">value</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="n">six</span><span class="o">.</span><span class="n">PY3</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="c1"># Ensure string is valid in given charset</span>
<span class="n">value</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">charset</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Convert bytestring using given charset</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">charset</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="c1"># Ensure string is valid in given charset</span>
<span class="n">value</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="n">charset</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Convert unicode string to given charset</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">charset</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">UnicodeError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="k">if</span> <span class="n">mime_encode</span><span class="p">:</span>
<span class="c1"># Wrapping in str() is a workaround for #12422 under Python 2.</span>
<span class="n">value</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">Header</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="s1">'utf-8'</span><span class="p">,</span> <span class="n">maxlinelen</span><span class="o">=</span><span class="n">sys</span><span class="o">.</span><span class="n">maxsize</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">())</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">e</span><span class="o">.</span><span class="n">reason</span> <span class="o">+=</span> <span class="s1">', HTTP response headers must be in </span><span class="si">%s</span><span class="s1"> format'</span> <span class="o">%</span> <span class="n">charset</span>
<span class="k">raise</span>
<span class="k">return</span> <span class="n">value</span>
<span class="k">def</span> <span class="nf">__setitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">header</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="n">header</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_convert_to_charset</span><span class="p">(</span><span class="n">header</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="bp">self</span><span class="o">.</span><span class="n">_convert_to_charset</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="s1">'latin-1'</span><span class="p">,</span> <span class="n">mime_encode</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_headers</span><span class="p">[</span><span class="n">header</span><span class="o">.</span><span class="n">lower</span><span class="p">()]</span> <span class="o">=</span> <span class="p">(</span><span class="n">header</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__delitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">header</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">_headers</span><span class="p">[</span><span class="n">header</span><span class="o">.</span><span class="n">lower</span><span class="p">()]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">header</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_headers</span><span class="p">[</span><span class="n">header</span><span class="o">.</span><span class="n">lower</span><span class="p">()][</span><span class="mi">1</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">has_header</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">header</span><span class="p">):</span>
<span class="sd">"""Case-insensitive check for a header."""</span>
<span class="k">return</span> <span class="n">header</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_headers</span>
<span class="n">__contains__</span> <span class="o">=</span> <span class="n">has_header</span>
<span class="k">def</span> <span class="nf">items</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_headers</span><span class="o">.</span><span class="n">values</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">header</span><span class="p">,</span> <span class="n">alternate</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">header</span><span class="o">.</span><span class="n">lower</span><span class="p">(),</span> <span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">alternate</span><span class="p">))[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">set_cookie</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">''</span><span class="p">,</span> <span class="n">max_age</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">expires</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="s1">'/'</span><span class="p">,</span>
<span class="n">domain</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">secure</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">httponly</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Sets a cookie.</span>
<span class="sd"> ``expires`` can be:</span>
<span class="sd"> - a string in the correct format,</span>
<span class="sd"> - a naive ``datetime.datetime`` object in UTC,</span>
<span class="sd"> - an aware ``datetime.datetime`` object in any time zone.</span>
<span class="sd"> If it is a ``datetime.datetime`` object then ``max_age`` will be calculated.</span>
<span class="sd"> """</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">force_str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cookies</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">if</span> <span class="n">expires</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">expires</span><span class="p">,</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="p">):</span>
<span class="k">if</span> <span class="n">timezone</span><span class="o">.</span><span class="n">is_aware</span><span class="p">(</span><span class="n">expires</span><span class="p">):</span>
<span class="n">expires</span> <span class="o">=</span> <span class="n">timezone</span><span class="o">.</span><span class="n">make_naive</span><span class="p">(</span><span class="n">expires</span><span class="p">,</span> <span class="n">timezone</span><span class="o">.</span><span class="n">utc</span><span class="p">)</span>
<span class="n">delta</span> <span class="o">=</span> <span class="n">expires</span> <span class="o">-</span> <span class="n">expires</span><span class="o">.</span><span class="n">utcnow</span><span class="p">()</span>
<span class="c1"># Add one second so the date matches exactly (a fraction of</span>
<span class="c1"># time gets lost between converting to a timedelta and</span>
<span class="c1"># then the date string).</span>
<span class="n">delta</span> <span class="o">=</span> <span class="n">delta</span> <span class="o">+</span> <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span><span class="n">seconds</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<span class="c1"># Just set max_age - the max_age logic will set expires.</span>
<span class="n">expires</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">max_age</span> <span class="o">=</span> <span class="nb">max</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">delta</span><span class="o">.</span><span class="n">days</span> <span class="o">*</span> <span class="mi">86400</span> <span class="o">+</span> <span class="n">delta</span><span class="o">.</span><span class="n">seconds</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cookies</span><span class="p">[</span><span class="n">key</span><span class="p">][</span><span class="s1">'expires'</span><span class="p">]</span> <span class="o">=</span> <span class="n">expires</span>
<span class="k">if</span> <span class="n">max_age</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cookies</span><span class="p">[</span><span class="n">key</span><span class="p">][</span><span class="s1">'max-age'</span><span class="p">]</span> <span class="o">=</span> <span class="n">max_age</span>
<span class="c1"># IE requires expires, so set it if hasn't been already.</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">expires</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cookies</span><span class="p">[</span><span class="n">key</span><span class="p">][</span><span class="s1">'expires'</span><span class="p">]</span> <span class="o">=</span> <span class="n">cookie_date</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">+</span>
<span class="n">max_age</span><span class="p">)</span>
<span class="k">if</span> <span class="n">path</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cookies</span><span class="p">[</span><span class="n">key</span><span class="p">][</span><span class="s1">'path'</span><span class="p">]</span> <span class="o">=</span> <span class="n">path</span>
<span class="k">if</span> <span class="n">domain</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cookies</span><span class="p">[</span><span class="n">key</span><span class="p">][</span><span class="s1">'domain'</span><span class="p">]</span> <span class="o">=</span> <span class="n">domain</span>
<span class="k">if</span> <span class="n">secure</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cookies</span><span class="p">[</span><span class="n">key</span><span class="p">][</span><span class="s1">'secure'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">if</span> <span class="n">httponly</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cookies</span><span class="p">[</span><span class="n">key</span><span class="p">][</span><span class="s1">'httponly'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">def</span> <span class="nf">setdefault</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""Sets a header unless it has already been set."""</span>
<span class="k">if</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">:</span>
<span class="bp">self</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">def</span> <span class="nf">set_signed_cookie</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">salt</span><span class="o">=</span><span class="s1">''</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">signing</span><span class="o">.</span><span class="n">get_cookie_signer</span><span class="p">(</span><span class="n">salt</span><span class="o">=</span><span class="n">key</span> <span class="o">+</span> <span class="n">salt</span><span class="p">)</span><span class="o">.</span><span class="n">sign</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">set_cookie</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">delete_cookie</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="s1">'/'</span><span class="p">,</span> <span class="n">domain</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_cookie</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">max_age</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="n">path</span><span class="p">,</span> <span class="n">domain</span><span class="o">=</span><span class="n">domain</span><span class="p">,</span>
<span class="n">expires</span><span class="o">=</span><span class="s1">'Thu, 01-Jan-1970 00:00:00 GMT'</span><span class="p">)</span>
<span class="c1"># Common methods used by subclasses</span>
<span class="k">def</span> <span class="nf">make_bytes</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""Turn a value into a bytestring encoded in the output charset."""</span>
<span class="c1"># Per PEP 3333, this response body must be bytes. To avoid returning</span>
<span class="c1"># an instance of a subclass, this function returns `bytes(value)`.</span>
<span class="c1"># This doesn't make a copy when `value` already contains bytes.</span>
<span class="c1"># Handle string types -- we can't rely on force_bytes here because:</span>
<span class="c1"># - under Python 3 it attempts str conversion first</span>
<span class="c1"># - when self._charset != 'utf-8' it re-encodes the content</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">bytes</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</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">return</span> <span class="nb">bytes</span><span class="p">(</span><span class="n">value</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">charset</span><span class="p">))</span>
<span class="c1"># Handle non-string types (#16494)</span>
<span class="k">return</span> <span class="n">force_bytes</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">charset</span><span class="p">)</span>
<span class="c1"># These methods partially implement the file-like object interface.</span>
<span class="c1"># See http://docs.python.org/lib/bltin-file-objects.html</span>
<span class="c1"># The WSGI server must call this method upon completion of the request.</span>
<span class="c1"># See http://blog.dscpl.com.au/2012/10/obligations-for-calling-close-on.html</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">for</span> <span class="n">closable</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_closable_objects</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">closable</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">pass</span>
<span class="bp">self</span><span class="o">.</span><span class="n">closed</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">signals</span><span class="o">.</span><span class="n">request_finished</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="n">sender</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_handler_class</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">content</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">IOError</span><span class="p">(</span><span class="s2">"This </span><span class="si">%s</span><span class="s2"> instance is not writable"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">)</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">pass</span>
<span class="k">def</span> <span class="nf">tell</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">IOError</span><span class="p">(</span><span class="s2">"This </span><span class="si">%s</span><span class="s2"> instance cannot tell its position"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">)</span>
<span class="c1"># These methods partially implement a stream-like object interface.</span>
<span class="c1"># See https://docs.python.org/library/io.html#io.IOBase</span>
<span class="k">def</span> <span class="nf">writable</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">def</span> <span class="nf">writelines</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">lines</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">IOError</span><span class="p">(</span><span class="s2">"This </span><span class="si">%s</span><span class="s2"> instance is not writable"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">)</span>
<div class="viewcode-block" id="HttpResponse"><a class="viewcode-back" href="../../../ref/request-response.html#django.middleware.common.HttpResponse">[docs]</a><span class="k">class</span> <span class="nc">HttpResponse</span><span class="p">(</span><span class="n">HttpResponseBase</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> An HTTP response class with a string as content.</span>
<span class="sd"> This content that can be read, appended to or replaced.</span>
<span class="sd"> """</span>
<span class="n">streaming</span> <span class="o">=</span> <span class="kc">False</span>
<div class="viewcode-block" id="HttpResponse.__init__"><a class="viewcode-back" href="../../../ref/request-response.html#django.middleware.common.HttpResponse.__init__">[docs]</a> <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">content</span><span class="o">=</span><span class="n">b</span><span class="s1">''</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="nb">super</span><span class="p">(</span><span class="n">HttpResponse</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="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="c1"># Content is a bytestring. See the `content` property methods.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">content</span> <span class="o">=</span> <span class="n">content</span></div>
<span class="k">def</span> <span class="nf">serialize</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Full HTTP message, including headers, as a bytestring."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">serialize_headers</span><span class="p">()</span> <span class="o">+</span> <span class="n">b</span><span class="s1">'</span><span class="se">\r\n\r\n</span><span class="s1">'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">content</span>
<span class="k">if</span> <span class="n">six</span><span class="o">.</span><span class="n">PY3</span><span class="p">:</span>
<span class="n">__bytes__</span> <span class="o">=</span> <span class="n">serialize</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">__str__</span> <span class="o">=</span> <span class="n">serialize</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">content</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</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">_container</span><span class="p">)</span>
<span class="nd">@content</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">content</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="c1"># Consume iterators upon assignment to allow repeated iteration.</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="s1">'__iter__'</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="p">(</span><span class="nb">bytes</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">)):</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="s1">'close'</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_closable_objects</span><span class="o">.</span><span class="n">append</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">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">make_bytes</span><span class="p">(</span><span class="n">chunk</span><span class="p">)</span> <span class="k">for</span> <span class="n">chunk</span> <span class="ow">in</span> <span class="n">value</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">make_bytes</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="c1"># Create a list of properly encoded bytestrings to support write().</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_container</span> <span class="o">=</span> <span class="p">[</span><span class="n">value</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">iter</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_container</span><span class="p">)</span>
<div class="viewcode-block" id="HttpResponse.write"><a class="viewcode-back" href="../../../ref/request-response.html#django.middleware.common.HttpResponse.write">[docs]</a> <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">content</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_container</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">make_bytes</span><span class="p">(</span><span class="n">content</span><span class="p">))</span></div>
<div class="viewcode-block" id="HttpResponse.tell"><a class="viewcode-back" href="../../../ref/request-response.html#django.middleware.common.HttpResponse.tell">[docs]</a> <span class="k">def</span> <span class="nf">tell</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">content</span><span class="p">)</span></div>
<div class="viewcode-block" id="HttpResponse.getvalue"><a class="viewcode-back" href="../../../ref/request-response.html#django.middleware.common.HttpResponse.getvalue">[docs]</a> <span class="k">def</span> <span class="nf">getvalue</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">content</span></div>
<div class="viewcode-block" id="HttpResponse.writable"><a class="viewcode-back" href="../../../ref/request-response.html#django.middleware.common.HttpResponse.writable">[docs]</a> <span class="k">def</span> <span class="nf">writable</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="HttpResponse.writelines"><a class="viewcode-back" href="../../../ref/request-response.html#django.middleware.common.HttpResponse.writelines">[docs]</a> <span class="k">def</span> <span class="nf">writelines</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">lines</span><span class="p">):</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">lines</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">line</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="StreamingHttpResponse"><a class="viewcode-back" href="../../../ref/request-response.html#django.middleware.common.StreamingHttpResponse">[docs]</a><span class="k">class</span> <span class="nc">StreamingHttpResponse</span><span class="p">(</span><span class="n">HttpResponseBase</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A streaming HTTP response class with an iterator as content.</span>
<span class="sd"> This should only be iterated once, when the response is streamed to the</span>
<span class="sd"> client. However, it can be appended to or replaced with a new iterator</span>
<span class="sd"> that wraps the original content (or yields entirely new content).</span>
<span class="sd"> """</span>
<span class="n">streaming</span> <span class="o">=</span> <span class="kc">True</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">streaming_content</span><span class="o">=</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="nb">super</span><span class="p">(</span><span class="n">StreamingHttpResponse</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="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="c1"># `streaming_content` should be an iterable of bytestrings.</span>
<span class="c1"># See the `streaming_content` property methods.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">streaming_content</span> <span class="o">=</span> <span class="n">streaming_content</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">content</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">(</span><span class="s2">"This </span><span class="si">%s</span><span class="s2"> instance has no `content` attribute. "</span>
<span class="s2">"Use `streaming_content` instead."</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">streaming_content</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">map</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">make_bytes</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_iterator</span><span class="p">)</span>
<span class="nd">@streaming_content</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">streaming_content</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_set_streaming_content</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_set_streaming_content</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="c1"># Ensure we can never iterate on "value" more than once.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_iterator</span> <span class="o">=</span> <span class="nb">iter</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="s1">'close'</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_closable_objects</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">streaming_content</span>
<span class="k">def</span> <span class="nf">getvalue</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</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">streaming_content</span><span class="p">)</span></div>
<div class="viewcode-block" id="FileResponse"><a class="viewcode-back" href="../../../ref/request-response.html#django.middleware.common.FileResponse">[docs]</a><span class="k">class</span> <span class="nc">FileResponse</span><span class="p">(</span><span class="n">StreamingHttpResponse</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A streaming HTTP response class optimized for files.</span>
<span class="sd"> """</span>
<span class="n">block_size</span> <span class="o">=</span> <span class="mi">4096</span>
<span class="k">def</span> <span class="nf">_set_streaming_content</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="s1">'read'</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">file_to_stream</span> <span class="o">=</span> <span class="n">value</span>
<span class="n">filelike</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">filelike</span><span class="p">,</span> <span class="s1">'close'</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_closable_objects</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">filelike</span><span class="p">)</span>
<span class="n">value</span> <span class="o">=</span> <span class="nb">iter</span><span class="p">(</span><span class="k">lambda</span><span class="p">:</span> <span class="n">filelike</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">block_size</span><span class="p">),</span> <span class="n">b</span><span class="s1">''</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">file_to_stream</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nb">super</span><span class="p">(</span><span class="n">FileResponse</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">_set_streaming_content</span><span class="p">(</span><span class="n">value</span><span class="p">)</span></div>
<span class="k">class</span> <span class="nc">HttpResponseRedirectBase</span><span class="p">(</span><span class="n">HttpResponse</span><span class="p">):</span>
<span class="n">allowed_schemes</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'http'</span><span class="p">,</span> <span class="s1">'https'</span><span class="p">,</span> <span class="s1">'ftp'</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="n">redirect_to</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="n">parsed</span> <span class="o">=</span> <span class="n">urlparse</span><span class="p">(</span><span class="n">force_text</span><span class="p">(</span><span class="n">redirect_to</span><span class="p">))</span>
<span class="k">if</span> <span class="n">parsed</span><span class="o">.</span><span class="n">scheme</span> <span class="ow">and</span> <span class="n">parsed</span><span class="o">.</span><span class="n">scheme</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">allowed_schemes</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">DisallowedRedirect</span><span class="p">(</span><span class="s2">"Unsafe redirect to URL with protocol '</span><span class="si">%s</span><span class="s2">'"</span> <span class="o">%</span> <span class="n">parsed</span><span class="o">.</span><span class="n">scheme</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">HttpResponseRedirectBase</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="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="bp">self</span><span class="p">[</span><span class="s1">'Location'</span><span class="p">]</span> <span class="o">=</span> <span class="n">iri_to_uri</span><span class="p">(</span><span class="n">redirect_to</span><span class="p">)</span>
<span class="n">url</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="k">lambda</span> <span class="bp">self</span><span class="p">:</span> <span class="bp">self</span><span class="p">[</span><span class="s1">'Location'</span><span class="p">])</span>
<div class="viewcode-block" id="HttpResponseRedirect"><a class="viewcode-back" href="../../../ref/request-response.html#django.middleware.common.HttpResponseRedirect">[docs]</a><span class="k">class</span> <span class="nc">HttpResponseRedirect</span><span class="p">(</span><span class="n">HttpResponseRedirectBase</span><span class="p">):</span>
<span class="n">status_code</span> <span class="o">=</span> <span class="mi">302</span></div>
<div class="viewcode-block" id="HttpResponsePermanentRedirect"><a class="viewcode-back" href="../../../ref/request-response.html#django.middleware.common.HttpResponsePermanentRedirect">[docs]</a><span class="k">class</span> <span class="nc">HttpResponsePermanentRedirect</span><span class="p">(</span><span class="n">HttpResponseRedirectBase</span><span class="p">):</span>
<span class="n">status_code</span> <span class="o">=</span> <span class="mi">301</span></div>
<div class="viewcode-block" id="HttpResponseNotModified"><a class="viewcode-back" href="../../../ref/request-response.html#django.middleware.common.HttpResponseNotModified">[docs]</a><span class="k">class</span> <span class="nc">HttpResponseNotModified</span><span class="p">(</span><span class="n">HttpResponse</span><span class="p">):</span>
<span class="n">status_code</span> <span class="o">=</span> <span class="mi">304</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="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="nb">super</span><span class="p">(</span><span class="n">HttpResponseNotModified</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="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="k">del</span> <span class="bp">self</span><span class="p">[</span><span class="s1">'content-type'</span><span class="p">]</span>
<span class="nd">@HttpResponse</span><span class="o">.</span><span class="n">content</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">content</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="k">if</span> <span class="n">value</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">(</span><span class="s2">"You cannot set content to a 304 (Not Modified) response"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_container</span> <span class="o">=</span> <span class="p">[]</span></div>
<div class="viewcode-block" id="HttpResponseBadRequest"><a class="viewcode-back" href="../../../ref/request-response.html#django.middleware.common.HttpResponseBadRequest">[docs]</a><span class="k">class</span> <span class="nc">HttpResponseBadRequest</span><span class="p">(</span><span class="n">HttpResponse</span><span class="p">):</span>
<span class="n">status_code</span> <span class="o">=</span> <span class="mi">400</span></div>
<div class="viewcode-block" id="HttpResponseNotFound"><a class="viewcode-back" href="../../../ref/request-response.html#django.middleware.common.HttpResponseNotFound">[docs]</a><span class="k">class</span> <span class="nc">HttpResponseNotFound</span><span class="p">(</span><span class="n">HttpResponse</span><span class="p">):</span>
<span class="n">status_code</span> <span class="o">=</span> <span class="mi">404</span></div>
<div class="viewcode-block" id="HttpResponseForbidden"><a class="viewcode-back" href="../../../ref/request-response.html#django.middleware.common.HttpResponseForbidden">[docs]</a><span class="k">class</span> <span class="nc">HttpResponseForbidden</span><span class="p">(</span><span class="n">HttpResponse</span><span class="p">):</span>
<span class="n">status_code</span> <span class="o">=</span> <span class="mi">403</span></div>
<div class="viewcode-block" id="HttpResponseNotAllowed"><a class="viewcode-back" href="../../../ref/request-response.html#django.middleware.common.HttpResponseNotAllowed">[docs]</a><span class="k">class</span> <span class="nc">HttpResponseNotAllowed</span><span class="p">(</span><span class="n">HttpResponse</span><span class="p">):</span>
<span class="n">status_code</span> <span class="o">=</span> <span class="mi">405</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">permitted_methods</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="nb">super</span><span class="p">(</span><span class="n">HttpResponseNotAllowed</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="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="bp">self</span><span class="p">[</span><span class="s1">'Allow'</span><span class="p">]</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">permitted_methods</span><span class="p">)</span></div>
<div class="viewcode-block" id="HttpResponseGone"><a class="viewcode-back" href="../../../ref/request-response.html#django.middleware.common.HttpResponseGone">[docs]</a><span class="k">class</span> <span class="nc">HttpResponseGone</span><span class="p">(</span><span class="n">HttpResponse</span><span class="p">):</span>
<span class="n">status_code</span> <span class="o">=</span> <span class="mi">410</span></div>
<div class="viewcode-block" id="HttpResponseServerError"><a class="viewcode-back" href="../../../ref/request-response.html#django.middleware.common.HttpResponseServerError">[docs]</a><span class="k">class</span> <span class="nc">HttpResponseServerError</span><span class="p">(</span><span class="n">HttpResponse</span><span class="p">):</span>
<span class="n">status_code</span> <span class="o">=</span> <span class="mi">500</span></div>
<span class="k">class</span> <span class="nc">Http404</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="k">pass</span>
<div class="viewcode-block" id="JsonResponse"><a class="viewcode-back" href="../../../ref/request-response.html#django.middleware.common.JsonResponse">[docs]</a><span class="k">class</span> <span class="nc">JsonResponse</span><span class="p">(</span><span class="n">HttpResponse</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> An HTTP response class that consumes data to be serialized to JSON.</span>
<span class="sd"> :param data: Data to be dumped into json. By default only ``dict`` objects</span>
<span class="sd"> are allowed to be passed due to a security flaw before EcmaScript 5. See</span>
<span class="sd"> the ``safe`` parameter for more information.</span>
<span class="sd"> :param encoder: Should be an json encoder class. Defaults to</span>
<span class="sd"> ``django.core.serializers.json.DjangoJSONEncoder``.</span>
<span class="sd"> :param safe: Controls if only ``dict`` objects may be serialized. Defaults</span>
<span class="sd"> to ``True``.</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">data</span><span class="p">,</span> <span class="n">encoder</span><span class="o">=</span><span class="n">DjangoJSONEncoder</span><span class="p">,</span> <span class="n">safe</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">if</span> <span class="n">safe</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'In order to allow non-dict objects to be '</span>
<span class="s1">'serialized set the safe parameter to False'</span><span class="p">)</span>
<span class="n">kwargs</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="s1">'content_type'</span><span class="p">,</span> <span class="s1">'application/json'</span><span class="p">)</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">cls</span><span class="o">=</span><span class="n">encoder</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">JsonResponse</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="n">content</span><span class="o">=</span><span class="n">data</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</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.http.response</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
>
122
