blob: 92d1ac88ba0d8d27cfc71b18d0b1b207f83bd157 [file] [log] [blame]
Guido van Rossume15dee51995-07-18 14:12:02 +00001/* Abstract Object Interface (many thanks to Jim Fulton) */
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002
Guido van Rossume15dee51995-07-18 14:12:02 +00003#include "Python.h"
Guido van Rossumfa0b6ab1998-05-22 15:23:36 +00004#include <ctype.h>
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00005#include "structmember.h" /* we need the offsetof() macro from there */
Tim Peters64b5ce32001-09-10 20:52:51 +00006#include "longintrepr.h"
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00007
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00008
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00009
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000010/* Shorthands to return certain errors */
Guido van Rossume15dee51995-07-18 14:12:02 +000011
12static PyObject *
Thomas Wouters0e3f5912006-08-11 14:57:12 +000013type_error(const char *msg, PyObject *obj)
Guido van Rossume15dee51995-07-18 14:12:02 +000014{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000015 PyErr_Format(PyExc_TypeError, msg, obj->ob_type->tp_name);
16 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +000017}
18
Guido van Rossum052b7e11996-11-11 15:08:19 +000019static PyObject *
Fred Drake79912472000-07-09 04:06:11 +000020null_error(void)
Guido van Rossume15dee51995-07-18 14:12:02 +000021{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000022 if (!PyErr_Occurred())
23 PyErr_SetString(PyExc_SystemError,
24 "null argument to internal routine");
25 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +000026}
27
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000028/* Operations on any object */
29
Guido van Rossume15dee51995-07-18 14:12:02 +000030PyObject *
Fred Drake79912472000-07-09 04:06:11 +000031PyObject_Type(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +000032{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000033 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +000034
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000035 if (o == NULL)
36 return null_error();
37 v = (PyObject *)o->ob_type;
38 Py_INCREF(v);
39 return v;
Guido van Rossume15dee51995-07-18 14:12:02 +000040}
41
Martin v. Löwis18e16552006-02-15 17:27:45 +000042Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +000043PyObject_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +000044{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000045 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +000046
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000047 if (o == NULL) {
48 null_error();
49 return -1;
50 }
Guido van Rossume15dee51995-07-18 14:12:02 +000051
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000052 m = o->ob_type->tp_as_sequence;
53 if (m && m->sq_length)
54 return m->sq_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +000055
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000056 return PyMapping_Size(o);
Guido van Rossume15dee51995-07-18 14:12:02 +000057}
58
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000059#undef PyObject_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +000060Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000061PyObject_Length(PyObject *o)
62{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000063 return PyObject_Size(o);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000064}
65#define PyObject_Length PyObject_Size
66
Armin Ronacheraa9a79d2012-10-06 14:03:24 +020067int
68_PyObject_HasLen(PyObject *o) {
69 return (Py_TYPE(o)->tp_as_sequence && Py_TYPE(o)->tp_as_sequence->sq_length) ||
70 (Py_TYPE(o)->tp_as_mapping && Py_TYPE(o)->tp_as_mapping->mp_length);
71}
Raymond Hettinger6b27cda2005-09-24 21:23:05 +000072
Christian Heimes255f53b2007-12-08 15:33:56 +000073/* The length hint function returns a non-negative value from o.__len__()
Armin Ronacher74b38b12012-10-07 10:29:32 +020074 or o.__length_hint__(). If those methods aren't found the defaultvalue is
75 returned. If one of the calls fails with an exception other than TypeError
76 this function returns -1.
Christian Heimes255f53b2007-12-08 15:33:56 +000077*/
78
79Py_ssize_t
Armin Ronacheraa9a79d2012-10-06 14:03:24 +020080PyObject_LengthHint(PyObject *o, Py_ssize_t defaultvalue)
Christian Heimes255f53b2007-12-08 15:33:56 +000081{
Christian Heimesb70e8a12012-10-06 17:16:39 +020082 PyObject *hint, *result;
Christian Heimes6314d162012-10-06 17:13:29 +020083 Py_ssize_t res;
Benjamin Petersonce798522012-01-22 11:24:29 -050084 _Py_IDENTIFIER(__length_hint__);
Serhiy Storchakaf740d462013-10-24 23:19:51 +030085 if (_PyObject_HasLen(o)) {
86 res = PyObject_Length(o);
87 if (res < 0 && PyErr_Occurred()) {
88 if (!PyErr_ExceptionMatches(PyExc_TypeError)) {
89 return -1;
90 }
91 PyErr_Clear();
Armin Ronacheraa9a79d2012-10-06 14:03:24 +020092 }
Serhiy Storchakaf740d462013-10-24 23:19:51 +030093 else {
94 return res;
95 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000096 }
Christian Heimes6314d162012-10-06 17:13:29 +020097 hint = _PyObject_LookupSpecial(o, &PyId___length_hint__);
Armin Ronacheraa9a79d2012-10-06 14:03:24 +020098 if (hint == NULL) {
99 if (PyErr_Occurred()) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000100 return -1;
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200101 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000102 return defaultvalue;
103 }
Christian Heimesb70e8a12012-10-06 17:16:39 +0200104 result = PyObject_CallFunctionObjArgs(hint, NULL);
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200105 Py_DECREF(hint);
106 if (result == NULL) {
107 if (PyErr_ExceptionMatches(PyExc_TypeError)) {
108 PyErr_Clear();
109 return defaultvalue;
110 }
111 return -1;
112 }
113 else if (result == Py_NotImplemented) {
114 Py_DECREF(result);
115 return defaultvalue;
116 }
117 if (!PyLong_Check(result)) {
Armin Ronacher74b38b12012-10-07 10:29:32 +0200118 PyErr_Format(PyExc_TypeError, "__length_hint__ must be an integer, not %.100s",
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200119 Py_TYPE(result)->tp_name);
120 Py_DECREF(result);
121 return -1;
122 }
Armin Ronacher74b38b12012-10-07 10:29:32 +0200123 res = PyLong_AsSsize_t(result);
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200124 Py_DECREF(result);
Armin Ronacher74b38b12012-10-07 10:29:32 +0200125 if (res < 0 && PyErr_Occurred()) {
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200126 return -1;
127 }
Armin Ronacher74b38b12012-10-07 10:29:32 +0200128 if (res < 0) {
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200129 PyErr_Format(PyExc_ValueError, "__length_hint__() should return >= 0");
130 return -1;
131 }
Armin Ronacher74b38b12012-10-07 10:29:32 +0200132 return res;
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000133}
134
Guido van Rossume15dee51995-07-18 14:12:02 +0000135PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000136PyObject_GetItem(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +0000137{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000138 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000139
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000140 if (o == NULL || key == NULL)
141 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +0000142
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000143 m = o->ob_type->tp_as_mapping;
144 if (m && m->mp_subscript)
145 return m->mp_subscript(o, key);
Guido van Rossume15dee51995-07-18 14:12:02 +0000146
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000147 if (o->ob_type->tp_as_sequence) {
148 if (PyIndex_Check(key)) {
149 Py_ssize_t key_value;
150 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
151 if (key_value == -1 && PyErr_Occurred())
152 return NULL;
153 return PySequence_GetItem(o, key_value);
154 }
155 else if (o->ob_type->tp_as_sequence->sq_item)
156 return type_error("sequence index must "
157 "be integer, not '%.200s'", key);
158 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000159
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000160 return type_error("'%.200s' object is not subscriptable", o);
Guido van Rossume15dee51995-07-18 14:12:02 +0000161}
162
163int
Fred Drake79912472000-07-09 04:06:11 +0000164PyObject_SetItem(PyObject *o, PyObject *key, PyObject *value)
Guido van Rossume15dee51995-07-18 14:12:02 +0000165{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000166 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000167
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000168 if (o == NULL || key == NULL || value == NULL) {
169 null_error();
170 return -1;
171 }
172 m = o->ob_type->tp_as_mapping;
173 if (m && m->mp_ass_subscript)
174 return m->mp_ass_subscript(o, key, value);
Guido van Rossume15dee51995-07-18 14:12:02 +0000175
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000176 if (o->ob_type->tp_as_sequence) {
177 if (PyIndex_Check(key)) {
178 Py_ssize_t key_value;
179 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
180 if (key_value == -1 && PyErr_Occurred())
181 return -1;
182 return PySequence_SetItem(o, key_value, value);
183 }
184 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
185 type_error("sequence index must be "
186 "integer, not '%.200s'", key);
187 return -1;
188 }
189 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000190
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000191 type_error("'%.200s' object does not support item assignment", o);
192 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +0000193}
194
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000195int
Fred Drake79912472000-07-09 04:06:11 +0000196PyObject_DelItem(PyObject *o, PyObject *key)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000197{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000198 PyMappingMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000199
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000200 if (o == NULL || key == NULL) {
201 null_error();
202 return -1;
203 }
204 m = o->ob_type->tp_as_mapping;
205 if (m && m->mp_ass_subscript)
206 return m->mp_ass_subscript(o, key, (PyObject*)NULL);
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000207
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000208 if (o->ob_type->tp_as_sequence) {
209 if (PyIndex_Check(key)) {
210 Py_ssize_t key_value;
211 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
212 if (key_value == -1 && PyErr_Occurred())
213 return -1;
214 return PySequence_DelItem(o, key_value);
215 }
216 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
217 type_error("sequence index must be "
218 "integer, not '%.200s'", key);
219 return -1;
220 }
221 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000222
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000223 type_error("'%.200s' object does not support item deletion", o);
224 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000225}
226
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000227int
Serhiy Storchakac6792272013-10-19 21:03:34 +0300228PyObject_DelItemString(PyObject *o, const char *key)
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000229{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000230 PyObject *okey;
231 int ret;
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000232
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000233 if (o == NULL || key == NULL) {
234 null_error();
235 return -1;
236 }
237 okey = PyUnicode_FromString(key);
238 if (okey == NULL)
239 return -1;
240 ret = PyObject_DelItem(o, okey);
241 Py_DECREF(okey);
242 return ret;
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000243}
244
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000245/* We release the buffer right after use of this function which could
Guido van Rossum98297ee2007-11-06 21:34:58 +0000246 cause issues later on. Don't use these functions in new code.
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000247 */
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000248int
249PyObject_AsCharBuffer(PyObject *obj,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000250 const char **buffer,
251 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000252{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000253 PyBufferProcs *pb;
254 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000255
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000256 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
257 null_error();
258 return -1;
259 }
260 pb = obj->ob_type->tp_as_buffer;
261 if (pb == NULL || pb->bf_getbuffer == NULL) {
262 PyErr_SetString(PyExc_TypeError,
R David Murray861470c2014-10-05 11:47:01 -0400263 "expected a bytes-like object");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000264 return -1;
265 }
266 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE)) return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000267
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000268 *buffer = view.buf;
269 *buffer_len = view.len;
270 if (pb->bf_releasebuffer != NULL)
271 (*pb->bf_releasebuffer)(obj, &view);
272 Py_XDECREF(view.obj);
273 return 0;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000274}
Guido van Rossum4c08d552000-03-10 22:55:18 +0000275
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000276int
277PyObject_CheckReadBuffer(PyObject *obj)
278{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000279 PyBufferProcs *pb = obj->ob_type->tp_as_buffer;
280 Py_buffer view;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000281
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000282 if (pb == NULL ||
283 pb->bf_getbuffer == NULL)
284 return 0;
285 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE) == -1) {
286 PyErr_Clear();
287 return 0;
288 }
289 PyBuffer_Release(&view);
290 return 1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000291}
292
293int PyObject_AsReadBuffer(PyObject *obj,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000294 const void **buffer,
295 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000296{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000297 PyBufferProcs *pb;
298 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000299
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000300 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
301 null_error();
302 return -1;
303 }
304 pb = obj->ob_type->tp_as_buffer;
305 if (pb == NULL ||
306 pb->bf_getbuffer == NULL) {
307 PyErr_SetString(PyExc_TypeError,
R David Murray861470c2014-10-05 11:47:01 -0400308 "expected a bytes-like object");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000309 return -1;
310 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000311
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000312 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE)) return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000313
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000314 *buffer = view.buf;
315 *buffer_len = view.len;
316 if (pb->bf_releasebuffer != NULL)
317 (*pb->bf_releasebuffer)(obj, &view);
318 Py_XDECREF(view.obj);
319 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000320}
321
322int PyObject_AsWriteBuffer(PyObject *obj,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000323 void **buffer,
324 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000325{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000326 PyBufferProcs *pb;
327 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000328
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000329 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
330 null_error();
331 return -1;
332 }
333 pb = obj->ob_type->tp_as_buffer;
334 if (pb == NULL ||
335 pb->bf_getbuffer == NULL ||
336 ((*pb->bf_getbuffer)(obj, &view, PyBUF_WRITABLE) != 0)) {
337 PyErr_SetString(PyExc_TypeError,
R David Murray861470c2014-10-05 11:47:01 -0400338 "expected a writable bytes-like object");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000339 return -1;
340 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000341
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000342 *buffer = view.buf;
343 *buffer_len = view.len;
344 if (pb->bf_releasebuffer != NULL)
345 (*pb->bf_releasebuffer)(obj, &view);
346 Py_XDECREF(view.obj);
347 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000348}
349
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000350/* Buffer C-API for Python 3.0 */
351
352int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000353PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000354{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000355 if (!PyObject_CheckBuffer(obj)) {
356 PyErr_Format(PyExc_TypeError,
R David Murray861470c2014-10-05 11:47:01 -0400357 "a bytes-like object is required, not '%.100s'",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000358 Py_TYPE(obj)->tp_name);
359 return -1;
360 }
361 return (*(obj->ob_type->tp_as_buffer->bf_getbuffer))(obj, view, flags);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000362}
363
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000364static int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100365_IsFortranContiguous(const Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000366{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000367 Py_ssize_t sd, dim;
368 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000369
Stefan Krah363af442015-02-01 14:53:54 +0100370 /* 1) len = product(shape) * itemsize
371 2) itemsize > 0
372 3) len = 0 <==> exists i: shape[i] = 0 */
373 if (view->len == 0) return 1;
374 if (view->strides == NULL) { /* C-contiguous by definition */
375 /* Trivially F-contiguous */
376 if (view->ndim <= 1) return 1;
377
378 /* ndim > 1 implies shape != NULL */
379 assert(view->shape != NULL);
380
381 /* Effectively 1-d */
382 sd = 0;
383 for (i=0; i<view->ndim; i++) {
384 if (view->shape[i] > 1) sd += 1;
385 }
386 return sd <= 1;
387 }
388
389 /* strides != NULL implies both of these */
390 assert(view->ndim > 0);
391 assert(view->shape != NULL);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000392
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000393 sd = view->itemsize;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000394 for (i=0; i<view->ndim; i++) {
395 dim = view->shape[i];
Stefan Krah363af442015-02-01 14:53:54 +0100396 if (dim > 1 && view->strides[i] != sd) {
397 return 0;
398 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000399 sd *= dim;
400 }
401 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000402}
403
404static int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100405_IsCContiguous(const Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000406{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000407 Py_ssize_t sd, dim;
408 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000409
Stefan Krah363af442015-02-01 14:53:54 +0100410 /* 1) len = product(shape) * itemsize
411 2) itemsize > 0
412 3) len = 0 <==> exists i: shape[i] = 0 */
413 if (view->len == 0) return 1;
414 if (view->strides == NULL) return 1; /* C-contiguous by definition */
415
416 /* strides != NULL implies both of these */
417 assert(view->ndim > 0);
418 assert(view->shape != NULL);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000419
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000420 sd = view->itemsize;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000421 for (i=view->ndim-1; i>=0; i--) {
422 dim = view->shape[i];
Stefan Krah363af442015-02-01 14:53:54 +0100423 if (dim > 1 && view->strides[i] != sd) {
424 return 0;
425 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000426 sd *= dim;
427 }
428 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000429}
430
431int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100432PyBuffer_IsContiguous(const Py_buffer *view, char order)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000433{
434
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000435 if (view->suboffsets != NULL) return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000436
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100437 if (order == 'C')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000438 return _IsCContiguous(view);
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100439 else if (order == 'F')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000440 return _IsFortranContiguous(view);
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100441 else if (order == 'A')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000442 return (_IsCContiguous(view) || _IsFortranContiguous(view));
443 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000444}
445
446
Guido van Rossum98297ee2007-11-06 21:34:58 +0000447void*
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000448PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000449{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000450 char* pointer;
451 int i;
452 pointer = (char *)view->buf;
453 for (i = 0; i < view->ndim; i++) {
454 pointer += view->strides[i]*indices[i];
455 if ((view->suboffsets != NULL) && (view->suboffsets[i] >= 0)) {
456 pointer = *((char**)pointer) + view->suboffsets[i];
457 }
458 }
459 return (void*)pointer;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000460}
461
462
Guido van Rossum98297ee2007-11-06 21:34:58 +0000463void
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000464_Py_add_one_to_index_F(int nd, Py_ssize_t *index, const Py_ssize_t *shape)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000465{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000466 int k;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000467
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000468 for (k=0; k<nd; k++) {
469 if (index[k] < shape[k]-1) {
470 index[k]++;
471 break;
472 }
473 else {
474 index[k] = 0;
475 }
476 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000477}
478
Guido van Rossum98297ee2007-11-06 21:34:58 +0000479void
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000480_Py_add_one_to_index_C(int nd, Py_ssize_t *index, const Py_ssize_t *shape)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000481{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000482 int k;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000484 for (k=nd-1; k>=0; k--) {
485 if (index[k] < shape[k]-1) {
486 index[k]++;
487 break;
488 }
489 else {
490 index[k] = 0;
491 }
492 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000493}
494
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000495int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000496PyBuffer_FromContiguous(Py_buffer *view, void *buf, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000497{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000498 int k;
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000499 void (*addone)(int, Py_ssize_t *, const Py_ssize_t *);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000500 Py_ssize_t *indices, elements;
501 char *src, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000502
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000503 if (len > view->len) {
504 len = view->len;
505 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000506
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000507 if (PyBuffer_IsContiguous(view, fort)) {
508 /* simplest copy is all that is needed */
509 memcpy(view->buf, buf, len);
510 return 0;
511 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000512
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000513 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000514
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000515 /* XXX(nnorwitz): need to check for overflow! */
516 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
517 if (indices == NULL) {
518 PyErr_NoMemory();
519 return -1;
520 }
521 for (k=0; k<view->ndim;k++) {
522 indices[k] = 0;
523 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000524
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000525 if (fort == 'F') {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000526 addone = _Py_add_one_to_index_F;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000527 }
528 else {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000529 addone = _Py_add_one_to_index_C;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000530 }
531 src = buf;
532 /* XXX : This is not going to be the fastest code in the world
533 several optimizations are possible.
534 */
535 elements = len / view->itemsize;
536 while (elements--) {
537 addone(view->ndim, indices, view->shape);
538 ptr = PyBuffer_GetPointer(view, indices);
539 memcpy(ptr, src, view->itemsize);
540 src += view->itemsize;
541 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000542
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000543 PyMem_Free(indices);
544 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000545}
546
Guido van Rossum98297ee2007-11-06 21:34:58 +0000547int PyObject_CopyData(PyObject *dest, PyObject *src)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000548{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000549 Py_buffer view_dest, view_src;
550 int k;
551 Py_ssize_t *indices, elements;
552 char *dptr, *sptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000553
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000554 if (!PyObject_CheckBuffer(dest) ||
555 !PyObject_CheckBuffer(src)) {
556 PyErr_SetString(PyExc_TypeError,
R David Murray861470c2014-10-05 11:47:01 -0400557 "both destination and source must be "\
558 "bytes-like objects");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000559 return -1;
560 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000561
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000562 if (PyObject_GetBuffer(dest, &view_dest, PyBUF_FULL) != 0) return -1;
563 if (PyObject_GetBuffer(src, &view_src, PyBUF_FULL_RO) != 0) {
564 PyBuffer_Release(&view_dest);
565 return -1;
566 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000567
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000568 if (view_dest.len < view_src.len) {
569 PyErr_SetString(PyExc_BufferError,
570 "destination is too small to receive data from source");
571 PyBuffer_Release(&view_dest);
572 PyBuffer_Release(&view_src);
573 return -1;
574 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000575
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000576 if ((PyBuffer_IsContiguous(&view_dest, 'C') &&
577 PyBuffer_IsContiguous(&view_src, 'C')) ||
578 (PyBuffer_IsContiguous(&view_dest, 'F') &&
579 PyBuffer_IsContiguous(&view_src, 'F'))) {
580 /* simplest copy is all that is needed */
581 memcpy(view_dest.buf, view_src.buf, view_src.len);
582 PyBuffer_Release(&view_dest);
583 PyBuffer_Release(&view_src);
584 return 0;
585 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000586
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000587 /* Otherwise a more elaborate copy scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000588
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000589 /* XXX(nnorwitz): need to check for overflow! */
590 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*view_src.ndim);
591 if (indices == NULL) {
592 PyErr_NoMemory();
593 PyBuffer_Release(&view_dest);
594 PyBuffer_Release(&view_src);
595 return -1;
596 }
597 for (k=0; k<view_src.ndim;k++) {
598 indices[k] = 0;
599 }
600 elements = 1;
601 for (k=0; k<view_src.ndim; k++) {
602 /* XXX(nnorwitz): can this overflow? */
603 elements *= view_src.shape[k];
604 }
605 while (elements--) {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000606 _Py_add_one_to_index_C(view_src.ndim, indices, view_src.shape);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000607 dptr = PyBuffer_GetPointer(&view_dest, indices);
608 sptr = PyBuffer_GetPointer(&view_src, indices);
609 memcpy(dptr, sptr, view_src.itemsize);
610 }
611 PyMem_Free(indices);
612 PyBuffer_Release(&view_dest);
613 PyBuffer_Release(&view_src);
614 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000615}
616
617void
618PyBuffer_FillContiguousStrides(int nd, Py_ssize_t *shape,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000619 Py_ssize_t *strides, int itemsize,
620 char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000621{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000622 int k;
623 Py_ssize_t sd;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000624
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000625 sd = itemsize;
626 if (fort == 'F') {
627 for (k=0; k<nd; k++) {
628 strides[k] = sd;
629 sd *= shape[k];
630 }
631 }
632 else {
633 for (k=nd-1; k>=0; k--) {
634 strides[k] = sd;
635 sd *= shape[k];
636 }
637 }
638 return;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000639}
640
641int
Martin v. Löwis423be952008-08-13 15:53:07 +0000642PyBuffer_FillInfo(Py_buffer *view, PyObject *obj, void *buf, Py_ssize_t len,
Stefan Krah4e141742012-03-06 15:27:31 +0100643 int readonly, int flags)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000644{
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100645 if (view == NULL) return 0; /* XXX why not -1? */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000646 if (((flags & PyBUF_WRITABLE) == PyBUF_WRITABLE) &&
647 (readonly == 1)) {
648 PyErr_SetString(PyExc_BufferError,
649 "Object is not writable.");
650 return -1;
651 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000652
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000653 view->obj = obj;
654 if (obj)
655 Py_INCREF(obj);
656 view->buf = buf;
657 view->len = len;
658 view->readonly = readonly;
659 view->itemsize = 1;
660 view->format = NULL;
661 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT)
662 view->format = "B";
663 view->ndim = 1;
664 view->shape = NULL;
665 if ((flags & PyBUF_ND) == PyBUF_ND)
666 view->shape = &(view->len);
667 view->strides = NULL;
668 if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES)
669 view->strides = &(view->itemsize);
670 view->suboffsets = NULL;
671 view->internal = NULL;
672 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000673}
674
Martin v. Löwis423be952008-08-13 15:53:07 +0000675void
676PyBuffer_Release(Py_buffer *view)
677{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000678 PyObject *obj = view->obj;
679 if (obj && Py_TYPE(obj)->tp_as_buffer && Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer)
680 Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer(obj, view);
681 Py_XDECREF(obj);
682 view->obj = NULL;
Martin v. Löwis423be952008-08-13 15:53:07 +0000683}
684
Eric Smith8fd3eba2008-02-17 19:48:00 +0000685PyObject *
686PyObject_Format(PyObject *obj, PyObject *format_spec)
687{
Eric Smith8fd3eba2008-02-17 19:48:00 +0000688 PyObject *meth;
689 PyObject *empty = NULL;
690 PyObject *result = NULL;
Benjamin Petersonce798522012-01-22 11:24:29 -0500691 _Py_IDENTIFIER(__format__);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000692
693 /* If no format_spec is provided, use an empty string */
694 if (format_spec == NULL) {
Victor Stinner9d3b93b2011-11-22 02:27:30 +0100695 empty = PyUnicode_New(0, 0);
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000696 format_spec = empty;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000697 }
698
Eric Smith8fd3eba2008-02-17 19:48:00 +0000699 /* Find the (unbound!) __format__ method (a borrowed reference) */
Benjamin Petersonce798522012-01-22 11:24:29 -0500700 meth = _PyObject_LookupSpecial(obj, &PyId___format__);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000701 if (meth == NULL) {
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000702 if (!PyErr_Occurred())
703 PyErr_Format(PyExc_TypeError,
704 "Type %.100s doesn't define __format__",
705 Py_TYPE(obj)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000706 goto done;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000707 }
708
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000709 /* And call it. */
710 result = PyObject_CallFunctionObjArgs(meth, format_spec, NULL);
Benjamin Peterson6f889ad32010-06-05 02:11:45 +0000711 Py_DECREF(meth);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000712
713 if (result && !PyUnicode_Check(result)) {
Ethan Furmanb95b5612015-01-23 20:05:18 -0800714 PyErr_Format(PyExc_TypeError,
715 "__format__ must return a str, not %.200s",
716 Py_TYPE(result)->tp_name);
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000717 Py_DECREF(result);
718 result = NULL;
719 goto done;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000720 }
721
722done:
723 Py_XDECREF(empty);
724 return result;
725}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000726/* Operations on numbers */
727
728int
Fred Drake79912472000-07-09 04:06:11 +0000729PyNumber_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +0000730{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000731 return o && o->ob_type->tp_as_number &&
732 (o->ob_type->tp_as_number->nb_int ||
733 o->ob_type->tp_as_number->nb_float);
Guido van Rossume15dee51995-07-18 14:12:02 +0000734}
735
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000736/* Binary operators */
Guido van Rossume15dee51995-07-18 14:12:02 +0000737
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000738#define NB_SLOT(x) offsetof(PyNumberMethods, x)
739#define NB_BINOP(nb_methods, slot) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000740 (*(binaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000741#define NB_TERNOP(nb_methods, slot) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000742 (*(ternaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000743
744/*
745 Calling scheme used for binary operations:
746
Neal Norwitz4886cc32006-08-21 17:06:07 +0000747 Order operations are tried until either a valid result or error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000748 w.op(v,w)[*], v.op(v,w), w.op(v,w)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000749
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000750 [*] only when v->ob_type != w->ob_type && w->ob_type is a subclass of
751 v->ob_type
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000752 */
753
754static PyObject *
755binary_op1(PyObject *v, PyObject *w, const int op_slot)
Guido van Rossume15dee51995-07-18 14:12:02 +0000756{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000757 PyObject *x;
758 binaryfunc slotv = NULL;
759 binaryfunc slotw = NULL;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000760
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000761 if (v->ob_type->tp_as_number != NULL)
762 slotv = NB_BINOP(v->ob_type->tp_as_number, op_slot);
763 if (w->ob_type != v->ob_type &&
764 w->ob_type->tp_as_number != NULL) {
765 slotw = NB_BINOP(w->ob_type->tp_as_number, op_slot);
766 if (slotw == slotv)
767 slotw = NULL;
768 }
769 if (slotv) {
770 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
771 x = slotw(v, w);
772 if (x != Py_NotImplemented)
773 return x;
774 Py_DECREF(x); /* can't do it */
775 slotw = NULL;
776 }
777 x = slotv(v, w);
778 if (x != Py_NotImplemented)
779 return x;
780 Py_DECREF(x); /* can't do it */
781 }
782 if (slotw) {
783 x = slotw(v, w);
784 if (x != Py_NotImplemented)
785 return x;
786 Py_DECREF(x); /* can't do it */
787 }
Brian Curtindfc80e32011-08-10 20:28:54 -0500788 Py_RETURN_NOTIMPLEMENTED;
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000789}
Guido van Rossum77660912002-04-16 16:32:50 +0000790
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000791static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000792binop_type_error(PyObject *v, PyObject *w, const char *op_name)
793{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000794 PyErr_Format(PyExc_TypeError,
795 "unsupported operand type(s) for %.100s: "
796 "'%.100s' and '%.100s'",
797 op_name,
798 v->ob_type->tp_name,
799 w->ob_type->tp_name);
800 return NULL;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000801}
802
803static PyObject *
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000804binary_op(PyObject *v, PyObject *w, const int op_slot, const char *op_name)
805{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000806 PyObject *result = binary_op1(v, w, op_slot);
807 if (result == Py_NotImplemented) {
808 Py_DECREF(result);
809 return binop_type_error(v, w, op_name);
810 }
811 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000812}
813
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000814
815/*
816 Calling scheme used for ternary operations:
817
Neal Norwitz4886cc32006-08-21 17:06:07 +0000818 Order operations are tried until either a valid result or error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000819 v.op(v,w,z), w.op(v,w,z), z.op(v,w,z)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000820 */
821
822static PyObject *
823ternary_op(PyObject *v,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000824 PyObject *w,
825 PyObject *z,
826 const int op_slot,
827 const char *op_name)
Guido van Rossume15dee51995-07-18 14:12:02 +0000828{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000829 PyNumberMethods *mv, *mw, *mz;
830 PyObject *x = NULL;
831 ternaryfunc slotv = NULL;
832 ternaryfunc slotw = NULL;
833 ternaryfunc slotz = NULL;
Guido van Rossum77660912002-04-16 16:32:50 +0000834
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000835 mv = v->ob_type->tp_as_number;
836 mw = w->ob_type->tp_as_number;
837 if (mv != NULL)
838 slotv = NB_TERNOP(mv, op_slot);
839 if (w->ob_type != v->ob_type &&
840 mw != NULL) {
841 slotw = NB_TERNOP(mw, op_slot);
842 if (slotw == slotv)
843 slotw = NULL;
844 }
845 if (slotv) {
846 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
847 x = slotw(v, w, z);
848 if (x != Py_NotImplemented)
849 return x;
850 Py_DECREF(x); /* can't do it */
851 slotw = NULL;
852 }
853 x = slotv(v, w, z);
854 if (x != Py_NotImplemented)
855 return x;
856 Py_DECREF(x); /* can't do it */
857 }
858 if (slotw) {
859 x = slotw(v, w, z);
860 if (x != Py_NotImplemented)
861 return x;
862 Py_DECREF(x); /* can't do it */
863 }
864 mz = z->ob_type->tp_as_number;
865 if (mz != NULL) {
866 slotz = NB_TERNOP(mz, op_slot);
867 if (slotz == slotv || slotz == slotw)
868 slotz = NULL;
869 if (slotz) {
870 x = slotz(v, w, z);
871 if (x != Py_NotImplemented)
872 return x;
873 Py_DECREF(x); /* can't do it */
874 }
875 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000876
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000877 if (z == Py_None)
878 PyErr_Format(
879 PyExc_TypeError,
880 "unsupported operand type(s) for ** or pow(): "
881 "'%.100s' and '%.100s'",
882 v->ob_type->tp_name,
883 w->ob_type->tp_name);
884 else
885 PyErr_Format(
886 PyExc_TypeError,
887 "unsupported operand type(s) for pow(): "
888 "'%.100s', '%.100s', '%.100s'",
889 v->ob_type->tp_name,
890 w->ob_type->tp_name,
891 z->ob_type->tp_name);
892 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000893}
894
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000895#define BINARY_FUNC(func, op, op_name) \
896 PyObject * \
897 func(PyObject *v, PyObject *w) { \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000898 return binary_op(v, w, NB_SLOT(op), op_name); \
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000899 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000900
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000901BINARY_FUNC(PyNumber_Or, nb_or, "|")
902BINARY_FUNC(PyNumber_Xor, nb_xor, "^")
903BINARY_FUNC(PyNumber_And, nb_and, "&")
904BINARY_FUNC(PyNumber_Lshift, nb_lshift, "<<")
905BINARY_FUNC(PyNumber_Rshift, nb_rshift, ">>")
906BINARY_FUNC(PyNumber_Subtract, nb_subtract, "-")
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000907BINARY_FUNC(PyNumber_Divmod, nb_divmod, "divmod()")
Guido van Rossume15dee51995-07-18 14:12:02 +0000908
909PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000910PyNumber_Add(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000911{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000912 PyObject *result = binary_op1(v, w, NB_SLOT(nb_add));
913 if (result == Py_NotImplemented) {
914 PySequenceMethods *m = v->ob_type->tp_as_sequence;
915 Py_DECREF(result);
916 if (m && m->sq_concat) {
917 return (*m->sq_concat)(v, w);
918 }
919 result = binop_type_error(v, w, "+");
920 }
921 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000922}
923
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000924static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000925sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000926{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000927 Py_ssize_t count;
928 if (PyIndex_Check(n)) {
929 count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
930 if (count == -1 && PyErr_Occurred())
931 return NULL;
932 }
933 else {
934 return type_error("can't multiply sequence by "
935 "non-int of type '%.200s'", n);
936 }
937 return (*repeatfunc)(seq, count);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000938}
939
940PyObject *
941PyNumber_Multiply(PyObject *v, PyObject *w)
942{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000943 PyObject *result = binary_op1(v, w, NB_SLOT(nb_multiply));
944 if (result == Py_NotImplemented) {
945 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
946 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
947 Py_DECREF(result);
948 if (mv && mv->sq_repeat) {
949 return sequence_repeat(mv->sq_repeat, v, w);
950 }
951 else if (mw && mw->sq_repeat) {
952 return sequence_repeat(mw->sq_repeat, w, v);
953 }
954 result = binop_type_error(v, w, "*");
955 }
956 return result;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000957}
958
Guido van Rossume15dee51995-07-18 14:12:02 +0000959PyObject *
Benjamin Petersond51374e2014-04-09 23:55:56 -0400960PyNumber_MatrixMultiply(PyObject *v, PyObject *w)
961{
962 return binary_op(v, w, NB_SLOT(nb_matrix_multiply), "@");
963}
964
965PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +0000966PyNumber_FloorDivide(PyObject *v, PyObject *w)
967{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000968 return binary_op(v, w, NB_SLOT(nb_floor_divide), "//");
Guido van Rossum4668b002001-08-08 05:00:18 +0000969}
970
971PyObject *
972PyNumber_TrueDivide(PyObject *v, PyObject *w)
973{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000974 return binary_op(v, w, NB_SLOT(nb_true_divide), "/");
Guido van Rossum4668b002001-08-08 05:00:18 +0000975}
976
977PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000978PyNumber_Remainder(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000979{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000980 return binary_op(v, w, NB_SLOT(nb_remainder), "%");
Guido van Rossume15dee51995-07-18 14:12:02 +0000981}
982
983PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000984PyNumber_Power(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossume15dee51995-07-18 14:12:02 +0000985{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000986 return ternary_op(v, w, z, NB_SLOT(nb_power), "** or pow()");
Guido van Rossume15dee51995-07-18 14:12:02 +0000987}
988
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000989/* Binary in-place operators */
990
991/* The in-place operators are defined to fall back to the 'normal',
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000992 non in-place operations, if the in-place methods are not in place.
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000993
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000994 - If the left hand object has the appropriate struct members, and
995 they are filled, call the appropriate function and return the
996 result. No coercion is done on the arguments; the left-hand object
997 is the one the operation is performed on, and it's up to the
998 function to deal with the right-hand object.
Guido van Rossum77660912002-04-16 16:32:50 +0000999
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001000 - Otherwise, in-place modification is not supported. Handle it exactly as
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001001 a non in-place operation of the same kind.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001002
1003 */
1004
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001005static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001006binary_iop1(PyObject *v, PyObject *w, const int iop_slot, const int op_slot)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001007{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001008 PyNumberMethods *mv = v->ob_type->tp_as_number;
1009 if (mv != NULL) {
1010 binaryfunc slot = NB_BINOP(mv, iop_slot);
1011 if (slot) {
1012 PyObject *x = (slot)(v, w);
1013 if (x != Py_NotImplemented) {
1014 return x;
1015 }
1016 Py_DECREF(x);
1017 }
1018 }
1019 return binary_op1(v, w, op_slot);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001020}
1021
1022static PyObject *
1023binary_iop(PyObject *v, PyObject *w, const int iop_slot, const int op_slot,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001024 const char *op_name)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001025{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001026 PyObject *result = binary_iop1(v, w, iop_slot, op_slot);
1027 if (result == Py_NotImplemented) {
1028 Py_DECREF(result);
1029 return binop_type_error(v, w, op_name);
1030 }
1031 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001032}
1033
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001034#define INPLACE_BINOP(func, iop, op, op_name) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001035 PyObject * \
1036 func(PyObject *v, PyObject *w) { \
1037 return binary_iop(v, w, NB_SLOT(iop), NB_SLOT(op), op_name); \
1038 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001039
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001040INPLACE_BINOP(PyNumber_InPlaceOr, nb_inplace_or, nb_or, "|=")
1041INPLACE_BINOP(PyNumber_InPlaceXor, nb_inplace_xor, nb_xor, "^=")
1042INPLACE_BINOP(PyNumber_InPlaceAnd, nb_inplace_and, nb_and, "&=")
1043INPLACE_BINOP(PyNumber_InPlaceLshift, nb_inplace_lshift, nb_lshift, "<<=")
1044INPLACE_BINOP(PyNumber_InPlaceRshift, nb_inplace_rshift, nb_rshift, ">>=")
1045INPLACE_BINOP(PyNumber_InPlaceSubtract, nb_inplace_subtract, nb_subtract, "-=")
Benjamin Petersond51374e2014-04-09 23:55:56 -04001046INPLACE_BINOP(PyNumber_InMatrixMultiply, nb_inplace_matrix_multiply, nb_matrix_multiply, "@=")
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001047
1048PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001049PyNumber_InPlaceFloorDivide(PyObject *v, PyObject *w)
1050{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001051 return binary_iop(v, w, NB_SLOT(nb_inplace_floor_divide),
1052 NB_SLOT(nb_floor_divide), "//=");
Guido van Rossum4668b002001-08-08 05:00:18 +00001053}
1054
1055PyObject *
1056PyNumber_InPlaceTrueDivide(PyObject *v, PyObject *w)
1057{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001058 return binary_iop(v, w, NB_SLOT(nb_inplace_true_divide),
1059 NB_SLOT(nb_true_divide), "/=");
Guido van Rossum4668b002001-08-08 05:00:18 +00001060}
1061
1062PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001063PyNumber_InPlaceAdd(PyObject *v, PyObject *w)
1064{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001065 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_add),
1066 NB_SLOT(nb_add));
1067 if (result == Py_NotImplemented) {
1068 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1069 Py_DECREF(result);
1070 if (m != NULL) {
1071 binaryfunc f = NULL;
1072 f = m->sq_inplace_concat;
1073 if (f == NULL)
1074 f = m->sq_concat;
1075 if (f != NULL)
1076 return (*f)(v, w);
1077 }
1078 result = binop_type_error(v, w, "+=");
1079 }
1080 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001081}
1082
1083PyObject *
1084PyNumber_InPlaceMultiply(PyObject *v, PyObject *w)
1085{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001086 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_multiply),
1087 NB_SLOT(nb_multiply));
1088 if (result == Py_NotImplemented) {
1089 ssizeargfunc f = NULL;
1090 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1091 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1092 Py_DECREF(result);
1093 if (mv != NULL) {
1094 f = mv->sq_inplace_repeat;
1095 if (f == NULL)
1096 f = mv->sq_repeat;
1097 if (f != NULL)
1098 return sequence_repeat(f, v, w);
1099 }
1100 else if (mw != NULL) {
1101 /* Note that the right hand operand should not be
1102 * mutated in this case so sq_inplace_repeat is not
1103 * used. */
1104 if (mw->sq_repeat)
1105 return sequence_repeat(mw->sq_repeat, w, v);
1106 }
1107 result = binop_type_error(v, w, "*=");
1108 }
1109 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001110}
1111
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001112PyObject *
Benjamin Petersond51374e2014-04-09 23:55:56 -04001113PyNumber_InPlaceMatrixMultiply(PyObject *v, PyObject *w)
1114{
1115 return binary_iop(v, w, NB_SLOT(nb_inplace_matrix_multiply),
1116 NB_SLOT(nb_matrix_multiply), "@=");
1117}
1118
1119PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001120PyNumber_InPlaceRemainder(PyObject *v, PyObject *w)
1121{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001122 return binary_iop(v, w, NB_SLOT(nb_inplace_remainder),
1123 NB_SLOT(nb_remainder), "%=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001124}
1125
1126PyObject *
1127PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
1128{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001129 if (v->ob_type->tp_as_number &&
1130 v->ob_type->tp_as_number->nb_inplace_power != NULL) {
1131 return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
1132 }
1133 else {
1134 return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
1135 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001136}
1137
1138
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001139/* Unary operators and functions */
Guido van Rossume15dee51995-07-18 14:12:02 +00001140
1141PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001142PyNumber_Negative(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001143{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001144 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001145
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001146 if (o == NULL)
1147 return null_error();
1148 m = o->ob_type->tp_as_number;
1149 if (m && m->nb_negative)
1150 return (*m->nb_negative)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001151
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001152 return type_error("bad operand type for unary -: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001153}
1154
1155PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001156PyNumber_Positive(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001157{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001158 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001159
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001160 if (o == NULL)
1161 return null_error();
1162 m = o->ob_type->tp_as_number;
1163 if (m && m->nb_positive)
1164 return (*m->nb_positive)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001165
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001166 return type_error("bad operand type for unary +: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001167}
1168
1169PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001170PyNumber_Invert(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001171{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001172 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001173
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001174 if (o == NULL)
1175 return null_error();
1176 m = o->ob_type->tp_as_number;
1177 if (m && m->nb_invert)
1178 return (*m->nb_invert)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001179
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001180 return type_error("bad operand type for unary ~: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001181}
1182
1183PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001184PyNumber_Absolute(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001185{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001186 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001187
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001188 if (o == NULL)
1189 return null_error();
1190 m = o->ob_type->tp_as_number;
1191 if (m && m->nb_absolute)
1192 return m->nb_absolute(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001193
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001194 return type_error("bad operand type for abs(): '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001195}
1196
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001197/* Return a Python int from the object item.
Serhiy Storchaka95949422013-08-27 19:40:23 +03001198 Raise TypeError if the result is not an int
Guido van Rossum98297ee2007-11-06 21:34:58 +00001199 or if the object cannot be interpreted as an index.
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001200*/
1201PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001202PyNumber_Index(PyObject *item)
1203{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001204 PyObject *result = NULL;
1205 if (item == NULL)
1206 return null_error();
1207 if (PyLong_Check(item)) {
1208 Py_INCREF(item);
1209 return item;
1210 }
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001211 if (!PyIndex_Check(item)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001212 PyErr_Format(PyExc_TypeError,
1213 "'%.200s' object cannot be interpreted "
1214 "as an integer", item->ob_type->tp_name);
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001215 return NULL;
1216 }
1217 result = item->ob_type->tp_as_number->nb_index(item);
1218 if (!result || PyLong_CheckExact(result))
1219 return result;
1220 if (!PyLong_Check(result)) {
1221 PyErr_Format(PyExc_TypeError,
1222 "__index__ returned non-int (type %.200s)",
1223 result->ob_type->tp_name);
1224 Py_DECREF(result);
1225 return NULL;
1226 }
1227 /* Issue #17576: warn if 'result' not of exact type int. */
1228 if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
1229 "__index__ returned non-int (type %.200s). "
1230 "The ability to return an instance of a strict subclass of int "
1231 "is deprecated, and may be removed in a future version of Python.",
1232 result->ob_type->tp_name)) {
1233 Py_DECREF(result);
1234 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001235 }
1236 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001237}
1238
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001239/* Return an error on Overflow only if err is not NULL*/
1240
1241Py_ssize_t
1242PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1243{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001244 Py_ssize_t result;
1245 PyObject *runerr;
1246 PyObject *value = PyNumber_Index(item);
1247 if (value == NULL)
1248 return -1;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001249
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001250 /* We're done if PyLong_AsSsize_t() returns without error. */
1251 result = PyLong_AsSsize_t(value);
1252 if (result != -1 || !(runerr = PyErr_Occurred()))
1253 goto finish;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001254
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001255 /* Error handling code -- only manage OverflowError differently */
1256 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
1257 goto finish;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001258
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001259 PyErr_Clear();
1260 /* If no error-handling desired then the default clipping
1261 is sufficient.
1262 */
1263 if (!err) {
1264 assert(PyLong_Check(value));
1265 /* Whether or not it is less than or equal to
1266 zero is determined by the sign of ob_size
1267 */
1268 if (_PyLong_Sign(value) < 0)
1269 result = PY_SSIZE_T_MIN;
1270 else
1271 result = PY_SSIZE_T_MAX;
1272 }
1273 else {
1274 /* Otherwise replace the error with caller's error object. */
1275 PyErr_Format(err,
1276 "cannot fit '%.200s' into an index-sized integer",
1277 item->ob_type->tp_name);
1278 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001279
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001280 finish:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001281 Py_DECREF(value);
1282 return result;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001283}
1284
1285
Guido van Rossume15dee51995-07-18 14:12:02 +00001286PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001287PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001288{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001289 PyNumberMethods *m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001290 PyObject *trunc_func;
1291 const char *buffer;
1292 Py_ssize_t buffer_len;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04001293 _Py_IDENTIFIER(__trunc__);
Christian Heimes15ebc882008-02-04 18:48:49 +00001294
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001295 if (o == NULL)
1296 return null_error();
1297 if (PyLong_CheckExact(o)) {
1298 Py_INCREF(o);
1299 return o;
1300 }
1301 m = o->ob_type->tp_as_number;
1302 if (m && m->nb_int) { /* This should include subclasses of int */
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001303 return (PyObject *)_PyLong_FromNbInt(o);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001304 }
Benjamin Peterson1b1a8e72012-03-20 23:48:11 -04001305 trunc_func = _PyObject_LookupSpecial(o, &PyId___trunc__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001306 if (trunc_func) {
1307 PyObject *truncated = PyEval_CallObject(trunc_func, NULL);
1308 PyObject *int_instance;
1309 Py_DECREF(trunc_func);
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001310 if (truncated == NULL || PyLong_Check(truncated))
1311 return truncated;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001312 /* __trunc__ is specified to return an Integral type,
Benjamin Peterson520e8502012-03-21 14:51:14 -04001313 but int() needs to return a int. */
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001314 m = truncated->ob_type->tp_as_number;
1315 if (m == NULL || m->nb_int == NULL) {
1316 PyErr_Format(
1317 PyExc_TypeError,
1318 "__trunc__ returned non-Integral (type %.200s)",
1319 truncated->ob_type->tp_name);
1320 Py_DECREF(truncated);
1321 return NULL;
1322 }
1323 int_instance = (PyObject *)_PyLong_FromNbInt(truncated);
1324 Py_DECREF(truncated);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001325 return int_instance;
1326 }
Benjamin Peterson1b1a8e72012-03-20 23:48:11 -04001327 if (PyErr_Occurred())
1328 return NULL;
Christian Heimes15ebc882008-02-04 18:48:49 +00001329
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001330 if (PyBytes_Check(o))
1331 /* need to do extra error checking that PyLong_FromString()
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03001332 * doesn't do. In particular int('9\x005') must raise an
1333 * exception, not truncate at the null.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001334 */
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03001335 return _PyLong_FromBytes(PyBytes_AS_STRING(o),
1336 PyBytes_GET_SIZE(o), 10);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001337 if (PyUnicode_Check(o))
1338 /* The above check is done in PyLong_FromUnicode(). */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001339 return PyLong_FromUnicodeObject(o, 10);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001340 if (!PyObject_AsCharBuffer(o, &buffer, &buffer_len))
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03001341 return _PyLong_FromBytes(buffer, buffer_len, 10);
Guido van Rossume15dee51995-07-18 14:12:02 +00001342
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001343 return type_error("int() argument must be a string or a "
1344 "number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001345}
1346
1347PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001348PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001349{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001350 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001351
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001352 if (o == NULL)
1353 return null_error();
1354 m = o->ob_type->tp_as_number;
1355 if (m && m->nb_float) { /* This should include subclasses of float */
1356 PyObject *res = m->nb_float(o);
1357 if (res && !PyFloat_Check(res)) {
1358 PyErr_Format(PyExc_TypeError,
1359 "__float__ returned non-float (type %.200s)",
1360 res->ob_type->tp_name);
1361 Py_DECREF(res);
1362 return NULL;
1363 }
1364 return res;
1365 }
1366 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
1367 PyFloatObject *po = (PyFloatObject *)o;
1368 return PyFloat_FromDouble(po->ob_fval);
1369 }
1370 return PyFloat_FromString(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001371}
1372
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001373
1374PyObject *
1375PyNumber_ToBase(PyObject *n, int base)
1376{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001377 PyObject *res = NULL;
1378 PyObject *index = PyNumber_Index(n);
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001379
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001380 if (!index)
1381 return NULL;
1382 if (PyLong_Check(index))
1383 res = _PyLong_Format(index, base);
1384 else
1385 /* It should not be possible to get here, as
1386 PyNumber_Index already has a check for the same
1387 condition */
Serhiy Storchaka95949422013-08-27 19:40:23 +03001388 PyErr_SetString(PyExc_ValueError, "PyNumber_ToBase: index not int");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001389 Py_DECREF(index);
1390 return res;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001391}
1392
1393
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001394/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001395
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001396int
Fred Drake79912472000-07-09 04:06:11 +00001397PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001398{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001399 if (PyDict_Check(s))
1400 return 0;
1401 return s != NULL && s->ob_type->tp_as_sequence &&
1402 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001403}
1404
Martin v. Löwis18e16552006-02-15 17:27:45 +00001405Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001406PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001407{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001408 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001409
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001410 if (s == NULL) {
1411 null_error();
1412 return -1;
1413 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001414
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001415 m = s->ob_type->tp_as_sequence;
1416 if (m && m->sq_length)
1417 return m->sq_length(s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001418
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001419 type_error("object of type '%.200s' has no len()", s);
1420 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001421}
1422
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001423#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001424Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001425PySequence_Length(PyObject *s)
1426{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001427 return PySequence_Size(s);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001428}
1429#define PySequence_Length PySequence_Size
1430
Guido van Rossume15dee51995-07-18 14:12:02 +00001431PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001432PySequence_Concat(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001433{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001434 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001436 if (s == NULL || o == NULL)
1437 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001438
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001439 m = s->ob_type->tp_as_sequence;
1440 if (m && m->sq_concat)
1441 return m->sq_concat(s, o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001442
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001443 /* Instances of user classes defining an __add__() method only
1444 have an nb_add slot, not an sq_concat slot. So we fall back
1445 to nb_add if both arguments appear to be sequences. */
1446 if (PySequence_Check(s) && PySequence_Check(o)) {
1447 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1448 if (result != Py_NotImplemented)
1449 return result;
1450 Py_DECREF(result);
1451 }
1452 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001453}
1454
1455PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001456PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001457{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001458 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001460 if (o == NULL)
1461 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001462
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001463 m = o->ob_type->tp_as_sequence;
1464 if (m && m->sq_repeat)
1465 return m->sq_repeat(o, count);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001466
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001467 /* Instances of user classes defining a __mul__() method only
1468 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1469 to nb_multiply if o appears to be a sequence. */
1470 if (PySequence_Check(o)) {
1471 PyObject *n, *result;
1472 n = PyLong_FromSsize_t(count);
1473 if (n == NULL)
1474 return NULL;
1475 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1476 Py_DECREF(n);
1477 if (result != Py_NotImplemented)
1478 return result;
1479 Py_DECREF(result);
1480 }
1481 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001482}
1483
1484PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001485PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1486{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001487 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001488
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001489 if (s == NULL || o == NULL)
1490 return null_error();
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001491
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001492 m = s->ob_type->tp_as_sequence;
1493 if (m && m->sq_inplace_concat)
1494 return m->sq_inplace_concat(s, o);
1495 if (m && m->sq_concat)
1496 return m->sq_concat(s, o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001497
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001498 if (PySequence_Check(s) && PySequence_Check(o)) {
1499 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1500 NB_SLOT(nb_add));
1501 if (result != Py_NotImplemented)
1502 return result;
1503 Py_DECREF(result);
1504 }
1505 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001506}
1507
1508PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001509PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001510{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001511 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001512
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001513 if (o == NULL)
1514 return null_error();
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001515
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001516 m = o->ob_type->tp_as_sequence;
1517 if (m && m->sq_inplace_repeat)
1518 return m->sq_inplace_repeat(o, count);
1519 if (m && m->sq_repeat)
1520 return m->sq_repeat(o, count);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001521
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001522 if (PySequence_Check(o)) {
1523 PyObject *n, *result;
1524 n = PyLong_FromSsize_t(count);
1525 if (n == NULL)
1526 return NULL;
1527 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1528 NB_SLOT(nb_multiply));
1529 Py_DECREF(n);
1530 if (result != Py_NotImplemented)
1531 return result;
1532 Py_DECREF(result);
1533 }
1534 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001535}
1536
1537PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001538PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001539{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001540 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001541
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001542 if (s == NULL)
1543 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001544
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001545 m = s->ob_type->tp_as_sequence;
1546 if (m && m->sq_item) {
1547 if (i < 0) {
1548 if (m->sq_length) {
1549 Py_ssize_t l = (*m->sq_length)(s);
1550 if (l < 0)
1551 return NULL;
1552 i += l;
1553 }
1554 }
1555 return m->sq_item(s, i);
1556 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001557
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001558 return type_error("'%.200s' object does not support indexing", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001559}
1560
1561PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001562PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00001563{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001564 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001565
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001566 if (!s) return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001567
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001568 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001569 if (mp && mp->mp_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001570 PyObject *res;
1571 PyObject *slice = _PySlice_FromIndices(i1, i2);
1572 if (!slice)
1573 return NULL;
1574 res = mp->mp_subscript(s, slice);
1575 Py_DECREF(slice);
1576 return res;
1577 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001578
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001579 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001580}
1581
1582int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001583PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001584{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001585 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001586
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001587 if (s == NULL) {
1588 null_error();
1589 return -1;
1590 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001591
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001592 m = s->ob_type->tp_as_sequence;
1593 if (m && m->sq_ass_item) {
1594 if (i < 0) {
1595 if (m->sq_length) {
1596 Py_ssize_t l = (*m->sq_length)(s);
1597 if (l < 0)
1598 return -1;
1599 i += l;
1600 }
1601 }
1602 return m->sq_ass_item(s, i, o);
1603 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001604
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001605 type_error("'%.200s' object does not support item assignment", s);
1606 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001607}
1608
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001609int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001610PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001611{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001612 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001613
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001614 if (s == NULL) {
1615 null_error();
1616 return -1;
1617 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001619 m = s->ob_type->tp_as_sequence;
1620 if (m && m->sq_ass_item) {
1621 if (i < 0) {
1622 if (m->sq_length) {
1623 Py_ssize_t l = (*m->sq_length)(s);
1624 if (l < 0)
1625 return -1;
1626 i += l;
1627 }
1628 }
1629 return m->sq_ass_item(s, i, (PyObject *)NULL);
1630 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001631
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001632 type_error("'%.200s' object doesn't support item deletion", s);
1633 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001634}
1635
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001636int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001637PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001638{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001639 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001640
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001641 if (s == NULL) {
1642 null_error();
1643 return -1;
1644 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001645
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001646 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001647 if (mp && mp->mp_ass_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001648 int res;
1649 PyObject *slice = _PySlice_FromIndices(i1, i2);
1650 if (!slice)
1651 return -1;
1652 res = mp->mp_ass_subscript(s, slice, o);
1653 Py_DECREF(slice);
1654 return res;
1655 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00001656
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001657 type_error("'%.200s' object doesn't support slice assignment", s);
1658 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001659}
1660
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001661int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001662PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001663{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001664 PyMappingMethods *mp;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001665
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001666 if (s == NULL) {
1667 null_error();
1668 return -1;
1669 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001670
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001671 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001672 if (mp && mp->mp_ass_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001673 int res;
1674 PyObject *slice = _PySlice_FromIndices(i1, i2);
1675 if (!slice)
1676 return -1;
1677 res = mp->mp_ass_subscript(s, slice, NULL);
1678 Py_DECREF(slice);
1679 return res;
1680 }
1681 type_error("'%.200s' object doesn't support slice deletion", s);
1682 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001683}
1684
Guido van Rossume15dee51995-07-18 14:12:02 +00001685PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001686PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00001687{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001688 PyObject *it; /* iter(v) */
1689 Py_ssize_t n; /* guess for result tuple size */
1690 PyObject *result = NULL;
1691 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00001692
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001693 if (v == NULL)
1694 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001695
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001696 /* Special-case the common tuple and list cases, for efficiency. */
1697 if (PyTuple_CheckExact(v)) {
1698 /* Note that we can't know whether it's safe to return
1699 a tuple *subclass* instance as-is, hence the restriction
1700 to exact tuples here. In contrast, lists always make
1701 a copy, so there's no need for exactness below. */
1702 Py_INCREF(v);
1703 return v;
1704 }
1705 if (PyList_Check(v))
1706 return PyList_AsTuple(v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001707
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001708 /* Get iterator. */
1709 it = PyObject_GetIter(v);
1710 if (it == NULL)
1711 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001712
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001713 /* Guess result size and allocate space. */
Armin Ronacheraa9a79d2012-10-06 14:03:24 +02001714 n = PyObject_LengthHint(v, 10);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001715 if (n == -1)
1716 goto Fail;
1717 result = PyTuple_New(n);
1718 if (result == NULL)
1719 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001720
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001721 /* Fill the tuple. */
1722 for (j = 0; ; ++j) {
1723 PyObject *item = PyIter_Next(it);
1724 if (item == NULL) {
1725 if (PyErr_Occurred())
1726 goto Fail;
1727 break;
1728 }
1729 if (j >= n) {
1730 Py_ssize_t oldn = n;
1731 /* The over-allocation strategy can grow a bit faster
1732 than for lists because unlike lists the
1733 over-allocation isn't permanent -- we reclaim
1734 the excess before the end of this routine.
1735 So, grow by ten and then add 25%.
1736 */
1737 n += 10;
1738 n += n >> 2;
1739 if (n < oldn) {
1740 /* Check for overflow */
1741 PyErr_NoMemory();
1742 Py_DECREF(item);
1743 goto Fail;
1744 }
1745 if (_PyTuple_Resize(&result, n) != 0) {
1746 Py_DECREF(item);
1747 goto Fail;
1748 }
1749 }
1750 PyTuple_SET_ITEM(result, j, item);
1751 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001752
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001753 /* Cut tuple back if guess was too large. */
1754 if (j < n &&
1755 _PyTuple_Resize(&result, j) != 0)
1756 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001757
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001758 Py_DECREF(it);
1759 return result;
Tim Peters6912d4d2001-05-05 03:56:37 +00001760
1761Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001762 Py_XDECREF(result);
1763 Py_DECREF(it);
1764 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001765}
1766
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001767PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001768PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001769{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001770 PyObject *result; /* result list */
1771 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00001772
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001773 if (v == NULL)
1774 return null_error();
Guido van Rossum5dba9e81998-07-10 18:03:50 +00001775
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001776 result = PyList_New(0);
1777 if (result == NULL)
1778 return NULL;
Tim Petersf553f892001-05-01 20:45:31 +00001779
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001780 rv = _PyList_Extend((PyListObject *)result, v);
1781 if (rv == NULL) {
1782 Py_DECREF(result);
1783 return NULL;
1784 }
1785 Py_DECREF(rv);
1786 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001787}
1788
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001789PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001790PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001791{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001792 PyObject *it;
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001793
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001794 if (v == NULL)
1795 return null_error();
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001796
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001797 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
1798 Py_INCREF(v);
1799 return v;
1800 }
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001801
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001802 it = PyObject_GetIter(v);
1803 if (it == NULL) {
1804 if (PyErr_ExceptionMatches(PyExc_TypeError))
1805 PyErr_SetString(PyExc_TypeError, m);
1806 return NULL;
1807 }
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001808
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001809 v = PySequence_List(it);
1810 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001811
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001812 return v;
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001813}
1814
Tim Peters16a77ad2001-09-08 04:00:12 +00001815/* Iterate over seq. Result depends on the operation:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001816 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
1817 PY_ITERSEARCH_INDEX: 0-based index of first occurrence of obj in seq;
1818 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00001819 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
1820*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001821Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001822_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00001823{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001824 Py_ssize_t n;
1825 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
1826 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00001827
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001828 if (seq == NULL || obj == NULL) {
1829 null_error();
1830 return -1;
1831 }
Tim Peters75f8e352001-05-05 11:33:43 +00001832
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001833 it = PyObject_GetIter(seq);
1834 if (it == NULL) {
1835 type_error("argument of type '%.200s' is not iterable", seq);
1836 return -1;
1837 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001838
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001839 n = wrapped = 0;
1840 for (;;) {
1841 int cmp;
1842 PyObject *item = PyIter_Next(it);
1843 if (item == NULL) {
1844 if (PyErr_Occurred())
1845 goto Fail;
1846 break;
1847 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001848
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001849 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
1850 Py_DECREF(item);
1851 if (cmp < 0)
1852 goto Fail;
1853 if (cmp > 0) {
1854 switch (operation) {
1855 case PY_ITERSEARCH_COUNT:
1856 if (n == PY_SSIZE_T_MAX) {
1857 PyErr_SetString(PyExc_OverflowError,
1858 "count exceeds C integer size");
1859 goto Fail;
1860 }
1861 ++n;
1862 break;
Tim Peters16a77ad2001-09-08 04:00:12 +00001863
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001864 case PY_ITERSEARCH_INDEX:
1865 if (wrapped) {
1866 PyErr_SetString(PyExc_OverflowError,
1867 "index exceeds C integer size");
1868 goto Fail;
1869 }
1870 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001871
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001872 case PY_ITERSEARCH_CONTAINS:
1873 n = 1;
1874 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001875
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001876 default:
1877 assert(!"unknown operation");
1878 }
1879 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001880
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001881 if (operation == PY_ITERSEARCH_INDEX) {
1882 if (n == PY_SSIZE_T_MAX)
1883 wrapped = 1;
1884 ++n;
1885 }
1886 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001887
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001888 if (operation != PY_ITERSEARCH_INDEX)
1889 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001890
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001891 PyErr_SetString(PyExc_ValueError,
1892 "sequence.index(x): x not in sequence");
1893 /* fall into failure code */
Tim Peters16a77ad2001-09-08 04:00:12 +00001894Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001895 n = -1;
1896 /* fall through */
Tim Peters16a77ad2001-09-08 04:00:12 +00001897Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001898 Py_DECREF(it);
1899 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00001900
Guido van Rossume15dee51995-07-18 14:12:02 +00001901}
1902
Tim Peters16a77ad2001-09-08 04:00:12 +00001903/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001904Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001905PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001906{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001907 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00001908}
1909
Tim Peterscb8d3682001-05-05 21:05:01 +00001910/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00001911 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00001912 */
1913int
1914PySequence_Contains(PyObject *seq, PyObject *ob)
1915{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001916 Py_ssize_t result;
1917 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
1918 if (sqm != NULL && sqm->sq_contains != NULL)
1919 return (*sqm->sq_contains)(seq, ob);
1920 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
1921 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00001922}
1923
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001924/* Backwards compatibility */
1925#undef PySequence_In
1926int
Fred Drake79912472000-07-09 04:06:11 +00001927PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001928{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001929 return PySequence_Contains(w, v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001930}
1931
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001932Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00001933PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001934{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001935 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00001936}
1937
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001938/* Operations on mappings */
1939
1940int
Fred Drake79912472000-07-09 04:06:11 +00001941PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001942{
Benjamin Peterson21992272011-12-28 12:01:31 -06001943 return o && o->ob_type->tp_as_mapping &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001944 o->ob_type->tp_as_mapping->mp_subscript;
Guido van Rossume15dee51995-07-18 14:12:02 +00001945}
1946
Martin v. Löwis18e16552006-02-15 17:27:45 +00001947Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001948PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001949{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001950 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001951
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001952 if (o == NULL) {
1953 null_error();
1954 return -1;
1955 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001956
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001957 m = o->ob_type->tp_as_mapping;
1958 if (m && m->mp_length)
1959 return m->mp_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001960
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001961 type_error("object of type '%.200s' has no len()", o);
1962 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001963}
1964
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001965#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001966Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001967PyMapping_Length(PyObject *o)
1968{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001969 return PyMapping_Size(o);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001970}
1971#define PyMapping_Length PyMapping_Size
1972
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001973PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +03001974PyMapping_GetItemString(PyObject *o, const char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001975{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001976 PyObject *okey, *r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001977
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001978 if (key == NULL)
1979 return null_error();
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001980
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001981 okey = PyUnicode_FromString(key);
1982 if (okey == NULL)
1983 return NULL;
1984 r = PyObject_GetItem(o, okey);
1985 Py_DECREF(okey);
1986 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001987}
1988
1989int
Serhiy Storchakac6792272013-10-19 21:03:34 +03001990PyMapping_SetItemString(PyObject *o, const char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001991{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001992 PyObject *okey;
1993 int r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001994
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001995 if (key == NULL) {
1996 null_error();
1997 return -1;
1998 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001999
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002000 okey = PyUnicode_FromString(key);
2001 if (okey == NULL)
2002 return -1;
2003 r = PyObject_SetItem(o, okey, value);
2004 Py_DECREF(okey);
2005 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002006}
2007
2008int
Serhiy Storchakac6792272013-10-19 21:03:34 +03002009PyMapping_HasKeyString(PyObject *o, const char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002010{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002011 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002012
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002013 v = PyMapping_GetItemString(o, key);
2014 if (v) {
2015 Py_DECREF(v);
2016 return 1;
2017 }
2018 PyErr_Clear();
2019 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002020}
2021
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002022int
Fred Drake79912472000-07-09 04:06:11 +00002023PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002024{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002025 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002026
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002027 v = PyObject_GetItem(o, key);
2028 if (v) {
2029 Py_DECREF(v);
2030 return 1;
2031 }
2032 PyErr_Clear();
2033 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002034}
2035
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002036PyObject *
2037PyMapping_Keys(PyObject *o)
2038{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002039 PyObject *keys;
2040 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002041 _Py_IDENTIFIER(keys);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002042
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002043 if (PyDict_CheckExact(o))
2044 return PyDict_Keys(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002045 keys = _PyObject_CallMethodId(o, &PyId_keys, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002046 if (keys == NULL)
2047 return NULL;
2048 fast = PySequence_Fast(keys, "o.keys() are not iterable");
2049 Py_DECREF(keys);
2050 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002051}
2052
2053PyObject *
2054PyMapping_Items(PyObject *o)
2055{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002056 PyObject *items;
2057 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002058 _Py_IDENTIFIER(items);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002060 if (PyDict_CheckExact(o))
2061 return PyDict_Items(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002062 items = _PyObject_CallMethodId(o, &PyId_items, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002063 if (items == NULL)
2064 return NULL;
2065 fast = PySequence_Fast(items, "o.items() are not iterable");
2066 Py_DECREF(items);
2067 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002068}
2069
2070PyObject *
2071PyMapping_Values(PyObject *o)
2072{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002073 PyObject *values;
2074 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002075 _Py_IDENTIFIER(values);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002076
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002077 if (PyDict_CheckExact(o))
2078 return PyDict_Values(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002079 values = _PyObject_CallMethodId(o, &PyId_values, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002080 if (values == NULL)
2081 return NULL;
2082 fast = PySequence_Fast(values, "o.values() are not iterable");
2083 Py_DECREF(values);
2084 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002085}
2086
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002087/* Operations on callable objects */
2088
2089/* XXX PyCallable_Check() is in object.c */
2090
Guido van Rossume15dee51995-07-18 14:12:02 +00002091PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002092PyObject_CallObject(PyObject *o, PyObject *a)
Guido van Rossume15dee51995-07-18 14:12:02 +00002093{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002094 return PyEval_CallObjectWithKeywords(o, a, NULL);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002095}
Guido van Rossume15dee51995-07-18 14:12:02 +00002096
2097PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002098PyObject_Call(PyObject *func, PyObject *arg, PyObject *kw)
2099{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002100 ternaryfunc call;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002101
Victor Stinner8f4ec8d2014-09-05 01:10:29 +02002102 /* PyObject_Call() must not be called with an exception set,
2103 because it may clear it (directly or indirectly) and so the
2104 caller looses its exception */
2105 assert(!PyErr_Occurred());
2106
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002107 if ((call = func->ob_type->tp_call) != NULL) {
2108 PyObject *result;
2109 if (Py_EnterRecursiveCall(" while calling a Python object"))
2110 return NULL;
2111 result = (*call)(func, arg, kw);
2112 Py_LeaveRecursiveCall();
Victor Stinner3de58692013-07-15 17:50:07 +02002113#ifdef NDEBUG
2114 if (result == NULL && !PyErr_Occurred()) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002115 PyErr_SetString(
2116 PyExc_SystemError,
2117 "NULL result without error in PyObject_Call");
Victor Stinner3de58692013-07-15 17:50:07 +02002118 }
2119#else
Victor Stinner4ac9c002013-12-19 13:47:35 +01002120 assert((result != NULL && !PyErr_Occurred())
2121 || (result == NULL && PyErr_Occurred()));
Victor Stinner3de58692013-07-15 17:50:07 +02002122#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002123 return result;
2124 }
2125 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
2126 func->ob_type->tp_name);
2127 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002128}
2129
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002130static PyObject*
2131call_function_tail(PyObject *callable, PyObject *args)
2132{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002133 PyObject *retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002134
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002135 if (args == NULL)
2136 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002137
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002138 if (!PyTuple_Check(args)) {
2139 PyObject *a;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002140
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002141 a = PyTuple_New(1);
2142 if (a == NULL) {
2143 Py_DECREF(args);
2144 return NULL;
2145 }
2146 PyTuple_SET_ITEM(a, 0, args);
2147 args = a;
2148 }
2149 retval = PyObject_Call(callable, args, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002150
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002151 Py_DECREF(args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002152
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002153 return retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002154}
2155
Tim Peters6d6c1a32001-08-02 04:15:00 +00002156PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002157PyObject_CallFunction(PyObject *callable, const char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002158{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002159 va_list va;
2160 PyObject *args;
Guido van Rossume15dee51995-07-18 14:12:02 +00002161
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002162 if (callable == NULL)
2163 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002164
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002165 if (format && *format) {
2166 va_start(va, format);
2167 args = Py_VaBuildValue(format, va);
2168 va_end(va);
2169 }
2170 else
2171 args = PyTuple_New(0);
Victor Stinner0b0c8672013-10-29 19:29:52 +01002172 if (args == NULL)
2173 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002174
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002175 return call_function_tail(callable, args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002176}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002177
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002178PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002179_PyObject_CallFunction_SizeT(PyObject *callable, const char *format, ...)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002180{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002181 va_list va;
2182 PyObject *args;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002184 if (callable == NULL)
2185 return null_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002186
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002187 if (format && *format) {
2188 va_start(va, format);
2189 args = _Py_VaBuildValue_SizeT(format, va);
2190 va_end(va);
2191 }
2192 else
2193 args = PyTuple_New(0);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002194
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002195 return call_function_tail(callable, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002196}
2197
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002198static PyObject*
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002199callmethod(PyObject* func, const char *format, va_list va, int is_size_t)
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002200{
2201 PyObject *retval = NULL;
2202 PyObject *args;
2203
2204 if (!PyCallable_Check(func)) {
2205 type_error("attribute of type '%.200s' is not callable", func);
2206 goto exit;
2207 }
2208
2209 if (format && *format) {
2210 if (is_size_t)
2211 args = _Py_VaBuildValue_SizeT(format, va);
2212 else
2213 args = Py_VaBuildValue(format, va);
2214 }
2215 else
2216 args = PyTuple_New(0);
2217
2218 retval = call_function_tail(func, args);
2219
2220 exit:
2221 /* args gets consumed in call_function_tail */
2222 Py_XDECREF(func);
2223
2224 return retval;
2225}
2226
Guido van Rossume15dee51995-07-18 14:12:02 +00002227PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002228PyObject_CallMethod(PyObject *o, const char *name, const char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002229{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002230 va_list va;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002231 PyObject *func = NULL;
2232 PyObject *retval = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002233
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002234 if (o == NULL || name == NULL)
2235 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002236
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002237 func = PyObject_GetAttrString(o, name);
Benjamin Peterson1791c222014-06-26 23:29:13 -07002238 if (func == NULL)
2239 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002240
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002241 va_start(va, format);
2242 retval = callmethod(func, format, va, 0);
2243 va_end(va);
2244 return retval;
2245}
2246
2247PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002248_PyObject_CallMethodId(PyObject *o, _Py_Identifier *name,
2249 const char *format, ...)
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002250{
2251 va_list va;
2252 PyObject *func = NULL;
2253 PyObject *retval = NULL;
2254
2255 if (o == NULL || name == NULL)
2256 return null_error();
2257
2258 func = _PyObject_GetAttrId(o, name);
Benjamin Peterson1791c222014-06-26 23:29:13 -07002259 if (func == NULL)
2260 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002261
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002262 va_start(va, format);
2263 retval = callmethod(func, format, va, 0);
2264 va_end(va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002265 return retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002266}
2267
2268PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002269_PyObject_CallMethod_SizeT(PyObject *o, const char *name,
2270 const char *format, ...)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002271{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002272 va_list va;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002273 PyObject *func = NULL;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002274 PyObject *retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002275
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002276 if (o == NULL || name == NULL)
2277 return null_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002278
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002279 func = PyObject_GetAttrString(o, name);
Benjamin Peterson1791c222014-06-26 23:29:13 -07002280 if (func == NULL)
2281 return NULL;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002282 va_start(va, format);
2283 retval = callmethod(func, format, va, 1);
2284 va_end(va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002285 return retval;
Guido van Rossume15dee51995-07-18 14:12:02 +00002286}
Guido van Rossum823649d2001-03-21 18:40:58 +00002287
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002288PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002289_PyObject_CallMethodId_SizeT(PyObject *o, _Py_Identifier *name,
2290 const char *format, ...)
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002291{
2292 va_list va;
2293 PyObject *func = NULL;
2294 PyObject *retval;
2295
2296 if (o == NULL || name == NULL)
2297 return null_error();
2298
2299 func = _PyObject_GetAttrId(o, name);
2300 if (func == NULL) {
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002301 return NULL;
2302 }
2303 va_start(va, format);
2304 retval = callmethod(func, format, va, 1);
2305 va_end(va);
2306 return retval;
2307}
Guido van Rossum823649d2001-03-21 18:40:58 +00002308
Fred Drakeb421b8c2001-10-26 16:21:32 +00002309static PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002310objargs_mktuple(va_list va)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002311{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002312 int i, n = 0;
2313 va_list countva;
2314 PyObject *result, *tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002315
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00002316 Py_VA_COPY(countva, va);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002317
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002318 while (((PyObject *)va_arg(countva, PyObject *)) != NULL)
2319 ++n;
2320 result = PyTuple_New(n);
2321 if (result != NULL && n > 0) {
2322 for (i = 0; i < n; ++i) {
2323 tmp = (PyObject *)va_arg(va, PyObject *);
2324 PyTuple_SET_ITEM(result, i, tmp);
2325 Py_INCREF(tmp);
2326 }
2327 }
2328 return result;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002329}
2330
2331PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002332PyObject_CallMethodObjArgs(PyObject *callable, PyObject *name, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002333{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002334 PyObject *args, *tmp;
2335 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002336
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002337 if (callable == NULL || name == NULL)
2338 return null_error();
Fred Drakeb421b8c2001-10-26 16:21:32 +00002339
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002340 callable = PyObject_GetAttr(callable, name);
2341 if (callable == NULL)
2342 return NULL;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002343
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002344 /* count the args */
2345 va_start(vargs, name);
2346 args = objargs_mktuple(vargs);
2347 va_end(vargs);
2348 if (args == NULL) {
2349 Py_DECREF(callable);
2350 return NULL;
2351 }
2352 tmp = PyObject_Call(callable, args, NULL);
2353 Py_DECREF(args);
2354 Py_DECREF(callable);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002355
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002356 return tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002357}
2358
2359PyObject *
Alexandre Vassalotti865eaa12013-05-02 10:44:04 -07002360_PyObject_CallMethodIdObjArgs(PyObject *callable,
Brett Cannonfd074152012-04-14 14:10:13 -04002361 struct _Py_Identifier *name, ...)
2362{
2363 PyObject *args, *tmp;
2364 va_list vargs;
2365
2366 if (callable == NULL || name == NULL)
2367 return null_error();
2368
2369 callable = _PyObject_GetAttrId(callable, name);
2370 if (callable == NULL)
2371 return NULL;
2372
2373 /* count the args */
2374 va_start(vargs, name);
2375 args = objargs_mktuple(vargs);
2376 va_end(vargs);
2377 if (args == NULL) {
2378 Py_DECREF(callable);
2379 return NULL;
2380 }
2381 tmp = PyObject_Call(callable, args, NULL);
2382 Py_DECREF(args);
2383 Py_DECREF(callable);
2384
2385 return tmp;
2386}
2387
2388PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002389PyObject_CallFunctionObjArgs(PyObject *callable, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002390{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002391 PyObject *args, *tmp;
2392 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002393
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002394 if (callable == NULL)
2395 return null_error();
Fred Drakeb421b8c2001-10-26 16:21:32 +00002396
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002397 /* count the args */
2398 va_start(vargs, callable);
2399 args = objargs_mktuple(vargs);
2400 va_end(vargs);
2401 if (args == NULL)
2402 return NULL;
2403 tmp = PyObject_Call(callable, args, NULL);
2404 Py_DECREF(args);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002406 return tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002407}
2408
2409
Guido van Rossum823649d2001-03-21 18:40:58 +00002410/* isinstance(), issubclass() */
2411
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002412/* abstract_get_bases() has logically 4 return states:
Barry Warsawf16951c2002-04-23 22:45:44 +00002413 *
Barry Warsawf16951c2002-04-23 22:45:44 +00002414 * 1. getattr(cls, '__bases__') could raise an AttributeError
2415 * 2. getattr(cls, '__bases__') could raise some other exception
2416 * 3. getattr(cls, '__bases__') could return a tuple
2417 * 4. getattr(cls, '__bases__') could return something other than a tuple
2418 *
2419 * Only state #3 is a non-error state and only it returns a non-NULL object
2420 * (it returns the retrieved tuple).
2421 *
2422 * Any raised AttributeErrors are masked by clearing the exception and
2423 * returning NULL. If an object other than a tuple comes out of __bases__,
2424 * then again, the return value is NULL. So yes, these two situations
2425 * produce exactly the same results: NULL is returned and no error is set.
2426 *
2427 * If some exception other than AttributeError is raised, then NULL is also
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002428 * returned, but the exception is not cleared. That's because we want the
Barry Warsawf16951c2002-04-23 22:45:44 +00002429 * exception to be propagated along.
2430 *
2431 * Callers are expected to test for PyErr_Occurred() when the return value
2432 * is NULL to decide whether a valid exception should be propagated or not.
2433 * When there's no exception to propagate, it's customary for the caller to
2434 * set a TypeError.
2435 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002436static PyObject *
2437abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002438{
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002439 _Py_IDENTIFIER(__bases__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002440 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002441
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002442 Py_ALLOW_RECURSION
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002443 bases = _PyObject_GetAttrId(cls, &PyId___bases__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002444 Py_END_ALLOW_RECURSION
2445 if (bases == NULL) {
2446 if (PyErr_ExceptionMatches(PyExc_AttributeError))
2447 PyErr_Clear();
2448 return NULL;
2449 }
2450 if (!PyTuple_Check(bases)) {
2451 Py_DECREF(bases);
2452 return NULL;
2453 }
2454 return bases;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002455}
2456
2457
2458static int
2459abstract_issubclass(PyObject *derived, PyObject *cls)
2460{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002461 PyObject *bases = NULL;
2462 Py_ssize_t i, n;
2463 int r = 0;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002464
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002465 while (1) {
2466 if (derived == cls)
2467 return 1;
2468 bases = abstract_get_bases(derived);
2469 if (bases == NULL) {
2470 if (PyErr_Occurred())
2471 return -1;
2472 return 0;
2473 }
2474 n = PyTuple_GET_SIZE(bases);
2475 if (n == 0) {
2476 Py_DECREF(bases);
2477 return 0;
2478 }
2479 /* Avoid recursivity in the single inheritance case */
2480 if (n == 1) {
2481 derived = PyTuple_GET_ITEM(bases, 0);
2482 Py_DECREF(bases);
2483 continue;
2484 }
2485 for (i = 0; i < n; i++) {
2486 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
2487 if (r != 0)
2488 break;
2489 }
2490 Py_DECREF(bases);
2491 return r;
2492 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002493}
2494
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002495static int
2496check_class(PyObject *cls, const char *error)
2497{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002498 PyObject *bases = abstract_get_bases(cls);
2499 if (bases == NULL) {
2500 /* Do not mask errors. */
2501 if (!PyErr_Occurred())
2502 PyErr_SetString(PyExc_TypeError, error);
2503 return 0;
2504 }
2505 Py_DECREF(bases);
2506 return -1;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002507}
2508
Brett Cannon4f653312004-03-20 22:52:14 +00002509static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002510recursive_isinstance(PyObject *inst, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002511{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002512 PyObject *icls;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002513 int retval = 0;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002514 _Py_IDENTIFIER(__class__);
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002515
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002516 if (PyType_Check(cls)) {
2517 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
2518 if (retval == 0) {
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002519 PyObject *c = _PyObject_GetAttrId(inst, &PyId___class__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002520 if (c == NULL) {
Benjamin Peterson72288d42010-11-20 17:21:08 +00002521 if (PyErr_ExceptionMatches(PyExc_AttributeError))
R. David Murray6bb99892010-11-20 16:33:30 +00002522 PyErr_Clear();
Benjamin Peterson72288d42010-11-20 17:21:08 +00002523 else
R. David Murray6bb99892010-11-20 16:33:30 +00002524 retval = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002525 }
2526 else {
2527 if (c != (PyObject *)(inst->ob_type) &&
2528 PyType_Check(c))
2529 retval = PyType_IsSubtype(
2530 (PyTypeObject *)c,
2531 (PyTypeObject *)cls);
2532 Py_DECREF(c);
2533 }
2534 }
2535 }
2536 else {
2537 if (!check_class(cls,
Benjamin Petersone893af52010-06-28 19:43:42 +00002538 "isinstance() arg 2 must be a type or tuple of types"))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002539 return -1;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002540 icls = _PyObject_GetAttrId(inst, &PyId___class__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002541 if (icls == NULL) {
Benjamin Peterson72288d42010-11-20 17:21:08 +00002542 if (PyErr_ExceptionMatches(PyExc_AttributeError))
R. David Murray6bb99892010-11-20 16:33:30 +00002543 PyErr_Clear();
Benjamin Peterson72288d42010-11-20 17:21:08 +00002544 else
R. David Murray6bb99892010-11-20 16:33:30 +00002545 retval = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002546 }
2547 else {
2548 retval = abstract_issubclass(icls, cls);
2549 Py_DECREF(icls);
2550 }
2551 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002552
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002553 return retval;
Guido van Rossum823649d2001-03-21 18:40:58 +00002554}
2555
2556int
Brett Cannon4f653312004-03-20 22:52:14 +00002557PyObject_IsInstance(PyObject *inst, PyObject *cls)
2558{
Benjamin Petersonce798522012-01-22 11:24:29 -05002559 _Py_IDENTIFIER(__instancecheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002560 PyObject *checker;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002561
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002562 /* Quick test for an exact match */
2563 if (Py_TYPE(inst) == (PyTypeObject *)cls)
2564 return 1;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002565
Georg Brandl72b8a802014-10-03 09:26:37 +02002566 /* We know what type's __instancecheck__ does. */
2567 if (PyType_CheckExact(cls)) {
2568 return recursive_isinstance(inst, cls);
2569 }
2570
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002571 if (PyTuple_Check(cls)) {
2572 Py_ssize_t i;
2573 Py_ssize_t n;
2574 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002575
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002576 if (Py_EnterRecursiveCall(" in __instancecheck__"))
2577 return -1;
2578 n = PyTuple_GET_SIZE(cls);
2579 for (i = 0; i < n; ++i) {
2580 PyObject *item = PyTuple_GET_ITEM(cls, i);
2581 r = PyObject_IsInstance(inst, item);
2582 if (r != 0)
2583 /* either found it, or got an error */
2584 break;
2585 }
2586 Py_LeaveRecursiveCall();
2587 return r;
2588 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002589
Benjamin Petersonce798522012-01-22 11:24:29 -05002590 checker = _PyObject_LookupSpecial(cls, &PyId___instancecheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002591 if (checker != NULL) {
2592 PyObject *res;
2593 int ok = -1;
2594 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2595 Py_DECREF(checker);
2596 return ok;
2597 }
2598 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
2599 Py_LeaveRecursiveCall();
2600 Py_DECREF(checker);
2601 if (res != NULL) {
2602 ok = PyObject_IsTrue(res);
2603 Py_DECREF(res);
2604 }
2605 return ok;
2606 }
2607 else if (PyErr_Occurred())
2608 return -1;
Georg Brandl72b8a802014-10-03 09:26:37 +02002609 /* Probably never reached anymore. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002610 return recursive_isinstance(inst, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002611}
2612
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002613static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002614recursive_issubclass(PyObject *derived, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002615{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002616 if (PyType_Check(cls) && PyType_Check(derived)) {
2617 /* Fast path (non-recursive) */
2618 return PyType_IsSubtype((PyTypeObject *)derived, (PyTypeObject *)cls);
2619 }
2620 if (!check_class(derived,
2621 "issubclass() arg 1 must be a class"))
2622 return -1;
2623 if (!check_class(cls,
2624 "issubclass() arg 2 must be a class"
2625 " or tuple of classes"))
2626 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002628 return abstract_issubclass(derived, cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002629}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002630
Brett Cannon4f653312004-03-20 22:52:14 +00002631int
2632PyObject_IsSubclass(PyObject *derived, PyObject *cls)
2633{
Benjamin Petersonce798522012-01-22 11:24:29 -05002634 _Py_IDENTIFIER(__subclasscheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002635 PyObject *checker;
Georg Brandldcfe8e42009-05-17 08:22:45 +00002636
Georg Brandl72b8a802014-10-03 09:26:37 +02002637 /* We know what type's __subclasscheck__ does. */
2638 if (PyType_CheckExact(cls)) {
2639 /* Quick test for an exact match */
2640 if (derived == cls)
2641 return 1;
2642 return recursive_issubclass(derived, cls);
2643 }
2644
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002645 if (PyTuple_Check(cls)) {
2646 Py_ssize_t i;
2647 Py_ssize_t n;
2648 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002649
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002650 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
2651 return -1;
2652 n = PyTuple_GET_SIZE(cls);
2653 for (i = 0; i < n; ++i) {
2654 PyObject *item = PyTuple_GET_ITEM(cls, i);
2655 r = PyObject_IsSubclass(derived, item);
2656 if (r != 0)
2657 /* either found it, or got an error */
2658 break;
2659 }
2660 Py_LeaveRecursiveCall();
2661 return r;
2662 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002663
Benjamin Petersonce798522012-01-22 11:24:29 -05002664 checker = _PyObject_LookupSpecial(cls, &PyId___subclasscheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002665 if (checker != NULL) {
2666 PyObject *res;
2667 int ok = -1;
2668 if (Py_EnterRecursiveCall(" in __subclasscheck__")) {
2669 Py_DECREF(checker);
2670 return ok;
2671 }
2672 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
2673 Py_LeaveRecursiveCall();
2674 Py_DECREF(checker);
2675 if (res != NULL) {
2676 ok = PyObject_IsTrue(res);
2677 Py_DECREF(res);
2678 }
2679 return ok;
2680 }
2681 else if (PyErr_Occurred())
2682 return -1;
Georg Brandl72b8a802014-10-03 09:26:37 +02002683 /* Probably never reached anymore. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002684 return recursive_issubclass(derived, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00002685}
2686
2687int
2688_PyObject_RealIsInstance(PyObject *inst, PyObject *cls)
2689{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002690 return recursive_isinstance(inst, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00002691}
2692
2693int
2694_PyObject_RealIsSubclass(PyObject *derived, PyObject *cls)
2695{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002696 return recursive_issubclass(derived, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002697}
2698
2699
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002700PyObject *
2701PyObject_GetIter(PyObject *o)
2702{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002703 PyTypeObject *t = o->ob_type;
2704 getiterfunc f = NULL;
2705 f = t->tp_iter;
2706 if (f == NULL) {
2707 if (PySequence_Check(o))
2708 return PySeqIter_New(o);
2709 return type_error("'%.200s' object is not iterable", o);
2710 }
2711 else {
2712 PyObject *res = (*f)(o);
2713 if (res != NULL && !PyIter_Check(res)) {
2714 PyErr_Format(PyExc_TypeError,
2715 "iter() returned non-iterator "
2716 "of type '%.100s'",
2717 res->ob_type->tp_name);
2718 Py_DECREF(res);
2719 res = NULL;
2720 }
2721 return res;
2722 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00002723}
2724
Tim Petersf4848da2001-05-05 00:14:56 +00002725/* Return next item.
2726 * If an error occurs, return NULL. PyErr_Occurred() will be true.
2727 * If the iteration terminates normally, return NULL and clear the
2728 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
2729 * will be false.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002730 * Else return the next object. PyErr_Occurred() will be false.
Tim Petersf4848da2001-05-05 00:14:56 +00002731 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002732PyObject *
2733PyIter_Next(PyObject *iter)
2734{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002735 PyObject *result;
2736 result = (*iter->ob_type->tp_iternext)(iter);
2737 if (result == NULL &&
2738 PyErr_Occurred() &&
2739 PyErr_ExceptionMatches(PyExc_StopIteration))
2740 PyErr_Clear();
2741 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002742}
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002743
2744
2745/*
2746 * Flatten a sequence of bytes() objects into a C array of
2747 * NULL terminated string pointers with a NULL char* terminating the array.
2748 * (ie: an argv or env list)
2749 *
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002750 * Memory allocated for the returned list is allocated using PyMem_Malloc()
2751 * and MUST be freed by _Py_FreeCharPArray().
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002752 */
2753char *const *
2754_PySequence_BytesToCharpArray(PyObject* self)
2755{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002756 char **array;
2757 Py_ssize_t i, argc;
2758 PyObject *item = NULL;
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002759 Py_ssize_t size;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002760
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002761 argc = PySequence_Size(self);
2762 if (argc == -1)
2763 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002764
Stefan Krah7cacd2e2012-08-21 08:16:09 +02002765 assert(argc >= 0);
2766
2767 if ((size_t)argc > (PY_SSIZE_T_MAX-sizeof(char *)) / sizeof(char *)) {
2768 PyErr_NoMemory();
2769 return NULL;
2770 }
2771
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002772 array = PyMem_Malloc((argc + 1) * sizeof(char *));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002773 if (array == NULL) {
2774 PyErr_NoMemory();
2775 return NULL;
2776 }
2777 for (i = 0; i < argc; ++i) {
2778 char *data;
2779 item = PySequence_GetItem(self, i);
Stefan Krahfd24f9e2012-08-20 11:04:24 +02002780 if (item == NULL) {
2781 /* NULL terminate before freeing. */
2782 array[i] = NULL;
2783 goto fail;
2784 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002785 data = PyBytes_AsString(item);
2786 if (data == NULL) {
2787 /* NULL terminate before freeing. */
2788 array[i] = NULL;
2789 goto fail;
2790 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002791 size = PyBytes_GET_SIZE(item) + 1;
2792 array[i] = PyMem_Malloc(size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002793 if (!array[i]) {
2794 PyErr_NoMemory();
2795 goto fail;
2796 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002797 memcpy(array[i], data, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002798 Py_DECREF(item);
2799 }
2800 array[argc] = NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002801
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002802 return array;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002803
2804fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002805 Py_XDECREF(item);
2806 _Py_FreeCharPArray(array);
2807 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002808}
2809
2810
2811/* Free's a NULL terminated char** array of C strings. */
2812void
2813_Py_FreeCharPArray(char *const array[])
2814{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002815 Py_ssize_t i;
2816 for (i = 0; array[i] != NULL; ++i) {
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002817 PyMem_Free(array[i]);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002818 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002819 PyMem_Free((void*)array);
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002820}