| Parameters: |
|
|---|
HttpRequest object handles an HTTP request, parses and provides a request data in a suitable format for further processing.
Actually it is designed to handle a web environment in WSGI application.
Benefit of using the wsgikit.HttpRequest:
Like:
foo[][bar]=1&foo[][baz]=2&foo[xyz]=777
will be parsed to the following dictionary:
{
foo : {
0 : {
"bar" : 1
},
1 : {
"baz" : 2
},
"xyz" : 777
}
}
Basic usage example:
import wsgikit
def my_wsgi_app( environ, start_response):
status = '200 OK'
response_headers = [('Content-type','text/plain')]
start_response( status, response_headers)
request = wsgikit.HttpRequest( environ)
return str( request)
Public Properties:
| Variables: |
|
|---|
File element structure is:
{
"filename" : str - uploaded file name,
"headers" : dict - headers retrieved from the attachment part of te file in request body
"tmp_name" : str - path to temporary file location
"length" : int - file size in bytes
"mime" : str - file mime-type
}
Public Methods:
Returns the content of BODY storage if none name passed or returns a value for body parameter with given name
Example:
request = wsgikit.HttpRequest( environ)
# returns dict of all request body parameters
request.body()
# returns value of passed_param or None if param not found
request.body('passed_param')
| Parameters: |
|
|---|---|
| Return type: | mixed - dict of body params or param value |
Returns the content of COOKIE storage if none name passed or returns a value for cookie parameter with given name
Example:
request = wsgikit.HttpRequest( environ)
# returns dict of all cookie variables passed from client
request.cookie()
# returns value of 'varname' from cookie or None if variable not found
request.cookie('varname')
| Parameters: |
|
|---|---|
| Return type: | mixed - dict of cookie params or param value |
Returns the content of FILES storage if none name passed or returns a value for uploaded files with given name
Example:
request = wsgikit.HttpRequest( environ)
# returns dict of all uploaded files within the request
request.file()
# returns file(s) description object(s) having name 'file_param_name', or None if not found
request.file('file_param_name')
| Parameters: |
|
|---|---|
| Return type: | mixed - dict of uploaded files or its part by a given name |
Returns an entire storage or a value stored in this storage retrieved by a given key. Known storages are:
| Parameters: |
|
|---|---|
| Return type: | mixed - storage dict or value or default_value |
Returns True if HTTP request body contains any params, False otherwise
| Return type: | bool |
|---|
Returns True if HTTP request pass any cookie variables, False otherwise
| Return type: | bool |
|---|
Returns True if HTTP request contains any files attached and uploaded, False otherwise
| Return type: | bool |
|---|
Returns True if HTTP request contains any params passed with QUERY_STRING, False otherwise
| Return type: | bool |
|---|
Returns the content of HEADER storage if none name passed or returns a value for header with given name
Example:
request = wsgikit.HttpRequest( environ)
# returns dict of all headers
request.header()
# returns value of Content-Type header
request.header('Content-Type')
# returns value of X-MyHeader or False if header not found
request.header('X-My-Header', False)
| Parameters: |
|
|---|---|
| Return type: | dict or str - headers dict or string header value |
Static method providing an ability to parse QUERY_STRING-like parameters in the same way as this object does.
Usage example:
import wsgikit
my_params = 'f[]=2&f[]=3&f[][]=4&f[][]=5&f[][]=6'
print( wsgikit.HttpRequest.parse_query( my_params))
| Parameters: | query_string – str - key=value params delimited with & |
|---|---|
| Return type: | dict - dictionary of parsed parameters |
Returns the content of QUERY storage if none name passed or returns a value for QYERY_STRING parameter with given name
Example:
request = wsgikit.HttpRequest( environ)
# returns dict of all QUERY_STRING parameters
request.query()
# returns value of passed_param in QUERY_STRING or None if param not found
request.query('passed_param')
| Parameters: |
|
|---|---|
| Return type: | mixed - dict of QUERY_STRING params or param value |
Returns the content of SERVER environment or the value of server environment variable.
Example:
request = wsgikit.HttpRequest( environ)
# returns dict of all server environment variables
request.server()
# returns value of 'REMOTE_ADDR' server environment variable
request.header('REMOTE_ADDR')
| Parameters: |
|
|---|---|
| Return type: | mixed - dict of body params or param value |
Converts HttpRequest to dictionary presentation
| Return type: | dict - dictionary representation of HttpRequest object |
|---|