interface documentation

class twisted.web.iweb.IRequest(Interface): (source)

Known implementations: twisted.web.server.Request

View In Hierarchy

An HTTP request.

Present Since9.0
Attribute method A bytes giving the HTTP method that was used.
Attribute uri A bytes giving the full encoded URI which was requested (including query arguments).
Attribute path A bytes giving the encoded query path of the request URI (not including query arguments).
Attribute args A mapping of decoded query argument names as bytes to corresponding query argument values as lists 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 prepath The URL path segments which have been processed during resource traversal, as a list of bytes.
Attribute postpath The URL path segments which have not (yet) been processed during resource traversal, as a list of bytes.
Attribute requestHeaders A http_headers.Headers instance giving all received HTTP request headers.
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 responseHeaders A http_headers.Headers instance holding all HTTP response headers to be sent.
Method getHeader Get an HTTP request header.
Method getCookie Get a cookie that was sent from the network.
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 HTTP client passed in to the request.
Method getHost Get my originally requesting transport's host.
Method getClientAddress Return the address of the client who submitted this request.
Method getClientIP Return the IP address of the client who submitted this request.
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 isSecure Return True if this request is using a secure transport.
Method getSession Look up the session associated with this request or create a new one if there is not one.
Method URLPath
Method prePathURL At any time during resource traversal or resource rendering, returns an absolute URL to the most nested resource which has yet been reached.
Method rememberRootURL Remember the currently-processed part of the URL for later recalling.
Method getRootURL Get a previously-remembered URL.
Method finish Indicate that the response to this request is complete.
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.
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 setHost Change the host and port the request thinks it's using.
method = (source)

A bytes giving the HTTP method that was used.

A bytes giving the full encoded URI which was requested (including query arguments).

path = (source)

A bytes giving the encoded query path of the request URI (not including query arguments).

args = (source)

A mapping of decoded query argument names as bytes to corresponding query argument values as lists 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']}.

prepath = (source)

The URL path segments which have been processed during resource traversal, as a list of bytes.

postpath = (source)

The URL path segments which have not (yet) been processed during resource traversal, as a list of bytes.

requestHeaders = (source)

A http_headers.Headers instance giving all received HTTP request headers.

content = (source)

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.

responseHeaders = (source)

A http_headers.Headers instance holding all HTTP response headers to be sent.

def getHeader(key): (source)

Get an HTTP request header.

ParameterskeyThe name of the header to get the value of. (type: bytes or str)
ReturnsThe value of the specified header, or None if that header was not present in the request. The string type of the result matches the type of key. (type: bytes or str or None)
def getCookie(key): (source)

Get a cookie that was sent from the network.

ParameterskeyThe name of the cookie to get. (type: bytes)
ReturnsThe value of the specified cookie, or None if that cookie was not present in the request. (type: bytes or None)
def getAllHeaders(): (source)

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.

def getRequestHostname(): (source)

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.

Returnsthe requested hostname (type: bytes)
NoteThis is the host portion of the requested resource, which means that:
  1. it might be an IPv4 or IPv6 address, not just a DNS host name,
  2. there's no guarantee it's even a valid host name or IP address, since the Host: header may be malformed,
  3. it does not include the port number.
def getHost(): (source)

Get my originally requesting transport's host.

ReturnsAn IAddress.
def getClientAddress(): (source)

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.

Returnsthe client's address. (type: an IAddress provider.)
Present Since18.4
def getClientIP(): (source)

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

This method is deprecated. See getClientAddress instead.

Returnsthe client IP address or None if the request was submitted over a transport where IP addresses do not make sense. (type: str or None)
def getUser(): (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(): (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 isSecure(): (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 getSession(sessionInterface=None): (source)

Look up the session associated with this request or create a new one if there is not one.

ReturnsThe Session instance identified by the session cookie in the request, or the sessionInterface component of that session if sessionInterface is specified.
def URLPath(): (source)
ReturnsA URLPath instance which identifies the URL for which this request is.
def prePathURL(): (source)

At any time during resource traversal or resource rendering, returns an absolute URL to the most nested resource which has yet been reached.

ReturnsAn absolute URL. (type: bytes)
See Also{twisted.web.server.Request.prepath}
def rememberRootURL(): (source)

Remember the currently-processed part of the URL for later recalling.

def getRootURL(): (source)

Get a previously-remembered URL.

ReturnsAn absolute URL. (type: bytes)
def finish(): (source)

Indicate that the response to this request is complete.

def write(data): (source)

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.

ParametersdataBytes of the response body. (type: bytes)
def addCookie(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(code, message=None): (source)

Set the HTTP response code.

ParameterscodeUndocumented (type: int)
messageUndocumented (type: bytes)
def setHeader(k, v): (source)

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

ParameterskThe name of the header for which to set the value. (type: bytes or str)
vThe 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. (type: bytes or str)
def redirect(url): (source)

Utility function that does a redirect.

The request should have finish() called after this.

def setLastModified(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: int or float)
ReturnsIf 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.
def setETag(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: str)
ReturnsIf 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.
def setHost(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)
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.