class IRequest(Interface): (source)
Known implementations: twisted.web.server.Request
An HTTP request.
Present Since | |
9.0 |
Method | add |
Set an outgoing HTTP cookie. |
Method | finish |
Indicate that the response to this request is complete. |
Method | get |
Return dictionary mapping the names of all received headers to the last value received for each. |
Method | get |
Return the address of the client who submitted this request. |
Method | get |
Return the IP address of the client who submitted this request. |
Method | get |
Get a cookie that was sent from the network. |
Method | get |
Get an HTTP request header. |
Method | get |
Get my originally requesting transport's host. |
Method | get |
Return the HTTP password sent with this request, if any. |
Method | get |
Get the hostname that the HTTP client passed in to the request. |
Method | get |
Get a previously-remembered URL. |
Method | get |
Look up the session associated with this request or create a new one if there is not one. |
Method | get |
Return the HTTP user sent with this request, if any. |
Method | is |
Return True if this request is using a secure transport. |
Method | pre |
At any time during resource traversal or resource rendering, returns an absolute URL to the most nested resource which has yet been reached. |
Method | redirect |
Utility function that does a redirect. |
Method | remember |
Remember the currently-processed part of the URL for later recalling. |
Method | set |
Set an entity tag for the outgoing response. |
Method | set |
Set an HTTP response header. Overrides any previously set values for this header. |
Method | set |
Change the host and port the request thinks it's using. |
Method | set |
Set the Last-Modified time for the response to this request. |
Method | set |
Set the HTTP response code. |
Method |
|
No summary |
Method | write |
Write some data to the body of the response to this request. Response headers are written the first time this method is called, after which new response headers may not be added. |
Attribute | args |
A mapping of decoded query argument names as bytes to corresponding query argument values as list s of bytes . For example, for a URI with foo=bar&foo=baz&quux=spam for its query part, args will be {b'foo': [b'bar', b'baz'], b'quux': [b'spam']}... |
Attribute | content |
A file-like object giving the request body. This may be a file on disk, an io.BytesIO , or some other type. The implementation is free to decide on a per-request basis. |
Attribute | method |
A bytes giving the HTTP method that was used. |
Attribute | path |
A bytes giving the encoded query path of the request URI (not including query arguments). |
Attribute | postpath |
The URL path segments which have not (yet) been processed during resource traversal, as a list of bytes . |
Attribute | prepath |
The URL path segments which have been processed during resource traversal, as a list of bytes . |
Attribute | request |
A http_headers.Headers instance giving all received HTTP request headers. |
Attribute | response |
A http_headers.Headers instance holding all HTTP response headers to be sent. |
Attribute | uri |
A bytes giving the full encoded URI which was requested (including query arguments). |
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.
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, requestHeaders.getAllRawHeaders() may be preferred.
Return the address of the client who submitted this request.
The address may not be a network address. Callers must check its type before using it.
Returns | |
an IAddress provider. | the client's address. |
Present Since | |
18.4 |
Return the IP address of the client who submitted this request.
This method is deprecated. See getClientAddress
instead.
Returns | |
str or None | the client IP address or None if the request was submitted over a transport where IP addresses do not make sense. |
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 |
Get the hostname that the HTTP client passed in to the request.
This will either use the Host: header (if it is available; which, for a spec-compliant request, it will be) or the IP address of the host we are listening on if the header is unavailable.
Returns | |
bytes | the requested hostname |
Note | |
This is the host portion of the requested resource, which means that:
|
Look up the session associated with this request or create a new one if there is not one.
Returns | |
The Session instance identified by the session cookie in the request, or the sessionInterface component of that session if sessionInterface is specified. |
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 |
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 |
At any time during resource traversal or resource rendering, returns an absolute URL to the most nested resource which has yet been reached.
Returns | |
bytes | An absolute URL. |
See Also | |
{twisted.web.server.Request.prepath} |
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:str | 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 CACHED to indicate that you should write no body. Otherwise, I return a false value. |
Set an HTTP response header. Overrides any previously set values for this header.
Parameters | |
k:bytes or str | The name of the header for which to set the value. |
v:bytes or str | The value to set for the named header. A str will be UTF-8 encoded, which may not interoperable with other implementations. Avoid passing non-ASCII characters if possible. |
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)
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:int or float | 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 CACHED to indicate that you should write no body. Otherwise, I return a false value. |
Write some data to the body of the response to this request. Response headers are written the first time this method is called, after which new response headers may not be added.
Parameters | |
data:bytes | Bytes of the response body. |
A file-like object giving the request body. This may be a file on disk, an io.BytesIO
, or some other type. The implementation is free to decide on a per-request basis.
The URL path segments which have not (yet) been processed during resource traversal, as a list of bytes
.