forked from QuantConnect/Lean
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDebuggerHelper.cs
More file actions
151 lines (138 loc) · 5.78 KB
/
DebuggerHelper.cs
File metadata and controls
151 lines (138 loc) · 5.78 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*
* 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
{
/// <summary>
/// Helper class used to start a new debugging session
/// </summary>
public static class DebuggerHelper
{
/// <summary>
/// The different implemented debugging methods
/// </summary>
public enum DebuggingMethod
{
/// <summary>
/// Local debugging through cmdline.
/// <see cref="Language.Python"/> will use built in 'pdb'
/// </summary>
LocalCmdline,
/// <summary>
/// Visual studio local debugging.
/// <see cref="Language.Python"/> will use 'Python Tools for Visual Studio',
/// attach manually selecting `Python` code type.
/// </summary>
VisualStudio,
/// <summary>
/// Python Tool for Visual Studio Debugger for remote python debugging.
/// <see cref="Language.Python"/> will use 'Python Extension in VS Code'
///or 'Python Tools in Visual Studio'
/// </summary>
PTVSD,
/// <summary>
/// PyCharm PyDev Debugger for remote python debugging.
/// <see cref="Language.Python"/> will use 'Python Debug Server' in PyCharm
/// </summary>
PyCharm
}
/// <summary>
/// Will start a new debugging session
/// </summary>
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}");
}
}
}
}