Class Response

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__

(inherited documentation)

repr(x)

Overrides: object.__repr__

(inherited documentation)

str(x)

Overrides: object.__str__

(inherited documentation)

Like the normal __call__ interface, but checks conditional headers:

* If-Modified-Since (304 Not Modified; only on GET, HEAD) * If-None-Match (304 Not Modified; only on GET, HEAD) * Range (406 Partial Content; only on GET, HEAD)

Delete a cookie from the client. Note that path and domain 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.

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 a ``Content-Length``

Generate an etag for the response object using an MD5 hash of the body (the body parameter, or ``self.body`` if not given)

Sets ``self.etag`` If ``set_content_md5`` is True sets ``self.content_md5`` as well

Merge the cookies that were set on this response with the given `resp` object (which can be any WSGI application).

If the `resp` is a :class:`webob.Response` object, then the other object will be modified in-place.

Set (add) a cookie for the response.

Arguments are:

``key``

   The cookie name.

``value``

   The cookie value, which should be a string or ``None``.  If
   ``value`` is ``None``, it's equivalent to calling the
   :meth:`webob.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 or ``None``.  If this
   value is an integer, it is used as the ``Max-Age`` of the
   generated cookie.  If ``expires`` is not passed and this value is
   an integer, the ``max_age`` value will also influence the
   ``Expires`` value of the cookie (``Expires`` will be set to now +
   max_age).  If this value is ``None``, the cookie will not have a
   ``Max-Age`` value (unless ``expires`` is also sent).

``path``

   A string representing the cookie ``Path`` value.  It defaults to
   ``/``.

``domain``

   A string representing the cookie ``Domain``, or ``None``.  If
   domain is ``None``, no ``Domain`` value will be sent in the
   cookie.

``secure``

   A boolean.  If it's ``True``, the ``secure`` flag will be sent in
   the cookie, if it's ``False``, the ``secure`` flag will not be
   sent in the cookie.

``httponly``

   A boolean.  If it's ``True``, the ``HttpOnly`` flag will be sent
   in the cookie, if it's ``False``, the ``HttpOnly`` flag will not
   be sent in the cookie.

``comment``

   A string representing the cookie ``Comment`` value, or ``None``.
   If ``comment`` is ``None``, no ``Comment`` value will be sent in
   the cookie.

``expires``

   A ``datetime.timedelta`` object representing an amount of time or
   the value ``None``.  A non-``None`` value is used to generate the
   ``Expires`` value of the generated cookie.  If ``max_age`` is not
   passed, but this value is not ``None``, it will influence the
   ``Max-Age`` header (``Max-Age`` will be 'expires_value -
   datetime.utcnow()').  If this value is ``None``, the ``Expires``
   cookie value will be unset (unless ``max_age`` is also passed).

``overwrite``

   If this key is ``True``, before setting the cookie, unset any
   existing cookie.

accept_ranges

Gets and sets the ``Accept-Ranges`` header (`HTTP spec section 14.5 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.5>`_).

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, value)

Delete Method:

unreachable.fdel(r)

age

Gets and sets the ``Age`` header (`HTTP spec section 14.6 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.6>`_). Converts it using int.

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, val)

Delete Method:

unreachable.fdel(r)

allow

Gets and sets the ``Allow`` header (`HTTP spec section 14.7 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.7>`_). Converts it using list.

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, val)

Delete Method:

unreachable.fdel(r)

app_iter

Returns the app_iter of the response.

If body was set, this will create an app_iter from that body (a single-item list)

Get Method:

_app_iter__get(self) - Returns the app_iter of the response.

Set Method:

_app_iter__set(self, value)

Delete Method:

_app_iter__del(self)

body

The body of the response, as a ``str``. This will read in the entire app_iter if necessary.

Get Method:

_body__get(self) - The body of the response, as a ``str``.

Set Method:

_body__set(self, value='')

Delete Method:

_body__set(self, value='')

body_file

A file-like object that can be used to write to the body. If you passed in a list app_iter, that app_iter will be modified by writes.

Get Method:

_body_file__get(self) - A file-like object that can be used to write to the body.

Set Method:

_body_file__set(self, file)

Delete Method:

_body_file__del(self)

cache_control

Get/set/modify the Cache-Control header (`HTTP spec section 14.9 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9>`_)

Get Method:

_cache_control__get(self) - Get/set/modify the Cache-Control header (`HTTP spec section 14.9 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9>`_)

Set Method:

_cache_control__set(self, value)

Delete Method:

_cache_control__del(self)

cache_expires

Get Method:

unreachable(self)

Set Method:

_cache_expires(self, seconds=0, **kw) - Set expiration on this request.

charset

Get/set the charset (in the Content-Type)

Get Method:

_charset__get(self) - Get/set the charset (in the Content-Type)

Set Method:

_charset__set(self, charset)

Delete Method:

_charset__del(self)

content_disposition

Gets and sets the ``Content-Disposition`` header (`HTTP spec section 19.5.1 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1>`_).

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, value)

Delete Method:

unreachable.fdel(r)

content_encoding

Gets and sets the ``Content-Encoding`` header (`HTTP spec section 14.11 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11>`_).

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, value)

Delete Method:

unreachable.fdel(r)

content_language

Gets and sets the ``Content-Language`` header (`HTTP spec section 14.12 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.12>`_). Converts it using list.

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, val)

Delete Method:

unreachable.fdel(r)

content_length

Gets and sets the ``Content-Length`` header (`HTTP spec section 14.17 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17>`_). Converts it using int.

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, val)

Delete Method:

unreachable.fdel(r)

content_location

Gets and sets the ``Content-Location`` header (`HTTP spec section 14.14 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.14>`_).

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, value)

Delete Method:

unreachable.fdel(r)

content_md5

Gets and sets the ``Content-MD5`` header (`HTTP spec section 14.14 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.14>`_).

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, value)

Delete Method:

unreachable.fdel(r)

content_range

Gets and sets the ``Content-Range`` header (`HTTP spec section 14.16 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.16>`_). Converts it using ContentRange object.

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, val)

Delete Method:

unreachable.fdel(r)

content_type

Get/set the Content-Type header (or None), *without* the charset or any parameters.

If you include parameters (or ``;`` at all) when setting the content_type, any existing parameters will be deleted; otherwise they will be preserved.

Get Method:

_content_type__get(self) - Get/set the Content-Type header (or None), *without* the charset or any parameters.

Set Method:

_content_type__set(self, value)

Delete Method:

_content_type__del(self)

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 would not be applied otherwise)

Get Method:

_content_type_params__get(self) - A dictionary of all the parameters in the content type.

Set Method:

_content_type_params__set(self, value_dict)

Delete Method:

_content_type_params__del(self)

date

Gets and sets the ``Date`` header (`HTTP spec section 14.18 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.18>`_). Converts it using HTTP date.

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, val)

Delete Method:

unreachable.fdel(r)

etag

Gets and sets the ``ETag`` header (`HTTP spec section 14.19 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.19>`_). Converts it using Entity tag.

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, val)

Delete Method:

unreachable.fdel(r)

etag_strong

Get Method:

unreachable.etag_strong(self)

expires

Gets and sets the ``Expires`` header (`HTTP spec section 14.21 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21>`_). Converts it using HTTP date.

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, val)

Delete Method:

unreachable.fdel(r)

headerlist

The list of response headers

Get Method:

_headerlist__get(self) - The list of response headers

Set Method:

_headerlist__set(self, value)

Delete Method:

_headerlist__del(self)

headers

The headers in a dictionary-like object

Get Method:

_headers__get(self) - The headers in a dictionary-like object

Set Method:

_headers__set(self, value)

json

Access the body of the response as JSON

Get Method:

_json_body__get(self) - Access the body of the response as JSON

Set Method:

_json_body__set(self, value)

Delete Method:

_json_body__del(self)

json_body

Access the body of the response as JSON

Get Method:

_json_body__get(self) - Access the body of the response as JSON

Set Method:

_json_body__set(self, value)

Delete Method:

_json_body__del(self)

last_modified

Gets and sets the ``Last-Modified`` header (`HTTP spec section 14.29 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.29>`_). Converts it using HTTP date.

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, val)

Delete Method:

unreachable.fdel(r)

location

Gets and sets the ``Location`` header (`HTTP spec section 14.30 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30>`_).

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, value)

Delete Method:

unreachable.fdel(r)

pragma

Gets and sets the ``Pragma`` header (`HTTP spec section 14.32 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.32>`_).

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, value)

Delete Method:

unreachable.fdel(r)

retry_after

Gets and sets the ``Retry-After`` header (`HTTP spec section 14.37 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.37>`_). Converts it using HTTP date or delta seconds.

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, val)

Delete Method:

unreachable.fdel(r)

server

Gets and sets the ``Server`` header (`HTTP spec section 14.38 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.38>`_).

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, value)

Delete Method:

unreachable.fdel(r)

status

The status string

Get Method:

_status__get(self) - The status string

Set Method:

_status__set(self, value)

status_code

The status as an integer

Get Method:

_status_code__get(self) - The status as an integer

Set Method:

_status_code__set(self, code)

status_int

The status as an integer

Get Method:

_status_code__get(self) - The status as an integer

Set Method:

_status_code__set(self, code)

text

Get/set the text value of the body (using the charset of the Content-Type)

Get Method:

_text__get(self) - Get/set the text value of the body (using the charset of the Content-Type)

Set Method:

_text__set(self, value)

Delete Method:

_text__del(self)

ubody

Deprecated alias for .text

Get Method:

_text__get(self) - Get/set the text value of the body (using the charset of the Content-Type)

Set Method:

_text__set(self, value)

Delete Method:

_text__del(self)

unicode_body

Deprecated alias for .text

Get Method:

_text__get(self) - Get/set the text value of the body (using the charset of the Content-Type)

Set Method:

_text__set(self, value)

Delete Method:

_text__del(self)

vary

Gets and sets the ``Vary`` header (`HTTP spec section 14.44 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.44>`_). Converts it using list.

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, val)

Delete Method:

unreachable.fdel(r)

www_authenticate

Gets and sets the ``WWW-Authenticate`` header (`HTTP spec section 14.47 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.47>`_). Converts it using ``parse_auth`` and ``serialize_auth``.

Get Method:

unreachable.fget(r)

Set Method:

unreachable.fset(r, val)

Delete Method:

unreachable.fdel(r)