twisted.web.util.DeferredResource

class documentation

class DeferredResource(resource.Resource): (source)

Constructor: DeferredResource(d)

View In Hierarchy

I wrap up a Deferred that will eventually result in a Resource object.

Method __init__ Initialize.
Method getChild Retrieve a 'child' resource from me.
Method render Render a given resource. See IResource's render method.
Class Variable isLeaf Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
Instance Variable d Undocumented
Method _cbChild Undocumented
Method _ebChild Undocumented

Inherited from Resource:

Method delEntity Undocumented
Method getChildForRequest Deprecated in favor of getChildForRequest.
Method getChildWithDefault Retrieve a static or dynamically generated child resource from me.
Method getDynamicEntity Undocumented
Method getStaticEntity Undocumented
Method listDynamicEntities Undocumented
Method listDynamicNames Undocumented
Method listEntities Undocumented
Method listNames Undocumented
Method listStaticEntities Undocumented
Method listStaticNames Undocumented
Method putChild Register a static child.
Method reallyPutEntity Undocumented
Method render_HEAD Default handling of HEAD method.
Class Variable allowedMethods Undocumented
Class Variable server Undocumented
Instance Variable children Undocumented
def __init__(self, d): (source)
overrides twisted.web.resource.Resource.__init__

Initialize.

def getChild(self, name, 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 and return value have the same meaning and requirements as those defined by IResource.getChildWithDefault.

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 byte string which will be the rendered page, unless the return value is server.NOT_DONE_YET, in which case it is this class's responsibility to write the results using request.write(data) and then call request.finish().

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

See Also
IResource.render
isLeaf: int = (source)
from twisted.web.resource.IResource
overrides twisted.web.resource.Resource.isLeaf

Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.

d = (source)

Undocumented

def _cbChild(self, child, request): (source)

Undocumented

def _ebChild(self, reason, request): (source)

Undocumented