/usr/share/doc/python-webob/docs/test_response.html is in python-webob 1.1.1-1.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 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 | <!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><no title> — WebOb 1.1.1 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.1.1',
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="WebOb 1.1.1 documentation" href="index.html" />
</head>
<body>
<div class="related">
<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><a href="index.html">WebOb 1.1.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<p>This demonstrates how the Response object works, and tests it at the
same time.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">doctest</span> <span class="kn">import</span> <span class="n">ELLIPSIS</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">webob</span> <span class="kn">import</span> <span class="n">Response</span><span class="p">,</span> <span class="n">UTC</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">res</span> <span class="o">=</span> <span class="n">Response</span><span class="p">(</span><span class="s">'Test'</span><span class="p">,</span> <span class="n">status</span><span class="o">=</span><span class="s">'200 OK'</span><span class="p">)</span>
</pre></div>
</div>
<p>This is a minimal response object. We can do things like get and set
the body:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">body</span>
<span class="go">'Test'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">body</span> <span class="o">=</span> <span class="s">'Another test'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">body</span>
<span class="go">'Another test'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">body</span> <span class="o">=</span> <span class="s">'Another'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">' test'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">app_iter</span>
<span class="go">['Another', ' test']</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">content_length</span>
<span class="go">12</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'content-length'</span><span class="p">]</span>
<span class="go">'12'</span>
</pre></div>
</div>
<p>Content-Length is only applied when setting the body to a string; you
have to set it manually otherwise. There are also getters and setters
for the various pieces:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">app_iter</span> <span class="o">=</span> <span class="p">[</span><span class="s">'test'</span><span class="p">]</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">res</span><span class="o">.</span><span class="n">content_length</span>
<span class="go">None</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">content_length</span> <span class="o">=</span> <span class="mi">4</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">status</span>
<span class="go">'200 OK'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">status_int</span>
<span class="go">200</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">headers</span>
<span class="go">ResponseHeaders([('Content-Type', 'text/html; charset=UTF-8'), ('Content-Length', '4')])</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">headerlist</span>
<span class="go">[('Content-Type', 'text/html; charset=UTF-8'), ('Content-Length', '4')]</span>
</pre></div>
</div>
<p>Content-type and charset are handled separately as properties, though
they are both in the <tt class="docutils literal"><span class="pre">res.headers['content-type']</span></tt> header:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">content_type</span>
<span class="go">'text/html'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">content_type</span> <span class="o">=</span> <span class="s">'text/html'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">content_type</span>
<span class="go">'text/html'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">charset</span>
<span class="go">'UTF-8'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">charset</span> <span class="o">=</span> <span class="s">'iso-8859-1'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">charset</span>
<span class="go">'iso-8859-1'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">content_type</span>
<span class="go">'text/html'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'content-type'</span><span class="p">]</span>
<span class="go">'text/html; charset=iso-8859-1'</span>
</pre></div>
</div>
<p>Cookie handling is done through methods:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">set_cookie</span><span class="p">(</span><span class="s">'test'</span><span class="p">,</span> <span class="s">'value'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'set-cookie'</span><span class="p">]</span>
<span class="go">'test=value; Path=/'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">set_cookie</span><span class="p">(</span><span class="s">'test2'</span><span class="p">,</span> <span class="s">'value2'</span><span class="p">,</span> <span class="n">max_age</span><span class="o">=</span><span class="mi">10000</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'set-cookie'</span><span class="p">]</span> <span class="c"># We only see the last header</span>
<span class="go">'test2=value2; Max-Age=10000; Path=/; expires=... GMT'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">getall</span><span class="p">(</span><span class="s">'set-cookie'</span><span class="p">)</span>
<span class="go">['test=value; Path=/', 'test2=value2; Max-Age=10000; Path=/; expires=... GMT']</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">unset_cookie</span><span class="p">(</span><span class="s">'test'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">getall</span><span class="p">(</span><span class="s">'set-cookie'</span><span class="p">)</span>
<span class="go">['test2=value2; Max-Age=10000; Path=/; expires=... GMT']</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">set_cookie</span><span class="p">(</span><span class="s">'test2'</span><span class="p">,</span> <span class="s">'value2-add'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">getall</span><span class="p">(</span><span class="s">'set-cookie'</span><span class="p">)</span>
<span class="go">['test2=value2; Max-Age=10000; Path=/; expires=... GMT', 'test2=value2-add; Path=/']</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">set_cookie</span><span class="p">(</span><span class="s">'test2'</span><span class="p">,</span> <span class="s">'value2-replace'</span><span class="p">,</span> <span class="n">overwrite</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">getall</span><span class="p">(</span><span class="s">'set-cookie'</span><span class="p">)</span>
<span class="go">['test2=value2-replace; Path=/']</span>
</pre></div>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">Response</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">set_cookie</span><span class="p">(</span><span class="s">'x'</span><span class="p">,</span> <span class="s">'x'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">set_cookie</span><span class="p">(</span><span class="s">'y'</span><span class="p">,</span> <span class="s">'y'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">set_cookie</span><span class="p">(</span><span class="s">'z'</span><span class="p">,</span> <span class="s">'z'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">getall</span><span class="p">(</span><span class="s">'set-cookie'</span><span class="p">)</span>
<span class="go">['x=x; Path=/', 'y=y; Path=/', 'z=z; Path=/']</span>
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">unset_cookie</span><span class="p">(</span><span class="s">'y'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">getall</span><span class="p">(</span><span class="s">'set-cookie'</span><span class="p">)</span>
<span class="go">['x=x; Path=/', 'z=z; Path=/']</span>
</pre></div>
</div>
<p>Most headers are available in a parsed getter/setter form through
properties:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">age</span> <span class="o">=</span> <span class="mi">10</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">age</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'age'</span><span class="p">]</span>
<span class="go">(10, '10')</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">allow</span> <span class="o">=</span> <span class="p">[</span><span class="s">'GET'</span><span class="p">,</span> <span class="s">'PUT'</span><span class="p">]</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">allow</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'allow'</span><span class="p">]</span>
<span class="go">(('GET', 'PUT'), 'GET, PUT')</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">cache_control</span>
<span class="go"><CacheControl ''></span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">res</span><span class="o">.</span><span class="n">cache_control</span><span class="o">.</span><span class="n">max_age</span>
<span class="go">None</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">cache_control</span><span class="o">.</span><span class="n">properties</span><span class="p">[</span><span class="s">'max-age'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">None</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">res</span><span class="o">.</span><span class="n">cache_control</span><span class="o">.</span><span class="n">max_age</span>
<span class="go">-1</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">cache_control</span><span class="o">.</span><span class="n">max_age</span> <span class="o">=</span> <span class="mi">10</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">cache_control</span>
<span class="go"><CacheControl 'max-age=10'></span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'cache-control'</span><span class="p">]</span>
<span class="go">'max-age=10'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">cache_control</span><span class="o">.</span><span class="n">max_stale</span> <span class="o">=</span> <span class="mi">10</span>
<span class="gt">Traceback (most recent call last):</span>
<span class="o">...</span>
<span class="gr">AttributeError</span>: <span class="n">The property max-stale only applies to request Cache-Control</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">cache_control</span> <span class="o">=</span> <span class="p">{}</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">cache_control</span>
<span class="go"><CacheControl ''></span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">content_disposition</span> <span class="o">=</span> <span class="s">'attachment; filename=foo.xml'</span>
<span class="gp">>>> </span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">content_disposition</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'content-disposition'</span><span class="p">])</span>
<span class="go">('attachment; filename=foo.xml', 'attachment; filename=foo.xml')</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">content_encoding</span> <span class="o">=</span> <span class="s">'gzip'</span>
<span class="gp">>>> </span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">content_encoding</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'content-encoding'</span><span class="p">])</span>
<span class="go">('gzip', 'gzip')</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">content_language</span> <span class="o">=</span> <span class="s">'en'</span>
<span class="gp">>>> </span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">content_language</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'content-language'</span><span class="p">])</span>
<span class="go">(('en',), 'en')</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">content_location</span> <span class="o">=</span> <span class="s">'http://localhost:8080'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'content-location'</span><span class="p">]</span>
<span class="go">'http://localhost:8080'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">content_range</span> <span class="o">=</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">100</span><span class="p">,</span> <span class="mi">1000</span><span class="p">)</span>
<span class="gp">>>> </span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">content_range</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'content-range'</span><span class="p">])</span>
<span class="go">(<ContentRange bytes 0-99/1000>, 'bytes 0-99/1000')</span>
<span class="gp">>>> </span><span class="n">res</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">2005</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">tzinfo</span><span class="o">=</span><span class="n">UTC</span><span class="p">)</span>
<span class="gp">>>> </span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">date</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'date'</span><span class="p">])</span>
<span class="go">(datetime.datetime(2005, 1, 1, 12, 0, tzinfo=UTC), 'Sat, 01 Jan 2005 12:00:00 GMT')</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">res</span><span class="o">.</span><span class="n">etag</span>
<span class="go">None</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">etag</span> <span class="o">=</span> <span class="s">'foo'</span>
<span class="gp">>>> </span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">etag</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'etag'</span><span class="p">])</span>
<span class="go">('foo', '"foo"')</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">etag</span> <span class="o">=</span> <span class="s">'something-with-"quotes"'</span>
<span class="gp">>>> </span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">etag</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'etag'</span><span class="p">])</span>
<span class="go">('something-with-"quotes"', '"something-with-\\"quotes\\""')</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">expires</span> <span class="o">=</span> <span class="n">res</span><span class="o">.</span><span class="n">date</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">retry_after</span> <span class="o">=</span> <span class="mi">120</span> <span class="c"># two minutes</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">retry_after</span>
<span class="go">datetime.datetime(...)</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">server</span> <span class="o">=</span> <span class="s">'Python/foo'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'server'</span><span class="p">]</span>
<span class="go">'Python/foo'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">vary</span> <span class="o">=</span> <span class="p">[</span><span class="s">'Cookie'</span><span class="p">]</span>
<span class="gp">>>> </span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">vary</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'vary'</span><span class="p">])</span>
<span class="go">(('Cookie',), 'Cookie')</span>
</pre></div>
</div>
<p>The location header will absolutify itself when the response
application is actually served. We can force this with
<tt class="docutils literal"><span class="pre">req.get_response</span></tt>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="s">'/test.html'</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">webob</span> <span class="kn">import</span> <span class="n">Request</span>
<span class="gp">>>> </span><span class="n">req</span> <span class="o">=</span> <span class="n">Request</span><span class="o">.</span><span class="n">blank</span><span class="p">(</span><span class="s">'/'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">location</span>
<span class="go">'/test.html'</span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span><span class="o">.</span><span class="n">location</span>
<span class="go">'http://localhost/test.html'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="s">'/test2.html'</span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span><span class="o">.</span><span class="n">location</span>
<span class="go">'http://localhost/test2.html'</span>
</pre></div>
</div>
<p>There’s some conditional response handling too (you have to turn on
conditional_response):</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">res</span> <span class="o">=</span> <span class="n">Response</span><span class="p">(</span><span class="s">'abc'</span><span class="p">,</span> <span class="n">conditional_response</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">req</span> <span class="o">=</span> <span class="n">Request</span><span class="o">.</span><span class="n">blank</span><span class="p">(</span><span class="s">'/'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">etag</span> <span class="o">=</span> <span class="s">'tag'</span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">if_none_match</span> <span class="o">=</span> <span class="s">'tag'</span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="go"><Response ... 304 Not Modified></span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">etag</span> <span class="o">=</span> <span class="s">'other-tag'</span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="go"><Response ... 200 OK></span>
<span class="gp">>>> </span><span class="k">del</span> <span class="n">req</span><span class="o">.</span><span class="n">if_none_match</span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">if_modified_since</span> <span class="o">=</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2005</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">tzinfo</span><span class="o">=</span><span class="n">UTC</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">last_modified</span> <span class="o">=</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2005</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">tzinfo</span><span class="o">=</span><span class="n">UTC</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="go">304 Not Modified</span>
<span class="go">ETag: "other-tag"</span>
<span class="go">Last-Modified: Sat, 01 Jan 2005 12:01:00 GMT</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">last_modified</span> <span class="o">=</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2006</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">tzinfo</span><span class="o">=</span><span class="n">UTC</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="go"><Response ... 200 OK></span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">last_modified</span> <span class="o">=</span> <span class="bp">None</span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="go"><Response ... 200 OK></span>
</pre></div>
</div>
<p>Weak etags:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">req</span> <span class="o">=</span> <span class="n">Request</span><span class="o">.</span><span class="n">blank</span><span class="p">(</span><span class="s">'/'</span><span class="p">,</span> <span class="n">if_none_match</span><span class="o">=</span><span class="s">'W/"test"'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">res</span> <span class="o">=</span> <span class="n">Response</span><span class="p">(</span><span class="n">conditional_response</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">etag</span><span class="o">=</span><span class="s">'test'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span><span class="o">.</span><span class="n">status</span>
<span class="go">'304 Not Modified'</span>
</pre></div>
</div>
<p>Also range response:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">res</span> <span class="o">=</span> <span class="n">Response</span><span class="p">(</span><span class="s">'0123456789'</span><span class="p">,</span> <span class="n">conditional_response</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">req</span> <span class="o">=</span> <span class="n">Request</span><span class="o">.</span><span class="n">blank</span><span class="p">(</span><span class="s">'/'</span><span class="p">,</span> <span class="nb">range</span><span class="o">=</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">5</span><span class="p">))</span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">range</span>
<span class="go"><Range ranges=(1, 5)></span>
<span class="gp">>>> </span><span class="nb">str</span><span class="p">(</span><span class="n">req</span><span class="o">.</span><span class="n">range</span><span class="p">)</span>
<span class="go">'bytes=1-4'</span>
<span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">body</span>
<span class="go">'1234'</span>
<span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">content_range</span><span class="o">.</span><span class="n">stop</span>
<span class="go">5</span>
<span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">content_range</span>
<span class="go"><ContentRange bytes 1-4/10></span>
<span class="gp">>>> </span><span class="nb">tuple</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">content_range</span><span class="p">)</span>
<span class="go">(1, 5, 10)</span>
<span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">content_length</span>
<span class="go">4</span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">range</span> <span class="o">=</span> <span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">20</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">str</span><span class="p">(</span><span class="n">req</span><span class="o">.</span><span class="n">range</span><span class="p">)</span>
<span class="go">'bytes=5-19'</span>
<span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">result</span>
<span class="go">206 Partial Content</span>
<span class="go">Content-Length: 5</span>
<span class="go">Content-Range: bytes 5-9/10</span>
<span class="go">Content-Type: text/html; charset=UTF-8</span>
<span class="go">56789</span>
<span class="gp">>>> </span><span class="nb">tuple</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">content_range</span><span class="p">)</span>
<span class="go">(5, 10, 10)</span>
<span class="gp">>>> </span><span class="n">req_head</span> <span class="o">=</span> <span class="n">req</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">req_head</span><span class="o">.</span><span class="n">method</span> <span class="o">=</span> <span class="s">'HEAD'</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">req_head</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="go">206 Partial Content</span>
<span class="go">Content-Length: 5</span>
<span class="go">Content-Range: bytes 5-9/10</span>
<span class="go">Content-Type: text/html; charset=UTF-8</span>
</pre></div>
</div>
<p>And an invalid requested range:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">range</span> <span class="o">=</span> <span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="mi">20</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">result</span>
<span class="go">416 Requested Range Not Satisfiable</span>
<span class="go">Content-Length: 44</span>
<span class="go">Content-Range: bytes */10</span>
<span class="go">Content-Type: text/plain</span>
<span class="go">Requested range not satisfiable: bytes=10-19</span>
<span class="gp">>>> </span><span class="nb">str</span><span class="p">(</span><span class="n">result</span><span class="o">.</span><span class="n">content_range</span><span class="p">)</span>
<span class="go">'bytes */10'</span>
</pre></div>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">req_head</span> <span class="o">=</span> <span class="n">req</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">req_head</span><span class="o">.</span><span class="n">method</span> <span class="o">=</span> <span class="s">'HEAD'</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">req_head</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="go">416 Requested Range Not Satisfiable</span>
<span class="go">Content-Length: 44</span>
<span class="go">Content-Range: bytes */10</span>
<span class="go">Content-Type: text/plain</span>
</pre></div>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">Request</span><span class="o">.</span><span class="n">blank</span><span class="p">(</span><span class="s">'/'</span><span class="p">,</span> <span class="nb">range</span><span class="o">=</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">))</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span>
<span class="gp">... </span> <span class="n">Response</span><span class="p">(</span><span class="s">'0123456789'</span><span class="p">,</span> <span class="n">conditional_response</span><span class="o">=</span><span class="bp">True</span><span class="p">))</span><span class="o">.</span><span class="n">content_length</span>
<span class="go">1</span>
</pre></div>
</div>
<p>That was easier; we’ll try it with a iterator for the body:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">res</span> <span class="o">=</span> <span class="n">Response</span><span class="p">(</span><span class="n">conditional_response</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">app_iter</span> <span class="o">=</span> <span class="p">[</span><span class="s">'01234'</span><span class="p">,</span> <span class="s">'567'</span><span class="p">,</span> <span class="s">'89'</span><span class="p">]</span>
<span class="gp">>>> </span><span class="n">req</span> <span class="o">=</span> <span class="n">Request</span><span class="o">.</span><span class="n">blank</span><span class="p">(</span><span class="s">'/'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">range</span> <span class="o">=</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
</pre></div>
</div>
<p>Because we don’t know the length of the app_iter, this doesn’t work:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">body</span>
<span class="go">'0123456789'</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">result</span><span class="o">.</span><span class="n">content_range</span>
<span class="go">None</span>
</pre></div>
</div>
<dl class="docutils">
<dt>But it will, if we set content_length::</dt>
<dd><div class="first last highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">content_length</span> <span class="o">=</span> <span class="mi">10</span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">range</span> <span class="o">=</span> <span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">body</span>
<span class="go">'56789'</span>
<span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">content_range</span>
<span class="go"><ContentRange bytes 5-9/10></span>
</pre></div>
</div>
</dd>
</dl>
<p>Ranges requesting x last bytes are supported too:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">range</span> <span class="o">=</span> <span class="s">'bytes=-1'</span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">range</span>
<span class="go"><Range ranges=(-1, None)></span>
<span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">body</span>
<span class="go">'9'</span>
<span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">content_range</span>
<span class="go"><ContentRange bytes 9-9/10></span>
<span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">content_length</span>
<span class="go">1</span>
</pre></div>
</div>
<p>If those ranges are not satisfiable, a 416 error is returned:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">range</span> <span class="o">=</span> <span class="s">'bytes=-100'</span>
<span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">status</span>
<span class="go">'416 Requested Range Not Satisfiable'</span>
<span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">content_range</span>
<span class="go"><ContentRange bytes */10></span>
<span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">body</span>
<span class="go">'Requested range not satisfiable: bytes=-100'</span>
</pre></div>
</div>
<p>If we set Content-Length then we can use it with an app_iter</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">content_length</span> <span class="o">=</span> <span class="mi">10</span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">range</span> <span class="o">=</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span> <span class="c"># python-style range</span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">range</span>
<span class="go"><Range ranges=(1, 5)></span>
<span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">body</span>
<span class="go">'1234'</span>
<span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">content_range</span>
<span class="go"><ContentRange bytes 1-4/10></span>
<span class="gp">>>> </span><span class="c"># And trying If-modified-since</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">etag</span> <span class="o">=</span> <span class="s">'foobar'</span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">if_range</span> <span class="o">=</span> <span class="s">'foobar'</span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">if_range</span>
<span class="go"><IfRange etag="foobar", date=*></span>
<span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">content_range</span>
<span class="go"><ContentRange bytes 1-4/10></span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">if_range</span> <span class="o">=</span> <span class="s">'blah'</span>
<span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">content_range</span>
<span class="gp">>>> </span><span class="n">req</span><span class="o">.</span><span class="n">if_range</span> <span class="o">=</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2005</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">tzinfo</span><span class="o">=</span><span class="n">UTC</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">last_modified</span> <span class="o">=</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2005</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">tzinfo</span><span class="o">=</span><span class="n">UTC</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">content_range</span>
<span class="go"><ContentRange bytes 1-4/10></span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">last_modified</span> <span class="o">=</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2006</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">tzinfo</span><span class="o">=</span><span class="n">UTC</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">result</span> <span class="o">=</span> <span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">res</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">result</span><span class="o">.</span><span class="n">content_range</span>
</pre></div>
</div>
<p>Some tests of Content-Range parsing:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">webob.byterange</span> <span class="kn">import</span> <span class="n">ContentRange</span>
<span class="gp">>>> </span><span class="n">ContentRange</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="s">'bytes */*'</span><span class="p">)</span>
<span class="go"><ContentRange bytes */*></span>
<span class="gp">>>> </span><span class="n">ContentRange</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="s">'bytes */10'</span><span class="p">)</span>
<span class="go"><ContentRange bytes */10></span>
<span class="gp">>>> </span><span class="n">ContentRange</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="s">'bytes 5-9/10'</span><span class="p">)</span>
<span class="go"><ContentRange bytes 5-9/10></span>
<span class="gp">>>> </span><span class="n">ContentRange</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="s">'bytes 5-10/*'</span><span class="p">)</span>
<span class="go"><ContentRange bytes 5-10/*></span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">ContentRange</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="s">'bytes 5-10/10'</span><span class="p">)</span>
<span class="go">None</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">ContentRange</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="s">'bytes 5-4/10'</span><span class="p">)</span>
<span class="go">None</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">ContentRange</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="s">'bytes 5-*/10'</span><span class="p">)</span>
<span class="go">None</span>
</pre></div>
</div>
<p>Some tests of exceptions:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">webob</span> <span class="kn">import</span> <span class="n">exc</span>
<span class="gp">>>> </span><span class="n">res</span> <span class="o">=</span> <span class="n">exc</span><span class="o">.</span><span class="n">HTTPNotFound</span><span class="p">(</span><span class="s">'Not found!'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">content_type</span> <span class="o">=</span> <span class="s">'text/plain'</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">content_type</span>
<span class="go">'text/plain'</span>
<span class="gp">>>> </span><span class="n">res</span> <span class="o">=</span> <span class="n">exc</span><span class="o">.</span><span class="n">HTTPNotModified</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">headers</span>
<span class="go">ResponseHeaders([])</span>
</pre></div>
</div>
<p>Headers can be set to unicode values:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">res</span> <span class="o">=</span> <span class="n">Response</span><span class="p">(</span><span class="s">'test'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">etag</span> <span class="o">=</span> <span class="s">u'fran</span><span class="se">\xe7</span><span class="s">ais'</span>
</pre></div>
</div>
<p>But they come out as str:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">res</span><span class="o">.</span><span class="n">etag</span>
<span class="go">'fran\xe7ais'</span>
</pre></div>
</div>
<p>Unicode can come up in unexpected places, make sure it doesn’t break things
(this particular case could be caused by a <cite>from __future__ import unicode_literals</cite>):</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">blank</span><span class="p">(</span><span class="s">'/'</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s">u'POST'</span><span class="p">)</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="n">exc</span><span class="o">.</span><span class="n">HTTPMethodNotAllowed</span><span class="p">())</span>
<span class="go"><Response at ... 405 Method Not Allowed></span>
</pre></div>
</div>
<p>Copying Responses should copy their internal structures</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">Response</span><span class="p">(</span><span class="n">app_iter</span><span class="o">=</span><span class="p">[])</span>
<span class="gp">>>> </span><span class="n">r2</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">headerlist</span> <span class="ow">is</span> <span class="n">r2</span><span class="o">.</span><span class="n">headerlist</span>
<span class="go">False</span>
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">app_iter</span> <span class="ow">is</span> <span class="n">r2</span><span class="o">.</span><span class="n">app_iter</span>
<span class="go">False</span>
</pre></div>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">Response</span><span class="p">(</span><span class="n">app_iter</span><span class="o">=</span><span class="nb">iter</span><span class="p">([</span><span class="s">'foo'</span><span class="p">]))</span>
<span class="gp">>>> </span><span class="n">r2</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="gp">>>> </span><span class="k">del</span> <span class="n">r2</span><span class="o">.</span><span class="n">content_type</span>
<span class="gp">>>> </span><span class="n">r2</span><span class="o">.</span><span class="n">body_file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">' bar'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">r</span>
<span class="go">200 OK</span>
<span class="go">Content-Type: text/html; charset=UTF-8</span>
<span class="go">foo</span>
<span class="gp">>>> </span><span class="k">print</span> <span class="n">r2</span>
<span class="go">200 OK</span>
<span class="go">Content-Length: 7</span>
<span class="go">foo bar</span>
</pre></div>
</div>
<p>Additional Response constructor keywords are used to set attributes</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">Response</span><span class="p">(</span><span class="n">cache_expires</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'Cache-Control'</span><span class="p">]</span>
<span class="go">'max-age=0, must-revalidate, no-cache, no-store'</span>
</pre></div>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">webob.exc</span> <span class="kn">import</span> <span class="n">HTTPBadRequest</span>
<span class="gp">>>> </span><span class="k">raise</span> <span class="n">HTTPBadRequest</span><span class="p">(</span><span class="s">'bad data'</span><span class="p">)</span>
<span class="gt">Traceback (most recent call last):</span>
<span class="c">...</span>
<span class="gr">HTTPBadRequest</span>: <span class="n">bad data</span>
<span class="gp">>>> </span><span class="k">raise</span> <span class="n">HTTPBadRequest</span><span class="p">()</span>
<span class="gt">Traceback (most recent call last):</span>
<span class="c">...</span>
<span class="gr">HTTPBadRequest</span>: <span class="n">The server could not comply with the request since it is either malformed or otherwise incorrect.</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/test_response.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<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="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">WebOb 1.1.1 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2011, Ian Bicking and contributors.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
|