Home | Trees | Index | Help |
---|
Package twisted :: Package web :: Module resource :: Class Resource |
|
Collection
--+ |Constrained
--+ |ConfigCollection
--+ | Resource
Gadget
,
ReverseProxyResource
,
NameVirtualHost
,
File
,
ResourceSubscription
,
ErrorPage
,
ResourceGuard
,
Page
,
RewriterResource
,
PythonScript
,
ResourceScriptWrapper
,
SOAPPublisher
,
Redirect
,
Data
,
CGIDirectory
,
CGIScript
,
Redirect
,
VHostMonsterResource
,
_HostResource
,
WidgetResource
,
XMLRPC
,
Controller
,
BlankPage
,
DOMTemplate
,
FormProcessor
,
PerspectiveWrapper
,
SessionWrapper
,
ModelLoader
,
_ChildJuggler
,
Tapestry
,
DOMController
,
SimpleResource
I define a web-accessible resource.
I serve 2 main purposes; one is to provide a standard representation for what HTTP specification calls an 'entity', and the other is to provide an abstract directory structure for URL retrieval.Method Summary | |
---|---|
Initialize. | |
Remove a static reference for 'name'. | |
A method that determines whether an entity may be added to me. (inherited from ConfigCollection )
| |
Retrieve a 'child' resource from me. | |
(internal) Get a child of mine dependant on a particular request. | |
(internal) Retrieve a static or dynamically generated child resource from me. | |
Subclass this to generate an entity on demand. | |
Retrieve an entity from me. (inherited from Collection )
| |
(inherited from ConfigCollection )
| |
(inherited from ConfigCollection )
| |
Get an entity that was added to me using putEntity. | |
A list of all name, entity that I can generate on demand. | |
Retrieve a list of the names of entities that I store references to. | |
Retrieve a list of all name, entity pairs that I store references to. | |
Retrieve a list of all name, entity pairs I contain. (inherited from Collection )
| |
Retrieve a list of the names of entities that I store references to. | |
Retrieve a list of all names for entities that I contain. (inherited from Collection )
| |
Retrieve a list of all name, entity pairs that I store references to. | |
Retrieve a list of the names of entities that I store references to. | |
A method that determines whether an entity may be added to me with a given name. (inherited from Constrained )
| |
Register a child with me. | |
Store an entity if it meets both constraints. (inherited from Constrained )
| |
reallyPutEntity(self,
name,
entity)
| |
Remove an entity for 'name', based on the content of 'request'. (inherited from Collection )
| |
Render a given resource. | |
Store an entity for 'name', based on the content of 'request'. (inherited from Collection )
|
Class Variable Summary | |
---|---|
tuple |
__implements__
|
class |
IResource
|
int |
isLeaf
|
NoneType |
server
|
Method Details |
---|
__init__(self)
Initialize.
|
delEntity(self, name)Remove a static reference for 'name'. Raises a KeyError if the operation fails.
|
getChild(self, path, request)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.
|
getChildForRequest(self, request)(internal) Get a child of mine dependant on a particular request. This will be called on me as a top-level resource of a site in order to retrieve my appropriate child or grandchild to display. |
getChildWithDefault(self, path, request)(internal) Retrieve a static or dynamically generated child resource from me. Arguments are similiar to getChild. This will check to see if I have a pre-registered child resource of the given name, and call getChild if I do not. |
getDynamicEntity(self, name, request)Subclass this to generate an entity on demand. This method should return 'None' if it fails.
|
getStaticEntity(self, name)Get an entity that was added to me using putEntity. This method will return 'None' if it fails.
|
listDynamicEntities(self, request)A list of all name, entity that I can generate on demand. See getDynamicEntity.
|
listDynamicNames(self)Retrieve a list of the names of entities that I store references to. See getDynamicEntity.
|
listEntities(self)Retrieve a list of all name, entity pairs that I store references to. See getStaticEntity.
|
listNames(self)Retrieve a list of the names of entities that I store references to. See getStaticEntity.
|
listStaticEntities(self)Retrieve a list of all name, entity pairs that I store references to. See getStaticEntity.
|
listStaticNames(self)Retrieve a list of the names of entities that I store references to. See getStaticEntity.
|
putChild(self, path, child)Register a child with me. |
render(self, request)Render a given resource. This must be implemented in all subclasses of Resource. The return value of this method will be the rendered page, unless the return value is twisted.web.server.NOT_DONE_YET, in which case it is this class's responsibility to write the results to request.write(data), then call request.finish(). |
Class Variable Details |
---|
__implements__
|
IResourceIResource = twisted.web.resource.IResource
|
isLeaf
|
server
|
Home | Trees | Index | Help |
---|
Generated by Epydoc 1.2 prerelease on Wed Jan 29 06:29:15 2003 | http://epydoc.sf.net |