This module provides a variety of utility functions for working with WSGI environments. A WSGI environment is a dictionary containing HTTP request variables as described in PEP 333. All of the functions taking an environ parameter expect a WSGI-compliant dictionary to be supplied; please see PEP 333 for a detailed specification.
wsgi.url_schemeshould be ``http'' or ``https'', by checking for a
HTTPSenvironment variable in the environ dictionary. The return value is a string.
This function is useful when creating a gateway that wraps CGI or a
CGI-like protocol such as FastCGI. Typically, servers providing such
protocols will include a
HTTPS variable with a value of ``1''
``yes'', or ``on'' when a request is received via SSL. So, this
function returns ``https'' if such a value is found, and ``http''
|environ [, include_query=1])|
QUERY_STRINGvariables are ignored. The result is the base URI of the application object addressed by the request.
SCRIPT_NAMEand return the name. The environ dictionary is modified in-place; use a copy if you need to keep the original
If there are no remaining path segments in
Typically, this routine is used to process each portion of a request
URI path, for example to treat the path as a series of dictionary keys.
This routine modifies the passed-in environment to make it suitable for
invoking another WSGI application that is located at the target URI.
For example, if there is a WSGI application at
/foo, and the
request URI path is
/foo/bar/baz, and the WSGI application at
/foo calls shift_path_info, it will receive the string
``bar'', and the environment will be updated to be suitable for passing
to a WSGI application at
/foo/bar. That is,
will change from
will change from
PATH_INFO is just a ``/'', this routine returns an empty
string and appends a trailing slash to
SCRIPT_NAME, even though
empty path segments are normally ignored, and
normally end in a slash. This is intentional behavior, to ensure that
an application can tell the difference between URIs ending in
from ones ending in
/x/ when using this routine to do object
This routine adds various parameters required for WSGI, including
PATH_INFO, and all of
the PEP 333-defined
wsgi.* variables. It only supplies default
values, and does not replace any existing settings for these variables.
This routine is intended to make it easier for unit tests of WSGI servers and applications to set up dummy environments. It should NOT be used by actual WSGI servers or applications, since the data is fake!
In addition to the environment functions above, the wsgiref.util module also provides these miscellaneous utilities:
|filelike [, blksize=8192])|
If filelike has a close() method, the returned object will also have a close() method, and it will invoke the filelike object's close() method when called.
See About this document... for information on suggesting changes.