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.IConsumerA HTTP request.
Subclasses should override the process() method to determine how the request will be processed.Instance Variables | method | The HTTP method that was used. |
uri | The full URI that was requested (includes arguments). | |
path | The path only (arguments not included). | |
args | All 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_headers | All received headers |
Method | __init__ | |
Method | _cleanup | Called when have finished responding and are no longer queued. |
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 | _sendError | Undocumented |
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 |
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 | Undocumented |
Method | isSecure | Undocumented |
Method | _authorize | Undocumented |
Method | getUser | Undocumented |
Method | getPassword | Undocumented |
Method | getClient | Undocumented |
Method | connectionLost | connection was lost |
Parameters | channel | the channel we're connected to. |
queued | are we in the request queue, or can we start writing to the transport? |
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.Called when HTTP channel got length of content in this request.
This method is not intended for users.Write a chunk of data.
This method is not intended for users.Called by channel when all data has been received.
This method is not intended for users.Override in subclasses.
This method is not intended for users.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.Utility function that does a redirect.
The request should have finish() called after this.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 toNOT_MODIFIED
if appropriate for the time given.
Parameters | when | The last time the resource being returned was modified, in seconds since the epoch. (type: number ) |
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.
|
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 toNOT_MODIFIED
or PRECONDITION_FAILED
, if
appropriate for the tag given.
Parameters | etag | The entity tag for the resource being returned. (type: string ) |
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.
|
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.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.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.