Latest Version: 0.9.6.2

WSGIRequest

WSGI Request API Object

This object represents a WSGI request with a more friendly interface. This does not expose every detail of the WSGI environment, and attempts to express nothing beyond what is available in the environment dictionary.

The only state maintained in this object is the desired charset, its associated errors handler, and the decode_param_names option.

The incoming parameter values will be automatically coerced to unicode objects of the charset encoding when charset is set. The incoming parameter names are not decoded to unicode unless the decode_param_names option is enabled.

When unicode is expected, charset will overridden by the the value of the Content-Type header's charset parameter if one was specified by the client.

The class variable defaults specifies default values for charset, errors, and langauge. These can be overridden for the current request via the registry.

The language default value is considered the fallback during i18n translations to ensure in odd cases that mixed languages don't occur should the language file contain the string but not another language in the accepted languages list. The language value only applies when getting a list of accepted languages from the HTTP Accept header.

This behavior is duplicated from Aquarium, and may seem strange but is very useful. Normally, everything in the code is in "en-us". However, the "en-us" translation catalog is usually empty. If the user requests ["en-us", "zh-cn"] and a translation isn't found for a string in "en-us", you don't want gettext to fallback to "zh-cn". You want it to just use the string itself. Hence, if a string isn't found in the language catalog, the string in the source code will be used.

All other state is kept in the environment dictionary; this is essential for interoperability.

You are free to subclass this object.


Attributes

a GET

Dictionary-like object representing the QUERY_STRING parameters. Always present, if possibly empty.

If the same key is present in the query string multiple times, a list of its values can be retrieved from the MultiDict via the getall method.

Returns a MultiDict container or a UnicodeMultiDict when charset is set.

a POST

Dictionary-like object representing the POST body.

Most values are encoded strings, or unicode strings when charset is set. There may also be FieldStorage objects representing file uploads. If this is not a POST request, or the body is not encoded fields (e.g., an XMLRPC request) then this will be empty.

This will consume wsgi.input when first accessed if applicable, but the raw version will be put in environ['paste.parsed_formvars'].

Returns a MultiDict container or a UnicodeMultiDict when charset is set.

a cookies

Dictionary of cookies keyed by cookie name.

Just a plain dictionary, may be empty but not None.

a defaults

{'errors': 'replace', 'decode_param_names': False, 'charset': None, 'language': 'en-us'}

a host

Host name provided in HTTP_HOST, with fall-back to SERVER_NAME

a is_xhr

Returns a boolean if X-Requested-With is present and a XMLHttpRequest

a languages

Return a list of preferred languages, most preferred first.

The list may be empty.

a params

Dictionary-like object of keys from POST, GET, URL dicts

Return a key value from the parameters, they are checked in the following order: POST, GET, URL

Additional methods supported:

getlist(key)
Returns a list of all the values by that key, collected from POST, GET, URL dicts

Returns a MultiDict container or a UnicodeMultiDict when charset is set.

a urlvars

Return any variables matched in the URL (e.g., wsgiorg.routing_args).

Methods

f __init__(self, environ) ...

f determine_browser_charset(self) ...

Determine the encoding as specified by the browser via the Content-Type's charset parameter, if one is set

f match_accept(self, mimetypes) ...

Return a list of specified mime-types that the browser's HTTP Accept header allows in the order provided.

See the source for more information.

Top