MessageAnalysis

QuantConnect.Lean.Engine.Results.Analysis.Analyses.Messages.MessageAnalysis

Abstract base class for analyses that detect issues by scanning log or order event messages for one or more expected text fragments.

expected_message_text: List[str]

This codeEntityType is protected.

issue: str

Gets a short (3–8 word) description of why the analysis was triggered.

weight: int

Gets the severity/impact weight (0–100). Higher values run first and rank higher in results.

match(
    messages: Sequence[str], expected_messages: List[str]
) -> Iterable[str]

Returns messages from messages that contain all strings in expected_messages (case-insensitive).

This codeEntityType is protected.

run(
    parameters: ResultsAnalysisRunParameters,
) -> Sequence[Analysis]

run(
    messages: Sequence[str], language: Language
) -> Sequence[Analysis]

Runs the analysis by scanning messages for the expected text fragments and returns results with solutions when matches are found.

solutions(language: Language) -> List[str]

This codeEntityType is protected.

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(
    responses: List[Analysis],
) -> Sequence[Analysis]

Filters responses to those with solutions, prefixes the class name, and returns a flat list.

This codeEntityType is protected.

format_code(code: str, language: Language) -> str

Formats the specified code string according to the conventions of the given programming language.

This codeEntityType is protected.