Index of the webob module
-
m
webob
...
-
a
month
...
-
a
day
...
-
a
minute
...
-
a
second
...
-
a
year
...
-
a
hour
...
-
a
week
...
-
a
UTC
...
-
C
Response
...
- Represents a WSGI response
-
a
content_length
...
-
a
pragma
...
-
a
vary
...
-
a
location
...
- Retrieve the Location header of the response, or None if there
is no header. If the header is not absolute and this response
is associated with a request, make the header absolute.
-
a
accept_ranges
...
-
a
server
...
-
a
body
...
- The body of the response, as a str. This will read in the
entire app_iter if necessary.
-
a
status_int
...
- The status as an integer
-
a
etag
...
-
a
content_range
...
-
a
content_md5
...
-
a
last_modified
...
-
a
unicode_body
...
- Get/set the unicode value of the body (using the charset of the Content-Type)
-
a
retry_after
...
-
a
content_language
...
-
a
content_location
...
-
a
default_charset
...
-
a
default_content_type
...
-
a
app_iter
...
- Returns the app_iter of the response.
-
a
content_encoding
...
-
a
cache_control
...
- Get/set/modify the Cache-Control header (section 14.9)
-
a
content_type_params
...
- Returns a dictionary of all the parameters in the content type.
-
a
content_type
...
- Get/set the Content-Type header (or None), without the
charset or any parameters.
-
a
default_conditional_response
...
-
a
headers
...
- The headers in a dictionary-like object
-
a
body_file
...
- Returns 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.
-
a
charset
...
- Get/set the charset (in the Content-Type)
-
a
status
...
- The status string
-
a
expires
...
-
a
date
...
-
a
age
...
-
a
request
...
- Return the request associated with this response if any.
-
a
headerlist
...
- The list of response headers
-
a
environ
...
- Get/set the request environ associated with this response, if
any.
-
a
allow
...
-
C
RequestClass
...
-
a
content_length
...
-
a
script_name
...
-
a
application_url
...
- The URL including SCRIPT_NAME (no PATH_INFO or query string)
-
a
server_name
...
-
a
accept_charset
...
-
a
accept_encoding
...
-
a
str_postvars
...
-
a
referrer
...
-
a
cookies
...
- Like .str_cookies, but may decode values and keys
-
a
path_qs
...
- The path of the request, without host but with query string
-
a
str_POST
...
- Return a MultiDict containing all the variables from a POST
form request. Does not return anything for non-POST
requests or for non-form requests (returns empty dict-like
object in that case).
-
a
if_range
...
-
a
unicode_errors
...
-
a
GET
...
- Like .str_GET, but may decode values and keys
-
a
postvars
...
-
a
server_port
...
-
a
method
...
-
a
body
...
- Return the content of the request body.
-
a
if_none_match
...
-
a
str_cookies
...
- Return a plain dictionary of cookies as found in the request.
-
a
host
...
- Host name provided in HTTP_HOST, with fall-back to SERVER_NAME
-
a
host_url
...
- The URL through the host (no path)
-
a
path
...
- The path of the request, without host or query string
-
a
POST
...
- Like .str_POST, but may decode values and keys
-
a
body_file
...
- Access the body of the request (wsgi.input) as a file-like
object.
-
a
range
...
-
a
content_type
...
-
a
user_agent
...
-
a
query_string
...
-
a
is_xhr
...
- Returns a boolean if X-Requested-With is present and XMLHttpRequest
-
a
path_url
...
- The URL including SCRIPT_NAME and PATH_INFO, but not QUERY_STRING
-
a
params
...
- Like .str_params, but may decode values and keys
-
a
scheme
...
-
a
cache_control
...
- Get/set/modify the Cache-Control header (section 14.9)
-
a
str_queryvars
...
-
a
urlvars
...
- Return any named variables matched in the URL.
-
a
pragma
...
-
a
if_match
...
-
a
headers
...
- All the request headers as a case-insensitive dictionary-like
object.
-
a
if_unmodified_since
...
-
a
urlargs
...
- Return any positional variables matched in the URL.
-
a
accept
...
-
a
remote_user
...
-
a
request_body_tempfile_limit
...
-
a
remote_addr
...
-
a
charset
...
-
a
str_params
...
- A dictionary-like object containing both the parameters from
the query string and request body.
-
a
path_info
...
-
a
accept_language
...
-
a
max_forwards
...
-
a
date
...
-
a
queryvars
...
-
a
str_GET
...
- Return a MultiDict containing all the variables from the
QUERY_STRING.
-
a
url
...
- The full request URL, including QUERY_STRING
-
a
if_modified_since
...
-
a
environ
...
- The WSGI environment dictionary for this request
-
f
relative_url
...
- Resolve other_url relative to the request URL.
-
f
path_info_peek
...
- Returns the next segment on PATH_INFO, or None if there is no
next segment. Doesn't modify the environment.
-
f
remove_conditional_headers
...
- Remove headers that make the request conditional.
-
f
call_application
...
- Call the given WSGI application, returning (status_string,
headerlist, app_iter)
-
f
path_info_pop
...
- 'Pops' off the next segment of PATH_INFO, pushing it onto
SCRIPT_NAME, and returning the popped segment. Returns None if
there is nothing left on PATH_INFO.
-
f
blank
...
- Create a blank request environ (and Request wrapper) with the
given path (path should be urlencoded), and any keys from
environ.
-
f
get_response
...
- Like .call_application(application), except returns a
response object with .status, .headers, and .body
attributes.
-
f
copy
...
- Copy the request and environment object.
-
f
__init__
...
-
f
copy_get
...
- Copies the request and environment object, but turning this request
into a GET along the way. If this was a POST request (or any other verb)
then it becomes GET, and the request body is thrown away.
-
f
cache_expires
...
- Set expiration on this request. This sets the response to
expire in the given seconds, and any other attributes are used
for cache_control (e.g., private=True, etc).
-
f
__call__
...
- WSGI application interface
-
f
encode_content
...
- Encode the content with the given encoding (only gzip and
identity are supported).
-
f
md5_etag
...
- Generate an etag for the response object using an MD5 hash of
the body (the body parameter, or self.body if not given)
-
f
decode_content
...
-
f
delete_cookie
...
- Delete a cookie from the client. Note that path and domain must match
how the cookie was originally set.
-
f
app_iter_range
...
- Return a new app_iter built from the response app_iter, that
serves up only the given start:stop range.
-
f
set_cookie
...
- Set (add) a cookie for the response
-
f
__init__
...
-
f
write
...
-
f
conditional_response_app
...
- Like the normal __call__ interface, but checks conditional headers:
-
f
unset_cookie
...
- Unset a cookie with the given name (remove it from the
response). If there are multiple cookies (e.g., two cookies
with the same name and different paths or domains), all such
cookies will be deleted.
-
f
html_escape
...
- HTML-escape a string or object