buildbot.status.html.StatusResource

Package buildbot :: Package status :: Module html :: Class StatusResource

Class StatusResource

Resource --+
           |
          StatusResource

Method Summary
	`__init__(self, status, control, changemaster, categories, css)`
	`getChild(self, path, request)` Retrieve a 'child' resource from me.
	`render(self, request)` Render a given resource.
Inherited from Resource
	`delEntity(self, name)`
	`getChildForRequest(self, request)`
	`getChildWithDefault(self, path, request)` Retrieve a static or dynamically generated child resource from me.
	`getDynamicEntity(self, name, request)`
	`getStaticEntity(self, name)`
	`listDynamicEntities(self, request)`
	`listDynamicNames(self)`
	`listEntities(self)`
	`listNames(self)`
	`listStaticEntities(self)`
	`listStaticNames(self)`
	`putChild(self, path, child)` Register a static child.
	`reallyPutEntity(self, name, entity)`
	`render_HEAD(self, request)` Default handling of HEAD method.

Class Variable Summary
`NoneType`	`control` = None
`NoneType`	`favicon` = None
`NoneType`	`robots_txt` = None
`NoneType`	`status` = None
Inherited from Resource
`Implements`	`__implemented__` = `<implementedBy twisted.web.resource.Re...`
`ClassProvides`	`__providedBy__` = `<zope.interface.declarations.ClassProvi...`
`ClassProvides`	`__provides__` = `<zope.interface.declarations.ClassProvide...`
`MetaInterface`	`entityType` = `<MetaInterface twisted.web.resource.IResour...`
`int`	`isLeaf` = 0
`NoneType`	`server` = None

Method Details

init(self, status, control, changemaster, categories, css)
(Constructor)

Parameters:: status
(type=buildbot.status.builder.Status); control
(type=buildbot.master.Control); changemaster
(type=buildbot.changes.changes.ChangeMaster)

Overrides:: twisted.web.resource.Resource.__init__

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.

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.

Overrides:: twisted.web.resource.Resource.getChild (inherited documentation)

render(self, request)

Render a given resource. See IResource's render method.

I delegate to methods of self with the form 'render_METHOD' where METHOD is the HTTP that was used to make the request. Examples: render_GET, render_HEAD, render_POST, and so on. Generally you should implement those methods instead of overriding this one.

render_METHOD methods are expected to return a string which 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().

Old code that overrides render() directly is likewise expected to return a string or NOT_DONE_YET.

Overrides:: twisted.web.resource.Resource.render (inherited documentation)

Class Variable Details

control

Type:: NoneType
Value:: None

favicon

Type:: NoneType
Value:: None

robots_txt

Type:: NoneType
Value:: None

status

Type:: NoneType
Value:: None

Generated by Epydoc 2.1 on Sun Dec 10 22:04:44 2006

http://epydoc.sf.net