What is the purpose of Twisted's isLeaf attribute?

Question

I found the following example of a Twisted request handler. I'm not clear what the isLeaf attribute is for. Why should I set it on a resource?

from twisted.internet import reactor
from twisted.web.server import Site
from twisted.web.resource import Resource

class RequestHandler(Resource):
    isLeaf = True

    def render_GET(self, request):
        request.setResponseCode(200)
        return "HelloWorld"

if __name__ == '__main__':
    resource = RequestHandler()
    factory = Site(resource)
    reactor.listenTCP(8001, factory)
    reactor.run()

davidism · Accepted Answer · 2017-03-14 14:41:41Z

6

From https://www.safaribooksonline.com/library/view/twisted-network-programming/9781449326104/ch04.html :

The isLeaf instance variable describes whether or not a resource will have children. Without more work on our part..., only leaf resources get rendered

Example:

/index.html is a typical leaf
/users/ is not if there are endpoints like /users/joe

edited Mar 14, 2017 at 14:41

davidism

128k31 gold badges417 silver badges348 bronze badges

answered Mar 14, 2017 at 10:40

Klaus D.

14.5k5 gold badges44 silver badges53 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

notorious.no Over a year ago

This is a fairly complete answer. isLeaf is really as simple as stated above. It just means that there are no more branching resources off of the "isLeaf" resource. So basically if you're not going to render other resources from a particular resource, then set isLeaf to signify that.

moshez · Accepted Answer · 2017-03-15 00:25:32Z

3

See twisted.web.resource.IResource.isLeaf documentation --

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

The way Twisted finds a resource to render is by splitting the path into segments, and calling "getChildWithDefault" on the root, and then whatever the root returns and so on. It stops if it either runs out of segments, or a "leaf" (i.e., isLeaf=True) resource is found.

At that point, it will call the render method on the resource. In a leaf resource, the renderer will often want to look at the "request.postpath" attribute -- stashed there is the list of segments that have not been used up to find the resource.

answered Mar 15, 2017 at 0:25

moshez

37.9k1 gold badge24 silver badges14 bronze badges

Collectives™ on Stack Overflow

What is the purpose of Twisted's isLeaf attribute?

2 Answers 2

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related