twisted.web.http.Request
class documentationtwisted.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, twisted.web.http._IDeprecatedHTTPChannelToRequestInterface
A HTTP request.
Subclasses should override the process() method to determine how the request will be processed.
Instance Variable | method | The HTTP method that was used. |
Instance Variable | uri | The full URI that was requested (includes arguments). |
Instance Variable | path | The path only (arguments not included). |
Instance Variable | 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']}.) |
Instance Variable | cookies | The cookies that will be sent in the response. (type: list
of bytes ) |
Instance Variable | requestHeaders | All received HTTP request headers. (type: http_headers.Headers ) |
Instance Variable | responseHeaders | All HTTP response headers to be sent. (type: http_headers.Headers ) |
Instance Variable | notifications | A list of Deferred s
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. |
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__ | Return a string description of the request including such information as the request method and request URI. |
Method | process | Override in subclasses. |
Method | registerProducer | Register a producer. |
Method | unregisterProducer | Unregister the producer. |
Method | getHeader | Get an HTTP request header. |
Method | getCookie | Get a cookie that was sent from the network. |
Method | notifyFinish | Notify when the response to this request has finished. |
Method | finish | Indicate that all response data has been written to this Request . |
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 HTTP response header. Overrides any previously set values for this 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 mapping the names of all received headers to the last value received for each. |
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 | getClientAddress | Return the 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 | connectionLost | There is no longer a connection for this request to respond over. Clean up anything which can't be useful anymore. |
Method | loseConnection | Pass the loseConnection through to the underlying channel. |
Method | __eq__ | Determines if two requests are the same object. |
Method | __ne__ | Determines if two requests are not the same object. |
Method | __hash__ | A Request is hashable so that it can be used as a mapping
key. |
Instance Variable | _disconnected | A flag which is False until the connection over which this
request was received is closed and which is True after that. (type: bool ) |
Instance Variable | _log | A logger instance for request related messages. (type: twisted.logger.Logger ) |
Method | _cleanup | Called when have finished responding and are no longer queued. |
Method | _authorize | Undocumented |
list
of Deferred
s
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.
False
until the connection over which this
request was received is closed and which is True
after that. (type: bool
)
Parameters | channel | the channel we're connected to. |
queued | (deprecated) 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.
In 16.3 this method was changed to become a no-op, as Request
objects are
now never queued.
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. |
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.
Parameters | command | The HTTP verb of this request. This has the case supplied by the client
(eg, it maybe "get" rather than "GET"). (type: bytes ) |
path | The URI of this request. (type: bytes ) | |
version | The HTTP version of this request. (type: bytes ) |
Override in subclasses.
This method is not intended for users.
Register a producer.
Unregister the producer.
Notify when the response to this request has finished.
Returns | 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). (type: Deferred ) | |
Note | There are some caveats around the reliability of the delivery of this
notification.
|
Indicate that all response data has been written to this Request
.
Write some data as a result of an HTTP request. The first time this is called, it writes out response data.
Parameters | data | Some bytes to be sent as part of the response body. (type: bytes ) |
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.
Parameters | k | cookie name (type: bytes
or unicode ) |
v | cookie value (type: bytes
or unicode ) | |
expires | cookie expire attribute value in "Wdy, DD Mon YYYY HH:MM:SS GMT"
format (type: bytes
or unicode ) | |
domain | cookie domain (type: bytes
or unicode ) | |
path | cookie path (type: bytes
or unicode ) | |
max_age | cookie expiration in seconds from reception (type: bytes
or unicode ) | |
comment | cookie comment (type: bytes
or unicode ) | |
secure | direct browser to send the cookie on encrypted connections only (type: bool ) | |
httpOnly | direct browser not to expose cookies through channels other than HTTP (and
HTTPS) requests (type: bool ) | |
sameSite | One of None
(default), 'lax' or 'strict' . Direct browsers not
to send this cookie on cross-origin requests. Please see: https://tools.ietf.org/html/draft-west-first-party-cookies-07 (type: None ,
bytes
or unicode ) | |
Raises | DeprecationWarning
if an argument is not bytes
or unicode .
ValueError
if the value for sameSite is not supported. |
Set an HTTP response header. Overrides any previously set values for this header.
Parameters | name | The name of the header for which to set the value. (type: bytes ) |
value | The value to set for the named header. (type: bytes ) |
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 to NOT_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 to NOT_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. |
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.
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 | the requested hostname (type: bytes ) |
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 b'http://localhost:8080/', they should say b'https://www.example.com/', so we do:
request.setHost(b'www.example.com', 443, ssl=1)
Parameters | host | The value to which to change the host header. (type: bytes ) |
ssl | A flag which, if True , indicates that the request is
considered secure (if True , isSecure
will return True ). (type: bool ) |
Return the IP address of the client who submitted this request.
This method is deprecated. Use getClientAddress
instead.
Returns | the client IP address (type: str ) |
Return the address of the client who submitted this request.
This may not be a network address (e.g., a server listening on a UNIX
domain socket will cause this to return UNIXAddress
).
Callers must check the type of the returned address.
Returns | the client's address. (type: IAddress ) | |
Present Since | 18.4 |
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 interfaces.ISSLTransport
.
This will also return True
if Request.setHost
has been called with ssl=True
.
Returns | True
if this request is secure (type: bool ) |
Return the HTTP user sent with this request, if any.
If no user was supplied, return the empty string.
Returns | the HTTP user, if any (type: bytes ) |
Return the HTTP password sent with this request, if any.
If no password was supplied, return the empty string.
Returns | the HTTP password, if any (type: bytes ) |
There is no longer a connection for this request to respond over. Clean up anything which can't be useful anymore.
A C{Request} is hashable so that it can be used as a mapping key. @return A C{int} based on the instance's identity.