BaseResultsAnalysis
QuantConnect.Lean.Engine.Results.Analysis.Analyses.BaseResultsAnalysis
Bases: Object
Abstract base class for all backtest diagnostic tests.
issue
issue: str
Gets a short (3–8 word) description of why the analysis was triggered.
weight
weight: int
Gets the severity/impact weight (0–100). Higher values run first and rank higher in results.
runs_in_run
runs_in_run: bool
Whether this analysis can also run while the backtest is still in progress, against a snapshot of the intermediate results. Most analyses read only the result snapshot, so this defaults to true. Analyses that need the completed run (runtime errors, equity curves, final statistics, completion logs) or that read algorithm state that is not safe to access while it runs override this to leave them to the final analysis only.
is_state_based
is_state_based: bool
Whether this analysis reads the current backtest state (statistics, orders, charts) instead of scanning the append-only order event and log streams. When run in-run, it runs against the full current state on every run and its findings replace the previous ones instead of accumulating.
single_response
single_response(
sample: Any, solutions: Sequence[str] = None
) -> Sequence[Analysis]
single_response(
sample: Any,
count: Optional[int],
solutions: Sequence[str] = None,
) -> Sequence[Analysis]
Wraps a single QuantConnect.Analysis in a one-element read-only list.
create_aggregated_response
Filters responses to those with solutions, prefixes the class name, and returns a flat list.
This Class is protected.
format_code
format_code(code: str, language: Language) -> str
Formats the specified code string according to the conventions of the given programming language.
This Class is protected.
run
run(
parameters: ResultsAnalysisRunParameters,
) -> Sequence[Analysis]
Runs the analysis against all backtest data provided in parameters.