twisted.web.widgets.Gadget : API documentation

Method	__init__	Initialize.
Method	render	Render a given resource. See `IResource`'s render method.
Method	putWidget	Gadget.putWidget(path, widget) Add a Widget to this Gadget. It will be rendered through the pageFactory associated with this Gadget, whenever 'path' is requested.
Method	addFile	Gadget.addFile(path) Add a static path to this Gadget. This method is obsolete, use Gadget.putPath instead.
Method	putPath	Gadget.putPath(path, pathname) Add a static path to this Gadget. Whenever 'path' is requested, twisted.web.static.File(pathname) is sent.
Method	getWidget	Undocumented
Method	pageFactory	No summary
Method	getChild	Retrieve a 'child' resource from me.

Inherited from Resource:

Method	listStaticNames	Undocumented
Method	listStaticEntities	Undocumented
Method	listNames	Undocumented
Method	listEntities	Undocumented
Method	listDynamicNames	Undocumented
Method	listDynamicEntities	Undocumented
Method	getStaticEntity	Undocumented
Method	getDynamicEntity	Undocumented
Method	delEntity	Undocumented
Method	reallyPutEntity	Undocumented
Method	getChildWithDefault	Retrieve a static or dynamically generated child resource from me.
Method	getChildForRequest	Undocumented
Method	putChild	Register a static child.
Method	render_HEAD	Default handling of HEAD method.

def render(self, request): (source)

from twisted.web.resource.IResource

overrides twisted.web.resource.Resource.render

Render a given resource. See IResource's render method.

I delegate to methods of self with the form 'render_METHOD' where METHOD is the HTTP that was used to make the request. Examples: render_GET, render_HEAD, render_POST, and so on. Generally you should implement those methods instead of overriding this one.

render_METHOD methods are expected to return a string which will be the rendered page, unless the return value is twisted.web.server.NOT_DONE_YET, in which case it is this class's responsibility to write the results to request.write(data), then call request.finish().

Old code that overrides render() directly is likewise expected to return a string or NOT_DONE_YET.

def pageFactory(self, *args, **kwargs): (source)

Gadget.pageFactory(*args, **kwargs) -> Resource By default, this method returns self.page(*args, **kwargs). It is only for backwards-compatibility -- you should set the 'pageFactory' attribute on your Gadget inside of its __init__ method.

def getChild(self, path, request): (source)

overrides twisted.web.resource.Resource.getChild

Retrieve a 'child' resource from me.

Implement this to create dynamic resource generation -- resources which are always available may be registered with self.putChild().

This will not be called if the class-level variable 'isLeaf' is set in your subclass; instead, the 'postpath' attribute of the request will be left as a list of the remaining path elements.

For example, the URL /foo/bar/baz will normally be:

 | site.resource.getChild('foo').getChild('bar').getChild('baz').

However, if the resource returned by 'bar' has isLeaf set to true, then the getChild call will never be made on it.

Parameters	path	a string, describing the child
	request	a twisted.web.server.Request specifying meta-information about the request that is being made for this child.

t.w.w.Gadget(resource.Resource) : class documentation