pyramid.response
¶
-
class
Response
(body=None, status=None, headerlist=None, app_iter=None, content_type=None, conditional_response=None, charset=<object object>, **kw)[source]¶ -
accept_ranges
¶ Gets and sets the
Accept-Ranges
header (HTTP spec section 14.5).
-
age
¶ Gets and sets the
Age
header (HTTP spec section 14.6). Converts it using int.
-
allow
¶ Gets and sets the
Allow
header (HTTP spec section 14.7). Converts it using list.
-
app_iter
¶ Returns the
app_iter
of the response.If
body
was set, this will create anapp_iter
from thatbody
(a single-item list).
-
app_iter_range
(start, stop)[source]¶ Return a new
app_iter
built from the responseapp_iter
, that serves up only the givenstart:stop
range.
-
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.
-
cache_control
¶ Get/set/modify the Cache-Control header (HTTP spec section 14.9).
-
charset
¶ Get/set the
charset
specified inContent-Type
.There is no checking to validate that a
content_type
actually allows for acharset
parameter.
-
conditional_response_app
(environ, start_response)[source]¶ 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
)
-
content_disposition
¶ Gets and sets the
Content-Disposition
header (HTTP spec section 19.5.1).
-
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_length
¶ Gets and sets the
Content-Length
header (HTTP spec section 14.17). Converts it using int.
-
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_range
¶ Gets and sets the
Content-Range
header (HTTP spec section 14.16). Converts it using ContentRange object.
-
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.)
-
date
¶ Gets and sets the
Date
header (HTTP spec section 14.18). Converts it using HTTP date.
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.
-
encode_content
(encoding='gzip', lazy=False)[source]¶ Encode the content with the given encoding (only
gzip
andidentity
are supported).
-
etag
¶ Gets and sets the
ETag
header (HTTP spec section 14.19). Converts it using Entity tag.
-
expires
¶ Gets and sets the
Expires
header (HTTP spec section 14.21). Converts it using HTTP date.
-
classmethod
from_file
(fp)[source]¶ 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
.
-
has_body
¶ Determine if the the response has a
body
. In contrast to simply accessingbody
, this method will not read the underlyingapp_iter
.
-
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.
-
last_modified
¶ Gets and sets the
Last-Modified
header (HTTP spec section 14.29). Converts it using HTTP date.
-
location
¶ Gets and sets the
Location
header (HTTP spec section 14.30).
-
md5_etag
(body=None, set_content_md5=False)[source]¶ 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.
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.
-
pragma
¶ Gets and sets the
Pragma
header (HTTP spec section 14.32).
-
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).
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"
or"Lax"
.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.
-
status
¶ The status string.
-
status_code
¶ The status as an integer.
-
status_int
¶ The status as an integer.
-
text
¶ Get/set the text value of the body using the
charset
of theContent-Type
or thedefault_body_encoding
.
-
ubody
¶ Deprecated alias for .text
-
unicode_body
¶ Deprecated alias for .text
Unset a cookie with the given name (remove it from the response).
-
vary
¶ Gets and sets the
Vary
header (HTTP spec section 14.44). Converts it using list.
-
www_authenticate
¶ Gets and sets the
WWW-Authenticate
header (HTTP spec section 14.47). Converts it usingparse_auth
andserialize_auth
.
-
-
class
FileResponse
(path, request=None, cache_max_age=None, content_type=None, content_encoding=None)[source]¶ A Response object that can be used to serve a static file from disk simply.
path
is a file path on disk.request
must be a Pyramid request object. Note that a request must be passed if the response is meant to attempt to use thewsgi.file_wrapper
feature of the web server that you're using to serve your Pyramid application.cache_max_age
is the number of seconds that should be used to HTTP cache this response.content_type
is the content_type of the response.content_encoding
is the content_encoding of the response. It's generally safe to leave this set toNone
if you're serving a binary file. This argument will be ignored if you also leavecontent-type
asNone
.
-
class
FileIter
(file, block_size=262144)[source]¶ A fixed-block-size iterator for use as a WSGI app_iter.
file
is a Python file pointer (or at least an object with aread
method that takes a size hint).block_size
is an optional block size for iteration.
Functions¶
-
response_adapter
(*types_or_ifaces, **kwargs)[source]¶ Decorator activated via a scan which treats the function being decorated as a response adapter for the set of types or interfaces passed as
*types_or_ifaces
to the decorator constructor.For example, if you scan the following response adapter:
from pyramid.response import Response from pyramid.response import response_adapter @response_adapter(int) def myadapter(i): return Response(status=i)
You can then return an integer from your view callables, and it will be converted into a response with the integer as the status code.
More than one type or interface can be passed as a constructor argument. The decorated response adapter will be called for each type or interface.
import json from pyramid.response import Response from pyramid.response import response_adapter @response_adapter(dict, list) def myadapter(ob): return Response(json.dumps(ob))
This method will have no effect until a scan is performed agains the package or module which contains it, ala:
from pyramid.config import Configurator config = Configurator() config.scan('somepackage_containing_adapters')
Two additional keyword arguments which will be passed to the venusian
attach
function are_depth
and_category
._depth
is provided for people who wish to reuse this class from another decorator. The default value is0
and should be specified relative to theresponse_adapter
invocation. It will be passed in to the venusianattach
function as the depth of the callstack when Venusian checks if the decorator is being used in a class or module context. It's not often used, but it can be useful in this circumstance._category
sets the decorator category name. It can be useful in combination with thecategory
argument ofscan
to control which views should be processed.See the
venusian.attach()
function in Venusian for more information about the_depth
and_category
arguments.Changed in version 1.9.1: Added the
_depth
and_category
arguments.