/usr/share/doc/python-werkzeug-doc/html/quickstart.html is in python-werkzeug-doc 0.10.4+dfsg1-1ubuntu1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 | <!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">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Quickstart — Werkzeug 0.10.4 documentation</title>
<link rel="stylesheet" href="_static/werkzeug.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.10.4',
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="top" title="Werkzeug 0.10.4 documentation" href="index.html" />
<link rel="next" title="Python 3 Notes" href="python3.html" />
<link rel="prev" title="API Levels" href="levels.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="python3.html" title="Python 3 Notes"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="levels.html" title="API Levels"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Werkzeug 0.10.4 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-werkzeug">
<span id="quickstart"></span><h1>Quickstart<a class="headerlink" href="#module-werkzeug" title="Permalink to this headline">¶</a></h1>
<p>This part of the documentation shows how to use the most important parts of
Werkzeug. It’s intended as a starting point for developers with basic
understanding of <span class="target" id="index-0"></span><a class="pep reference external" href="https://www.python.org/dev/peps/pep-0333"><strong>PEP 333</strong></a> (WSGI) and <span class="target" id="index-1"></span><a class="rfc reference external" href="https://tools.ietf.org/html/rfc2616.html"><strong>RFC 2616</strong></a> (HTTP).</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p>Make sure to import all objects from the places the documentation
suggests. It is theoretically possible in some situations to import
objects from different locations but this is not supported.</p>
<p class="last">For example <code class="xref py py-class docutils literal"><span class="pre">MultiDict</span></code> is a member of the <cite>werkzeug</cite> module
but internally implemented in a different one.</p>
</div>
<div class="section" id="wsgi-environment">
<h2>WSGI Environment<a class="headerlink" href="#wsgi-environment" title="Permalink to this headline">¶</a></h2>
<p>The WSGI environment contains all the information the user request transmits
to the application. It is passed to the WSGI application but you can also
create a WSGI environ dict using the <code class="xref py py-func docutils literal"><span class="pre">create_environ()</span></code> helper:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">werkzeug.test</span> <span class="kn">import</span> <span class="n">create_environ</span>
<span class="gp">>>> </span><span class="n">environ</span> <span class="o">=</span> <span class="n">create_environ</span><span class="p">(</span><span class="s1">'/foo'</span><span class="p">,</span> <span class="s1">'http://localhost:8080/'</span><span class="p">)</span>
</pre></div>
</div>
<p>Now we have an environment to play around:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">environ</span><span class="p">[</span><span class="s1">'PATH_INFO'</span><span class="p">]</span>
<span class="go">'/foo'</span>
<span class="gp">>>> </span><span class="n">environ</span><span class="p">[</span><span class="s1">'SCRIPT_NAME'</span><span class="p">]</span>
<span class="go">''</span>
<span class="gp">>>> </span><span class="n">environ</span><span class="p">[</span><span class="s1">'SERVER_NAME'</span><span class="p">]</span>
<span class="go">'localhost'</span>
</pre></div>
</div>
<p>Usually nobody wants to work with the environ directly because it is limited
to bytestrings and does not provide any way to access the form data besides
parsing that data by hand.</p>
</div>
<div class="section" id="enter-request">
<h2>Enter Request<a class="headerlink" href="#enter-request" title="Permalink to this headline">¶</a></h2>
<p>For access to the request data the <code class="xref py py-class docutils literal"><span class="pre">Request</span></code> object is much more fun.
It wraps the <cite>environ</cite> and provides a read-only access to the data from
there:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">werkzeug.wrappers</span> <span class="kn">import</span> <span class="n">Request</span>
<span class="gp">>>> </span><span class="n">request</span> <span class="o">=</span> <span class="n">Request</span><span class="p">(</span><span class="n">environ</span><span class="p">)</span>
</pre></div>
</div>
<p>Now you can access the important variables and Werkzeug will parse them
for you and decode them where it makes sense. The default charset for
requests is set to <cite>utf-8</cite> but you can change that by subclassing
<code class="xref py py-class docutils literal"><span class="pre">Request</span></code>.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">path</span>
<span class="go">u'/foo'</span>
<span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">script_root</span>
<span class="go">u''</span>
<span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">host</span>
<span class="go">'localhost:8080'</span>
<span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">url</span>
<span class="go">'http://localhost:8080/foo'</span>
</pre></div>
</div>
<p>We can also find out which HTTP method was used for the request:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">method</span>
<span class="go">'GET'</span>
</pre></div>
</div>
<p>This way we can also access URL arguments (the query string) and data that
was transmitted in a POST/PUT request.</p>
<p>For testing purposes we can create a request object from supplied data
using the <code class="xref py py-meth docutils literal"><span class="pre">from_values()</span></code> method:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">cStringIO</span> <span class="kn">import</span> <span class="n">StringIO</span>
<span class="gp">>>> </span><span class="n">data</span> <span class="o">=</span> <span class="s2">"name=this+is+encoded+form+data&another_key=another+one"</span>
<span class="gp">>>> </span><span class="n">request</span> <span class="o">=</span> <span class="n">Request</span><span class="o">.</span><span class="n">from_values</span><span class="p">(</span><span class="n">query_string</span><span class="o">=</span><span class="s1">'foo=bar&blah=blafasel'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">content_length</span><span class="o">=</span><span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">),</span> <span class="n">input_stream</span><span class="o">=</span><span class="n">StringIO</span><span class="p">(</span><span class="n">data</span><span class="p">),</span>
<span class="gp">... </span> <span class="n">content_type</span><span class="o">=</span><span class="s1">'application/x-www-form-urlencoded'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">method</span><span class="o">=</span><span class="s1">'POST'</span><span class="p">)</span>
<span class="gp">...</span>
<span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">method</span>
<span class="go">'POST'</span>
</pre></div>
</div>
<p>Now we can access the URL parameters easily:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">args</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
<span class="go">['blah', 'foo']</span>
<span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="s1">'blah'</span><span class="p">]</span>
<span class="go">u'blafasel'</span>
</pre></div>
</div>
<p>Same for the supplied form data:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">form</span><span class="p">[</span><span class="s1">'name'</span><span class="p">]</span>
<span class="go">u'this is encoded form data'</span>
</pre></div>
</div>
<p>Handling for uploaded files is not much harder as you can see from this
example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">store_file</span><span class="p">(</span><span class="n">request</span><span class="p">):</span>
<span class="nb">file</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">files</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'my_file'</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">file</span><span class="p">:</span>
<span class="nb">file</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="s1">'/where/to/store/the/file.txt'</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">handle_the_error</span><span class="p">()</span>
</pre></div>
</div>
<p>The files are represented as <code class="xref py py-class docutils literal"><span class="pre">FileStorage</span></code> objects which provide
some common operations to work with them.</p>
<p>Request headers can be accessed by using the <code class="xref py py-class docutils literal"><span class="pre">headers</span></code>
attribute:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s1">'Content-Length'</span><span class="p">]</span>
<span class="go">'54'</span>
<span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s1">'Content-Type'</span><span class="p">]</span>
<span class="go">'application/x-www-form-urlencoded'</span>
</pre></div>
</div>
<p>The keys for the headers are of course case insensitive.</p>
</div>
<div class="section" id="header-parsing">
<h2>Header Parsing<a class="headerlink" href="#header-parsing" title="Permalink to this headline">¶</a></h2>
<p>There is more. Werkzeug provides convenient access to often used HTTP headers
and other request data.</p>
<p>Let’s create a request object with all the data a typical web browser transmits
so that we can play with it:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">environ</span> <span class="o">=</span> <span class="n">create_environ</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">environ</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
<span class="gp">... </span> <span class="n">HTTP_USER_AGENT</span><span class="o">=</span><span class="s1">'Mozilla/5.0 (Macintosh; U; Mac OS X 10.5; en-US; ) Firefox/3.1'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">HTTP_ACCEPT</span><span class="o">=</span><span class="s1">'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">HTTP_ACCEPT_LANGUAGE</span><span class="o">=</span><span class="s1">'de-at,en-us;q=0.8,en;q=0.5'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">HTTP_ACCEPT_ENCODING</span><span class="o">=</span><span class="s1">'gzip,deflate'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">HTTP_ACCEPT_CHARSET</span><span class="o">=</span><span class="s1">'ISO-8859-1,utf-8;q=0.7,*;q=0.7'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">HTTP_IF_MODIFIED_SINCE</span><span class="o">=</span><span class="s1">'Fri, 20 Feb 2009 10:10:25 GMT'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">HTTP_IF_NONE_MATCH</span><span class="o">=</span><span class="s1">'"e51c9-1e5d-46356dc86c640"'</span><span class="p">,</span>
<span class="gp">... </span> <span class="n">HTTP_CACHE_CONTROL</span><span class="o">=</span><span class="s1">'max-age=0'</span>
<span class="gp">... </span><span class="p">)</span>
<span class="gp">...</span>
<span class="gp">>>> </span><span class="n">request</span> <span class="o">=</span> <span class="n">Request</span><span class="p">(</span><span class="n">environ</span><span class="p">)</span>
</pre></div>
</div>
<p>Let’s start with the most useless header: the user agent:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">user_agent</span><span class="o">.</span><span class="n">browser</span>
<span class="go">'firefox'</span>
<span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">user_agent</span><span class="o">.</span><span class="n">platform</span>
<span class="go">'macos'</span>
<span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">user_agent</span><span class="o">.</span><span class="n">version</span>
<span class="go">'3.1'</span>
<span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">user_agent</span><span class="o">.</span><span class="n">language</span>
<span class="go">'en-US'</span>
</pre></div>
</div>
<p>A more useful header is the accept header. With this header the browser
informs the web application what mimetypes it can handle and how well. All
accept headers are sorted by the quality, the best item being the first:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">accept_mimetypes</span><span class="o">.</span><span class="n">best</span>
<span class="go">'text/html'</span>
<span class="gp">>>> </span><span class="s1">'application/xhtml+xml'</span> <span class="ow">in</span> <span class="n">request</span><span class="o">.</span><span class="n">accept_mimetypes</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">request</span><span class="o">.</span><span class="n">accept_mimetypes</span><span class="p">[</span><span class="s2">"application/json"</span><span class="p">]</span>
<span class="go">0.8</span>
</pre></div>
</div>
<p>The same works for languages:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">accept_languages</span><span class="o">.</span><span class="n">best</span>
<span class="go">'de-at'</span>
<span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">accept_languages</span><span class="o">.</span><span class="n">values</span><span class="p">()</span>
<span class="go">['de-at', 'en-us', 'en']</span>
</pre></div>
</div>
<p>And of course encodings and charsets:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="s1">'gzip'</span> <span class="ow">in</span> <span class="n">request</span><span class="o">.</span><span class="n">accept_encodings</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">accept_charsets</span><span class="o">.</span><span class="n">best</span>
<span class="go">'ISO-8859-1'</span>
<span class="gp">>>> </span><span class="s1">'utf-8'</span> <span class="ow">in</span> <span class="n">request</span><span class="o">.</span><span class="n">accept_charsets</span>
<span class="go">True</span>
</pre></div>
</div>
<p>Normalization is available, so you can safely use alternative forms to perform
containment checking:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="s1">'UTF8'</span> <span class="ow">in</span> <span class="n">request</span><span class="o">.</span><span class="n">accept_charsets</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="s1">'de_AT'</span> <span class="ow">in</span> <span class="n">request</span><span class="o">.</span><span class="n">accept_languages</span>
<span class="go">True</span>
</pre></div>
</div>
<p>E-tags and other conditional headers are available in parsed form as well:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">if_modified_since</span>
<span class="go">datetime.datetime(2009, 2, 20, 10, 10, 25)</span>
<span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">if_none_match</span>
<span class="go"><ETags '"e51c9-1e5d-46356dc86c640"'></span>
<span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">cache_control</span>
<span class="go"><RequestCacheControl 'max-age=0'></span>
<span class="gp">>>> </span><span class="n">request</span><span class="o">.</span><span class="n">cache_control</span><span class="o">.</span><span class="n">max_age</span>
<span class="go">0</span>
<span class="gp">>>> </span><span class="s1">'e51c9-1e5d-46356dc86c640'</span> <span class="ow">in</span> <span class="n">request</span><span class="o">.</span><span class="n">if_none_match</span>
<span class="go">True</span>
</pre></div>
</div>
</div>
<div class="section" id="responses">
<h2>Responses<a class="headerlink" href="#responses" title="Permalink to this headline">¶</a></h2>
<p>Response objects are the opposite of request objects. They are used to send
data back to the client. In reality, response objects are nothing more than
glorified WSGI applications.</p>
<p>So what you are doing is not <em>returning</em> the response objects from your WSGI
application but <em>calling</em> it as WSGI application inside your WSGI application
and returning the return value of that call.</p>
<p>So imagine your standard WSGI “Hello World” application:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">application</span><span class="p">(</span><span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">):</span>
<span class="n">start_response</span><span class="p">(</span><span class="s1">'200 OK'</span><span class="p">,</span> <span class="p">[(</span><span class="s1">'Content-Type'</span><span class="p">,</span> <span class="s1">'text/plain'</span><span class="p">)])</span>
<span class="k">return</span> <span class="p">[</span><span class="s1">'Hello World!'</span><span class="p">]</span>
</pre></div>
</div>
<p>With response objects it would look like this:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">werkzeug.wrappers</span> <span class="kn">import</span> <span class="n">Response</span>
<span class="k">def</span> <span class="nf">application</span><span class="p">(</span><span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">):</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">Response</span><span class="p">(</span><span class="s1">'Hello World!'</span><span class="p">)</span>
<span class="k">return</span> <span class="n">response</span><span class="p">(</span><span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">)</span>
</pre></div>
</div>
<p>Also, unlike request objects, response objects are designed to be modified.
So here is what you can do with them:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">werkzeug.wrappers</span> <span class="kn">import</span> <span class="n">Response</span>
<span class="gp">>>> </span><span class="n">response</span> <span class="o">=</span> <span class="n">Response</span><span class="p">(</span><span class="s2">"Hello World!"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s1">'content-type'</span><span class="p">]</span>
<span class="go">'text/plain; charset=utf-8'</span>
<span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">data</span>
<span class="go">'Hello World!'</span>
<span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s1">'content-length'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">data</span><span class="p">)</span>
</pre></div>
</div>
<p>You can modify the status of the response in the same way. Either just the
code or provide a message as well:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">status</span>
<span class="go">'200 OK'</span>
<span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">status</span> <span class="o">=</span> <span class="s1">'404 Not Found'</span>
<span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span>
<span class="go">404</span>
<span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">=</span> <span class="mi">400</span>
<span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">status</span>
<span class="go">'400 BAD REQUEST'</span>
</pre></div>
</div>
<p>As you can see attributes work in both directions. So you can set both
<code class="xref py py-attr docutils literal"><span class="pre">status</span></code> and <code class="xref py py-attr docutils literal"><span class="pre">status_code</span></code> and the
change will be reflected to the other.</p>
<p>Also common headers are exposed as attributes or with methods to set /
retrieve them:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">content_length</span>
<span class="go">12</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">datetime</span>
<span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">date</span> <span class="o">=</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2009</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">20</span><span class="p">,</span> <span class="mi">17</span><span class="p">,</span> <span class="mi">42</span><span class="p">,</span> <span class="mi">51</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s1">'Date'</span><span class="p">]</span>
<span class="go">'Fri, 20 Feb 2009 17:42:51 GMT'</span>
</pre></div>
</div>
<p>Because etags can be weak or strong there are methods to set them:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">set_etag</span><span class="p">(</span><span class="s2">"12345-abcd"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s1">'etag'</span><span class="p">]</span>
<span class="go">'"12345-abcd"'</span>
<span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">get_etag</span><span class="p">()</span>
<span class="go">('12345-abcd', False)</span>
<span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">set_etag</span><span class="p">(</span><span class="s2">"12345-abcd"</span><span class="p">,</span> <span class="n">weak</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">get_etag</span><span class="p">()</span>
<span class="go">('12345-abcd', True)</span>
</pre></div>
</div>
<p>Some headers are available as mutable structures. For example most
of the <cite>Content-</cite> headers are sets of values:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">content_language</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s1">'en-us'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">content_language</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s1">'en'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s1">'Content-Language'</span><span class="p">]</span>
<span class="go">'en-us, en'</span>
</pre></div>
</div>
<p>Also here this works in both directions:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s1">'Content-Language'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'de-AT, de'</span>
<span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">content_language</span>
<span class="go">HeaderSet(['de-AT', 'de'])</span>
</pre></div>
</div>
<p>Authentication headers can be set that way as well:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">www_authenticate</span><span class="o">.</span><span class="n">set_basic</span><span class="p">(</span><span class="s2">"My protected resource"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s1">'www-authenticate'</span><span class="p">]</span>
<span class="go">'Basic realm="My protected resource"'</span>
</pre></div>
</div>
<p>Cookies can be set as well:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">set_cookie</span><span class="p">(</span><span class="s1">'name'</span><span class="p">,</span> <span class="s1">'value'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s1">'Set-Cookie'</span><span class="p">]</span>
<span class="go">'name=value; Path=/'</span>
<span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">set_cookie</span><span class="p">(</span><span class="s1">'name2'</span><span class="p">,</span> <span class="s1">'value2'</span><span class="p">)</span>
</pre></div>
</div>
<p>If headers appear multiple times you can use the <code class="xref py py-meth docutils literal"><span class="pre">getlist()</span></code>
method to get all values for a header:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">getlist</span><span class="p">(</span><span class="s1">'Set-Cookie'</span><span class="p">)</span>
<span class="go">['name=value; Path=/', 'name2=value2; Path=/']</span>
</pre></div>
</div>
<p>Finally if you have set all the conditional values, you can make the
response conditional against a request. Which means that if the request
can assure that it has the information already, no data besides the headers
is sent over the network which saves traffic. For that you should set at
least an etag (which is used for comparison) and the date header and then
call <code class="xref py py-class docutils literal"><span class="pre">make_conditional</span></code> with the request object.</p>
<p>The response is modified accordingly (status code changed, response body
removed, entity headers removed etc.)</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><p class="logo"><a href="index.html">
<img class="logo" src="_static/werkzeug.png" alt="Logo"/>
</a></p>
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Quickstart</a><ul>
<li><a class="reference internal" href="#wsgi-environment">WSGI Environment</a></li>
<li><a class="reference internal" href="#enter-request">Enter Request</a></li>
<li><a class="reference internal" href="#header-parsing">Header Parsing</a></li>
<li><a class="reference internal" href="#responses">Responses</a></li>
</ul>
</li>
</ul>
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="levels.html" title="previous chapter">API Levels</a></li>
<li>Next: <a href="python3.html" title="next chapter">Python 3 Notes</a></li>
</ul></li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/quickstart.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2011, The Werkzeug Team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
</body>
</html>
|