Package buildbot :: Package status :: Module html :: Class HtmlResource
[frames | no frames]

Class HtmlResource

Resource --+
           |
          HtmlResource

Known Subclasses:
StaticHTML, StatusResourceBuild, StatusResourceBuilder, StatusResourceBuildStep, StatusResourceChanges, StatusResourceTestResult, StatusResourceTestResults, WaterfallStatusResource

Method Summary
  body(self, request)
  content(self, request)
  render(self, request)
Render a given resource.
    Inherited from Resource
  __init__(self)
Initialize.
  delEntity(self, name)
  getChild(self, path, request)
Retrieve a 'child' resource from me.
  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
str contentType = 'text/html; charset=UTF-8'
NoneType css = None                                                                  
str title = 'Dummy'
    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

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

contentType

Type:
str
Value:
'text/html; charset=UTF-8'                                             

css

Type:
NoneType
Value:
None                                                                  

title

Type:
str
Value:
'Dummy'                                                                

Generated by Epydoc 2.1 on Sun Dec 10 22:04:44 2006 http://epydoc.sf.net