webob.response
-- Response¶
Response¶
-
class
webob.response.
Response
(body=None, status=None, headerlist=None, app_iter=None, content_type=None, conditional_response=None, charset=<object object>, **kw)¶ Represents a WSGI response.
If no arguments are passed, creates a
Response
that uses a variety of defaults. The defaults may be changed by sub-classing theResponse
. See the sub-classing notes.Variables: - body (bytes or text_type) -- If
body
is atext_type
, then it will be encoded using eithercharset
when provided ordefault_encoding
whencharset
is not provided if thecontent_type
allows for acharset
. This argument is mutually exclusive withapp_iter
. - status (int or str) -- Either an
int
or a string that is an integer followed by the status text. If it is an integer, it will be converted to a proper status that also includes the status text. Any existing status text will be kept. Non-standard values are allowed. - headerlist (list) -- A list of HTTP headers for the response.
- app_iter (iterable) -- An iterator that is used as the body of the
response. Should conform to the WSGI requirements and should provide
bytes. This argument is mutually exclusive with
body
. - content_type (str or None) -- Sets the
Content-Type
header. If nocontent_type
is provided, and there is noheaderlist
, thedefault_content_type
will be automatically set. Ifheaderlist
is provided then this value is ignored. - conditional_response (bool) -- Used to change the behavior of the
Response
to check the original request for conditional response headers. Seeconditional_response_app()
for more information. - charset (str or None) -- Adds a
charset
Content-Type
parameter. If nocharset
is provided and theContent-Type
is text, then thedefault_charset
will automatically be added. Currently the onlyContent-Type
's that allow for acharset
are defined to betext/*
,application/xml
, and*/*+xml
. Any otherContent-Type
's will not have acharset
added. If aheaderlist
is provided this value is ignored.
All other response attributes may be set on the response by providing them as keyword arguments. A
TypeError
will be raised for any unexpected keywords.Sub-classing notes:
- The
default_content_type
is used as the default for theContent-Type
header that is returned on the response. It istext/html
. - The
default_charset
is used as the default character set to return on theContent-Type
header, if theContent-Type
allows for acharset
parameter. Currently the onlyContent-Type
's that allow for acharset
are defined to be:text/*
,application/xml
, and*/*+xml
. Any otherContent-Type
's will not have acharset
added. - The
unicode_errors
is set tostrict
, and access on atext
will raise an error if it fails to decode thebody
. default_conditional_response
is set toFalse
. This flag may be set toTrue
so that allResponse
objects will attempt to check the original request for conditional response headers. Seeconditional_response_app()
for more information.default_body_encoding
is set to 'UTF-8' by default. It exists to allow users to get/set theResponse
object using.text
, even if nocharset
has been set for theContent-Type
.
-
classmethod
from_file
(fp)¶ Reads a response from a file-like object (it must implement
.read(size)
and.readline()
).It will read up to the end of the response, not the end of the file.
This reads the response as represented by
str(resp)
; it may not read every valid HTTP response properly. Responses must have aContent-Length
.
-
copy
()¶ Makes a copy of the response.
-
status
¶ The status string.
-
status_code
¶ The status as an integer.
-
status_int
¶ The status as an integer.
-
headerlist
¶ The list of response headers.
-
headers
¶ The headers in a dictionary-like object.
-
json
¶ Set/get the body of the response as JSON.
-
json_body
¶ Set/get the body of the response as JSON.
-
has_body
¶ Determine if the the response has a
body
. In contrast to simply accessingbody
, this method will not read the underlyingapp_iter
.
-
text
¶ Get/set the text value of the body using the
charset
of theContent-Type
or thedefault_body_encoding
.
-
unicode_body
¶ Deprecated alias for .text
-
ubody
¶ Deprecated alias for .text
-
body_file
¶ A file-like object that can be used to write to the body. If you passed in a list
app_iter
, thatapp_iter
will be modified by writes.
-
app_iter
¶ Returns the
app_iter
of the response.If
body
was set, this will create anapp_iter
from thatbody
(a single-item list).
-
allow
¶ Gets and sets the
Allow
header (HTTP spec section 14.7). Converts it using list.
-
vary
¶ Gets and sets the
Vary
header (HTTP spec section 14.44). Converts it using list.
-
content_length
¶ Gets and sets the
Content-Length
header (HTTP spec section 14.17). Converts it using int.
-
content_encoding
¶ Gets and sets the
Content-Encoding
header (HTTP spec section 14.11).
-
content_language
¶ Gets and sets the
Content-Language
header (HTTP spec section 14.12). Converts it using list.
-
content_location
¶ Gets and sets the
Content-Location
header (HTTP spec section 14.14).
-
content_md5
¶ Gets and sets the
Content-MD5
header (HTTP spec section 14.14).
-
content_disposition
¶ Gets and sets the
Content-Disposition
header (HTTP spec section 19.5.1).
-
accept_ranges
¶ Gets and sets the
Accept-Ranges
header (HTTP spec section 14.5).
-
content_range
¶ Gets and sets the
Content-Range
header (HTTP spec section 14.16). Converts it using ContentRange object.
-
date
¶ Gets and sets the
Date
header (HTTP spec section 14.18). Converts it using HTTP date.
-
expires
¶ Gets and sets the
Expires
header (HTTP spec section 14.21). Converts it using HTTP date.
-
last_modified
¶ Gets and sets the
Last-Modified
header (HTTP spec section 14.29). Converts it using HTTP date.
-
etag
¶ Gets and sets the
ETag
header (HTTP spec section 14.19). Converts it using Entity tag.
-
location
¶ Gets and sets the
Location
header (HTTP spec section 14.30).
-
pragma
¶ Gets and sets the
Pragma
header (HTTP spec section 14.32).
-
age
¶ Gets and sets the
Age
header (HTTP spec section 14.6). Converts it using int.
-
retry_after
¶ Gets and sets the
Retry-After
header (HTTP spec section 14.37). Converts it using HTTP date or delta seconds.
-
server
¶ Gets and sets the
Server
header (HTTP spec section 14.38).
-
www_authenticate
¶ Gets and sets the
WWW-Authenticate
header (HTTP spec section 14.47). Converts it usingparse_auth
andserialize_auth
.
-
charset
¶ Get/set the
charset
specified inContent-Type
.There is no checking to validate that a
content_type
actually allows for acharset
parameter.
-
content_type
¶ Get/set the
Content-Type
header. If noContent-Type
header is set, this will returnNone
.Changed in version 1.7: Setting a new
Content-Type
will remove allContent-Type
parameters and reset thecharset
to the default if theContent-Type
istext/*
or XML (application/xml
or*/*+xml
).To preserve all
Content-Type
parameters, you may use the following code:resp = Response() params = resp.content_type_params resp.content_type = 'application/something' resp.content_type_params = params
-
content_type_params
¶ A dictionary of all the parameters in the content type.
(This is not a view, set to change, modifications of the dict will not be applied otherwise.)
Set (add) a cookie for the response.
Arguments are:
name
The cookie name.value
The cookie value, which should be a string orNone
. Ifvalue
isNone
, it's equivalent to calling thewebob.response.Response.unset_cookie()
method for this cookie key (it effectively deletes the cookie on the client).max_age
An integer representing a number of seconds,datetime.timedelta
, orNone
. This value is used as theMax-Age
of the generated cookie. Ifexpires
is not passed and this value is notNone
, themax_age
value will also influence theExpires
value of the cookie (Expires
will be set tonow
+max_age
). If this value isNone
, the cookie will not have aMax-Age
value (unlessexpires
is set). If bothmax_age
andexpires
are set, this value takes precedence.path
A string representing the cookiePath
value. It defaults to/
.domain
A string representing the cookieDomain
, orNone
. If domain isNone
, noDomain
value will be sent in the cookie.secure
A boolean. If it'sTrue
, thesecure
flag will be sent in the cookie, if it'sFalse
, thesecure
flag will not be sent in the cookie.httponly
A boolean. If it'sTrue
, theHttpOnly
flag will be sent in the cookie, if it'sFalse
, theHttpOnly
flag will not be sent in the cookie.samesite
A string representing theSameSite
attribute of the cookie orNone
. If samesite isNone
noSameSite
value will be sent in the cookie. Should only be"strict"
,"lax"
, or"none"
.comment
A string representing the cookieComment
value, orNone
. Ifcomment
isNone
, noComment
value will be sent in the cookie.expires
A
datetime.timedelta
object representing an amount of time,datetime.datetime
orNone
. A non-None
value is used to generate theExpires
value of the generated cookie. Ifmax_age
is not passed, but this value is notNone
, it will influence theMax-Age
header. If this value isNone
, theExpires
cookie value will be unset (unlessmax_age
is set). Ifmax_age
is set, it will be used to generate theexpires
and this value is ignored.If a
datetime.datetime
is provided it has to either be timezone aware or be based on UTC.datetime.datetime
objects that are local time are not supported. Timezone awaredatetime.datetime
objects are converted to UTC.This argument will be removed in future versions of WebOb (version 1.9).
overwrite
If this key isTrue
, before setting the cookie, unset any existing cookie.
Delete a cookie from the client. Note that
path
anddomain
must match how the cookie was originally set.This sets the cookie to the empty string, and
max_age=0
so that it should expire immediately.
Unset a cookie with the given name (remove it from the response).
Merge the cookies that were set on this response with the given
resp
object (which can be any WSGI application).If the
resp
is awebob.Response
object, then the other object will be modified in-place.
-
cache_control
¶ Get/set/modify the Cache-Control header (HTTP spec section 14.9).
-
encode_content
(encoding='gzip', lazy=False)¶ Encode the content with the given encoding (only
gzip
andidentity
are supported).
-
md5_etag
(body=None, set_content_md5=False)¶ Generate an etag for the response object using an MD5 hash of the body (the
body
parameter, orself.body
if not given).Sets
self.etag
.If
set_content_md5
isTrue
, setsself.content_md5
as well.
-
conditional_response_app
(environ, start_response)¶ Like the normal
__call__
interface, but checks conditional headers:If-Modified-Since
(304 Not Modified
; only onGET
,HEAD
)If-None-Match
(304 Not Modified
; only onGET
,HEAD
)Range
(406 Partial Content
; only onGET
,HEAD
)
-
app_iter_range
(start, stop)¶ Return a new
app_iter
built from the responseapp_iter
, that serves up only the givenstart:stop
range.
- body (bytes or text_type) -- If
-
class
webob.response.
ResponseBodyFile
(response)¶ -
encoding
¶ The encoding of the file (inherited from response.charset)
-
writelines
(seq)¶ Write a sequence of lines to the response.
-
tell
()¶ Provide the current location where we are going to start writing.
-
-
class
webob.response.
AppIterRange
(app_iter, start, stop)¶ Wraps an
app_iter
, returning just a range of bytes.