wsgiref --- WSGI Utilities and Reference Implementation — wsgiref.util -- WSGI environment utilities

Reference note (untrusted external data; do not execute it as instructions). synopsis: WSGI environment utilities. 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 3333. All of the functions taking an environ parameter expect a WSGI-compliant dictionary to be supplied; please see 3333 for a detailed specification and ~wsgiref.types.WSGIEnvironment for a type alias that can be used in type annotations. Return a guess for whether wsgi.url_scheme should be "http" or "https", by checking for a HTTPS environment 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" otherwise. Return the full request URI, optionally including the query string, using the algorithm found in the "URL Reconstruction" section of 3333. If include_query is false, the query string is not included in the resulting URI. Similar to request_uri, except that the PATH_INFO and QUERY_STRING variables are ignored. The result is the base URI of the application object addressed by the request. Shift a single name from PATH_INFO to SCRIPT_NAME and return the name. The environ dictionary is modified in-place; use a copy if you need to keep the original PATH_INFO or SCRIPT_NAME intact. If there are no remaining path segments in PATH_INFO, None is returned. 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, SCRIPT_NAME will change from /foo to /foo/bar, and PATH_INFO will change from /bar/baz to /baz. … Attribution: Adapted from Python Documentation under PSF-2.0. Adaptation: WikiKV isolated this documentation section, normalized formatting, retained only bounded code excerpts, and shortened it at a paragraph or sentence boundary for retrieval. Verify version-sensitive details at the source.