Repository navigation
Expand file tree
/
Copy pathPyModule.cs
More file actions
475 lines (418 loc) · 15.1 KB
/
Copy pathPyModule.cs
File metadata and controls
475 lines (418 loc) · 15.1 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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
using System;
using System.Linq;
using System.Collections.Generic;
using System.Dynamic;
using System.Runtime.Serialization;
namespace Python.Runtime
{
[Serializable]
public class PyModule : PyObject
{
internal BorrowedReference variables => VarsRef;
internal BorrowedReference VarsRef
{
get
{
var vars = Runtime.PyModule_GetDict(Reference);
PythonException.ThrowIfIsNull(vars);
return vars;
}
}
public PyModule(string name = "") : this(Create(name))
{
InitializeBuiltins();
}
static StolenReference Create(string name)
{
if (name is null)
{
throw new ArgumentNullException(nameof(name));
}
return Runtime.PyModule_New(name).StealOrThrow();
}
internal PyModule(in StolenReference reference) : base(reference)
{
if (!IsModule(Reference))
{
throw new ArgumentException("object is not a module");
}
}
protected PyModule(SerializationInfo info, StreamingContext context)
: base(info, context) { }
private void InitializeBuiltins()
{
int res = Runtime.PyDict_SetItem(
VarsRef, PyIdentifier.__builtins__,
Runtime.PyEval_GetBuiltins()
);
PythonException.ThrowIfIsNotZero(res);
}
internal PyModule(BorrowedReference reference) : this(new NewReference(reference).Steal())
{
}
/// <summary>
/// Given a module or package name, import the module and return the resulting object.
/// </summary>
/// <param name="name">Fully-qualified module or package name</param>
public static PyObject Import(string name)
{
if (name is null) throw new ArgumentNullException(nameof(name));
NewReference op = Runtime.PyImport_ImportModule(name);
return IsModule(op.BorrowOrThrow()) ? new PyModule(op.Steal()) : op.MoveToPyObject();
}
/// <summary>
/// Reloads the module, and returns the updated object
/// </summary>
public PyModule Reload()
{
NewReference op = Runtime.PyImport_ReloadModule(this.Reference);
return new PyModule(op.StealOrThrow());
}
public static PyModule FromString(string name, string code)
{
using NewReference c = Runtime.Py_CompileString(code, "none", (int)RunFlagType.File);
NewReference m = Runtime.PyImport_ExecCodeModule(name, c.BorrowOrThrow());
return new PyModule(m.StealOrThrow());
}
public PyModule SetBuiltins(PyDict builtins)
{
if (builtins == null || builtins.IsNone())
{
throw new ArgumentNullException(nameof(builtins));
}
BorrowedReference globals = Runtime.PyModule_GetDict(this.Reference);
PythonException.ThrowIfIsNull(globals);
int rc = Runtime.PyDict_SetItemString(globals, "__builtins__", builtins.Reference);
PythonException.ThrowIfIsNotZero(rc);
return this;
}
public static PyDict SysModules
{
get
{
BorrowedReference sysModulesRef = Runtime.PyImport_GetModuleDict();
PythonException.ThrowIfIsNull(sysModulesRef);
return new PyDict(sysModulesRef);
}
}
internal static bool IsModule(BorrowedReference reference)
{
if (reference == null) return false;
BorrowedReference type = Runtime.PyObject_TYPE(reference);
return Runtime.PyType_IsSubtype(type, Runtime.PyModuleType);
}
/// <summary>
/// Returns the variables dict of the module.
/// </summary>
public PyDict Variables() => new(VarsRef);
/// <summary>
/// Create a scope, and import all from this scope
/// </summary>
public PyModule NewScope()
{
var scope = new PyModule();
scope.ImportAll(this);
return scope;
}
/// <summary>
/// Import module by its name.
/// </summary>
public PyObject Import(string name, string? asname = null)
{
Check();
asname ??= name;
var module = PyModule.Import(name);
Import(module, asname);
return module;
}
/// <summary>
/// Import module as a variable of given name.
/// </summary>
public void Import(PyModule module, string asname)
{
if (module is null) throw new ArgumentNullException(nameof(module));
if (asname is null) throw new ArgumentNullException(nameof(asname));
this.SetPyValue(asname, module);
}
/// <summary>
/// The 'import .. as ..' statement in Python.
/// Import a module as a variable.
/// </summary>
public void Import(PyObject module, string? asname = null)
{
if (module is null) throw new ArgumentNullException(nameof(module));
asname ??= module.GetAttr("__name__").As<string>();
if (asname is null) throw new ArgumentException("Module has no name");
Set(asname, module);
}
/// <summary>
/// Import all variables of the module into this module.
/// </summary>
public void ImportAll(PyModule module)
{
if (module is null) throw new ArgumentNullException(nameof(module));
int result = Runtime.PyDict_Update(VarsRef, module.VarsRef);
if (result < 0)
{
throw PythonException.ThrowLastAsClrException();
}
}
/// <remarks>
/// Import all variables of the module into this module.
/// </remarks>
public void ImportAll(PyObject module)
{
if (module is null) throw new ArgumentNullException(nameof(module));
if (!IsModule(module.Reference))
{
throw new ArgumentException("object is not a module", paramName: nameof(module));
}
var module_dict = Runtime.PyModule_GetDict(module.Reference);
int result = Runtime.PyDict_Update(VarsRef, module_dict);
if (result < 0)
{
throw PythonException.ThrowLastAsClrException();
}
}
/// <summary>
/// Import all variables in the dictionary into this module.
/// </summary>
public void ImportAll(PyDict dict)
{
if (dict is null) throw new ArgumentNullException(nameof(dict));
int result = Runtime.PyDict_Update(VarsRef, dict.Reference);
if (result < 0)
{
throw PythonException.ThrowLastAsClrException();
}
}
/// <summary>
/// Execute method
/// </summary>
/// <remarks>
/// Execute a Python ast and return the result as a PyObject.
/// The ast can be either an expression or stmts.
/// </remarks>
public PyObject Execute(PyObject script, PyDict? locals = null)
{
if (script is null) throw new ArgumentNullException(nameof(script));
Check();
BorrowedReference _locals = locals == null ? variables : locals.obj;
using var ptr = Runtime.PyEval_EvalCode(script, variables, _locals);
PythonException.ThrowIfIsNull(ptr);
return ptr.MoveToPyObject();
}
/// <summary>
/// Execute a Python ast and return the result as a <see cref="PyObject"/>,
/// and convert the result to a Managed Object of given type.
/// The ast can be either an expression or stmts.
/// </summary>
public T? Execute<T>(PyObject script, PyDict? locals = null)
{
Check();
PyObject pyObj = Execute(script, locals);
var obj = pyObj.As<T>();
return obj;
}
/// <summary>
/// Evaluate a Python expression and return the result as a <see cref="PyObject"/>.
/// </summary>
public PyObject Eval(string code, PyDict? locals = null)
{
if (code is null) throw new ArgumentNullException(nameof(code));
Check();
BorrowedReference _locals = locals == null ? VarsRef : locals.Reference;
NewReference reference = Runtime.PyRun_String(
code, RunFlagType.Eval, VarsRef, _locals
);
PythonException.ThrowIfIsNull(reference);
return reference.MoveToPyObject();
}
/// <summary>
/// Evaluate a Python expression
/// </summary>
/// <remarks>
/// Evaluate a Python expression
/// and convert the result to a Managed Object of given type.
/// </remarks>
public T? Eval<T>(string code, PyDict? locals = null)
{
Check();
PyObject pyObj = Eval(code, locals);
var obj = pyObj.As<T>();
return obj;
}
/// <summary>
/// Exec Method
/// </summary>
/// <remarks>
/// Exec a Python script and save its local variables in the current local variable dict.
/// </remarks>
public PyModule Exec(string code, PyDict? locals = null)
{
Check();
BorrowedReference _locals = locals == null ? VarsRef : locals.Reference;
Exec(code, VarsRef, _locals);
return this;
}
private void Exec(string code, BorrowedReference _globals, BorrowedReference _locals)
{
using NewReference reference = Runtime.PyRun_String(
code, RunFlagType.File, _globals, _locals
);
PythonException.ThrowIfIsNull(reference);
}
/// <summary>
/// Set Variable Method
/// </summary>
/// <remarks>
/// Add a new variable to the variables dict if it not exist
/// or update its value if the variable exists.
/// </remarks>
public PyModule Set(string name, object? value)
{
if (name is null) throw new ArgumentNullException(nameof(name));
using var _value = Converter.ToPythonDetectType(value);
SetPyValue(name, _value.Borrow());
return this;
}
private void SetPyValue(string name, BorrowedReference value)
{
Check();
using (var pyKey = new PyString(name))
{
int r = Runtime.PyObject_SetItem(variables, pyKey.obj, value);
if (r < 0)
{
throw PythonException.ThrowLastAsClrException();
}
}
}
/// <summary>
/// Remove Method
/// </summary>
/// <remarks>
/// Remove a variable from the variables dict.
/// </remarks>
public PyModule Remove(string name)
{
if (name is null) throw new ArgumentNullException(nameof(name));
Check();
using (var pyKey = new PyString(name))
{
int r = Runtime.PyObject_DelItem(variables, pyKey.obj);
if (r < 0)
{
throw PythonException.ThrowLastAsClrException();
}
}
return this;
}
/// <summary>
/// Returns true if the variable exists in the module.
/// </summary>
public bool Contains(string name)
{
if (name is null) throw new ArgumentNullException(nameof(name));
Check();
using (var pyKey = new PyString(name))
{
return Runtime.PyMapping_HasKey(variables, pyKey.obj) != 0;
}
}
/// <summary>
/// Returns the value of the variable with the given name.
/// </summary>
/// <exception cref="KeyNotFoundException">
/// Thrown when variable with the given name does not exist.
/// </exception>
public PyObject Get(string name)
{
if (name is null) throw new ArgumentNullException(nameof(name));
var state = TryGet(name, out var value);
if (!state)
{
throw new KeyNotFoundException($"The module has no attribute '{name}'");
}
return value!;
}
/// <summary>
/// TryGet Method
/// </summary>
/// <remarks>
/// Returns the value of the variable, local variable first.
/// If the variable does not exist, return null.
/// </remarks>
public bool TryGet(string name, out PyObject? value)
{
if (name is null) throw new ArgumentNullException(nameof(name));
Check();
using (var pyKey = new PyString(name))
{
if (Runtime.PyMapping_HasKey(variables, pyKey.obj) != 0)
{
using var op = Runtime.PyObject_GetItem(variables, pyKey.obj);
value = new PyObject(op.StealOrThrow());
return true;
}
else
{
value = null;
return false;
}
}
}
/// <summary>
/// Get Method
/// </summary>
/// <remarks>
/// Obtain the value of the variable of given name,
/// and convert the result to a Managed Object of given type.
/// If the variable does not exist, throw an Exception.
/// </remarks>
public T Get<T>(string name)
{
if (name is null) throw new ArgumentNullException(nameof(name));
Check();
PyObject pyObj = Get(name);
return pyObj.As<T>()!;
}
/// <summary>
/// TryGet Method
/// </summary>
/// <remarks>
/// Obtain the value of the variable of given name,
/// and convert the result to a Managed Object of given type.
/// If the variable does not exist, return false.
/// </remarks>
public bool TryGet<T>(string name, out T? value)
{
Check();
var result = TryGet(name, out var pyObj);
if (!result)
{
value = default(T);
return false;
}
value = pyObj!.As<T>();
return true;
}
public override bool TryGetMember(GetMemberBinder binder, out object? result)
{
result = CheckNone(this.Get(binder.Name));
return true;
}
public override bool TrySetMember(SetMemberBinder binder, object? value)
{
this.Set(binder.Name, value);
return true;
}
private void Check()
{
if (this.rawPtr == IntPtr.Zero)
{
throw new ObjectDisposedException(nameof(PyModule));
}
}
}
}