DebugPacket

QuantConnect.Packets.DebugPacket

DebugPacket()

DebugPacket(packet_type: PacketType)

DebugPacket(
    project_id: int,
    algorithm_id: str,
    compile_id: str,
    message: str,
    toast: bool = False,
)

Bases: Packet

Send a simple debug message from the users algorithm to the console.

Signature descriptions:

• Default constructor for JSON

• Constructor for inherited types

• Create a new instance of the notify debug packet:

Parameters:

Name	Type	Description	Default
packet_type	Optional[PacketType]	The type of packet to create	None

message

message: str

String debug message to send to the users console

algorithm_id

algorithm_id: str

Associated algorithm Id.

compile_id

compile_id: str

Compile id of the algorithm sending this message

project_id

project_id: int

Project Id for this message

toast

toast: bool

True to emit message as a popup notification (toast), false to emit message in console as text

type

type: PacketType

Packet type defined by a string enum

channel

channel: str

User unique specific channel endpoint to send the packets