WebObTestCoverage / tests / test_response.txt

  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
This demonstrates how the Response object works, and tests it at the
same time.

    >>> from dtopt import ELLIPSIS
    >>> from webob import Response, UTC
    >>> from datetime import datetime
    >>> res = Response('Test', status='200 OK')

This is a minimal response object.  We can do things like get and set
the body:

    >>> res.body
    'Test'
    >>> res.body = 'Another test'
    >>> res.body
    'Another test'
    >>> res.body = 'Another'
    >>> res.write(' test')
    >>> res.app_iter
    ['Another test']
    >>> res.content_length
    12
    >>> res.headers['content-length']
    '12'

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:

    >>> res.app_iter = ['test']
    >>> print res.content_length
    None
    >>> res.content_length = 4
    >>> res.status
    '200 OK'
    >>> res.status_int
    200
    >>> res.headers
    ResponseHeaders([('Content-Type', 'text/html; charset=UTF-8'), ('Content-Length', '4')])
    >>> res.headerlist
    [('Content-Type', 'text/html; charset=UTF-8'), ('Content-Length', '4')]

Content-type and charset are handled separately as properties, though
they are both in the ``res.headers['content-type']`` header:

    >>> res.content_type
    'text/html'
    >>> res.content_type = 'text/html'
    >>> res.content_type
    'text/html'
    >>> res.charset
    'UTF-8'
    >>> res.charset = 'iso-8859-1'
    >>> res.charset
    'iso-8859-1'
    >>> res.content_type
    'text/html'
    >>> res.headers['content-type']
    'text/html; charset=iso-8859-1'

Cookie handling is done through methods:

    >>> res.set_cookie('test', 'value')
    >>> res.headers['set-cookie']
    'test=value; Path=/'
    >>> res.set_cookie('test2', 'value2', max_age=10000)
    >>> res.headers['set-cookie'] # We only see the last header
    'test2=value2; expires="... GMT"; Max-Age=10000; Path=/'
    >>> res.headers.getall('set-cookie')
    ['test=value; Path=/', 'test2=value2; expires="... GMT"; Max-Age=10000; Path=/']
    >>> res.unset_cookie('test')
    >>> res.headers.getall('set-cookie')
    ['test2=value2; expires="... GMT"; Max-Age=10000; Path=/']
    >>> res.set_cookie('test2', 'value2-add')
    >>> res.headers.getall('set-cookie')
    ['test2=value2; expires="... GMT"; Max-Age=10000; Path=/', 'test2=value2-add; Path=/']
    >>> res.set_cookie('test2', 'value2-replace', overwrite=True)
    >>> res.headers.getall('set-cookie')
    ['test2=value2-replace; Path=/']


    >>> r = Response()
    >>> r.set_cookie('x', 'x')
    >>> r.set_cookie('y', 'y')
    >>> r.set_cookie('z', 'z')
    >>> r.headers.getall('set-cookie')
    ['x=x; Path=/', 'y=y; Path=/', 'z=z; Path=/']
    >>> r.unset_cookie('y')
    >>> r.headers.getall('set-cookie')
    ['x=x; Path=/', 'z=z; Path=/']


Most headers are available in a parsed getter/setter form through
properties:

    >>> res.age = 10
    >>> res.age, res.headers['age']
    (10, '10')
    >>> res.allow = ['GET', 'PUT']
    >>> res.allow, res.headers['allow']
    (('GET', 'PUT'), 'GET, PUT')
    >>> res.cache_control
    <CacheControl ''>
    >>> print res.cache_control.max_age
    None
    >>> res.cache_control.properties['max-age'] = None
    >>> print res.cache_control.max_age
    -1
    >>> res.cache_control.max_age = 10
    >>> res.cache_control
    <CacheControl 'max-age=10'>
    >>> res.headers['cache-control']
    'max-age=10'
    >>> res.cache_control.max_stale = 10
    Traceback (most recent call last):
        ...
    AttributeError: The property max-stale only applies to request Cache-Control
    >>> res.cache_control = {}
    >>> res.cache_control
    <CacheControl ''>
    >>> res.content_disposition = 'attachment; filename=foo.xml'
    >>> (res.content_disposition, res.headers['content-disposition'])
    ('attachment; filename=foo.xml', 'attachment; filename=foo.xml')
    >>> res.content_encoding = 'gzip'
    >>> (res.content_encoding, res.headers['content-encoding'])
    ('gzip', 'gzip')
    >>> res.content_language = 'en'
    >>> (res.content_language, res.headers['content-language'])
    (('en',), 'en')
    >>> res.content_location = 'http://localhost:8080'
    >>> res.headers['content-location']
    'http://localhost:8080'
    >>> res.content_range = (0, 100, 1000)
    >>> (res.content_range, res.headers['content-range'])
    (<ContentRange bytes 0-99/1000>, 'bytes 0-99/1000')
    >>> res.date = datetime(2005, 1, 1, 12, 0, tzinfo=UTC)
    >>> (res.date, res.headers['date'])
    (datetime.datetime(2005, 1, 1, 12, 0, tzinfo=UTC), 'Sat, 01 Jan 2005 12:00:00 GMT')
    >>> print res.etag
    None
    >>> res.etag = 'foo'
    >>> (res.etag, res.headers['etag'])
    ('foo', '"foo"')
    >>> res.etag = 'something-with-"quotes"'
    >>> (res.etag, res.headers['etag'])
    ('something-with-"quotes"', '"something-with-\\"quotes\\""')
    >>> res.expires = res.date
    >>> res.retry_after = 120 # two minutes
    >>> res.retry_after
    datetime.datetime(...)
    >>> res.server = 'Python/foo'
    >>> res.headers['server']
    'Python/foo'
    >>> res.vary = ['Cookie']
    >>> (res.vary, res.headers['vary'])
    (('Cookie',), 'Cookie')

The location header will absolutify itself when the response
application is actually served.  We can force this with
``req.get_response``::

    >>> res.location = '/test.html'
    >>> from webob import Request
    >>> req = Request.blank('/')
    >>> res.location
    '/test.html'
    >>> req.get_response(res).location
    'http://localhost/test.html'
    >>> res.location = '/test2.html'
    >>> req.get_response(res).location
    'http://localhost/test2.html'

There's some conditional response handling too (you have to turn on
conditional_response)::

    >>> res = Response('abc', conditional_response=True) # doctest: +ELLIPSIS
    >>> req = Request.blank('/')
    >>> res.etag = 'tag'
    >>> req.if_none_match = 'tag'
    >>> req.get_response(res)
    <Response ... 304 Not Modified>
    >>> res.etag = 'other-tag'
    >>> req.get_response(res)
    <Response ... 200 OK>
    >>> del req.if_none_match
    >>> req.if_modified_since = datetime(2005, 1, 1, 12, 1, tzinfo=UTC)
    >>> res.last_modified = datetime(2005, 1, 1, 12, 1, tzinfo=UTC)
    >>> print req.get_response(res)
    304 Not Modified
    ETag: "other-tag"
    Last-Modified: Sat, 01 Jan 2005 12:01:00 GMT
    >>> res.last_modified = datetime(2006, 1, 1, 12, 1, tzinfo=UTC)
    >>> req.get_response(res)
    <Response ... 200 OK>
    >>> res.last_modified = None
    >>> req.get_response(res)
    <Response ... 200 OK>

Weak etags::

    >>> req = Request.blank('/', if_none_match='W/"test"')
    >>> res = Response(conditional_response=True, etag='test')
    >>> req.get_response(res).status
    '304 Not Modified'

Also range response::

    >>> res = Response('0123456789', conditional_response=True)
    >>> req = Request.blank('/', range=(1, 5))
    >>> req.range
    <Range ranges=(1, 5)>
    >>> str(req.range)
    'bytes=1-4'
    >>> result = req.get_response(res)
    >>> result.body
    '1234'
    >>> result.content_range.stop
    5
    >>> result.content_range
    <ContentRange bytes 1-4/10>
    >>> tuple(result.content_range)
    (1, 5, 10)
    >>> result.content_length
    4


    >>> req.range = (5, 20)
    >>> str(req.range)
    'bytes=5-19'
    >>> result = req.get_response(res)
    >>> print result
    206 Partial Content
    Content-Length: 5
    Content-Range: bytes 5-9/10
    Content-Type: text/html; charset=UTF-8
    <BLANKLINE>
    56789
    >>> tuple(result.content_range)
    (5, 10, 10)

    >>> req_head = req.copy()
    >>> req_head.method = 'HEAD'
    >>> print req_head.get_response(res)
    206 Partial Content
    Content-Length: 5
    Content-Range: bytes 5-9/10
    Content-Type: text/html; charset=UTF-8

And an invalid requested range:

    >>> req.range = (10, 20)
    >>> result = req.get_response(res)
    >>> print result
    416 Requested Range Not Satisfiable
    Content-Length: 44
    Content-Range: bytes */10
    Content-Type: text/plain
    <BLANKLINE>
    Requested range not satisfiable: bytes=10-19
    >>> str(result.content_range)
    'bytes */10'

    >>> req_head = req.copy()
    >>> req_head.method = 'HEAD'
    >>> print req_head.get_response(res)
    416 Requested Range Not Satisfiable
    Content-Length: 44
    Content-Range: bytes */10
    Content-Type: text/plain

    >>> Request.blank('/', range=(1,2)).get_response(
    ...     Response('0123456789', conditional_response=True)).content_length
    1


That was easier; we'll try it with a iterator for the body::

    >>> res = Response(conditional_response=True)
    >>> res.app_iter = ['01234', '567', '89']
    >>> req = Request.blank('/')
    >>> req.range = (1, 5)
    >>> result = req.get_response(res)

Because we don't know the length of the app_iter, this doesn't work::

    >>> result.body
    '0123456789'
    >>> print result.content_range
    None

But it will, if we set content_length::
    >>> res.content_length = 10
    >>> req.range = (5, None)
    >>> result = req.get_response(res)
    >>> result.body
    '56789'
    >>> result.content_range
    <ContentRange bytes 5-9/10>


Ranges requesting x last bytes are supported too:

    >>> req.range = 'bytes=-1'
    >>> req.range
    <Range ranges=(-1, None)>
    >>> result = req.get_response(res)
    >>> result.body
    '9'
    >>> result.content_range
    <ContentRange bytes 9-9/10>
    >>> result.content_length
    1


If those ranges are not satisfiable, a 416 error is returned:

    >>> req.range = 'bytes=-100'
    >>> result = req.get_response(res)
    >>> result.status
    '416 Requested Range Not Satisfiable'
    >>> result.content_range
    <ContentRange bytes */10>
    >>> result.body
    'Requested range not satisfiable: bytes=-100'


If we set Content-Length then we can use it with an app_iter

    >>> res.content_length = 10
    >>> req.range = (1, 5) # python-style range
    >>> req.range
    <Range ranges=(1, 5)>
    >>> result = req.get_response(res)
    >>> result.body
    '1234'
    >>> result.content_range
    <ContentRange bytes 1-4/10>
    >>> # And trying If-modified-since
    >>> res.etag = 'foobar'
    >>> req.if_range = 'foobar'
    >>> req.if_range
    <IfRange etag=foobar, date=*>
    >>> result = req.get_response(res)
    >>> result.content_range
    <ContentRange bytes 1-4/10>
    >>> req.if_range = 'blah'
    >>> result = req.get_response(res)
    >>> result.content_range
    >>> req.if_range = datetime(2005, 1, 1, 12, 0, tzinfo=UTC)
    >>> res.last_modified = datetime(2005, 1, 1, 12, 0, tzinfo=UTC)
    >>> result = req.get_response(res)
    >>> result.content_range
    <ContentRange bytes 1-4/10>
    >>> res.last_modified = datetime(2006, 1, 1, 12, 0, tzinfo=UTC)
    >>> result = req.get_response(res)
    >>> result.content_range

Some tests of Content-Range parsing::

    >>> from webob.byterange import ContentRange
    >>> ContentRange.parse('bytes */*')
    <ContentRange bytes */*>
    >>> ContentRange.parse('bytes */10')
    <ContentRange bytes */10>
    >>> ContentRange.parse('bytes 5-9/10')
    <ContentRange bytes 5-9/10>
    >>> ContentRange.parse('bytes 5-10/*')
    <ContentRange bytes 5-10/*>
    >>> print ContentRange.parse('bytes 5-10/10')
    None
    >>> print ContentRange.parse('bytes 5-4/10')
    None
    >>> print ContentRange.parse('bytes 5-*/10')
    None

Some tests of exceptions::

    >>> from webob import exc
    >>> res = exc.HTTPNotFound('Not found!')
    >>> res.exception.content_type = 'text/plain'
    >>> res.content_type
    'text/plain'
    >>> res = exc.HTTPNotModified()
    >>> res.headers
    ResponseHeaders([])

Headers can be set to unicode values::

    >>> res = Response('test')
    >>> res.etag = u'fran\xe7ais'

But they come out as str::

    >>> res.etag
    'fran\xe7ais'


Unicode can come up in unexpected places, make sure it doesn't break things
(this particular case could be caused by a `from __future__ import unicode_literals`)::

    >>> Request.blank('/', method=u'POST').get_response(exc.HTTPMethodNotAllowed())
    <Response at ... 405 Method Not Allowed>

Copying Responses should copy their internal structures

    >>> r = Response(app_iter=[])
    >>> r2 = r.copy()
    >>> r.headerlist is r2.headerlist
    False
    >>> r.app_iter is r2.app_iter
    False

    >>> r = Response(app_iter=iter(['foo']))
    >>> r2 = r.copy()
    >>> del r2.content_type
    >>> r2.body_file.write(' bar')
    >>> print r
    200 OK
    Content-Type: text/html; charset=UTF-8
    Content-Length: 3
    <BLANKLINE>
    foo
    >>> print r2
    200 OK
    Content-Length: 7
    <BLANKLINE>
    foo bar


Additional Response constructor keywords are used to set attributes

    >>> r = Response(cache_expires=True)
    >>> r.headers['Cache-Control']
    'max-age=0, must-revalidate, no-cache, no-store'



    >>> from webob.exc import HTTPBadRequest
    >>> raise HTTPBadRequest('bad data')
    Traceback (most recent call last):
    ...
    HTTPBadRequest: bad data
    >>> raise HTTPBadRequest()
    Traceback (most recent call last):
    ...
    HTTPBadRequest: The server could not comply with the request since it is either malformed or otherwise incorrect.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.