/*
* QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
* Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System;
using System.Diagnostics;
using System.Threading;
using Python.Runtime;
using QuantConnect.Configuration;
using QuantConnect.Logging;
using QuantConnect.Python;
namespace QuantConnect.AlgorithmFactory
{
///
/// Helper class used to start a new debugging session
///
public static class DebuggerHelper
{
///
/// The different implemented debugging methods
///
public enum DebuggingMethod
{
///
/// Local debugging through cmdline.
/// will use built in 'pdb'
///
LocalCmdline,
///
/// Visual studio local debugging.
/// will use 'Python Tools for Visual Studio',
/// attach manually selecting `Python` code type.
///
VisualStudio,
///
/// Python Tool for Visual Studio Debugger for remote python debugging.
/// will use 'Python Extension in VS Code'
///or 'Python Tools in Visual Studio'
///
PTVSD,
///
/// PyCharm PyDev Debugger for remote python debugging.
/// will use 'Python Debug Server' in PyCharm
///
PyCharm
}
///
/// Will start a new debugging session
///
public static void Initialize(Language language)
{
if (language == Language.Python)
{
DebuggingMethod debuggingType;
Enum.TryParse(Config.Get("debugging-method", DebuggingMethod.LocalCmdline.ToString()), out debuggingType);
Log.Trace("DebuggerHelper.Initialize(): initializing python...");
PythonInitializer.Initialize();
Log.Trace("DebuggerHelper.Initialize(): python initialization done");
using (Py.GIL())
{
Log.Trace("DebuggerHelper.Initialize(): starting...");
switch (debuggingType)
{
case DebuggingMethod.LocalCmdline:
PythonEngine.RunSimpleString("import pdb; pdb.set_trace()");
break;
case DebuggingMethod.VisualStudio:
Log.Trace("DebuggerHelper.Initialize(): waiting for debugger to attach...");
PythonEngine.RunSimpleString(@"import sys; import time;
while not sys.gettrace():
time.sleep(0.25)");
break;
case DebuggingMethod.PTVSD:
Log.Trace("DebuggerHelper.Initialize(): waiting for PTVSD debugger to attach at localhost:5678...");
PythonEngine.RunSimpleString("import ptvsd; ptvsd.enable_attach(); ptvsd.wait_for_attach()");
break;
case DebuggingMethod.PyCharm:
Log.Trace("DebuggerHelper.Initialize(): Attempting to connect to Pycharm PyDev debugger server...");
PythonEngine.RunSimpleString(@"import pydevd_pycharm; import time;
count = 1
while count <= 10:
try:
pydevd_pycharm.settrace('localhost', port=5678, stdoutToServer=True, stderrToServer=True, suspend=False)
print('SUCCESS: Connected to local program')
break
except ConnectionRefusedError:
pass
try:
pydevd_pycharm.settrace('host.docker.internal', port=5678, stdoutToServer=True, stderrToServer=True, suspend=False)
print('SUCCESS: Connected to docker container')
break
except ConnectionRefusedError:
pass
print('\n')
print('Failed: Ensure your PyCharm Debugger is actively waiting for a connection at port 5678!')
print('Try ' + count.__str__() + ' out of 10')
print('\n')
count += 1
time.sleep(3)");
break;
}
Log.Trace("DebuggerHelper.Initialize(): started");
}
}
else if(language == Language.CSharp)
{
if (Debugger.IsAttached)
{
Log.Trace("DebuggerHelper.Initialize(): debugger is already attached, triggering initial break.");
Debugger.Break();
}
else
{
Log.Trace("DebuggerHelper.Initialize(): waiting for debugger to attach...");
while (!Debugger.IsAttached)
{
Thread.Sleep(250);
}
Log.Trace("DebuggerHelper.Initialize(): debugger attached");
}
}
else
{
throw new NotImplementedException($"DebuggerHelper.Initialize(): not implemented for {language}");
}
}
}
}