Trees       Indices       Help   
twisted :: web :: http :: Request :: Class Request
[hide private]

Class Request

Known Subclasses:

A HTTP request.

Subclasses should override the process() method to determine how the request will be processed.

Instance Methods [hide private]
 
__init__(self, channel, queued)
 
__providedBy__(...)
Implement the `__providedBy__` attribute
 
__repr__(self)
 
__setattr__(self, name, value)
Support assignment of dict instances to received_headers for backwards-compatibility.
 
_authorize(self)
 
_cleanup(self)
Called when have finished responding and are no longer queued.
 
_sendError(self, code, resp='')
 
addCookie(self, k, v, expires=None, domain=None, path=None, max_age=None, comment=None, secure=None)
Set an outgoing HTTP cookie.
 
connectionLost(self, reason)
There is no longer a connection for this request to respond over.
 
finish(self)
Indicate that all response data has been written to this Request.
 
getAllHeaders(self)
Return dictionary mapping the names of all received headers to the last value received for each.
 
getClient(self)
str
getClientIP(self)
Return the IP address of the client who submitted this request.
 
getCookie(self, key)
Get a cookie that was sent from the network.
str or NoneType
getHeader(self, key)
Get an HTTP request header.
 
getHost(self)
Get my originally requesting transport's host.
str
getPassword(self)
Return the HTTP password sent with this request, if any.
str
getRequestHostname(self)
Get the hostname that the user passed in to the request.
str
getUser(self)
Return the HTTP user sent with this request, if any.
 
gotLength(self, length)
Called when HTTP channel got length of content in this request.
 
handleContentChunk(self, data)
Write a chunk of data.
bool
isSecure(self)
Return True if this request is using a secure transport.
 
noLongerQueued(self)
Notify the object that it is no longer queued.
Deferred
notifyFinish(self)
Notify when the response to this request has finished.
 
parseCookies(self)
Parse cookie headers.
 
process(self)
Override in subclasses.
 
redirect(self, url)
Utility function that does a redirect.
 
registerProducer(self, producer, streaming)
Register a producer.
 
requestReceived(self, command, path, version)
Called by channel when all data has been received.
 
setETag(self, etag)
Set an entity tag for the outgoing response.
 
setHeader(self, name, value)
Set an HTTP response header.
 
setHost(self, host, port, ssl=0)
Change the host and port the request thinks it's using.
 
setLastModified(self, when)
Set the Last-Modified time for the response to this request.
 
setResponseCode(self, code, message=None)
Set the HTTP response code.
 
unregisterProducer(self)
Unregister the producer.
 
write(self, data)
Write some data as a result of an HTTP request.
Class Variables [hide private]
  __implemented__ = <implementedBy twisted.web.http.Request>
  __provides__ = <zope.interface.declarations.ClassProvides obje...
  _forceSSL = 0
  chunked = 0
  clientproto = '(no clientproto yet)'
  code = 200
  code_message = 'OK'
  content = None
hash(x)
  etag = None
hash(x)
  finished = 0
  lastModified = None
hash(x)
  producer = None
hash(x)
  sentLength = 0
  startedWriting = 0
Instance Variables [hide private]
bool _disconnected = False
A flag which is False until the connection over which this request was received is closed and which is True after that.
A mapping of strings (the argument names) to lists of values. i.e., ?foo=bar&foo=baz&quux=spam results in {'foo': ['bar', 'baz'], 'quux': ['spam']}. args = None
All of the arguments, including URL and POST arguments.
  headers
Backwards-compatibility access to responseHeaders.
  method = '(no method yet)'
The HTTP method that was used.
  notifications
A list of Deferreds which are waiting for notification that the response to this request has been finished (successfully or with an error).
  path = None
The path only (arguments not included).
  received_headers
Backwards-compatibility access to requestHeaders.
http_headers.Headers requestHeaders
All received HTTP request headers.
http_headers.Headers responseHeaders
All HTTP response headers to be sent.
  uri = '(no uri yet)'
The full URI that was requested (includes arguments).
Method Details [hide private]

__init__(self, channel, queued)
(Constructor)

 
Parameters:
  • channel - the channel we're connected to.
  • queued - are we in the request queue, or can we start writing to the transport?

__providedBy__(...)

  
Implement the `__providedBy__` attribute

The `__providedBy__` attribute computes the interfaces peovided by
an object.

addCookie(self, k, v, expires=None, domain=None, path=None, max_age=None, comment=None, secure=None)

 

Set an outgoing HTTP cookie.

In general, you should consider using sessions instead of cookies, see twisted.web.server.Request.getSession and the twisted.web.server.Session class for details.

connectionLost(self, reason)

 

There is no longer a connection for this request to respond over. Clean up anything which can't be useful anymore.

getAllHeaders(self)

 

Return dictionary mapping the names of all received headers to the last value received for each.

Since this method does not return all header information, self.requestHeaders.getAllRawHeaders() may be preferred.

getClientIP(self)

 

Return the IP address of the client who submitted this request.

Returns: str
the client IP address

getHeader(self, key)

 

Get an HTTP request header.

Parameters:
  • key (str) - The name of the header to get the value of.
Returns: str or NoneType
The value of the specified header, or None if that header was not present in the request.

getHost(self)

 

Get my originally requesting transport's host.

Don't rely on the 'transport' attribute, since Request objects may be copied remotely. For information on this method's return value, see twisted.internet.tcp.Port.

getPassword(self)

 

Return the HTTP password sent with this request, if any.

If no password was supplied, return the empty string.

Returns: str
the HTTP password, if any

getRequestHostname(self)

 

Get the hostname that the user passed in to the request.

This will either use the Host: header (if it is available) or the host we are listening on if the header is unavailable.

Returns: str
the requested hostname

getUser(self)

 

Return the HTTP user sent with this request, if any.

If no user was supplied, return the empty string.

Returns: str
the HTTP user, if any

gotLength(self, length)

 

Called when HTTP channel got length of content in this request.

This method is not intended for users.

Parameters:
  • length - The length of the request body, as indicated by the request headers. None if the request headers do not indicate a length.

handleContentChunk(self, data)

 

Write a chunk of data.

This method is not intended for users.

isSecure(self)

 

Return True if this request is using a secure transport.

Normally this method returns True if this request's HTTPChannel instance is using a transport that implements ISSLTransport.

This will also return True if setHost() has been called with ssl=True.

Returns: bool
True if this request is secure

noLongerQueued(self)

 

Notify the object that it is no longer queued.

We start writing whatever data we have to the transport, etc.

This method is not intended for users.

notifyFinish(self)

 

Notify when the response to this request has finished.

Returns: Deferred
A Deferred which will be triggered when the request is finished -- with a None value if the request finishes successfully or with an error if the request is interrupted by an error (for example, the client closing the connection prematurely).

parseCookies(self)

 

Parse cookie headers.

This method is not intended for users.

process(self)

 

Override in subclasses.

This method is not intended for users.

redirect(self, url)

 

Utility function that does a redirect.

The request should have finish() called after this.

requestReceived(self, command, path, version)

 

Called by channel when all data has been received.

This method is not intended for users.

Parameters:
  • command (str) - The HTTP verb of this request. This has the case supplied by the client (eg, it maybe "get" rather than "GET").
  • path (str) - The URI of this request.
  • version (str) - The HTTP version of this request.

setETag(self, etag)

 

Set an entity tag for the outgoing response.

That's "entity tag" as in the HTTP/1.1 ETag header, "used for comparing two or more entities from the same requested resource."

If I am a conditional request, I may modify my response code to NOT_MODIFIED or PRECONDITION_FAILED, if appropriate for the tag given.

Parameters:
  • etag (string) - The entity tag for the resource being returned.
Returns:
If I am a If-None-Match conditional request and the tag matches one in the request, I return http.CACHED to indicate that you should write no body. Otherwise, I return a false value.

setHeader(self, name, value)

 

Set an HTTP response header. Overrides any previously set values for this header.

Parameters:
  • name (str) - The name of the header for which to set the value.
  • value (str) - The value to set for the named header.

setHost(self, host, port, ssl=0)

 

Change the host and port the request thinks it's using.

This method is useful for working with reverse HTTP proxies (e.g. both Squid and Apache's mod_proxy can do this), when the address the HTTP client is using is different than the one we're listening on.

For example, Apache may be listening on https://www.example.com, and then forwarding requests to http://localhost:8080, but we don't want HTML produced by Twisted to say 'http://localhost:8080', they should say 'https://www.example.com', so we do:

  request.setHost('www.example.com', 443, ssl=1)
Parameters:
  • host (str) - The value to which to change the host header.
  • ssl (bool) - A flag which, if True, indicates that the request is considered secure (if True, isSecure will return True).

setLastModified(self, when)

 

Set the Last-Modified time for the response to this request.

If I am called more than once, I ignore attempts to set Last-Modified earlier, only replacing the Last-Modified time if it is to a later value.

If I am a conditional request, I may modify my response code to NOT_MODIFIED if appropriate for the time given.

Parameters:
  • when (number) - The last time the resource being returned was modified, in seconds since the epoch.
Returns:
If I am a If-Modified-Since conditional request and the time given is not newer than the condition, I return http.CACHED to indicate that you should write no body. Otherwise, I return a false value.

write(self, data)

 

Write some data as a result of an HTTP request. The first time this is called, it writes out response data.

Parameters:
  • data (str) - Some bytes to be sent as part of the response body.

Class Variable Details [hide private]

__provides__

Value:
<zope.interface.declarations.ClassProvides object at 0xaa8c7ac>

Instance Variable Details [hide private]

headers

Backwards-compatibility access to responseHeaders. Use responseHeaders instead. headers behaves mostly like a dict and does not provide access to all header values nor does it allow multiple values for one header to be set.

notifications

A list of Deferreds which are waiting for notification that the response to this request has been finished (successfully or with an error). Don't use this attribute directly, instead use the Request.notifyFinish method.

received_headers

Backwards-compatibility access to requestHeaders. Use requestHeaders instead. received_headers behaves mostly like a dict and does not provide access to all header values.

   Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Fri Sep 24 12:50:21 2010 http://epydoc.sourceforge.net