twisted.web.distrib.UserDirectory

class documentation

class UserDirectory(resource.Resource): (source)

Constructor: UserDirectory(userDatabase)

View In Hierarchy

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

Method __init__ Initialize.
Method getChild Retrieve a 'child' resource from me.
Method render_GET Render as HTML a listing of all known users with links to their personal resources.
Class Variable template Undocumented
Class Variable userDirName Undocumented
Class Variable userSocketName Undocumented
Method _users Return a list of two-tuples giving links to user resources and text to associate with those links.
Instance Variable _pwd An object like pwd which is used to enumerate users and their home directories.

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 Render a given resource. See IResource's render method.
Method render_HEAD Default handling of HEAD method.
Class Variable allowedMethods Undocumented
Class Variable isLeaf Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
Class Variable server Undocumented
Instance Variable children Undocumented
def __init__(self, userDatabase=None): (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_GET(self, request): (source)

Render as HTML a listing of all known users with links to their personal resources.

template: str = (source)

Undocumented

userDirName: str = (source)

Undocumented

userSocketName: str = (source)

Undocumented

def _users(self): (source)

Return a list of two-tuples giving links to user resources and text to associate with those links.

_pwd = (source)

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