forked from pythonnet/pythonnet
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMethodBinding.cs
More file actions
284 lines (255 loc) · 11.2 KB
/
MethodBinding.cs
File metadata and controls
284 lines (255 loc) · 11.2 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
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Reflection;
namespace Python.Runtime
{
using MaybeMethodInfo = MaybeMethodBase<MethodBase>;
/// <summary>
/// Implements a Python binding type for CLR methods. These work much like
/// standard Python method bindings, but the same type is used to bind
/// both static and instance methods.
/// </summary>
[Serializable]
internal class MethodBinding : ExtensionType
{
internal MaybeMethodInfo info;
internal MethodObject m;
internal PyObject? target;
internal PyType? targetType;
public MethodBinding(MethodObject m, PyObject? target, PyType? targetType = null)
{
this.target = target;
this.targetType = targetType ?? target?.GetPythonType();
this.info = null;
this.m = m;
}
/// <summary>
/// Implement binding of generic methods using the subscript syntax [].
/// </summary>
public static NewReference mp_subscript(BorrowedReference tp, BorrowedReference idx)
{
var self = (MethodBinding)GetManagedObject(tp)!;
Type[]? types = Runtime.PythonArgsToTypeArray(idx);
if (types == null)
{
return Exceptions.RaiseTypeError("type(s) expected");
}
MethodBase[] overloads = self.m.IsInstanceConstructor
? self.m.type.Value.GetConstructor(types) is { } ctor
? new[] { ctor }
: Array.Empty<MethodBase>()
: MethodBinder.MatchParameters(self.m.info, types);
if (overloads.Length == 0)
{
return Exceptions.RaiseTypeError("No match found for given type params");
}
MethodObject overloaded = self.m.WithOverloads(overloads);
var mb = new MethodBinding(overloaded, self.target, self.targetType);
return mb.Alloc();
}
PyObject Signature
{
get
{
var infos = this.info.Valid ? new[] { this.info.Value } : this.m.info;
Type type = infos.Select(i => i.DeclaringType)
.OrderByDescending(t => t, new TypeSpecificityComparer())
.First();
infos = infos.Where(info => info.DeclaringType == type).ToArray();
// this is a primitive version
// the overload with the maximum number of parameters should be used
MethodBase primary = infos.OrderByDescending(i => i.GetParameters().Length).First();
var primaryParameters = primary.GetParameters();
PyObject signatureClass = Runtime.InspectModule.GetAttr("Signature");
using var parameters = new PyList();
using var parameterClass = primaryParameters.Length > 0 ? Runtime.InspectModule.GetAttr("Parameter") : null;
using var positionalOrKeyword = parameterClass?.GetAttr("POSITIONAL_OR_KEYWORD");
for (int i = 0; i < primaryParameters.Length; i++)
{
var parameter = primaryParameters[i];
var alternatives = infos.Select(info =>
{
ParameterInfo[] altParamters = info.GetParameters();
return i < altParamters.Length ? altParamters[i] : null;
}).WhereNotNull();
using var defaultValue = alternatives
.Select(alternative => alternative!.DefaultValue != DBNull.Value ? alternative.DefaultValue.ToPython() : null)
.FirstOrDefault(v => v != null) ?? parameterClass?.GetAttr("empty");
if (alternatives.Any(alternative => alternative.Name != parameter.Name)
|| positionalOrKeyword is null)
{
return signatureClass.Invoke();
}
using var args = new PyTuple(new[] { parameter.Name.ToPython(), positionalOrKeyword });
using var kw = new PyDict();
if (defaultValue is not null)
{
kw["default"] = defaultValue;
}
using var parameterInfo = parameterClass!.Invoke(args: args, kw: kw);
parameters.Append(parameterInfo);
}
// TODO: add return annotation
return signatureClass.Invoke(parameters);
}
}
struct TypeSpecificityComparer : IComparer<Type>
{
public int Compare(Type a, Type b)
{
if (a == b) return 0;
if (a.IsSubclassOf(b)) return 1;
if (b.IsSubclassOf(a)) return -1;
throw new NotSupportedException();
}
}
/// <summary>
/// MethodBinding __getattribute__ implementation.
/// </summary>
public static NewReference tp_getattro(BorrowedReference ob, BorrowedReference key)
{
var self = (MethodBinding)GetManagedObject(ob)!;
if (!Runtime.PyString_Check(key))
{
Exceptions.SetError(Exceptions.TypeError, "string expected");
return default;
}
string? name = InternString.GetManagedString(key);
switch (name)
{
case "__doc__":
return self.m.GetDocString();
// FIXME: deprecate __overloads__ soon...
case "__overloads__":
case "Overloads":
var om = new OverloadMapper(self.m, self.target);
return om.Alloc();
case "__signature__" when Runtime.InspectModule is not null:
var sig = self.Signature;
if (sig is null)
{
return Runtime.PyObject_GenericGetAttr(ob, key);
}
return sig.NewReferenceOrNull();
case "__name__":
return self.m.GetName();
default:
return Runtime.PyObject_GenericGetAttr(ob, key);
}
}
/// <summary>
/// MethodBinding __call__ implementation.
/// </summary>
public static NewReference tp_call(BorrowedReference ob, BorrowedReference args, BorrowedReference kw)
{
var self = (MethodBinding)GetManagedObject(ob)!;
// This works around a situation where the wrong generic method is picked,
// for example this method in the tests: string Overloaded<T>(int arg1, int arg2, string arg3)
if (self.info.Valid)
{
var info = self.info.Value;
if (info.IsGenericMethod)
{
Type[]? sigTp = Runtime.PythonArgsToTypeArray(args, true);
if (sigTp != null)
{
Type[] genericTp = info.GetGenericArguments();
MethodInfo? betterMatch = MethodBinder.MatchSignatureAndParameters(self.m.info, genericTp, sigTp);
if (betterMatch != null)
{
self.info = betterMatch;
}
}
}
}
// This supports calling a method 'unbound', passing the instance
// as the first argument. Note that this is not supported if any
// of the overloads are static since we can't know if the intent
// was to call the static method or the unbound instance method.
var disposeList = new List<PyObject>();
try
{
PyObject? target = self.target;
if (target is null && !self.m.IsStatic())
{
var len = Runtime.PyTuple_Size(args);
if (len < 1)
{
Exceptions.SetError(Exceptions.TypeError, "not enough arguments");
return default;
}
target = new PyObject(Runtime.PyTuple_GetItem(args, 0));
disposeList.Add(target);
var unboundArgs = Runtime.PyTuple_GetSlice(args, 1, len).MoveToPyObject();
disposeList.Add(unboundArgs);
args = unboundArgs;
}
// if the class is a IPythonDerivedClass and target is not the same as self.targetType
// (eg if calling the base class method) then call the original base class method instead
// of the target method.
IntPtr superType = IntPtr.Zero;
if (target is not null && Runtime.PyObject_TYPE(target) != self.targetType!)
{
var inst = GetManagedObject(target) as CLRObject;
if (inst?.inst is IPythonDerivedType)
{
if (GetManagedObject(self.targetType!) is ClassBase baseType && baseType.type.Valid)
{
var baseMethodName = $"_{baseType.type.Value.Name}__{self.m.name}";
using var baseMethod = Runtime.PyObject_GetAttrString(target, baseMethodName);
if (!baseMethod.IsNull())
{
if (GetManagedObject(baseMethod.Borrow()) is MethodBinding baseSelf)
{
self = baseSelf;
}
}
else
{
Runtime.PyErr_Clear();
}
}
}
}
return self.m.Invoke(target is null ? BorrowedReference.Null : target, args, kw, self.info.UnsafeValue);
}
finally
{
foreach (var ptr in disposeList)
{
ptr.Dispose();
}
}
}
/// <summary>
/// MethodBinding __hash__ implementation.
/// </summary>
public static nint tp_hash(BorrowedReference ob)
{
var self = (MethodBinding)GetManagedObject(ob)!;
nint x = 0;
if (self.target is not null)
{
x = Runtime.PyObject_Hash(self.target);
if (x == -1)
{
return x;
}
}
nint y = self.m.GetHashCode();
return x ^ y;
}
/// <summary>
/// MethodBinding __repr__ implementation.
/// </summary>
public static NewReference tp_repr(BorrowedReference ob)
{
var self = (MethodBinding)GetManagedObject(ob)!;
string type = self.target is null ? "unbound" : "bound";
string name = self.m.name;
return Runtime.PyString_FromString($"<{type} method '{name}'>");
}
}
}