twisted.web.distrib.UserDirectory : API documentation

A resource which lists available user resources and serves them as children.

Instance Variables _pwd An object like pwd which is used to enumerate users and their home directories.

Method	__init__	Initialize.
Method	render_GET	Render as HTML a listing of all known users with links to their personal resources.
Method	getChild	Retrieve a 'child' resource from me.
Method	_users	Return a list of two-tuples giving links to user resources and text to associate with those links.

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	Render a given resource. See `IResource`'s render method.
Method	render_HEAD	Default handling of HEAD method.

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	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.d.UserDirectory(resource.Resource) : class documentation