forked from QuantConnect/pythonnet
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathTestPythonException.cs
More file actions
345 lines (300 loc) · 11.5 KB
/
TestPythonException.cs
File metadata and controls
345 lines (300 loc) · 11.5 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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
using System;
using System.IO;
using System.Linq;
using NUnit.Framework;
using Python.Runtime;
namespace Python.EmbeddingTest
{
public class TestPythonException
{
[OneTimeSetUp]
public void SetUp()
{
PythonEngine.Initialize();
// Add scripts folder to path in order to be able to import the test modules
string testPath = Path.Combine(TestContext.CurrentContext.TestDirectory, "fixtures");
TestContext.Out.WriteLine(testPath);
using var str = Runtime.Runtime.PyString_FromString(testPath);
Assert.IsFalse(str.IsNull());
BorrowedReference path = Runtime.Runtime.PySys_GetObject("path");
Assert.IsFalse(path.IsNull);
Runtime.Runtime.PyList_Append(path, str.Borrow());
}
[OneTimeTearDown]
public void Dispose()
{
PythonEngine.Shutdown();
}
[Test]
public void TestMessage()
{
var list = new PyList();
PyObject foo = null;
var ex = Assert.Throws<PythonException>(() => foo = list[0]);
Assert.AreEqual("list index out of range", ex.Message);
Assert.IsNull(foo);
}
[Test]
public void TestType()
{
var list = new PyList();
PyObject foo = null;
var ex = Assert.Throws<PythonException>(() => foo = list[0]);
Assert.AreEqual("IndexError", ex.Type.Name);
Assert.IsNull(foo);
}
[Test]
public void TestMessageComplete()
{
using (Py.GIL())
{
try
{
// importing a module with syntax error 'x = 01' will throw
PyModule.FromString(Guid.NewGuid().ToString(), "x = 01");
}
catch (PythonException exception)
{
Assert.True(exception.Message.Contains("x = 01"));
return;
}
Assert.Fail("No Exception was thrown!");
}
}
[Test]
public void TestNoError()
{
// There is no PyErr to fetch
Assert.Throws<InvalidOperationException>(() => PythonException.FetchCurrentRaw());
var currentError = PythonException.FetchCurrentOrNullRaw();
Assert.IsNull(currentError);
}
[Test]
public void TestNestedExceptions()
{
try
{
PythonEngine.Exec(@"
try:
raise Exception('inner')
except Exception as ex:
raise Exception('outer') from ex
");
}
catch (PythonException ex)
{
Assert.That(ex.InnerException, Is.InstanceOf<PythonException>());
Assert.That(ex.InnerException.Message, Is.EqualTo("inner"));
}
}
[Test]
public void InnerIsEmptyWithNoCause()
{
var list = new PyList();
PyObject foo = null;
var ex = Assert.Throws<PythonException>(() => foo = list[0]);
Assert.IsNull(ex.InnerException);
}
[Test]
public void TestPythonExceptionFormat()
{
try
{
PythonEngine.Exec("raise ValueError('Error!')");
Assert.Fail("Exception should have been raised");
}
catch (PythonException ex)
{
// Console.WriteLine($"Format: {ex.Format()}");
// Console.WriteLine($"Stacktrace: {ex.StackTrace}");
Assert.That(
ex.Format(),
Does.Contain("Traceback")
.And.Contains("(most recent call last):")
.And.Contains("ValueError: Error!")
);
// Check that the stacktrace is properly formatted
Assert.That(
ex.StackTrace,
Does.Not.StartWith("[")
.And.Not.Contain("\\n")
);
}
}
[Test]
public void TestPythonExceptionFormatNoTraceback()
{
try
{
var module = PyModule.Import("really____unknown___module");
Assert.Fail("Unknown module should not be loaded");
}
catch (PythonException ex)
{
// ImportError/ModuleNotFoundError do not have a traceback when not running in a script
Assert.AreEqual(ex.StackTrace, ex.Format());
}
}
[Test]
public void TestPythonExceptionFormatNormalized()
{
try
{
PythonEngine.Exec("a=b\n");
Assert.Fail("Exception should have been raised");
}
catch (PythonException ex)
{
Assert.AreEqual("Traceback (most recent call last):\n File \"<string>\", line 1, in <module>\nNameError: name 'b' is not defined\n", ex.Format());
}
}
[Test]
public void TestPythonException_PyErr_NormalizeException()
{
using (var scope = Py.CreateScope())
{
scope.Exec(@"
class TestException(NameError):
def __init__(self, val):
super().__init__(val)
x = int(val)");
Assert.IsTrue(scope.TryGet("TestException", out PyObject type));
PyObject str = "dummy string".ToPython();
var typePtr = new NewReference(type.Reference);
var strPtr = new NewReference(str.Reference);
var tbPtr = new NewReference(Runtime.Runtime.None.Reference);
Runtime.Runtime.PyErr_NormalizeException(ref typePtr, ref strPtr, ref tbPtr);
using var typeObj = typePtr.MoveToPyObject();
using var strObj = strPtr.MoveToPyObject();
using var tbObj = tbPtr.MoveToPyObject();
// the type returned from PyErr_NormalizeException should not be the same type since a new
// exception was raised by initializing the exception
Assert.AreNotEqual(type.Handle, typeObj.Handle);
// the message should now be the string from the throw exception during normalization
Assert.AreEqual("invalid literal for int() with base 10: 'dummy string'", strObj.ToString());
}
}
[Test]
public void TestPythonException_Normalize_ThrowsWhenErrorSet()
{
Exceptions.SetError(Exceptions.TypeError, "Error!");
var pythonException = PythonException.FetchCurrentRaw();
Exceptions.SetError(Exceptions.TypeError, "Another error");
Assert.Throws<InvalidOperationException>(() => pythonException.Normalize());
Exceptions.Clear();
}
[Test]
public void TestGetsPythonCodeInfoInStackTrace()
{
using (Py.GIL())
{
dynamic testClassModule = PyModule.FromString("TestGetsPythonCodeInfoInStackTrace_Module", @"
from clr import AddReference
AddReference(""Python.EmbeddingTest"")
from Python.EmbeddingTest import *
class TestPythonClass(TestPythonException.TestClass):
def CallThrow(self):
super().ThrowException()
");
try
{
var instance = testClassModule.TestPythonClass();
dynamic module = Py.Import("PyImportTest.SampleScript");
module.invokeMethod(instance, "CallThrow");
}
catch (ClrBubbledException ex)
{
Assert.AreEqual("Test Exception Message", ex.InnerException.Message);
var pythonTracebackLines = ex.PythonTraceback.TrimEnd('\n').Split('\n').Select(x => x.Trim()).ToList();
Assert.AreEqual(5, pythonTracebackLines.Count);
Assert.AreEqual("File \"none\", line 9, in CallThrow", pythonTracebackLines[0]);
Assert.IsTrue(new[]
{
"File ",
"fixtures\\PyImportTest\\SampleScript.py",
"line 5",
"in invokeMethodImpl"
}.All(x => pythonTracebackLines[1].Contains(x)));
Assert.AreEqual("getattr(instance, method_name)()", pythonTracebackLines[2]);
Assert.IsTrue(new[]
{
"File ",
"fixtures\\PyImportTest\\SampleScript.py",
"line 2",
"in invokeMethod"
}.All(x => pythonTracebackLines[3].Contains(x)));
Assert.AreEqual("invokeMethodImpl(instance, method_name)", pythonTracebackLines[4]);
}
catch (Exception ex)
{
Assert.Fail($"Unexpected exception: {ex}");
}
}
}
[Test]
public void TestGetsPythonCodeInfoInStackTraceForNestedInterop()
{
using (Py.GIL())
{
dynamic testClassModule = PyModule.FromString("TestGetsPythonCodeInfoInStackTraceForNestedInterop_Module", @"
from clr import AddReference
AddReference(""Python.EmbeddingTest"")
AddReference(""System"")
from Python.EmbeddingTest import *
from System import Action
class TestPythonClass(TestPythonException.TestClass):
def CallThrow(self):
super().ThrowExceptionNested()
def GetThrowAction():
return Action(CallThrow)
def CallThrow():
TestPythonClass().CallThrow()
");
try
{
var action = testClassModule.GetThrowAction();
action();
}
catch (ClrBubbledException ex)
{
Assert.AreEqual("Test Exception Message", ex.InnerException.Message);
var pythonTracebackLines = ex.PythonTraceback.TrimEnd('\n').Split('\n').Select(x => x.Trim()).ToList();
Assert.AreEqual(4, pythonTracebackLines.Count);
Assert.IsTrue(new[]
{
"File ",
"fixtures\\PyImportTest\\SampleScript.py",
"line 5",
"in invokeMethodImpl"
}.All(x => pythonTracebackLines[0].Contains(x)));
Assert.AreEqual("getattr(instance, method_name)()", pythonTracebackLines[1]);
Assert.IsTrue(new[]
{
"File ",
"fixtures\\PyImportTest\\SampleScript.py",
"line 2",
"in invokeMethod"
}.All(x => pythonTracebackLines[2].Contains(x)));
Assert.AreEqual("invokeMethodImpl(instance, method_name)", pythonTracebackLines[3]);
}
catch (Exception ex)
{
Assert.Fail($"Unexpected exception: {ex}");
}
}
}
public class TestClass
{
public void ThrowException()
{
throw new ArgumentException("Test Exception Message");
}
public void ThrowExceptionNested()
{
using var _ = Py.GIL();
dynamic module = Py.Import("PyImportTest.SampleScript");
module.invokeMethod(this, "ThrowException");
}
}
}
}