App Engine Python SDK  v1.6.9 rev.445
The Python runtime is available as an experimental Preview feature.
Public Member Functions | Static Public Attributes | Properties | List of all members
google.appengine.ext.webapp._webapp25.Request Class Reference
Inheritance diagram for google.appengine.ext.webapp._webapp25.Request:

Public Member Functions

def __init__
 
def get
 
def get_all
 
def arguments
 
def get_range
 

Static Public Attributes

int request_body_tempfile_limit = 0
 

Properties

 uri = property(lambda self: self.url)
 
 query = property(lambda self: self.query_string)
 

Detailed Description

Abstraction for an HTTP request.

Properties:
  uri: the complete URI requested by the user
  scheme: 'http' or 'https'
  host: the host, including the port
  path: the path up to the ';' or '?' in the URL
  parameters: the part of the URL between the ';' and the '?', if any
  query: the part of the URL after the '?'

You can access parsed query and POST values with the get() method; do not
parse the query string yourself.

Constructor & Destructor Documentation

def google.appengine.ext.webapp._webapp25.Request.__init__ (   self,
  environ 
)
Constructs a Request object from a WSGI environment.

If the charset isn't specified in the Content-Type header, defaults
to UTF-8.

Args:
  environ: A WSGI-compliant environment dictionary.

Member Function Documentation

def google.appengine.ext.webapp._webapp25.Request.arguments (   self)
Returns a list of the arguments provided in the query and/or POST.

The return value is a list of strings.
def google.appengine.ext.webapp._webapp25.Request.get (   self,
  argument_name,
  default_value = '',
  allow_multiple = False 
)
Returns the query or POST argument with the given name.

We parse the query string and POST payload lazily, so this will be a
slower operation on the first call.

Args:
  argument_name: the name of the query or POST argument
  default_value: the value to return if the given argument is not present
  allow_multiple: return a list of values with the given name (deprecated)

Returns:
  If allow_multiple is False (which it is by default), we return the first
  value with the given name given in the request. If it is True, we always
  return a list.
def google.appengine.ext.webapp._webapp25.Request.get_all (   self,
  argument_name,
  default_value = None 
)
Returns a list of query or POST arguments with the given name.

We parse the query string and POST payload lazily, so this will be a
slower operation on the first call.

Args:
  argument_name: the name of the query or POST argument
  default_value: the value to return if the given argument is not present,
None may not be used as a default, if it is then an empty list will be
returned instead.

Returns:
  A (possibly empty) list of values.
def google.appengine.ext.webapp._webapp25.Request.get_range (   self,
  name,
  min_value = None,
  max_value = None,
  default = 0 
)
Parses the given int argument, limiting it to the given range.

Args:
  name: the name of the argument
  min_value: the minimum int value of the argument (if any)
  max_value: the maximum int value of the argument (if any)
  default: the default value of the argument if it is not given

Returns:
  An int within the given range for the argument

The documentation for this class was generated from the following file: