twisted.web.server.Request : API documentation

Known subclasses: twisted.web.distrib.Request

Implements interfaces: twisted.web.iweb.IRequest

An HTTP request.

Instance Variable	defaultContentType	A `bytes` giving the default Content-Type value to send in responses if no other value is set. `None` disables the default.
Method	__init__
Method	getStateToCopyFor	Undocumented
Method	sibLink	Return the text that links to a sibling of the requested resource.
Method	childLink	Return the text that links to a child of the requested resource.
Method	process	Process a request.
Method	write	Write data to the transport (if not responding to a HEAD request).
Method	finish	Override `http.Request.finish` for possible encoding.
Method	render	Ask a resource to render itself.
Method	processingFailed	Undocumented
Method	view_write	Remote version of write; same interface.
Method	view_finish	Remote version of finish; same interface.
Method	view_addCookie	Remote version of addCookie; same interface.
Method	view_setHeader	Remote version of setHeader; same interface.
Method	view_setLastModified	Remote version of setLastModified; same interface.
Method	view_setETag	Remote version of setETag; same interface.
Method	view_setResponseCode	Remote version of setResponseCode; same interface.
Method	view_registerProducer	Remote version of registerProducer; same interface. (requires a remote producer.)
Method	view_unregisterProducer	Undocumented
Method	getSession	Look up the session associated with this request or create a new one if there is not one.
Method	prePathURL
Method	URLPath
Method	rememberRootURL	Remember the currently-processed part of the URL for later recalling.
Method	getRootURL	Get a previously-remembered URL.
Method	_prePathURL	Undocumented

Inherited from Componentized:

Method	locateAdapterClass	Undocumented
Method	setAdapter	Cache a provider for the given interface, by adapting `self` using the given adapter class.
Method	addAdapter	Utility method that calls addComponent. I take an adapter class and instantiate it with myself as the first argument.
Method	setComponent	Cache a provider of the given interface.
Method	addComponent	Add a component to me, for all appropriate interfaces.
Method	unsetComponent	Remove my component specified by the given interface class.
Method	removeComponent	Remove the given component from me entirely, for all interfaces for which it has been registered.
Method	getComponent	Create or retrieve an adapter for the given interface.
Method	__conform__	Undocumented

Inherited from Componentized:

Method	locateAdapterClass	Undocumented
Method	setAdapter	Cache a provider for the given interface, by adapting `self` using the given adapter class.
Method	addAdapter	Utility method that calls addComponent. I take an adapter class and instantiate it with myself as the first argument.
Method	setComponent	Cache a provider of the given interface.
Method	addComponent	Add a component to me, for all appropriate interfaces.
Method	unsetComponent	Remove my component specified by the given interface class.
Method	removeComponent	Remove the given component from me entirely, for all interfaces for which it has been registered.
Method	getComponent	Create or retrieve an adapter for the given interface.
Method	__conform__	Undocumented

defaultContentType =

A bytes giving the default Content-Type value to send in responses if no other value is set. None disables the default.

def __init__(self, *args, **kw): (source)

overrides twisted.web.http.Request.__init__

Parameters	channel	the channel we're connected to.
	queued	are we in the request queue, or can we start writing to the transport?

def getStateToCopyFor(self, issuer): (source)

Undocumented

def sibLink(self, name): (source)

Return the text that links to a sibling of the requested resource.

def childLink(self, name): (source)

Return the text that links to a child of the requested resource.

def process(self): (source)

overrides twisted.web.http.Request.process

Process a request.

def write(self, data): (source)

from twisted.web.iweb.IRequest

overrides twisted.web.http.Request.write

overridden in twisted.web.distrib.Request

Write data to the transport (if not responding to a HEAD request).

Parameters data A string to write to the response.

def finish(self): (source)

from twisted.web.iweb.IRequest

overrides twisted.web.http.Request.finish

Override http.Request.finish for possible encoding.

def render(self, resrc): (source)

Ask a resource to render itself.

Parameters resrc a twisted.web.resource.IResource.

def processingFailed(self, reason): (source)

Undocumented

def view_write(self, issuer, data): (source)

Remote version of write; same interface.

def view_finish(self, issuer): (source)

Remote version of finish; same interface.

def view_addCookie(self, issuer, k, v, **kwargs): (source)

Remote version of addCookie; same interface.

def view_setHeader(self, issuer, k, v): (source)

Remote version of setHeader; same interface.

def view_setLastModified(self, issuer, when): (source)

Remote version of setLastModified; same interface.

def view_setETag(self, issuer, tag): (source)

Remote version of setETag; same interface.

def view_setResponseCode(self, issuer, code, message=None): (source)

Remote version of setResponseCode; same interface.

def view_registerProducer(self, issuer, producer, streaming): (source)

Remote version of registerProducer; same interface. (requires a remote producer.)

def view_unregisterProducer(self, issuer): (source)

Undocumented

def getSession(self, sessionInterface=None): (source)

from twisted.web.iweb.IRequest

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.

def _prePathURL(self, prepath): (source)

Undocumented

def prePathURL(self): (source)

from twisted.web.iweb.IRequest

Returns At any time during resource traversal, a str giving an absolute URL to the most nested resource which has yet been reached.

def URLPath(self): (source)

from twisted.web.iweb.IRequest

Returns A URLPath instance which identifies the URL for which this request is.

def rememberRootURL(self): (source)

from twisted.web.iweb.IRequest

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

def getRootURL(self): (source)

from twisted.web.iweb.IRequest

Get a previously-remembered URL.

API Documentation for Twisted, generated by pydoctor at 2015-11-29 11:40:45.

twisted.web.server.Request(Copyable, http.Request, components.Componentized) class documentation

`twisted.web.server.Request(Copyable, http.Request, components.Componentized)` class documentation