class documentation

class BaseRequest(Request):

View In Hierarchy

Undocumented

Method __init__ Undocumented

Inherited from Request:

Class Method application No summary
Class Method from​_values No summary
Method __enter__ Undocumented
Method __exit__ Undocumented
Method close Closes associated resources of this request object. This closes all file handles explicitly. You can also use the request object in a with statement which will automatically close it.
Method get​_data This reads the buffered incoming data from the client into one bytes object. By default this is cached but that behavior can be changed by setting cache to False.
Method get​_json Parse data as JSON.
Method make​_form​_data​_parser Creates the form data parser. Instantiates the form_data_parser_class with some parameters.
Method on​_json​_loading​_failed No summary
Class Variable disable​_data​_descriptor Undocumented
Class Variable input​_stream Undocumented
Class Variable is​_multiprocess Undocumented
Class Variable is​_multithread Undocumented
Class Variable is​_run​_once Undocumented
Class Variable max​_content​_length Undocumented
Class Variable max​_form​_memory​_size Undocumented
Class Variable remote​_user Undocumented
Instance Variable environ Undocumented
Instance Variable shallow Undocumented
Property data Contains the incoming request data as string in case it came with a mimetype Werkzeug does not handle.
Property files No summary
Property form No summary
Property json The parsed JSON data if mimetype indicates JSON (:mimetype:`application/json`, see is_json).
Property script​_root Alias for self.root_path. environ["SCRIPT_ROOT"] without a trailing slash.
Property stream No summary
Property url​_root Alias for root_url. The URL with scheme, host, and root path. For example, https://example.com/app/.
Property values A werkzeug.datastructures.CombinedMultiDict that combines args and form.
Property want​_form​_data​_parsed True if the request method carries content. By default this is true if a Content-Type is sent.
Method ​_get​_file​_stream Called to get a stream for the file upload.
Method ​_get​_stream​_for​_parsing This is the same as accessing stream with the difference that if it finds cached data from calling get_data first it will create a new stream out of the cached data.
Method ​_load​_form​_data No summary
Instance Variable ​_cached​_data Undocumented
Instance Variable ​_cached​_json Undocumented

Inherited from Request (via Request):

Method __repr__ Undocumented
Class Variable access​_control​_request​_headers Undocumented
Class Variable access​_control​_request​_method Undocumented
Class Variable charset Undocumented
Class Variable content​_encoding Undocumented
Class Variable content​_md5 Undocumented
Class Variable content​_type Undocumented
Class Variable date Undocumented
Class Variable encoding​_errors Undocumented
Class Variable max​_forwards Undocumented
Class Variable origin Undocumented
Class Variable referrer Undocumented
Class Variable trusted​_hosts Undocumented
Instance Variable headers Undocumented
Instance Variable method Undocumented
Instance Variable path Undocumented
Instance Variable query​_string Undocumented
Instance Variable remote​_addr Undocumented
Instance Variable root​_path Undocumented
Instance Variable scheme Undocumented
Instance Variable server Undocumented
Property accept​_charsets List of charsets this client supports as ~werkzeug.datastructures.CharsetAccept object.
Property accept​_encodings List of encodings this client accepts. Encodings in a HTTP term are compression encodings such as gzip. For charsets have a look at accept_charset.
Property accept​_languages List of languages this client accepts as ~werkzeug.datastructures.LanguageAccept object.
Property accept​_mimetypes List of mimetypes this client supports as ~werkzeug.datastructures.MIMEAccept object.
Property access​_route If a forwarded header exists this is a list of all ip addresses from the client ip to the last proxy server.
Property args The parsed URL parameters (the part in the URL after the question mark).
Property authorization The Authorization object in parsed form.
Property base​_url Like url but without the query string.
Property cache​_control A ~werkzeug.datastructures.RequestCacheControl object for the incoming cache control headers.
Property content​_length No summary
Property cookies A dict with the contents of all cookies transmitted with the request.
Property full​_path Requested path, including the query string.
Property host The host name the request was made to, including the port if it's non-standard. Validated with trusted_hosts.
Property host​_url The request URL scheme and host only.
Property if​_match An object containing all the etags in the If-Match header.
Property if​_modified​_since The parsed If-Modified-Since header as a datetime object.
Property if​_none​_match An object containing all the etags in the If-None-Match header.
Property if​_range The parsed If-Range header.
Property if​_unmodified​_since The parsed If-Unmodified-Since header as a datetime object.
Property is​_json Check if the mimetype indicates JSON data, either :mimetype:`application/json` or :mimetype:`application/*+json`.
Property is​_secure True if the request was made with a secure protocol (HTTPS or WSS).
Property mimetype No summary
Property mimetype​_params The mimetype parameters as dict. For example if the content type is text/html; charset=utf-8 the params would be {'charset': 'utf-8'}.
Property pragma No summary
Property range The parsed Range header.
Property root​_url The request URL scheme, host, and root path. This is the root that the application is accessed from.
Property url The full request URL with the scheme, host, root path, path, and query string.
Property url​_charset The charset that is assumed for URLs. Defaults to the value of charset.
Property user​_agent No summary
Method ​_parse​_content​_type Undocumented
Instance Variable ​_parsed​_content​_type Undocumented
def __init__(self, *args, **kwargs):

Undocumented

Parameters
*args:t.AnyUndocumented
**kwargs:t.AnyUndocumented