t.w.v.VHostURIRewrite(object) : class documentation

Part of twisted.web2.vhost View Source View In Hierarchy

Implements interfaces: twisted.web2.iweb.IResource

I do request mangling to insure that children know what host they are being accessed from behind mod_proxy.

Usage:
Method __init__
Method renderHTTP Return an IResponse or a deferred which will fire an IResponse. This response will be written to the web browser which initiated the request.
Method locateChild Locate another object which can be adapted to IResource.
def __init__(self, uri, resource): (source)
ParametersuriThe URI to be used for mutating the request. This MUST include scheme://hostname/path. (type: str )
resourceThe resource to serve after mutating the request. (type: twisted.web2.iweb.IResource )
def renderHTTP(self, req): (source)
Return an IResponse or a deferred which will fire an IResponse. This response will be written to the web browser which initiated the request.
def locateChild(self, req, segments): (source)
Locate another object which can be adapted to IResource.
Returns

A 2-tuple of (resource, remaining-path-segments), or a deferred which will fire the above.

Causes the object publishing machinery to continue on with specified resource and segments, calling the appropriate method on the specified resource.

If you return (self, server.StopTraversal), this instructs web2 to immediately stop the lookup stage, and switch to the rendering stage, leaving the remaining path alone for your render function to handle.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.