twisted.web2.iweb.IOldRequest : API documentation

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.

received_headers =

All received headers

def getHeader(key): (source)

Get a header that was sent from the network.

def getCookie(key): (source)

Get a cookie that was sent from the network.

def getAllHeaders(): (source)

Return dictionary of all headers the request received.

def getRequestHostname(): (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.

def getHost(): (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 getClientIP(): (source)

Undocumented

def getClient(): (source)

Undocumented

def getUser(): (source)

Undocumented

def getPassword(): (source)

Undocumented

def isSecure(): (source)

Undocumented

def getSession(sessionInterface=None): (source)

Undocumented

def URLPath(): (source)

Undocumented

def prePathURL(): (source)

Undocumented

def rememberRootURL(): (source)

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

def getRootURL(): (source)

Get a previously-remembered URL.

def finish(): (source)

We are finished writing data.

def write(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(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.

def setHeader(k, v): (source)

Set an outgoing HTTP header.

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.

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.

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.

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.

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)

This method is experimental.

Attribute	method	The HTTP method that was used.
Attribute	uri	The full URI that was requested (includes arguments).
Attribute	path	The path only (arguments not included).
Attribute	args	All of the arguments, including URL and POST arguments.
Attribute	received_headers	All received headers
Method	getHeader	Get a header that was sent from the network.
Method	getCookie	Get a cookie that was sent from the network.
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	getClientIP	Undocumented
Method	getClient	Undocumented
Method	getUser	Undocumented
Method	getPassword	Undocumented
Method	isSecure	Undocumented
Method	getSession	Undocumented
Method	URLPath	Undocumented
Method	prePathURL	Undocumented
Method	rememberRootURL	Remember the currently-processed part of the URL for later recalling.
Method	getRootURL	Get a previously-remembered URL.
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	setHost	Change the host and port the request thinks it's using.

t.w.i.IOldRequest(Interface) : interface documentation