Package bitten :: Module api :: Class IReportSummarizer

Class IReportSummarizer

         object --+    
                  |    
trac.core.Interface --+
                      |
                     IReportSummarizer

Extension point interface for components that render a summary of reports of some kind.
Instance Methods
 
get_supported_categories()
Return a list of strings identifying the types of reports this component supports.
 
render_summary(req, config, build, step, category)
Render a summary for the given report.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

Inherited from object: __class__

Method Details

render_summary(req, config, build, step, category)

 

Render a summary for the given report.

This function should return a tuple of the form (template, data), where template` is the name of the template to use and ``data is the data to be passed to the template.

Parameters:
  • req - the request object
  • config (BuildConfig) - the build configuration
  • build (Build) - the build
  • step (BuildStep) - the build step
  • category (basestring) - the category of the report that should be summarized