Lean  $LEAN_TAG$
QuantConnect.AlgorithmFactory.DebuggerHelper Class Reference

Helper class used to start a new debugging session More...

Public Types

enum  DebuggingMethod {
  DebuggingMethod.LocalCmdline, DebuggingMethod.VisualStudio, DebuggingMethod.PTVSD, DebuggingMethod.DebugPy,
  DebuggingMethod.PyCharm
}
 The different implemented debugging methods More...
 

Static Public Member Functions

static void Initialize (Language language, out Action workersInitializationCallback)
 Will start a new debugging session More...
 

Detailed Description

Helper class used to start a new debugging session

Definition at line 30 of file DebuggerHelper.cs.

Member Enumeration Documentation

◆ DebuggingMethod

The different implemented debugging methods

Enumerator
LocalCmdline 

Local debugging through cmdline. Language.Python will use built in 'pdb'

VisualStudio 

Visual studio local debugging. Language.Python will use 'Python Tools for Visual Studio', attach manually selecting Python code type.

PTVSD 

Python Tool for Visual Studio Debugger for remote python debugging. Language.Python. Deprecated, routes to DebugPy which is it's replacement. Used in the same way.

DebugPy 

DebugPy - a debugger for Python. Language.Python can use Python Extension in VS Code or attach to Python in Visual Studio

PyCharm 

PyCharm PyDev Debugger for remote python debugging. Language.Python will use 'Python Debug Server' in PyCharm

Definition at line 37 of file DebuggerHelper.cs.

Member Function Documentation

◆ Initialize()

static void QuantConnect.AlgorithmFactory.DebuggerHelper.Initialize ( Language  language,
out Action  workersInitializationCallback 
)
static

Will start a new debugging session

Parameters
languageThe algorithms programming language
workersInitializationCallbackOptionally, the debugging method will set an action which the data stack workers should execute so we can debug code executed by them, this is specially important for python.

Definition at line 79 of file DebuggerHelper.cs.

Here is the call graph for this function:

The documentation for this class was generated from the following file: