blob: 686baf9ece76310dbad6abe544f3df10e40771cb [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Method object implementation */
3
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004#include "Python.h"
Jeremy Hylton4f0dcc92003-01-31 18:33:18 +00005#include "structmember.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00006
Christian Heimes2202f872008-02-06 14:31:34 +00007/* Free list for method objects to safe malloc/free overhead
8 * The m_self element is used to chain the objects.
9 */
Guido van Rossum1f39c5c1997-08-05 02:11:41 +000010static PyCFunctionObject *free_list = NULL;
Christian Heimes2202f872008-02-06 14:31:34 +000011static int numfree = 0;
12#ifndef PyCFunction_MAXFREELIST
13#define PyCFunction_MAXFREELIST 256
14#endif
Guido van Rossum1f39c5c1997-08-05 02:11:41 +000015
Andrew Svetlov4de29242012-12-26 23:08:54 +020016/* undefine macro trampoline to PyCFunction_NewEx */
17#undef PyCFunction_New
18
Guido van Rossumc0b618a1997-05-02 03:12:38 +000019PyObject *
Andrew Svetlov3ba3a3e2012-12-25 13:32:35 +020020PyCFunction_New(PyMethodDef *ml, PyObject *self)
21{
22 return PyCFunction_NewEx(ml, self, NULL);
23}
24
25PyObject *
Jeremy Hylton4f0dcc92003-01-31 18:33:18 +000026PyCFunction_NewEx(PyMethodDef *ml, PyObject *self, PyObject *module)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000027{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000028 PyCFunctionObject *op;
29 op = free_list;
30 if (op != NULL) {
31 free_list = (PyCFunctionObject *)(op->m_self);
Christian Heimesd3afe782013-12-04 09:27:47 +010032 (void)PyObject_INIT(op, &PyCFunction_Type);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000033 numfree--;
34 }
35 else {
36 op = PyObject_GC_New(PyCFunctionObject, &PyCFunction_Type);
37 if (op == NULL)
38 return NULL;
39 }
Antoine Pitroub349e4c2014-08-06 19:31:40 -040040 op->m_weakreflist = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000041 op->m_ml = ml;
42 Py_XINCREF(self);
43 op->m_self = self;
44 Py_XINCREF(module);
45 op->m_module = module;
46 _PyObject_GC_TRACK(op);
47 return (PyObject *)op;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000048}
49
Guido van Rossumc0b618a1997-05-02 03:12:38 +000050PyCFunction
Fred Drakeee238b92000-07-09 06:03:25 +000051PyCFunction_GetFunction(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000052{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000053 if (!PyCFunction_Check(op)) {
54 PyErr_BadInternalCall();
55 return NULL;
56 }
Antoine Pitrou5b629422011-12-23 12:40:16 +010057 return PyCFunction_GET_FUNCTION(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000058}
59
Guido van Rossumc0b618a1997-05-02 03:12:38 +000060PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +000061PyCFunction_GetSelf(PyObject *op)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000062{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000063 if (!PyCFunction_Check(op)) {
64 PyErr_BadInternalCall();
65 return NULL;
66 }
Antoine Pitrou5b629422011-12-23 12:40:16 +010067 return PyCFunction_GET_SELF(op);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000068}
69
Guido van Rossumc0602291991-12-16 13:07:24 +000070int
Fred Drakeee238b92000-07-09 06:03:25 +000071PyCFunction_GetFlags(PyObject *op)
Guido van Rossumc0602291991-12-16 13:07:24 +000072{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000073 if (!PyCFunction_Check(op)) {
74 PyErr_BadInternalCall();
75 return -1;
76 }
Antoine Pitrou5b629422011-12-23 12:40:16 +010077 return PyCFunction_GET_FLAGS(op);
Guido van Rossumc0602291991-12-16 13:07:24 +000078}
79
Jeremy Hylton910d7d42001-08-12 21:52:24 +000080PyObject *
81PyCFunction_Call(PyObject *func, PyObject *arg, PyObject *kw)
82{
Victor Stinner9035ad92013-07-11 23:44:46 +020083#define CHECK_RESULT(res) assert(res != NULL || PyErr_Occurred())
84
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000085 PyCFunctionObject* f = (PyCFunctionObject*)func;
86 PyCFunction meth = PyCFunction_GET_FUNCTION(func);
87 PyObject *self = PyCFunction_GET_SELF(func);
Victor Stinner9035ad92013-07-11 23:44:46 +020088 PyObject *res;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000089 Py_ssize_t size;
Jeremy Hylton910d7d42001-08-12 21:52:24 +000090
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000091 switch (PyCFunction_GET_FLAGS(func) & ~(METH_CLASS | METH_STATIC | METH_COEXIST)) {
92 case METH_VARARGS:
Victor Stinner9035ad92013-07-11 23:44:46 +020093 if (kw == NULL || PyDict_Size(kw) == 0) {
94 res = (*meth)(self, arg);
95 CHECK_RESULT(res);
96 return res;
97 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000098 break;
99 case METH_VARARGS | METH_KEYWORDS:
Victor Stinner9035ad92013-07-11 23:44:46 +0200100 res = (*(PyCFunctionWithKeywords)meth)(self, arg, kw);
101 CHECK_RESULT(res);
102 return res;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000103 case METH_NOARGS:
104 if (kw == NULL || PyDict_Size(kw) == 0) {
105 size = PyTuple_GET_SIZE(arg);
Victor Stinner9035ad92013-07-11 23:44:46 +0200106 if (size == 0) {
107 res = (*meth)(self, NULL);
108 CHECK_RESULT(res);
109 return res;
110 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000111 PyErr_Format(PyExc_TypeError,
112 "%.200s() takes no arguments (%zd given)",
113 f->m_ml->ml_name, size);
114 return NULL;
115 }
116 break;
117 case METH_O:
118 if (kw == NULL || PyDict_Size(kw) == 0) {
119 size = PyTuple_GET_SIZE(arg);
Victor Stinner9035ad92013-07-11 23:44:46 +0200120 if (size == 1) {
121 res = (*meth)(self, PyTuple_GET_ITEM(arg, 0));
122 CHECK_RESULT(res);
123 return res;
124 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000125 PyErr_Format(PyExc_TypeError,
126 "%.200s() takes exactly one argument (%zd given)",
127 f->m_ml->ml_name, size);
128 return NULL;
129 }
130 break;
131 default:
132 PyErr_SetString(PyExc_SystemError, "Bad call flags in "
133 "PyCFunction_Call. METH_OLDARGS is no "
134 "longer supported!");
135
136 return NULL;
137 }
138 PyErr_Format(PyExc_TypeError, "%.200s() takes no keyword arguments",
139 f->m_ml->ml_name);
140 return NULL;
Victor Stinner9035ad92013-07-11 23:44:46 +0200141
142#undef CHECK_RESULT
Jeremy Hylton910d7d42001-08-12 21:52:24 +0000143}
144
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000145/* Methods (the standard built-in methods, that is) */
146
147static void
Fred Drakeee238b92000-07-09 06:03:25 +0000148meth_dealloc(PyCFunctionObject *m)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000149{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000150 _PyObject_GC_UNTRACK(m);
Antoine Pitroub349e4c2014-08-06 19:31:40 -0400151 if (m->m_weakreflist != NULL) {
152 PyObject_ClearWeakRefs((PyObject*) m);
153 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000154 Py_XDECREF(m->m_self);
155 Py_XDECREF(m->m_module);
156 if (numfree < PyCFunction_MAXFREELIST) {
157 m->m_self = (PyObject *)free_list;
158 free_list = m;
159 numfree++;
160 }
161 else {
162 PyObject_GC_Del(m);
163 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000164}
165
Alexandre Vassalotti4c05d3b2013-11-24 02:41:05 -0800166static PyObject *
167meth_reduce(PyCFunctionObject *m)
168{
169 PyObject *builtins;
170 PyObject *getattr;
171 _Py_IDENTIFIER(getattr);
172
173 if (m->m_self == NULL || PyModule_Check(m->m_self))
174 return PyUnicode_FromString(m->m_ml->ml_name);
175
176 builtins = PyEval_GetBuiltins();
177 getattr = _PyDict_GetItemId(builtins, &PyId_getattr);
178 return Py_BuildValue("O(Os)", getattr, m->m_self, m->m_ml->ml_name);
179}
180
181static PyMethodDef meth_methods[] = {
182 {"__reduce__", (PyCFunction)meth_reduce, METH_NOARGS, NULL},
183 {NULL, NULL}
184};
185
Larry Hastings44e2eaa2013-11-23 15:37:55 -0800186static PyObject *
187meth_get__text_signature__(PyCFunctionObject *m, void *closure)
188{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800189 return _PyType_GetTextSignatureFromInternalDoc(m->m_ml->ml_name, m->m_ml->ml_doc);
Larry Hastings44e2eaa2013-11-23 15:37:55 -0800190}
191
Tim Peters6d6c1a32001-08-02 04:15:00 +0000192static PyObject *
193meth_get__doc__(PyCFunctionObject *m, void *closure)
194{
Larry Hastings2623c8c2014-02-08 22:15:29 -0800195 return _PyType_GetDocFromInternalDoc(m->m_ml->ml_name, m->m_ml->ml_doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000196}
197
198static PyObject *
199meth_get__name__(PyCFunctionObject *m, void *closure)
200{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000201 return PyUnicode_FromString(m->m_ml->ml_name);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000202}
203
Antoine Pitrou5b629422011-12-23 12:40:16 +0100204static PyObject *
205meth_get__qualname__(PyCFunctionObject *m, void *closure)
206{
207 /* If __self__ is a module or NULL, return m.__name__
208 (e.g. len.__qualname__ == 'len')
209
210 If __self__ is a type, return m.__self__.__qualname__ + '.' + m.__name__
211 (e.g. dict.fromkeys.__qualname__ == 'dict.fromkeys')
212
213 Otherwise return type(m.__self__).__qualname__ + '.' + m.__name__
214 (e.g. [].append.__qualname__ == 'list.append') */
215 PyObject *type, *type_qualname, *res;
216 _Py_IDENTIFIER(__qualname__);
217
218 if (m->m_self == NULL || PyModule_Check(m->m_self))
219 return PyUnicode_FromString(m->m_ml->ml_name);
220
221 type = PyType_Check(m->m_self) ? m->m_self : (PyObject*)Py_TYPE(m->m_self);
222
223 type_qualname = _PyObject_GetAttrId(type, &PyId___qualname__);
224 if (type_qualname == NULL)
225 return NULL;
226
227 if (!PyUnicode_Check(type_qualname)) {
228 PyErr_SetString(PyExc_TypeError, "<method>.__class__."
229 "__qualname__ is not a unicode object");
230 Py_XDECREF(type_qualname);
231 return NULL;
232 }
233
234 res = PyUnicode_FromFormat("%S.%s", type_qualname, m->m_ml->ml_name);
235 Py_DECREF(type_qualname);
236 return res;
237}
238
Neil Schemenauer10c66922001-07-12 13:27:35 +0000239static int
240meth_traverse(PyCFunctionObject *m, visitproc visit, void *arg)
241{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000242 Py_VISIT(m->m_self);
243 Py_VISIT(m->m_module);
244 return 0;
Neil Schemenauer10c66922001-07-12 13:27:35 +0000245}
246
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000247static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000248meth_get__self__(PyCFunctionObject *m, void *closure)
Guido van Rossumcab650d1995-01-07 12:34:58 +0000249{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000250 PyObject *self;
Guido van Rossuma8add0e2007-05-14 22:03:55 +0000251
Antoine Pitrou5b629422011-12-23 12:40:16 +0100252 self = PyCFunction_GET_SELF(m);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000253 if (self == NULL)
254 self = Py_None;
255 Py_INCREF(self);
256 return self;
Guido van Rossumcab650d1995-01-07 12:34:58 +0000257}
258
Guido van Rossum32d34c82001-09-20 21:45:26 +0000259static PyGetSetDef meth_getsets [] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000260 {"__doc__", (getter)meth_get__doc__, NULL, NULL},
261 {"__name__", (getter)meth_get__name__, NULL, NULL},
Antoine Pitrou5b629422011-12-23 12:40:16 +0100262 {"__qualname__", (getter)meth_get__qualname__, NULL, NULL},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000263 {"__self__", (getter)meth_get__self__, NULL, NULL},
Larry Hastings44e2eaa2013-11-23 15:37:55 -0800264 {"__text_signature__", (getter)meth_get__text_signature__, NULL, NULL},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000265 {0}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000266};
267
Jeremy Hylton4f0dcc92003-01-31 18:33:18 +0000268#define OFF(x) offsetof(PyCFunctionObject, x)
269
270static PyMemberDef meth_members[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000271 {"__module__", T_OBJECT, OFF(m_module), PY_WRITE_RESTRICTED},
272 {NULL}
Jeremy Hylton4f0dcc92003-01-31 18:33:18 +0000273};
274
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000275static PyObject *
Fred Drakeee238b92000-07-09 06:03:25 +0000276meth_repr(PyCFunctionObject *m)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000277{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000278 if (m->m_self == NULL || PyModule_Check(m->m_self))
279 return PyUnicode_FromFormat("<built-in function %s>",
280 m->m_ml->ml_name);
281 return PyUnicode_FromFormat("<built-in method %s of %s object at %p>",
282 m->m_ml->ml_name,
283 m->m_self->ob_type->tp_name,
284 m->m_self);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000285}
286
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000287static PyObject *
288meth_richcompare(PyObject *self, PyObject *other, int op)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000289{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000290 PyCFunctionObject *a, *b;
291 PyObject *res;
292 int eq;
Guido van Rossum47b9ff62006-08-24 00:41:19 +0000293
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000294 if ((op != Py_EQ && op != Py_NE) ||
295 !PyCFunction_Check(self) ||
296 !PyCFunction_Check(other))
297 {
Brian Curtindfc80e32011-08-10 20:28:54 -0500298 Py_RETURN_NOTIMPLEMENTED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000299 }
300 a = (PyCFunctionObject *)self;
301 b = (PyCFunctionObject *)other;
302 eq = a->m_self == b->m_self;
303 if (eq)
304 eq = a->m_ml->ml_meth == b->m_ml->ml_meth;
305 if (op == Py_EQ)
306 res = eq ? Py_True : Py_False;
307 else
308 res = eq ? Py_False : Py_True;
309 Py_INCREF(res);
310 return res;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000311}
312
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000313static Py_hash_t
Fred Drakeee238b92000-07-09 06:03:25 +0000314meth_hash(PyCFunctionObject *a)
Guido van Rossum9bfef441993-03-29 10:43:31 +0000315{
Benjamin Peterson8f67d082010-10-17 20:54:53 +0000316 Py_hash_t x, y;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000317 if (a->m_self == NULL)
318 x = 0;
319 else {
320 x = PyObject_Hash(a->m_self);
321 if (x == -1)
322 return -1;
323 }
324 y = _Py_HashPointer((void*)(a->m_ml->ml_meth));
325 if (y == -1)
326 return -1;
327 x ^= y;
328 if (x == -1)
329 x = -2;
330 return x;
Guido van Rossum9bfef441993-03-29 10:43:31 +0000331}
332
Tim Peters6d6c1a32001-08-02 04:15:00 +0000333
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000334PyTypeObject PyCFunction_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000335 PyVarObject_HEAD_INIT(&PyType_Type, 0)
336 "builtin_function_or_method",
337 sizeof(PyCFunctionObject),
338 0,
339 (destructor)meth_dealloc, /* tp_dealloc */
340 0, /* tp_print */
341 0, /* tp_getattr */
342 0, /* tp_setattr */
343 0, /* tp_reserved */
344 (reprfunc)meth_repr, /* tp_repr */
345 0, /* tp_as_number */
346 0, /* tp_as_sequence */
347 0, /* tp_as_mapping */
348 (hashfunc)meth_hash, /* tp_hash */
349 PyCFunction_Call, /* tp_call */
350 0, /* tp_str */
351 PyObject_GenericGetAttr, /* tp_getattro */
352 0, /* tp_setattro */
353 0, /* tp_as_buffer */
354 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
355 0, /* tp_doc */
356 (traverseproc)meth_traverse, /* tp_traverse */
357 0, /* tp_clear */
358 meth_richcompare, /* tp_richcompare */
Antoine Pitroub349e4c2014-08-06 19:31:40 -0400359 offsetof(PyCFunctionObject, m_weakreflist), /* tp_weaklistoffset */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000360 0, /* tp_iter */
361 0, /* tp_iternext */
Alexandre Vassalotti4c05d3b2013-11-24 02:41:05 -0800362 meth_methods, /* tp_methods */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000363 meth_members, /* tp_members */
364 meth_getsets, /* tp_getset */
365 0, /* tp_base */
366 0, /* tp_dict */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000367};
Guido van Rossum3f5da241990-12-20 15:06:42 +0000368
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000369/* Clear out the free list */
370
Christian Heimesa156e092008-02-16 07:38:31 +0000371int
372PyCFunction_ClearFreeList(void)
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000373{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000374 int freelist_size = numfree;
375
376 while (free_list) {
377 PyCFunctionObject *v = free_list;
378 free_list = (PyCFunctionObject *)(v->m_self);
379 PyObject_GC_Del(v);
380 numfree--;
381 }
382 assert(numfree == 0);
383 return freelist_size;
Christian Heimesa156e092008-02-16 07:38:31 +0000384}
385
386void
387PyCFunction_Fini(void)
388{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000389 (void)PyCFunction_ClearFreeList();
Guido van Rossum1f39c5c1997-08-05 02:11:41 +0000390}
Jeremy Hylton4f0dcc92003-01-31 18:33:18 +0000391
David Malcolm49526f42012-06-22 14:55:41 -0400392/* Print summary info about the state of the optimized allocator */
393void
394_PyCFunction_DebugMallocStats(FILE *out)
395{
396 _PyDebugAllocatorStats(out,
Antoine Pitrou36b045f2013-04-11 21:01:40 +0200397 "free PyCFunctionObject",
Antoine Pitrou0811f982012-12-30 22:46:04 +0100398 numfree, sizeof(PyCFunctionObject));
David Malcolm49526f42012-06-22 14:55:41 -0400399}