twisted.web.distrib.UserDirectory

Package twisted :: Package web :: Module distrib :: Class UserDirectory

Class UserDirectory

Collection --+                
             |                
   Constrained --+            
                 |            
  ConfigCollection --+        
                     |        
              Resource --+    
                         |    
                    Gadget --+
                             |
                Widget --+   |
                         |   |
              StreamWidget --+
                             |
                            UserDirectory

Method Summary
	`getWidget(self, chnam, request)`
	`stream(self, write, request)` Call 'write' multiple times with a string argument to represent this widget.
Inherited from Gadget
	`__init__(self)` Initialize.
	`addFile(self, path)` Gadget.addFile(path) Add a static path to this Gadget.
	`getChild(self, path, request)` Retrieve a 'child' resource from me.
	`pageFactory(self, args, kwargs)` Gadget.pageFactory(args, *kwargs) -> Resource By default, this method returns self.page(args, **kwargs).
	`putPath(self, path, pathname)` Gadget.putPath(path, pathname) Add a static path to this Gadget.
	`putWidget(self, path, widget)` Gadget.putWidget(path, widget) Add a Widget to this Gadget.
	`render(self, request)` Render a given resource.
Inherited from Resource
	`delEntity(self, name)` Remove a static reference for 'name'.
	`getChildForRequest(self, request)` (internal) Get a child of mine dependant on a particular request.
	`getChildWithDefault(self, path, request)` Retrieve a static or dynamically generated child resource from me.
	`getDynamicEntity(self, name, request)` Subclass this to generate an entity on demand.
	`getStaticEntity(self, name)` Get an entity that was added to me using putEntity.
	`listDynamicEntities(self, request)` A list of all name, entity that I can generate on demand.
	`listDynamicNames(self)` Retrieve a list of the names of entities that I store references to.
	`listEntities(self)`
	`listNames(self)`
	`listStaticEntities(self)` Retrieve a list of all name, entity pairs that I store references to.
	`listStaticNames(self)` Retrieve a list of the names of entities that I store references to.
	`putChild(self, path, child)` Register a static child.
	`reallyPutEntity(self, name, entity)`
Inherited from ConfigCollection
	`entityConstraint(self, entity)` A method that determines whether an entity may be added to me.
	`getEntityType(self)`
	`getNameType(self)`
Inherited from Constrained
	`nameConstraint(self, name)` A method that determines whether an entity may be added to me with a given name.
	`putEntity(self, name, entity)` Store an entity if it meets both constraints.
Inherited from Collection
	`getEntity(self, name, request)` Retrieve an entity from me.
	`removeEntity(self, name, request)` Remove an entity for 'name', based on the content of 'request'.
	`storeEntity(self, name, request)` Store an entity for 'name', based on the content of 'request'.
Inherited from StreamWidget
	`display(self, request)` Produce a list containing a single string.
Inherited from Widget
	`getTitle(self, request)`

Class Variable Summary
`str`	`userDirName` = `'public_html'`
`str`	`userSocketName` = `'.twistd-web-pb'`
Inherited from Gadget
`int`	`isLeaf` = 0
Inherited from Resource
`tuple`	`__implements__` = `(<class twisted.web.resource.IResource ...`
`NoneType`	`server` = None
Inherited from Widget
`NoneType`	`title` = None

Method Details

stream(self, write, request)

Call 'write' multiple times with a string argument to represent this widget.

Overrides:: twisted.web.widgets.StreamWidget.stream (inherited documentation)

Class Variable Details

userDirName

Type:: str
Value:: 'public_html'

userSocketName

Type:: str
Value:: '.twistd-web-pb'

Generated by Epydoc 2.0 on Sat Sep 13 04:20:47 2003

http://epydoc.sf.net