backtrader.reports.reporter module

Main report generator.

Generates backtest reports in HTML, PDF, and JSON formats.

class backtrader.reports.reporter.ReportGenerator[source]

Bases: object

Main report generator.

Generates backtest reports in HTML, PDF, and JSON formats.

strategy

Strategy instance

calculator

Performance calculator

charts

Chart generator

Usage example:

report = ReportGenerator(strategy) report.generate_html(‘report.html’) report.generate_pdf(‘report.pdf’) report.generate_json(‘report.json’)

__init__(strategy, template='default')[source]

Initialize the report generator.

Parameters:

  • strategy – backtrader strategy instance

  • template – Template name or template string

generate_html(output_path, user=None, memo=None, **kwargs)[source]

Generate HTML report.

Parameters:

  • output_path – Output file path

  • user – Username

  • memo – Notes

  • **kwargs – Additional template variables

Returns:

Output file path

Return type:

str

generate_pdf(output_path, user=None, memo=None, **kwargs)[source]

Generate PDF report.

Parameters:

  • output_path – Output file path

  • user – Username

  • memo – Notes

  • **kwargs – Additional template variables

Returns:

Output file path

Return type:

str

generate_json(output_path, indent=2, **kwargs)[source]

Generate JSON report.

Parameters:

  • output_path – Output file path

  • indent – JSON indentation

  • **kwargs – Additional data

Returns:

Output file path

Return type:

str

get_metrics()[source]

Get all performance metrics.

Returns:

Performance metrics dictionary

Return type:

dict

print_summary()[source]

Print performance summary to console.