forked from pythonnet/pythonnet
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMethodObject.cs
More file actions
237 lines (208 loc) · 8.31 KB
/
MethodObject.cs
File metadata and controls
237 lines (208 loc) · 8.31 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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
namespace Python.Runtime
{
using MaybeMethodInfo = MaybeMethodBase<MethodBase>;
/// <summary>
/// Implements a Python type that represents a CLR method. Method objects
/// support a subscript syntax [] to allow explicit overload selection.
/// </summary>
/// <remarks>
/// TODO: ForbidPythonThreadsAttribute per method info
/// </remarks>
[Serializable]
internal class MethodObject : ExtensionType
{
[NonSerialized]
private MethodBase[]? _info = null;
private readonly List<MaybeMethodInfo> infoList;
internal string name;
internal readonly MethodBinder binder;
internal bool is_static = false;
internal PyString? doc;
internal MaybeType type;
public MethodObject(MaybeType type, string name, MethodBase[] info, bool allow_threads)
{
this.type = type;
this.name = name;
this.infoList = new List<MaybeMethodInfo>();
binder = new MethodBinder();
foreach (MethodBase item in info)
{
this.infoList.Add(item);
binder.AddMethod(item);
if (item.IsStatic)
{
this.is_static = true;
}
}
binder.allow_threads = allow_threads;
}
public MethodObject(MaybeType type, string name, MethodBase[] info)
: this(type, name, info, allow_threads: AllowThreads(info))
{
}
public bool IsInstanceConstructor => name == "__init__";
public MethodObject WithOverloads(MethodBase[] overloads)
=> new(type, name, overloads, allow_threads: binder.allow_threads);
internal MethodBase[] info
{
get
{
if (_info == null)
{
_info = (from i in infoList where i.Valid select i.Value).ToArray();
}
return _info;
}
}
public virtual NewReference Invoke(BorrowedReference inst, BorrowedReference args, BorrowedReference kw)
{
return Invoke(inst, args, kw, null);
}
public virtual NewReference Invoke(BorrowedReference target, BorrowedReference args, BorrowedReference kw, MethodBase? info)
{
return binder.Invoke(target, args, kw, info, this.info);
}
/// <summary>
/// Helper to get docstrings from reflected method / param info.
/// </summary>
internal NewReference GetDocString()
{
if (doc is not null)
{
return new NewReference(doc);
}
var str = "";
Type marker = typeof(DocStringAttribute);
MethodBase[] methods = binder.GetMethods();
foreach (MethodBase method in methods)
{
if (str.Length > 0)
{
str += Environment.NewLine;
}
var attrs = (Attribute[])method.GetCustomAttributes(marker, false);
if (attrs.Length == 0)
{
str += method.ToString();
}
else
{
var attr = (DocStringAttribute)attrs[0];
str += attr.DocString;
}
}
doc = new PyString(str);
return new NewReference(doc);
}
internal NewReference GetName()
{
var names = new HashSet<string>(binder.GetMethods().Select(m => m.Name));
if (names.Count != 1) {
Exceptions.SetError(Exceptions.AttributeError, "a method has no name");
return default;
}
return Runtime.PyString_FromString(names.First());
}
/// <summary>
/// This is a little tricky: a class can actually have a static method
/// and instance methods all with the same name. That makes it tough
/// to support calling a method 'unbound' (passing the instance as the
/// first argument), because in this case we can't know whether to call
/// the instance method unbound or call the static method.
/// </summary>
/// <remarks>
/// The rule we is that if there are both instance and static methods
/// with the same name, then we always call the static method. So this
/// method returns true if any of the methods that are represented by
/// the descriptor are static methods (called by MethodBinding).
/// </remarks>
internal bool IsStatic()
{
return is_static;
}
/// <summary>
/// Descriptor __getattribute__ implementation.
/// </summary>
public static NewReference tp_getattro(BorrowedReference ob, BorrowedReference key)
{
var self = (MethodObject)GetManagedObject(ob)!;
if (!Runtime.PyString_Check(key))
{
return Exceptions.RaiseTypeError("string expected");
}
if (Runtime.PyUnicode_Compare(key, PyIdentifier.__doc__) == 0)
{
return self.GetDocString();
}
return Runtime.PyObject_GenericGetAttr(ob, key);
}
/// <summary>
/// Descriptor __get__ implementation. Accessing a CLR method returns
/// a "bound" method similar to a Python bound method.
/// </summary>
public static NewReference tp_descr_get(BorrowedReference ds, BorrowedReference ob, BorrowedReference tp)
{
var self = (MethodObject)GetManagedObject(ds)!;
if (!self.type.Valid)
{
return Exceptions.RaiseTypeError(self.type.DeletedMessage);
}
// If the method is accessed through its type (rather than via
// an instance) we return an 'unbound' MethodBinding that will
// cached for future accesses through the type.
if (ob == null)
{
var binding = new MethodBinding(self, target: null, targetType: new PyType(tp));
return binding.Alloc();
}
if (Runtime.PyObject_IsInstance(ob, tp) < 1)
{
return Exceptions.RaiseTypeError("invalid argument");
}
// If the object this descriptor is being called with is a subclass of the type
// this descriptor was defined on then it will be because the base class method
// is being called via super(Derived, self).method(...).
// In which case create a MethodBinding bound to the base class.
if (GetManagedObject(ob) is CLRObject obj
&& obj.inst.GetType() != self.type.Value
&& obj.inst is IPythonDerivedType
&& self.type.Value.IsInstanceOfType(obj.inst))
{
var basecls = ReflectedClrType.GetOrCreate(self.type.Value);
return new MethodBinding(self, new PyObject(ob), basecls).Alloc();
}
return new MethodBinding(self, target: new PyObject(ob), targetType: new PyType(tp)).Alloc();
}
/// <summary>
/// Descriptor __repr__ implementation.
/// </summary>
public static NewReference tp_repr(BorrowedReference ob)
{
var self = (MethodObject)GetManagedObject(ob)!;
return Runtime.PyString_FromString($"<method '{self.name}'>");
}
static bool AllowThreads(MethodBase[] methods)
{
bool hasAllowOverload = false, hasForbidOverload = false;
foreach (var method in methods)
{
bool forbidsThreads = method.GetCustomAttribute<ForbidPythonThreadsAttribute>(inherit: false) != null;
if (forbidsThreads)
{
hasForbidOverload = true;
}
else
{
hasAllowOverload = true;
}
}
if (hasAllowOverload && hasForbidOverload)
throw new NotImplementedException("All method overloads currently must either allow or forbid Python threads together");
return !hasForbidOverload;
}
}
}