t.w.h.Request : class documentation

Part of twisted.web.http View Source View In Hierarchy

Known subclasses: twisted.web.proxy.ProxyRequest, twisted.web.proxy.ReverseProxyRequest, twisted.web.server.Request

Implements interfaces: twisted.internet.interfaces.IConsumer

A HTTP request.

Subclasses should override the process() method to determine how the request will be processed.
Instance VariablesmethodThe HTTP method that was used.
uriThe full URI that was requested (includes arguments).
pathThe path only (arguments not included).
argsAll of the arguments, including URL and POST arguments. (type: 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']}. )
received_headersAll received headers
Method __init__
Method noLongerQueued Notify the object that it is no longer queued.
Method gotLength Called when HTTP channel got length of content in this request.
Method parseCookies Parse cookie headers.
Method handleContentChunk Write a chunk of data.
Method requestReceived Called by channel when all data has been received.
Method __repr__ Undocumented
Method process Override in subclasses.
Method registerProducer Register a producer.
Method unregisterProducer Unregister the producer.
Method getHeader Get a header that was sent from the network.
Method getCookie Get a cookie that was sent from the network.
Method finish We are finished writing data.
Method write Write some data as a result of an HTTP request. The first time this is called, it writes out response data.
Method addCookie Set an outgoing HTTP cookie.
Method setResponseCode Set the HTTP response code.
Method setHeader Set an outgoing HTTP header.
Method redirect Utility function that does a redirect.
Method setLastModified Set the Last-Modified time for the response to this request.
Method setETag Set an entity tag for the outgoing response.
Method getAllHeaders Return dictionary of all headers the request received.
Method getRequestHostname Get the hostname that the user passed in to the request.
Method getHost Get my originally requesting transport's host.
Method setHost Change the host and port the request thinks it's using.
Method getClientIP Return the IP address of the client who submitted this request.
Method isSecure Return True if this request is using a secure transport.
Method getUser Return the HTTP user sent with this request, if any.
Method getPassword Return the HTTP password sent with this request, if any.
Method getClient Undocumented
Method connectionLost connection was lost
Method _cleanup Called when have finished responding and are no longer queued.
Method _sendError Undocumented
Method _authorize Undocumented
def __init__(self, channel, queued): (source)
Parameterschannelthe channel we're connected to.
queuedare we in the request queue, or can we start writing to the transport?
def _cleanup(self): (source)
Called when have finished responding and are no longer queued.
def noLongerQueued(self): (source)

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.
def gotLength(self, length): (source)

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

This method is not intended for users.
def parseCookies(self): (source)

Parse cookie headers.

This method is not intended for users.
def handleContentChunk(self, data): (source)

Write a chunk of data.

This method is not intended for users.
def requestReceived(self, command, path, version): (source)

Called by channel when all data has been received.

This method is not intended for users.
def __repr__(self): (source)
Undocumented
def process(self): (source)

Override in subclasses.

This method is not intended for users.
def registerProducer(self, producer, streaming): (source)
Register a producer.
def unregisterProducer(self): (source)
Unregister the producer.
def _sendError(self, code, resp=''): (source)
Undocumented
def getHeader(self, key): (source)
Get a header that was sent from the network.
def getCookie(self, key): (source)
Get a cookie that was sent from the network.
def finish(self): (source)
We are finished writing data.
def write(self, data): (source)
Write some data as a result of an HTTP request. The first time this is called, it writes out response data.
def addCookie(self, k, v, expires=None, domain=None, path=None, max_age=None, comment=None, secure=None): (source)

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.
def setResponseCode(self, code, message=None): (source)
Set the HTTP response code.
def setHeader(self, k, v): (source)
Set an outgoing HTTP header.
def redirect(self, url): (source)

Utility function that does a redirect.

The request should have finish() called after this.
def setLastModified(self, when): (source)

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.
ParameterswhenThe last time the resource being returned was modified, in seconds since the epoch. (type: number )
ReturnsIf 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.
def setETag(self, etag): (source)

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.
ParametersetagThe entity tag for the resource being returned. (type: string )
ReturnsIf 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.
def getAllHeaders(self): (source)
Return dictionary of all headers the request received.
def getRequestHostname(self): (source)

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.
Returnsthe requested hostname (type: str )
def getHost(self): (source)

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.
def setHost(self, host, port, ssl=0): (source)

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)
This method is experimental.
def getClientIP(self): (source)
Return the IP address of the client who submitted this request.
Returnsthe client IP address (type: str )
def isSecure(self): (source)

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.
ReturnsTrue if this request is secure (type: bool )
def _authorize(self): (source)
Undocumented
def getUser(self): (source)

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

If no user was supplied, return the empty string.
Returnsthe HTTP user, if any (type: str )
def getPassword(self): (source)

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

If no password was supplied, return the empty string.
Returnsthe HTTP password, if any (type: str )
def getClient(self): (source)
Undocumented
def connectionLost(self, reason): (source)
connection was lost
API Documentation for Twisted, generated by pydoctor at 2011-10-27 15:57:47.