Crisis

QuantConnect.Report.Crisis

Crisis(
    name: str,
    start: Union[datetime, date],
    end: Union[datetime, date],
)

Bases: Object

Crisis events utility class

Creates a new crisis instance with the given name and start/end date.

Parameters:

Name	Type	Description	Default
name	str	Name of the crisis	required
start	Union[datetime, date]	Start date of the crisis	required
end	Union[datetime, date]	End date of the crisis	required

EVENTS

EVENTS: Dictionary[CrisisEvent, Crisis] = ...

Crisis events and pre-defined values

start

start: datetime

Start of the crisis event

end

end: datetime

End of the crisis event

name

name: str

Name of the crisis

to_string

to_string() -> str

to_string(
    start: Union[datetime, date], end: Union[datetime, date]
) -> str

Signature descriptions:

• Converts instance to string using the dates in the instance as start/end dates

• Converts instance to string using the provided dates

Parameters:

Name	Type	Description	Default
start	Optional[Union[datetime, date]]	Start date	None
end	Optional[Union[datetime, date]]	End date	None

from_crisis

from_crisis(crisis_event: CrisisEvent) -> Crisis

Returns a pre-defined crisis event

Parameters:

Name	Type	Description	Default
crisis_event	CrisisEvent	Crisis Event	required

Returns:

Type	Description
Crisis	Pre-defined crisis event.