blob: 88205bd0ce73caf78b6c2d1a5d20d422c0de9ff0 [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{
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200253 return PyObject_AsReadBuffer(obj, (const void **)buffer, buffer_len);
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000254}
Guido van Rossum4c08d552000-03-10 22:55:18 +0000255
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000256int
257PyObject_CheckReadBuffer(PyObject *obj)
258{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000259 PyBufferProcs *pb = obj->ob_type->tp_as_buffer;
260 Py_buffer view;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000261
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000262 if (pb == NULL ||
263 pb->bf_getbuffer == NULL)
264 return 0;
265 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE) == -1) {
266 PyErr_Clear();
267 return 0;
268 }
269 PyBuffer_Release(&view);
270 return 1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000271}
272
273int PyObject_AsReadBuffer(PyObject *obj,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000274 const void **buffer,
275 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000276{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000277 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000278
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000279 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
280 null_error();
281 return -1;
282 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200283 if (PyObject_GetBuffer(obj, &view, PyBUF_SIMPLE) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000284 return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000285
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000286 *buffer = view.buf;
287 *buffer_len = view.len;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200288 PyBuffer_Release(&view);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000289 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000290}
291
292int PyObject_AsWriteBuffer(PyObject *obj,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000293 void **buffer,
294 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000295{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000296 PyBufferProcs *pb;
297 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000298
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000299 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
300 null_error();
301 return -1;
302 }
303 pb = obj->ob_type->tp_as_buffer;
304 if (pb == NULL ||
305 pb->bf_getbuffer == NULL ||
306 ((*pb->bf_getbuffer)(obj, &view, PyBUF_WRITABLE) != 0)) {
307 PyErr_SetString(PyExc_TypeError,
R David Murray861470c2014-10-05 11:47:01 -0400308 "expected a writable 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 *buffer = view.buf;
313 *buffer_len = view.len;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200314 PyBuffer_Release(&view);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000315 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000316}
317
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000318/* Buffer C-API for Python 3.0 */
319
320int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000321PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000322{
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200323 PyBufferProcs *pb = obj->ob_type->tp_as_buffer;
324
325 if (pb == NULL || pb->bf_getbuffer == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000326 PyErr_Format(PyExc_TypeError,
R David Murray861470c2014-10-05 11:47:01 -0400327 "a bytes-like object is required, not '%.100s'",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000328 Py_TYPE(obj)->tp_name);
329 return -1;
330 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200331 return (*pb->bf_getbuffer)(obj, view, flags);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000332}
333
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000334static int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100335_IsFortranContiguous(const Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000336{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000337 Py_ssize_t sd, dim;
338 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000339
Stefan Krah363af442015-02-01 14:53:54 +0100340 /* 1) len = product(shape) * itemsize
341 2) itemsize > 0
342 3) len = 0 <==> exists i: shape[i] = 0 */
343 if (view->len == 0) return 1;
344 if (view->strides == NULL) { /* C-contiguous by definition */
345 /* Trivially F-contiguous */
346 if (view->ndim <= 1) return 1;
347
348 /* ndim > 1 implies shape != NULL */
349 assert(view->shape != NULL);
350
351 /* Effectively 1-d */
352 sd = 0;
353 for (i=0; i<view->ndim; i++) {
354 if (view->shape[i] > 1) sd += 1;
355 }
356 return sd <= 1;
357 }
358
359 /* strides != NULL implies both of these */
360 assert(view->ndim > 0);
361 assert(view->shape != NULL);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000362
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000363 sd = view->itemsize;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000364 for (i=0; i<view->ndim; i++) {
365 dim = view->shape[i];
Stefan Krah363af442015-02-01 14:53:54 +0100366 if (dim > 1 && view->strides[i] != sd) {
367 return 0;
368 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000369 sd *= dim;
370 }
371 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000372}
373
374static int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100375_IsCContiguous(const Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000376{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000377 Py_ssize_t sd, dim;
378 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000379
Stefan Krah363af442015-02-01 14:53:54 +0100380 /* 1) len = product(shape) * itemsize
381 2) itemsize > 0
382 3) len = 0 <==> exists i: shape[i] = 0 */
383 if (view->len == 0) return 1;
384 if (view->strides == NULL) return 1; /* C-contiguous by definition */
385
386 /* strides != NULL implies both of these */
387 assert(view->ndim > 0);
388 assert(view->shape != NULL);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000389
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000390 sd = view->itemsize;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000391 for (i=view->ndim-1; i>=0; i--) {
392 dim = view->shape[i];
Stefan Krah363af442015-02-01 14:53:54 +0100393 if (dim > 1 && view->strides[i] != sd) {
394 return 0;
395 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000396 sd *= dim;
397 }
398 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000399}
400
401int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100402PyBuffer_IsContiguous(const Py_buffer *view, char order)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000403{
404
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000405 if (view->suboffsets != NULL) return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000406
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100407 if (order == 'C')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000408 return _IsCContiguous(view);
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100409 else if (order == 'F')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000410 return _IsFortranContiguous(view);
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100411 else if (order == 'A')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000412 return (_IsCContiguous(view) || _IsFortranContiguous(view));
413 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000414}
415
416
Guido van Rossum98297ee2007-11-06 21:34:58 +0000417void*
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000418PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000419{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000420 char* pointer;
421 int i;
422 pointer = (char *)view->buf;
423 for (i = 0; i < view->ndim; i++) {
424 pointer += view->strides[i]*indices[i];
425 if ((view->suboffsets != NULL) && (view->suboffsets[i] >= 0)) {
426 pointer = *((char**)pointer) + view->suboffsets[i];
427 }
428 }
429 return (void*)pointer;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000430}
431
432
Guido van Rossum98297ee2007-11-06 21:34:58 +0000433void
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000434_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 +0000435{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000436 int k;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000438 for (k=0; k<nd; k++) {
439 if (index[k] < shape[k]-1) {
440 index[k]++;
441 break;
442 }
443 else {
444 index[k] = 0;
445 }
446 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000447}
448
Guido van Rossum98297ee2007-11-06 21:34:58 +0000449void
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000450_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 +0000451{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000452 int k;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000453
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000454 for (k=nd-1; k>=0; k--) {
455 if (index[k] < shape[k]-1) {
456 index[k]++;
457 break;
458 }
459 else {
460 index[k] = 0;
461 }
462 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000463}
464
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000465int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000466PyBuffer_FromContiguous(Py_buffer *view, void *buf, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000467{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000468 int k;
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000469 void (*addone)(int, Py_ssize_t *, const Py_ssize_t *);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000470 Py_ssize_t *indices, elements;
471 char *src, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000472
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000473 if (len > view->len) {
474 len = view->len;
475 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000476
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000477 if (PyBuffer_IsContiguous(view, fort)) {
478 /* simplest copy is all that is needed */
479 memcpy(view->buf, buf, len);
480 return 0;
481 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000482
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000483 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000484
Stefan Krah7213fcc2015-02-01 16:19:23 +0100485 /* view->ndim <= 64 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000486 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
487 if (indices == NULL) {
488 PyErr_NoMemory();
489 return -1;
490 }
491 for (k=0; k<view->ndim;k++) {
492 indices[k] = 0;
493 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000494
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000495 if (fort == 'F') {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000496 addone = _Py_add_one_to_index_F;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000497 }
498 else {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000499 addone = _Py_add_one_to_index_C;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000500 }
501 src = buf;
502 /* XXX : This is not going to be the fastest code in the world
503 several optimizations are possible.
504 */
505 elements = len / view->itemsize;
506 while (elements--) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000507 ptr = PyBuffer_GetPointer(view, indices);
508 memcpy(ptr, src, view->itemsize);
509 src += view->itemsize;
Stefan Krah7213fcc2015-02-01 16:19:23 +0100510 addone(view->ndim, indices, view->shape);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000511 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000512
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000513 PyMem_Free(indices);
514 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000515}
516
Guido van Rossum98297ee2007-11-06 21:34:58 +0000517int PyObject_CopyData(PyObject *dest, PyObject *src)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000518{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000519 Py_buffer view_dest, view_src;
520 int k;
521 Py_ssize_t *indices, elements;
522 char *dptr, *sptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000523
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000524 if (!PyObject_CheckBuffer(dest) ||
525 !PyObject_CheckBuffer(src)) {
526 PyErr_SetString(PyExc_TypeError,
R David Murray861470c2014-10-05 11:47:01 -0400527 "both destination and source must be "\
528 "bytes-like objects");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000529 return -1;
530 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000531
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000532 if (PyObject_GetBuffer(dest, &view_dest, PyBUF_FULL) != 0) return -1;
533 if (PyObject_GetBuffer(src, &view_src, PyBUF_FULL_RO) != 0) {
534 PyBuffer_Release(&view_dest);
535 return -1;
536 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000537
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000538 if (view_dest.len < view_src.len) {
539 PyErr_SetString(PyExc_BufferError,
540 "destination is too small to receive data from source");
541 PyBuffer_Release(&view_dest);
542 PyBuffer_Release(&view_src);
543 return -1;
544 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000545
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000546 if ((PyBuffer_IsContiguous(&view_dest, 'C') &&
547 PyBuffer_IsContiguous(&view_src, 'C')) ||
548 (PyBuffer_IsContiguous(&view_dest, 'F') &&
549 PyBuffer_IsContiguous(&view_src, 'F'))) {
550 /* simplest copy is all that is needed */
551 memcpy(view_dest.buf, view_src.buf, view_src.len);
552 PyBuffer_Release(&view_dest);
553 PyBuffer_Release(&view_src);
554 return 0;
555 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000556
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000557 /* Otherwise a more elaborate copy scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000558
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000559 /* XXX(nnorwitz): need to check for overflow! */
560 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*view_src.ndim);
561 if (indices == NULL) {
562 PyErr_NoMemory();
563 PyBuffer_Release(&view_dest);
564 PyBuffer_Release(&view_src);
565 return -1;
566 }
567 for (k=0; k<view_src.ndim;k++) {
568 indices[k] = 0;
569 }
570 elements = 1;
571 for (k=0; k<view_src.ndim; k++) {
572 /* XXX(nnorwitz): can this overflow? */
573 elements *= view_src.shape[k];
574 }
575 while (elements--) {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000576 _Py_add_one_to_index_C(view_src.ndim, indices, view_src.shape);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000577 dptr = PyBuffer_GetPointer(&view_dest, indices);
578 sptr = PyBuffer_GetPointer(&view_src, indices);
579 memcpy(dptr, sptr, view_src.itemsize);
580 }
581 PyMem_Free(indices);
582 PyBuffer_Release(&view_dest);
583 PyBuffer_Release(&view_src);
584 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000585}
586
587void
588PyBuffer_FillContiguousStrides(int nd, Py_ssize_t *shape,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000589 Py_ssize_t *strides, int itemsize,
590 char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000591{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000592 int k;
593 Py_ssize_t sd;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000594
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000595 sd = itemsize;
596 if (fort == 'F') {
597 for (k=0; k<nd; k++) {
598 strides[k] = sd;
599 sd *= shape[k];
600 }
601 }
602 else {
603 for (k=nd-1; k>=0; k--) {
604 strides[k] = sd;
605 sd *= shape[k];
606 }
607 }
608 return;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000609}
610
611int
Martin v. Löwis423be952008-08-13 15:53:07 +0000612PyBuffer_FillInfo(Py_buffer *view, PyObject *obj, void *buf, Py_ssize_t len,
Stefan Krah4e141742012-03-06 15:27:31 +0100613 int readonly, int flags)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000614{
Stefan Krah5178d912015-02-03 16:57:21 +0100615 if (view == NULL) {
616 PyErr_SetString(PyExc_BufferError,
617 "PyBuffer_FillInfo: view==NULL argument is obsolete");
618 return -1;
619 }
620
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000621 if (((flags & PyBUF_WRITABLE) == PyBUF_WRITABLE) &&
622 (readonly == 1)) {
623 PyErr_SetString(PyExc_BufferError,
624 "Object is not writable.");
625 return -1;
626 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000628 view->obj = obj;
629 if (obj)
630 Py_INCREF(obj);
631 view->buf = buf;
632 view->len = len;
633 view->readonly = readonly;
634 view->itemsize = 1;
635 view->format = NULL;
636 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT)
637 view->format = "B";
638 view->ndim = 1;
639 view->shape = NULL;
640 if ((flags & PyBUF_ND) == PyBUF_ND)
641 view->shape = &(view->len);
642 view->strides = NULL;
643 if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES)
644 view->strides = &(view->itemsize);
645 view->suboffsets = NULL;
646 view->internal = NULL;
647 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000648}
649
Martin v. Löwis423be952008-08-13 15:53:07 +0000650void
651PyBuffer_Release(Py_buffer *view)
652{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000653 PyObject *obj = view->obj;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200654 PyBufferProcs *pb;
655 if (obj == NULL)
656 return;
657 pb = Py_TYPE(obj)->tp_as_buffer;
658 if (pb && pb->bf_releasebuffer)
659 pb->bf_releasebuffer(obj, view);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000660 view->obj = NULL;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200661 Py_DECREF(obj);
Martin v. Löwis423be952008-08-13 15:53:07 +0000662}
663
Eric Smith8fd3eba2008-02-17 19:48:00 +0000664PyObject *
665PyObject_Format(PyObject *obj, PyObject *format_spec)
666{
Eric Smith8fd3eba2008-02-17 19:48:00 +0000667 PyObject *meth;
668 PyObject *empty = NULL;
669 PyObject *result = NULL;
Benjamin Petersonce798522012-01-22 11:24:29 -0500670 _Py_IDENTIFIER(__format__);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000671
672 /* If no format_spec is provided, use an empty string */
673 if (format_spec == NULL) {
Victor Stinner9d3b93b2011-11-22 02:27:30 +0100674 empty = PyUnicode_New(0, 0);
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000675 format_spec = empty;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000676 }
677
Eric Smith8fd3eba2008-02-17 19:48:00 +0000678 /* Find the (unbound!) __format__ method (a borrowed reference) */
Benjamin Petersonce798522012-01-22 11:24:29 -0500679 meth = _PyObject_LookupSpecial(obj, &PyId___format__);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000680 if (meth == NULL) {
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000681 if (!PyErr_Occurred())
682 PyErr_Format(PyExc_TypeError,
683 "Type %.100s doesn't define __format__",
684 Py_TYPE(obj)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000685 goto done;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000686 }
687
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000688 /* And call it. */
689 result = PyObject_CallFunctionObjArgs(meth, format_spec, NULL);
Benjamin Peterson6f889ad32010-06-05 02:11:45 +0000690 Py_DECREF(meth);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000691
692 if (result && !PyUnicode_Check(result)) {
Ethan Furmanb95b5612015-01-23 20:05:18 -0800693 PyErr_Format(PyExc_TypeError,
694 "__format__ must return a str, not %.200s",
695 Py_TYPE(result)->tp_name);
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000696 Py_DECREF(result);
697 result = NULL;
698 goto done;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000699 }
700
701done:
702 Py_XDECREF(empty);
703 return result;
704}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000705/* Operations on numbers */
706
707int
Fred Drake79912472000-07-09 04:06:11 +0000708PyNumber_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +0000709{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000710 return o && o->ob_type->tp_as_number &&
711 (o->ob_type->tp_as_number->nb_int ||
712 o->ob_type->tp_as_number->nb_float);
Guido van Rossume15dee51995-07-18 14:12:02 +0000713}
714
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000715/* Binary operators */
Guido van Rossume15dee51995-07-18 14:12:02 +0000716
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000717#define NB_SLOT(x) offsetof(PyNumberMethods, x)
718#define NB_BINOP(nb_methods, slot) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000719 (*(binaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000720#define NB_TERNOP(nb_methods, slot) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000721 (*(ternaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000722
723/*
724 Calling scheme used for binary operations:
725
Neal Norwitz4886cc32006-08-21 17:06:07 +0000726 Order operations are tried until either a valid result or error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000727 w.op(v,w)[*], v.op(v,w), w.op(v,w)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000728
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000729 [*] only when v->ob_type != w->ob_type && w->ob_type is a subclass of
730 v->ob_type
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000731 */
732
733static PyObject *
734binary_op1(PyObject *v, PyObject *w, const int op_slot)
Guido van Rossume15dee51995-07-18 14:12:02 +0000735{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000736 PyObject *x;
737 binaryfunc slotv = NULL;
738 binaryfunc slotw = NULL;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000739
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000740 if (v->ob_type->tp_as_number != NULL)
741 slotv = NB_BINOP(v->ob_type->tp_as_number, op_slot);
742 if (w->ob_type != v->ob_type &&
743 w->ob_type->tp_as_number != NULL) {
744 slotw = NB_BINOP(w->ob_type->tp_as_number, op_slot);
745 if (slotw == slotv)
746 slotw = NULL;
747 }
748 if (slotv) {
749 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
750 x = slotw(v, w);
751 if (x != Py_NotImplemented)
752 return x;
753 Py_DECREF(x); /* can't do it */
754 slotw = NULL;
755 }
756 x = slotv(v, w);
757 if (x != Py_NotImplemented)
758 return x;
759 Py_DECREF(x); /* can't do it */
760 }
761 if (slotw) {
762 x = slotw(v, w);
763 if (x != Py_NotImplemented)
764 return x;
765 Py_DECREF(x); /* can't do it */
766 }
Brian Curtindfc80e32011-08-10 20:28:54 -0500767 Py_RETURN_NOTIMPLEMENTED;
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000768}
Guido van Rossum77660912002-04-16 16:32:50 +0000769
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000770static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000771binop_type_error(PyObject *v, PyObject *w, const char *op_name)
772{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000773 PyErr_Format(PyExc_TypeError,
774 "unsupported operand type(s) for %.100s: "
775 "'%.100s' and '%.100s'",
776 op_name,
777 v->ob_type->tp_name,
778 w->ob_type->tp_name);
779 return NULL;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000780}
781
782static PyObject *
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000783binary_op(PyObject *v, PyObject *w, const int op_slot, const char *op_name)
784{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000785 PyObject *result = binary_op1(v, w, op_slot);
786 if (result == Py_NotImplemented) {
787 Py_DECREF(result);
788 return binop_type_error(v, w, op_name);
789 }
790 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000791}
792
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000793
794/*
795 Calling scheme used for ternary operations:
796
Neal Norwitz4886cc32006-08-21 17:06:07 +0000797 Order operations are tried until either a valid result or error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000798 v.op(v,w,z), w.op(v,w,z), z.op(v,w,z)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000799 */
800
801static PyObject *
802ternary_op(PyObject *v,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000803 PyObject *w,
804 PyObject *z,
805 const int op_slot,
806 const char *op_name)
Guido van Rossume15dee51995-07-18 14:12:02 +0000807{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000808 PyNumberMethods *mv, *mw, *mz;
809 PyObject *x = NULL;
810 ternaryfunc slotv = NULL;
811 ternaryfunc slotw = NULL;
812 ternaryfunc slotz = NULL;
Guido van Rossum77660912002-04-16 16:32:50 +0000813
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000814 mv = v->ob_type->tp_as_number;
815 mw = w->ob_type->tp_as_number;
816 if (mv != NULL)
817 slotv = NB_TERNOP(mv, op_slot);
818 if (w->ob_type != v->ob_type &&
819 mw != NULL) {
820 slotw = NB_TERNOP(mw, op_slot);
821 if (slotw == slotv)
822 slotw = NULL;
823 }
824 if (slotv) {
825 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
826 x = slotw(v, w, z);
827 if (x != Py_NotImplemented)
828 return x;
829 Py_DECREF(x); /* can't do it */
830 slotw = NULL;
831 }
832 x = slotv(v, w, z);
833 if (x != Py_NotImplemented)
834 return x;
835 Py_DECREF(x); /* can't do it */
836 }
837 if (slotw) {
838 x = slotw(v, w, z);
839 if (x != Py_NotImplemented)
840 return x;
841 Py_DECREF(x); /* can't do it */
842 }
843 mz = z->ob_type->tp_as_number;
844 if (mz != NULL) {
845 slotz = NB_TERNOP(mz, op_slot);
846 if (slotz == slotv || slotz == slotw)
847 slotz = NULL;
848 if (slotz) {
849 x = slotz(v, w, z);
850 if (x != Py_NotImplemented)
851 return x;
852 Py_DECREF(x); /* can't do it */
853 }
854 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000855
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000856 if (z == Py_None)
857 PyErr_Format(
858 PyExc_TypeError,
859 "unsupported operand type(s) for ** or pow(): "
860 "'%.100s' and '%.100s'",
861 v->ob_type->tp_name,
862 w->ob_type->tp_name);
863 else
864 PyErr_Format(
865 PyExc_TypeError,
866 "unsupported operand type(s) for pow(): "
867 "'%.100s', '%.100s', '%.100s'",
868 v->ob_type->tp_name,
869 w->ob_type->tp_name,
870 z->ob_type->tp_name);
871 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000872}
873
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000874#define BINARY_FUNC(func, op, op_name) \
875 PyObject * \
876 func(PyObject *v, PyObject *w) { \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000877 return binary_op(v, w, NB_SLOT(op), op_name); \
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000878 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000879
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000880BINARY_FUNC(PyNumber_Or, nb_or, "|")
881BINARY_FUNC(PyNumber_Xor, nb_xor, "^")
882BINARY_FUNC(PyNumber_And, nb_and, "&")
883BINARY_FUNC(PyNumber_Lshift, nb_lshift, "<<")
884BINARY_FUNC(PyNumber_Rshift, nb_rshift, ">>")
885BINARY_FUNC(PyNumber_Subtract, nb_subtract, "-")
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000886BINARY_FUNC(PyNumber_Divmod, nb_divmod, "divmod()")
Guido van Rossume15dee51995-07-18 14:12:02 +0000887
888PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000889PyNumber_Add(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000890{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000891 PyObject *result = binary_op1(v, w, NB_SLOT(nb_add));
892 if (result == Py_NotImplemented) {
893 PySequenceMethods *m = v->ob_type->tp_as_sequence;
894 Py_DECREF(result);
895 if (m && m->sq_concat) {
896 return (*m->sq_concat)(v, w);
897 }
898 result = binop_type_error(v, w, "+");
899 }
900 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000901}
902
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000903static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000904sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000905{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000906 Py_ssize_t count;
907 if (PyIndex_Check(n)) {
908 count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
909 if (count == -1 && PyErr_Occurred())
910 return NULL;
911 }
912 else {
913 return type_error("can't multiply sequence by "
914 "non-int of type '%.200s'", n);
915 }
916 return (*repeatfunc)(seq, count);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000917}
918
919PyObject *
920PyNumber_Multiply(PyObject *v, PyObject *w)
921{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000922 PyObject *result = binary_op1(v, w, NB_SLOT(nb_multiply));
923 if (result == Py_NotImplemented) {
924 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
925 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
926 Py_DECREF(result);
927 if (mv && mv->sq_repeat) {
928 return sequence_repeat(mv->sq_repeat, v, w);
929 }
930 else if (mw && mw->sq_repeat) {
931 return sequence_repeat(mw->sq_repeat, w, v);
932 }
933 result = binop_type_error(v, w, "*");
934 }
935 return result;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000936}
937
Guido van Rossume15dee51995-07-18 14:12:02 +0000938PyObject *
Benjamin Petersond51374e2014-04-09 23:55:56 -0400939PyNumber_MatrixMultiply(PyObject *v, PyObject *w)
940{
941 return binary_op(v, w, NB_SLOT(nb_matrix_multiply), "@");
942}
943
944PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +0000945PyNumber_FloorDivide(PyObject *v, PyObject *w)
946{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000947 return binary_op(v, w, NB_SLOT(nb_floor_divide), "//");
Guido van Rossum4668b002001-08-08 05:00:18 +0000948}
949
950PyObject *
951PyNumber_TrueDivide(PyObject *v, PyObject *w)
952{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000953 return binary_op(v, w, NB_SLOT(nb_true_divide), "/");
Guido van Rossum4668b002001-08-08 05:00:18 +0000954}
955
956PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000957PyNumber_Remainder(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000958{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000959 return binary_op(v, w, NB_SLOT(nb_remainder), "%");
Guido van Rossume15dee51995-07-18 14:12:02 +0000960}
961
962PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000963PyNumber_Power(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossume15dee51995-07-18 14:12:02 +0000964{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000965 return ternary_op(v, w, z, NB_SLOT(nb_power), "** or pow()");
Guido van Rossume15dee51995-07-18 14:12:02 +0000966}
967
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000968/* Binary in-place operators */
969
970/* The in-place operators are defined to fall back to the 'normal',
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000971 non in-place operations, if the in-place methods are not in place.
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000972
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000973 - If the left hand object has the appropriate struct members, and
974 they are filled, call the appropriate function and return the
975 result. No coercion is done on the arguments; the left-hand object
976 is the one the operation is performed on, and it's up to the
977 function to deal with the right-hand object.
Guido van Rossum77660912002-04-16 16:32:50 +0000978
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000979 - Otherwise, in-place modification is not supported. Handle it exactly as
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000980 a non in-place operation of the same kind.
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000981
982 */
983
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000984static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000985binary_iop1(PyObject *v, PyObject *w, const int iop_slot, const int op_slot)
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000986{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000987 PyNumberMethods *mv = v->ob_type->tp_as_number;
988 if (mv != NULL) {
989 binaryfunc slot = NB_BINOP(mv, iop_slot);
990 if (slot) {
991 PyObject *x = (slot)(v, w);
992 if (x != Py_NotImplemented) {
993 return x;
994 }
995 Py_DECREF(x);
996 }
997 }
998 return binary_op1(v, w, op_slot);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000999}
1000
1001static PyObject *
1002binary_iop(PyObject *v, PyObject *w, const int iop_slot, const int op_slot,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001003 const char *op_name)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001004{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001005 PyObject *result = binary_iop1(v, w, iop_slot, op_slot);
1006 if (result == Py_NotImplemented) {
1007 Py_DECREF(result);
1008 return binop_type_error(v, w, op_name);
1009 }
1010 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001011}
1012
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001013#define INPLACE_BINOP(func, iop, op, op_name) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001014 PyObject * \
1015 func(PyObject *v, PyObject *w) { \
1016 return binary_iop(v, w, NB_SLOT(iop), NB_SLOT(op), op_name); \
1017 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001018
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001019INPLACE_BINOP(PyNumber_InPlaceOr, nb_inplace_or, nb_or, "|=")
1020INPLACE_BINOP(PyNumber_InPlaceXor, nb_inplace_xor, nb_xor, "^=")
1021INPLACE_BINOP(PyNumber_InPlaceAnd, nb_inplace_and, nb_and, "&=")
1022INPLACE_BINOP(PyNumber_InPlaceLshift, nb_inplace_lshift, nb_lshift, "<<=")
1023INPLACE_BINOP(PyNumber_InPlaceRshift, nb_inplace_rshift, nb_rshift, ">>=")
1024INPLACE_BINOP(PyNumber_InPlaceSubtract, nb_inplace_subtract, nb_subtract, "-=")
Benjamin Petersond51374e2014-04-09 23:55:56 -04001025INPLACE_BINOP(PyNumber_InMatrixMultiply, nb_inplace_matrix_multiply, nb_matrix_multiply, "@=")
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001026
1027PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001028PyNumber_InPlaceFloorDivide(PyObject *v, PyObject *w)
1029{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001030 return binary_iop(v, w, NB_SLOT(nb_inplace_floor_divide),
1031 NB_SLOT(nb_floor_divide), "//=");
Guido van Rossum4668b002001-08-08 05:00:18 +00001032}
1033
1034PyObject *
1035PyNumber_InPlaceTrueDivide(PyObject *v, PyObject *w)
1036{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001037 return binary_iop(v, w, NB_SLOT(nb_inplace_true_divide),
1038 NB_SLOT(nb_true_divide), "/=");
Guido van Rossum4668b002001-08-08 05:00:18 +00001039}
1040
1041PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001042PyNumber_InPlaceAdd(PyObject *v, PyObject *w)
1043{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001044 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_add),
1045 NB_SLOT(nb_add));
1046 if (result == Py_NotImplemented) {
1047 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1048 Py_DECREF(result);
1049 if (m != NULL) {
1050 binaryfunc f = NULL;
1051 f = m->sq_inplace_concat;
1052 if (f == NULL)
1053 f = m->sq_concat;
1054 if (f != NULL)
1055 return (*f)(v, w);
1056 }
1057 result = binop_type_error(v, w, "+=");
1058 }
1059 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001060}
1061
1062PyObject *
1063PyNumber_InPlaceMultiply(PyObject *v, PyObject *w)
1064{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001065 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_multiply),
1066 NB_SLOT(nb_multiply));
1067 if (result == Py_NotImplemented) {
1068 ssizeargfunc f = NULL;
1069 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1070 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1071 Py_DECREF(result);
1072 if (mv != NULL) {
1073 f = mv->sq_inplace_repeat;
1074 if (f == NULL)
1075 f = mv->sq_repeat;
1076 if (f != NULL)
1077 return sequence_repeat(f, v, w);
1078 }
1079 else if (mw != NULL) {
1080 /* Note that the right hand operand should not be
1081 * mutated in this case so sq_inplace_repeat is not
1082 * used. */
1083 if (mw->sq_repeat)
1084 return sequence_repeat(mw->sq_repeat, w, v);
1085 }
1086 result = binop_type_error(v, w, "*=");
1087 }
1088 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001089}
1090
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001091PyObject *
Benjamin Petersond51374e2014-04-09 23:55:56 -04001092PyNumber_InPlaceMatrixMultiply(PyObject *v, PyObject *w)
1093{
1094 return binary_iop(v, w, NB_SLOT(nb_inplace_matrix_multiply),
1095 NB_SLOT(nb_matrix_multiply), "@=");
1096}
1097
1098PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001099PyNumber_InPlaceRemainder(PyObject *v, PyObject *w)
1100{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001101 return binary_iop(v, w, NB_SLOT(nb_inplace_remainder),
1102 NB_SLOT(nb_remainder), "%=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001103}
1104
1105PyObject *
1106PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
1107{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001108 if (v->ob_type->tp_as_number &&
1109 v->ob_type->tp_as_number->nb_inplace_power != NULL) {
1110 return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
1111 }
1112 else {
1113 return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
1114 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001115}
1116
1117
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001118/* Unary operators and functions */
Guido van Rossume15dee51995-07-18 14:12:02 +00001119
1120PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001121PyNumber_Negative(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001122{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001123 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001124
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001125 if (o == NULL)
1126 return null_error();
1127 m = o->ob_type->tp_as_number;
1128 if (m && m->nb_negative)
1129 return (*m->nb_negative)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001130
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001131 return type_error("bad operand type for unary -: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001132}
1133
1134PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001135PyNumber_Positive(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001136{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001137 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001138
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001139 if (o == NULL)
1140 return null_error();
1141 m = o->ob_type->tp_as_number;
1142 if (m && m->nb_positive)
1143 return (*m->nb_positive)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001144
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001145 return type_error("bad operand type for unary +: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001146}
1147
1148PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001149PyNumber_Invert(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001150{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001151 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001152
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001153 if (o == NULL)
1154 return null_error();
1155 m = o->ob_type->tp_as_number;
1156 if (m && m->nb_invert)
1157 return (*m->nb_invert)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001158
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001159 return type_error("bad operand type for unary ~: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001160}
1161
1162PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001163PyNumber_Absolute(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001164{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001165 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001166
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001167 if (o == NULL)
1168 return null_error();
1169 m = o->ob_type->tp_as_number;
1170 if (m && m->nb_absolute)
1171 return m->nb_absolute(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001172
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001173 return type_error("bad operand type for abs(): '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001174}
1175
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001176/* Return a Python int from the object item.
Serhiy Storchaka95949422013-08-27 19:40:23 +03001177 Raise TypeError if the result is not an int
Guido van Rossum98297ee2007-11-06 21:34:58 +00001178 or if the object cannot be interpreted as an index.
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001179*/
1180PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001181PyNumber_Index(PyObject *item)
1182{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001183 PyObject *result = NULL;
1184 if (item == NULL)
1185 return null_error();
1186 if (PyLong_Check(item)) {
1187 Py_INCREF(item);
1188 return item;
1189 }
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001190 if (!PyIndex_Check(item)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001191 PyErr_Format(PyExc_TypeError,
1192 "'%.200s' object cannot be interpreted "
1193 "as an integer", item->ob_type->tp_name);
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001194 return NULL;
1195 }
1196 result = item->ob_type->tp_as_number->nb_index(item);
1197 if (!result || PyLong_CheckExact(result))
1198 return result;
1199 if (!PyLong_Check(result)) {
1200 PyErr_Format(PyExc_TypeError,
1201 "__index__ returned non-int (type %.200s)",
1202 result->ob_type->tp_name);
1203 Py_DECREF(result);
1204 return NULL;
1205 }
1206 /* Issue #17576: warn if 'result' not of exact type int. */
1207 if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
1208 "__index__ returned non-int (type %.200s). "
1209 "The ability to return an instance of a strict subclass of int "
1210 "is deprecated, and may be removed in a future version of Python.",
1211 result->ob_type->tp_name)) {
1212 Py_DECREF(result);
1213 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001214 }
1215 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001216}
1217
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001218/* Return an error on Overflow only if err is not NULL*/
1219
1220Py_ssize_t
1221PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1222{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001223 Py_ssize_t result;
1224 PyObject *runerr;
1225 PyObject *value = PyNumber_Index(item);
1226 if (value == NULL)
1227 return -1;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001228
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001229 /* We're done if PyLong_AsSsize_t() returns without error. */
1230 result = PyLong_AsSsize_t(value);
1231 if (result != -1 || !(runerr = PyErr_Occurred()))
1232 goto finish;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001233
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001234 /* Error handling code -- only manage OverflowError differently */
1235 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
1236 goto finish;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001237
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001238 PyErr_Clear();
1239 /* If no error-handling desired then the default clipping
1240 is sufficient.
1241 */
1242 if (!err) {
1243 assert(PyLong_Check(value));
1244 /* Whether or not it is less than or equal to
1245 zero is determined by the sign of ob_size
1246 */
1247 if (_PyLong_Sign(value) < 0)
1248 result = PY_SSIZE_T_MIN;
1249 else
1250 result = PY_SSIZE_T_MAX;
1251 }
1252 else {
1253 /* Otherwise replace the error with caller's error object. */
1254 PyErr_Format(err,
1255 "cannot fit '%.200s' into an index-sized integer",
1256 item->ob_type->tp_name);
1257 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001258
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001259 finish:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001260 Py_DECREF(value);
1261 return result;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001262}
1263
1264
Guido van Rossume15dee51995-07-18 14:12:02 +00001265PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001266PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001267{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001268 PyNumberMethods *m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001269 PyObject *trunc_func;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001270 Py_buffer view;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04001271 _Py_IDENTIFIER(__trunc__);
Christian Heimes15ebc882008-02-04 18:48:49 +00001272
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001273 if (o == NULL)
1274 return null_error();
1275 if (PyLong_CheckExact(o)) {
1276 Py_INCREF(o);
1277 return o;
1278 }
1279 m = o->ob_type->tp_as_number;
1280 if (m && m->nb_int) { /* This should include subclasses of int */
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001281 return (PyObject *)_PyLong_FromNbInt(o);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001282 }
Benjamin Peterson1b1a8e72012-03-20 23:48:11 -04001283 trunc_func = _PyObject_LookupSpecial(o, &PyId___trunc__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001284 if (trunc_func) {
1285 PyObject *truncated = PyEval_CallObject(trunc_func, NULL);
1286 PyObject *int_instance;
1287 Py_DECREF(trunc_func);
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001288 if (truncated == NULL || PyLong_Check(truncated))
1289 return truncated;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001290 /* __trunc__ is specified to return an Integral type,
Martin Panter7462b6492015-11-02 03:37:02 +00001291 but int() needs to return an int. */
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001292 m = truncated->ob_type->tp_as_number;
1293 if (m == NULL || m->nb_int == NULL) {
1294 PyErr_Format(
1295 PyExc_TypeError,
1296 "__trunc__ returned non-Integral (type %.200s)",
1297 truncated->ob_type->tp_name);
1298 Py_DECREF(truncated);
1299 return NULL;
1300 }
1301 int_instance = (PyObject *)_PyLong_FromNbInt(truncated);
1302 Py_DECREF(truncated);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001303 return int_instance;
1304 }
Benjamin Peterson1b1a8e72012-03-20 23:48:11 -04001305 if (PyErr_Occurred())
1306 return NULL;
Christian Heimes15ebc882008-02-04 18:48:49 +00001307
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001308 if (PyUnicode_Check(o))
1309 /* The below check is done in PyLong_FromUnicode(). */
1310 return PyLong_FromUnicodeObject(o, 10);
1311
Martin Pantereeb896c2015-11-07 02:32:21 +00001312 if (PyBytes_Check(o))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001313 /* need to do extra error checking that PyLong_FromString()
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03001314 * doesn't do. In particular int('9\x005') must raise an
1315 * exception, not truncate at the null.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001316 */
Martin Pantereeb896c2015-11-07 02:32:21 +00001317 return _PyLong_FromBytes(PyBytes_AS_STRING(o),
1318 PyBytes_GET_SIZE(o), 10);
1319
1320 if (PyByteArray_Check(o))
1321 return _PyLong_FromBytes(PyByteArray_AS_STRING(o),
1322 PyByteArray_GET_SIZE(o), 10);
1323
1324 if (PyObject_GetBuffer(o, &view, PyBUF_SIMPLE) == 0) {
1325 PyObject *result, *bytes;
1326
1327 /* Copy to NUL-terminated buffer. */
1328 bytes = PyBytes_FromStringAndSize((const char *)view.buf, view.len);
1329 if (bytes == NULL) {
1330 PyBuffer_Release(&view);
1331 return NULL;
1332 }
1333 result = _PyLong_FromBytes(PyBytes_AS_STRING(bytes),
1334 PyBytes_GET_SIZE(bytes), 10);
1335 Py_DECREF(bytes);
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001336 PyBuffer_Release(&view);
1337 return result;
1338 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001339
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001340 return type_error("int() argument must be a string, a bytes-like object "
1341 "or a number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001342}
1343
1344PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001345PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001346{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001347 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001348
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001349 if (o == NULL)
1350 return null_error();
1351 m = o->ob_type->tp_as_number;
1352 if (m && m->nb_float) { /* This should include subclasses of float */
1353 PyObject *res = m->nb_float(o);
1354 if (res && !PyFloat_Check(res)) {
1355 PyErr_Format(PyExc_TypeError,
1356 "__float__ returned non-float (type %.200s)",
1357 res->ob_type->tp_name);
1358 Py_DECREF(res);
1359 return NULL;
1360 }
1361 return res;
1362 }
1363 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
1364 PyFloatObject *po = (PyFloatObject *)o;
1365 return PyFloat_FromDouble(po->ob_fval);
1366 }
1367 return PyFloat_FromString(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001368}
1369
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001370
1371PyObject *
1372PyNumber_ToBase(PyObject *n, int base)
1373{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001374 PyObject *res = NULL;
1375 PyObject *index = PyNumber_Index(n);
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001376
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001377 if (!index)
1378 return NULL;
1379 if (PyLong_Check(index))
1380 res = _PyLong_Format(index, base);
1381 else
1382 /* It should not be possible to get here, as
1383 PyNumber_Index already has a check for the same
1384 condition */
Serhiy Storchaka95949422013-08-27 19:40:23 +03001385 PyErr_SetString(PyExc_ValueError, "PyNumber_ToBase: index not int");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001386 Py_DECREF(index);
1387 return res;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001388}
1389
1390
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001391/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001392
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001393int
Fred Drake79912472000-07-09 04:06:11 +00001394PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001395{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001396 if (PyDict_Check(s))
1397 return 0;
1398 return s != NULL && s->ob_type->tp_as_sequence &&
1399 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001400}
1401
Martin v. Löwis18e16552006-02-15 17:27:45 +00001402Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001403PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001404{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001405 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001406
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001407 if (s == NULL) {
1408 null_error();
1409 return -1;
1410 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001411
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001412 m = s->ob_type->tp_as_sequence;
1413 if (m && m->sq_length)
1414 return m->sq_length(s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001415
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001416 type_error("object of type '%.200s' has no len()", s);
1417 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001418}
1419
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001420#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001421Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001422PySequence_Length(PyObject *s)
1423{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001424 return PySequence_Size(s);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001425}
1426#define PySequence_Length PySequence_Size
1427
Guido van Rossume15dee51995-07-18 14:12:02 +00001428PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001429PySequence_Concat(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001430{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001431 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001432
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001433 if (s == NULL || o == NULL)
1434 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001436 m = s->ob_type->tp_as_sequence;
1437 if (m && m->sq_concat)
1438 return m->sq_concat(s, o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001439
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001440 /* Instances of user classes defining an __add__() method only
1441 have an nb_add slot, not an sq_concat slot. So we fall back
1442 to nb_add if both arguments appear to be sequences. */
1443 if (PySequence_Check(s) && PySequence_Check(o)) {
1444 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1445 if (result != Py_NotImplemented)
1446 return result;
1447 Py_DECREF(result);
1448 }
1449 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001450}
1451
1452PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001453PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001454{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001455 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001456
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001457 if (o == NULL)
1458 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001460 m = o->ob_type->tp_as_sequence;
1461 if (m && m->sq_repeat)
1462 return m->sq_repeat(o, count);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001463
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001464 /* Instances of user classes defining a __mul__() method only
1465 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1466 to nb_multiply if o appears to be a sequence. */
1467 if (PySequence_Check(o)) {
1468 PyObject *n, *result;
1469 n = PyLong_FromSsize_t(count);
1470 if (n == NULL)
1471 return NULL;
1472 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1473 Py_DECREF(n);
1474 if (result != Py_NotImplemented)
1475 return result;
1476 Py_DECREF(result);
1477 }
1478 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001479}
1480
1481PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001482PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1483{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001484 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001485
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001486 if (s == NULL || o == NULL)
1487 return null_error();
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001488
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001489 m = s->ob_type->tp_as_sequence;
1490 if (m && m->sq_inplace_concat)
1491 return m->sq_inplace_concat(s, o);
1492 if (m && m->sq_concat)
1493 return m->sq_concat(s, o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001494
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001495 if (PySequence_Check(s) && PySequence_Check(o)) {
1496 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1497 NB_SLOT(nb_add));
1498 if (result != Py_NotImplemented)
1499 return result;
1500 Py_DECREF(result);
1501 }
1502 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001503}
1504
1505PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001506PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001507{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001508 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001510 if (o == NULL)
1511 return null_error();
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001512
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001513 m = o->ob_type->tp_as_sequence;
1514 if (m && m->sq_inplace_repeat)
1515 return m->sq_inplace_repeat(o, count);
1516 if (m && m->sq_repeat)
1517 return m->sq_repeat(o, count);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001518
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001519 if (PySequence_Check(o)) {
1520 PyObject *n, *result;
1521 n = PyLong_FromSsize_t(count);
1522 if (n == NULL)
1523 return NULL;
1524 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1525 NB_SLOT(nb_multiply));
1526 Py_DECREF(n);
1527 if (result != Py_NotImplemented)
1528 return result;
1529 Py_DECREF(result);
1530 }
1531 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001532}
1533
1534PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001535PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001536{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001537 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001538
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001539 if (s == NULL)
1540 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001541
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001542 m = s->ob_type->tp_as_sequence;
1543 if (m && m->sq_item) {
1544 if (i < 0) {
1545 if (m->sq_length) {
1546 Py_ssize_t l = (*m->sq_length)(s);
1547 if (l < 0)
1548 return NULL;
1549 i += l;
1550 }
1551 }
1552 return m->sq_item(s, i);
1553 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001554
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001555 return type_error("'%.200s' object does not support indexing", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001556}
1557
1558PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001559PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00001560{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001561 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001562
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001563 if (!s) return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001564
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001565 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001566 if (mp && mp->mp_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567 PyObject *res;
1568 PyObject *slice = _PySlice_FromIndices(i1, i2);
1569 if (!slice)
1570 return NULL;
1571 res = mp->mp_subscript(s, slice);
1572 Py_DECREF(slice);
1573 return res;
1574 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001575
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001576 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001577}
1578
1579int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001580PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001581{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001582 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001583
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001584 if (s == NULL) {
1585 null_error();
1586 return -1;
1587 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001588
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001589 m = s->ob_type->tp_as_sequence;
1590 if (m && m->sq_ass_item) {
1591 if (i < 0) {
1592 if (m->sq_length) {
1593 Py_ssize_t l = (*m->sq_length)(s);
1594 if (l < 0)
1595 return -1;
1596 i += l;
1597 }
1598 }
1599 return m->sq_ass_item(s, i, o);
1600 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001601
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001602 type_error("'%.200s' object does not support item assignment", s);
1603 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001604}
1605
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001606int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001607PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001608{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001609 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001610
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001611 if (s == NULL) {
1612 null_error();
1613 return -1;
1614 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001615
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001616 m = s->ob_type->tp_as_sequence;
1617 if (m && m->sq_ass_item) {
1618 if (i < 0) {
1619 if (m->sq_length) {
1620 Py_ssize_t l = (*m->sq_length)(s);
1621 if (l < 0)
1622 return -1;
1623 i += l;
1624 }
1625 }
1626 return m->sq_ass_item(s, i, (PyObject *)NULL);
1627 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001628
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001629 type_error("'%.200s' object doesn't support item deletion", s);
1630 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001631}
1632
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001633int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001634PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001635{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001636 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001637
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001638 if (s == NULL) {
1639 null_error();
1640 return -1;
1641 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001642
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001643 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001644 if (mp && mp->mp_ass_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001645 int res;
1646 PyObject *slice = _PySlice_FromIndices(i1, i2);
1647 if (!slice)
1648 return -1;
1649 res = mp->mp_ass_subscript(s, slice, o);
1650 Py_DECREF(slice);
1651 return res;
1652 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00001653
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001654 type_error("'%.200s' object doesn't support slice assignment", s);
1655 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001656}
1657
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001658int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001659PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001660{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001661 PyMappingMethods *mp;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001662
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001663 if (s == NULL) {
1664 null_error();
1665 return -1;
1666 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001667
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001668 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001669 if (mp && mp->mp_ass_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001670 int res;
1671 PyObject *slice = _PySlice_FromIndices(i1, i2);
1672 if (!slice)
1673 return -1;
1674 res = mp->mp_ass_subscript(s, slice, NULL);
1675 Py_DECREF(slice);
1676 return res;
1677 }
1678 type_error("'%.200s' object doesn't support slice deletion", s);
1679 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001680}
1681
Guido van Rossume15dee51995-07-18 14:12:02 +00001682PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001683PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00001684{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001685 PyObject *it; /* iter(v) */
1686 Py_ssize_t n; /* guess for result tuple size */
1687 PyObject *result = NULL;
1688 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00001689
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001690 if (v == NULL)
1691 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001692
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001693 /* Special-case the common tuple and list cases, for efficiency. */
1694 if (PyTuple_CheckExact(v)) {
1695 /* Note that we can't know whether it's safe to return
1696 a tuple *subclass* instance as-is, hence the restriction
1697 to exact tuples here. In contrast, lists always make
1698 a copy, so there's no need for exactness below. */
1699 Py_INCREF(v);
1700 return v;
1701 }
Raymond Hettinger610a51f2015-05-17 14:45:58 -07001702 if (PyList_CheckExact(v))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001703 return PyList_AsTuple(v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001704
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001705 /* Get iterator. */
1706 it = PyObject_GetIter(v);
1707 if (it == NULL)
1708 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001709
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001710 /* Guess result size and allocate space. */
Armin Ronacheraa9a79d2012-10-06 14:03:24 +02001711 n = PyObject_LengthHint(v, 10);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001712 if (n == -1)
1713 goto Fail;
1714 result = PyTuple_New(n);
1715 if (result == NULL)
1716 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001717
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001718 /* Fill the tuple. */
1719 for (j = 0; ; ++j) {
1720 PyObject *item = PyIter_Next(it);
1721 if (item == NULL) {
1722 if (PyErr_Occurred())
1723 goto Fail;
1724 break;
1725 }
1726 if (j >= n) {
Martin Pantere8db8612016-07-25 02:30:05 +00001727 size_t newn = (size_t)n;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001728 /* The over-allocation strategy can grow a bit faster
1729 than for lists because unlike lists the
1730 over-allocation isn't permanent -- we reclaim
1731 the excess before the end of this routine.
1732 So, grow by ten and then add 25%.
1733 */
Martin Pantere8db8612016-07-25 02:30:05 +00001734 newn += 10u;
1735 newn += newn >> 2;
1736 if (newn > PY_SSIZE_T_MAX) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001737 /* Check for overflow */
1738 PyErr_NoMemory();
1739 Py_DECREF(item);
1740 goto Fail;
1741 }
Martin Pantere8db8612016-07-25 02:30:05 +00001742 n = (Py_ssize_t)newn;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001743 if (_PyTuple_Resize(&result, n) != 0) {
1744 Py_DECREF(item);
1745 goto Fail;
1746 }
1747 }
1748 PyTuple_SET_ITEM(result, j, item);
1749 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001750
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001751 /* Cut tuple back if guess was too large. */
1752 if (j < n &&
1753 _PyTuple_Resize(&result, j) != 0)
1754 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001755
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001756 Py_DECREF(it);
1757 return result;
Tim Peters6912d4d2001-05-05 03:56:37 +00001758
1759Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001760 Py_XDECREF(result);
1761 Py_DECREF(it);
1762 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001763}
1764
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001765PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001766PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001767{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001768 PyObject *result; /* result list */
1769 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00001770
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001771 if (v == NULL)
1772 return null_error();
Guido van Rossum5dba9e81998-07-10 18:03:50 +00001773
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001774 result = PyList_New(0);
1775 if (result == NULL)
1776 return NULL;
Tim Petersf553f892001-05-01 20:45:31 +00001777
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001778 rv = _PyList_Extend((PyListObject *)result, v);
1779 if (rv == NULL) {
1780 Py_DECREF(result);
1781 return NULL;
1782 }
1783 Py_DECREF(rv);
1784 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001785}
1786
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001787PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001788PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001789{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001790 PyObject *it;
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001791
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001792 if (v == NULL)
1793 return null_error();
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001794
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001795 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
1796 Py_INCREF(v);
1797 return v;
1798 }
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001799
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001800 it = PyObject_GetIter(v);
1801 if (it == NULL) {
1802 if (PyErr_ExceptionMatches(PyExc_TypeError))
1803 PyErr_SetString(PyExc_TypeError, m);
1804 return NULL;
1805 }
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001806
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001807 v = PySequence_List(it);
1808 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001809
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001810 return v;
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001811}
1812
Tim Peters16a77ad2001-09-08 04:00:12 +00001813/* Iterate over seq. Result depends on the operation:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001814 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
1815 PY_ITERSEARCH_INDEX: 0-based index of first occurrence of obj in seq;
1816 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00001817 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
1818*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001819Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001820_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00001821{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001822 Py_ssize_t n;
1823 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
1824 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00001825
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001826 if (seq == NULL || obj == NULL) {
1827 null_error();
1828 return -1;
1829 }
Tim Peters75f8e352001-05-05 11:33:43 +00001830
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001831 it = PyObject_GetIter(seq);
1832 if (it == NULL) {
1833 type_error("argument of type '%.200s' is not iterable", seq);
1834 return -1;
1835 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001836
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001837 n = wrapped = 0;
1838 for (;;) {
1839 int cmp;
1840 PyObject *item = PyIter_Next(it);
1841 if (item == NULL) {
1842 if (PyErr_Occurred())
1843 goto Fail;
1844 break;
1845 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001846
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001847 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
1848 Py_DECREF(item);
1849 if (cmp < 0)
1850 goto Fail;
1851 if (cmp > 0) {
1852 switch (operation) {
1853 case PY_ITERSEARCH_COUNT:
1854 if (n == PY_SSIZE_T_MAX) {
1855 PyErr_SetString(PyExc_OverflowError,
1856 "count exceeds C integer size");
1857 goto Fail;
1858 }
1859 ++n;
1860 break;
Tim Peters16a77ad2001-09-08 04:00:12 +00001861
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001862 case PY_ITERSEARCH_INDEX:
1863 if (wrapped) {
1864 PyErr_SetString(PyExc_OverflowError,
1865 "index exceeds C integer size");
1866 goto Fail;
1867 }
1868 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001869
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001870 case PY_ITERSEARCH_CONTAINS:
1871 n = 1;
1872 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001873
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001874 default:
1875 assert(!"unknown operation");
1876 }
1877 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001878
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001879 if (operation == PY_ITERSEARCH_INDEX) {
1880 if (n == PY_SSIZE_T_MAX)
1881 wrapped = 1;
1882 ++n;
1883 }
1884 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001885
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001886 if (operation != PY_ITERSEARCH_INDEX)
1887 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001888
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001889 PyErr_SetString(PyExc_ValueError,
1890 "sequence.index(x): x not in sequence");
1891 /* fall into failure code */
Tim Peters16a77ad2001-09-08 04:00:12 +00001892Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001893 n = -1;
1894 /* fall through */
Tim Peters16a77ad2001-09-08 04:00:12 +00001895Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001896 Py_DECREF(it);
1897 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00001898
Guido van Rossume15dee51995-07-18 14:12:02 +00001899}
1900
Tim Peters16a77ad2001-09-08 04:00:12 +00001901/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001902Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001903PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001904{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001905 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00001906}
1907
Tim Peterscb8d3682001-05-05 21:05:01 +00001908/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00001909 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00001910 */
1911int
1912PySequence_Contains(PyObject *seq, PyObject *ob)
1913{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001914 Py_ssize_t result;
1915 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
1916 if (sqm != NULL && sqm->sq_contains != NULL)
1917 return (*sqm->sq_contains)(seq, ob);
1918 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
1919 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00001920}
1921
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001922/* Backwards compatibility */
1923#undef PySequence_In
1924int
Fred Drake79912472000-07-09 04:06:11 +00001925PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001926{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001927 return PySequence_Contains(w, v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001928}
1929
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001930Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00001931PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001932{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001933 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00001934}
1935
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001936/* Operations on mappings */
1937
1938int
Fred Drake79912472000-07-09 04:06:11 +00001939PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001940{
Benjamin Peterson21992272011-12-28 12:01:31 -06001941 return o && o->ob_type->tp_as_mapping &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001942 o->ob_type->tp_as_mapping->mp_subscript;
Guido van Rossume15dee51995-07-18 14:12:02 +00001943}
1944
Martin v. Löwis18e16552006-02-15 17:27:45 +00001945Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001946PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001947{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001948 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001949
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001950 if (o == NULL) {
1951 null_error();
1952 return -1;
1953 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001954
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001955 m = o->ob_type->tp_as_mapping;
1956 if (m && m->mp_length)
1957 return m->mp_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001958
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001959 type_error("object of type '%.200s' has no len()", o);
1960 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001961}
1962
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001963#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001964Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001965PyMapping_Length(PyObject *o)
1966{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001967 return PyMapping_Size(o);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001968}
1969#define PyMapping_Length PyMapping_Size
1970
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001971PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +03001972PyMapping_GetItemString(PyObject *o, const char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001973{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001974 PyObject *okey, *r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001975
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001976 if (key == NULL)
1977 return null_error();
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001978
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001979 okey = PyUnicode_FromString(key);
1980 if (okey == NULL)
1981 return NULL;
1982 r = PyObject_GetItem(o, okey);
1983 Py_DECREF(okey);
1984 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001985}
1986
1987int
Serhiy Storchakac6792272013-10-19 21:03:34 +03001988PyMapping_SetItemString(PyObject *o, const char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001989{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001990 PyObject *okey;
1991 int r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001992
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001993 if (key == NULL) {
1994 null_error();
1995 return -1;
1996 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001997
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001998 okey = PyUnicode_FromString(key);
1999 if (okey == NULL)
2000 return -1;
2001 r = PyObject_SetItem(o, okey, value);
2002 Py_DECREF(okey);
2003 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002004}
2005
2006int
Serhiy Storchakac6792272013-10-19 21:03:34 +03002007PyMapping_HasKeyString(PyObject *o, const char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002008{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002009 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002010
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002011 v = PyMapping_GetItemString(o, key);
2012 if (v) {
2013 Py_DECREF(v);
2014 return 1;
2015 }
2016 PyErr_Clear();
2017 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002018}
2019
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002020int
Fred Drake79912472000-07-09 04:06:11 +00002021PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002022{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002023 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002024
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002025 v = PyObject_GetItem(o, key);
2026 if (v) {
2027 Py_DECREF(v);
2028 return 1;
2029 }
2030 PyErr_Clear();
2031 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002032}
2033
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002034PyObject *
2035PyMapping_Keys(PyObject *o)
2036{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002037 PyObject *keys;
2038 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002039 _Py_IDENTIFIER(keys);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002040
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002041 if (PyDict_CheckExact(o))
2042 return PyDict_Keys(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002043 keys = _PyObject_CallMethodId(o, &PyId_keys, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002044 if (keys == NULL)
2045 return NULL;
2046 fast = PySequence_Fast(keys, "o.keys() are not iterable");
2047 Py_DECREF(keys);
2048 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002049}
2050
2051PyObject *
2052PyMapping_Items(PyObject *o)
2053{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002054 PyObject *items;
2055 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002056 _Py_IDENTIFIER(items);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002057
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002058 if (PyDict_CheckExact(o))
2059 return PyDict_Items(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002060 items = _PyObject_CallMethodId(o, &PyId_items, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002061 if (items == NULL)
2062 return NULL;
2063 fast = PySequence_Fast(items, "o.items() are not iterable");
2064 Py_DECREF(items);
2065 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002066}
2067
2068PyObject *
2069PyMapping_Values(PyObject *o)
2070{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002071 PyObject *values;
2072 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002073 _Py_IDENTIFIER(values);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002074
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002075 if (PyDict_CheckExact(o))
2076 return PyDict_Values(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002077 values = _PyObject_CallMethodId(o, &PyId_values, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002078 if (values == NULL)
2079 return NULL;
2080 fast = PySequence_Fast(values, "o.values() are not iterable");
2081 Py_DECREF(values);
2082 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002083}
2084
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002085/* Operations on callable objects */
2086
2087/* XXX PyCallable_Check() is in object.c */
2088
Guido van Rossume15dee51995-07-18 14:12:02 +00002089PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002090PyObject_CallObject(PyObject *o, PyObject *a)
Guido van Rossume15dee51995-07-18 14:12:02 +00002091{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002092 return PyEval_CallObjectWithKeywords(o, a, NULL);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002093}
Guido van Rossume15dee51995-07-18 14:12:02 +00002094
Victor Stinner4a7cc882015-03-06 23:35:27 +01002095PyObject*
Victor Stinnerefde1462015-03-21 15:04:43 +01002096_Py_CheckFunctionResult(PyObject *func, PyObject *result, const char *where)
Victor Stinner4a7cc882015-03-06 23:35:27 +01002097{
2098 int err_occurred = (PyErr_Occurred() != NULL);
2099
Victor Stinnerefde1462015-03-21 15:04:43 +01002100 assert((func != NULL) ^ (where != NULL));
2101
Victor Stinner4a7cc882015-03-06 23:35:27 +01002102 if (result == NULL) {
2103 if (!err_occurred) {
Victor Stinnerefde1462015-03-21 15:04:43 +01002104 if (func)
2105 PyErr_Format(PyExc_SystemError,
2106 "%R returned NULL without setting an error",
2107 func);
2108 else
2109 PyErr_Format(PyExc_SystemError,
2110 "%s returned NULL without setting an error",
2111 where);
Victor Stinner944fbcc2015-03-24 16:28:52 +01002112#ifdef Py_DEBUG
Martin Panter2275e622016-06-20 07:52:50 +00002113 /* Ensure that the bug is caught in debug mode */
Victor Stinner944fbcc2015-03-24 16:28:52 +01002114 Py_FatalError("a function returned NULL without setting an error");
2115#endif
2116 return NULL;
Victor Stinner4a7cc882015-03-06 23:35:27 +01002117 }
2118 }
2119 else {
2120 if (err_occurred) {
2121 PyObject *exc, *val, *tb;
2122 PyErr_Fetch(&exc, &val, &tb);
2123
2124 Py_DECREF(result);
2125
Victor Stinnerefde1462015-03-21 15:04:43 +01002126 if (func)
2127 PyErr_Format(PyExc_SystemError,
2128 "%R returned a result with an error set",
2129 func);
2130 else
2131 PyErr_Format(PyExc_SystemError,
2132 "%s returned a result with an error set",
2133 where);
Victor Stinner4a7cc882015-03-06 23:35:27 +01002134 _PyErr_ChainExceptions(exc, val, tb);
Victor Stinner944fbcc2015-03-24 16:28:52 +01002135#ifdef Py_DEBUG
Martin Panter2275e622016-06-20 07:52:50 +00002136 /* Ensure that the bug is caught in debug mode */
Victor Stinner944fbcc2015-03-24 16:28:52 +01002137 Py_FatalError("a function returned a result with an error set");
2138#endif
2139 return NULL;
Victor Stinner4a7cc882015-03-06 23:35:27 +01002140 }
2141 }
2142 return result;
2143}
2144
Guido van Rossume15dee51995-07-18 14:12:02 +00002145PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002146PyObject_Call(PyObject *func, PyObject *arg, PyObject *kw)
2147{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002148 ternaryfunc call;
Victor Stinner4a7cc882015-03-06 23:35:27 +01002149 PyObject *result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002150
Victor Stinner8f4ec8d2014-09-05 01:10:29 +02002151 /* PyObject_Call() must not be called with an exception set,
2152 because it may clear it (directly or indirectly) and so the
Martin Panterec1aa5c2015-10-07 11:03:53 +00002153 caller loses its exception */
Victor Stinner8f4ec8d2014-09-05 01:10:29 +02002154 assert(!PyErr_Occurred());
2155
Victor Stinner4a7cc882015-03-06 23:35:27 +01002156 call = func->ob_type->tp_call;
2157 if (call == NULL) {
2158 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
2159 func->ob_type->tp_name);
2160 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002161 }
Victor Stinner4a7cc882015-03-06 23:35:27 +01002162
2163 if (Py_EnterRecursiveCall(" while calling a Python object"))
2164 return NULL;
2165
2166 result = (*call)(func, arg, kw);
2167
2168 Py_LeaveRecursiveCall();
2169
Victor Stinnerefde1462015-03-21 15:04:43 +01002170 return _Py_CheckFunctionResult(func, result, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002171}
2172
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002173static PyObject*
2174call_function_tail(PyObject *callable, PyObject *args)
2175{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002176 PyObject *retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002177
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002178 if (args == NULL)
2179 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002180
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002181 if (!PyTuple_Check(args)) {
2182 PyObject *a;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002184 a = PyTuple_New(1);
2185 if (a == NULL) {
2186 Py_DECREF(args);
2187 return NULL;
2188 }
2189 PyTuple_SET_ITEM(a, 0, args);
2190 args = a;
2191 }
2192 retval = PyObject_Call(callable, args, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002193
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002194 Py_DECREF(args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002195
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002196 return retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002197}
2198
Tim Peters6d6c1a32001-08-02 04:15:00 +00002199PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002200PyObject_CallFunction(PyObject *callable, const char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002201{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002202 va_list va;
2203 PyObject *args;
Guido van Rossume15dee51995-07-18 14:12:02 +00002204
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002205 if (callable == NULL)
2206 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002207
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002208 if (format && *format) {
2209 va_start(va, format);
2210 args = Py_VaBuildValue(format, va);
2211 va_end(va);
2212 }
2213 else
2214 args = PyTuple_New(0);
Victor Stinner0b0c8672013-10-29 19:29:52 +01002215 if (args == NULL)
2216 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002217
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002218 return call_function_tail(callable, args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002219}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002220
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002221PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002222_PyObject_CallFunction_SizeT(PyObject *callable, const char *format, ...)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002223{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002224 va_list va;
2225 PyObject *args;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002226
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002227 if (callable == NULL)
2228 return null_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002229
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002230 if (format && *format) {
2231 va_start(va, format);
2232 args = _Py_VaBuildValue_SizeT(format, va);
2233 va_end(va);
2234 }
2235 else
2236 args = PyTuple_New(0);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002237
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002238 return call_function_tail(callable, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002239}
2240
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002241static PyObject*
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002242callmethod(PyObject* func, const char *format, va_list va, int is_size_t)
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002243{
2244 PyObject *retval = NULL;
2245 PyObject *args;
2246
2247 if (!PyCallable_Check(func)) {
2248 type_error("attribute of type '%.200s' is not callable", func);
2249 goto exit;
2250 }
2251
2252 if (format && *format) {
2253 if (is_size_t)
2254 args = _Py_VaBuildValue_SizeT(format, va);
2255 else
2256 args = Py_VaBuildValue(format, va);
2257 }
2258 else
2259 args = PyTuple_New(0);
2260
2261 retval = call_function_tail(func, args);
2262
2263 exit:
2264 /* args gets consumed in call_function_tail */
2265 Py_XDECREF(func);
2266
2267 return retval;
2268}
2269
Guido van Rossume15dee51995-07-18 14:12:02 +00002270PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002271PyObject_CallMethod(PyObject *o, const char *name, const char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002272{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002273 va_list va;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002274 PyObject *func = NULL;
2275 PyObject *retval = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002276
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002277 if (o == NULL || name == NULL)
2278 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002279
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002280 func = PyObject_GetAttrString(o, name);
Benjamin Peterson1791c222014-06-26 23:29:13 -07002281 if (func == NULL)
2282 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002283
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002284 va_start(va, format);
2285 retval = callmethod(func, format, va, 0);
2286 va_end(va);
2287 return retval;
2288}
2289
2290PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002291_PyObject_CallMethodId(PyObject *o, _Py_Identifier *name,
2292 const char *format, ...)
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002293{
2294 va_list va;
2295 PyObject *func = NULL;
2296 PyObject *retval = NULL;
2297
2298 if (o == NULL || name == NULL)
2299 return null_error();
2300
2301 func = _PyObject_GetAttrId(o, name);
Benjamin Peterson1791c222014-06-26 23:29:13 -07002302 if (func == NULL)
2303 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002304
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002305 va_start(va, format);
2306 retval = callmethod(func, format, va, 0);
2307 va_end(va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002308 return retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002309}
2310
2311PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002312_PyObject_CallMethod_SizeT(PyObject *o, const char *name,
2313 const char *format, ...)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002314{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002315 va_list va;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002316 PyObject *func = NULL;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002317 PyObject *retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002318
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002319 if (o == NULL || name == NULL)
2320 return null_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002321
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002322 func = PyObject_GetAttrString(o, name);
Benjamin Peterson1791c222014-06-26 23:29:13 -07002323 if (func == NULL)
2324 return NULL;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002325 va_start(va, format);
2326 retval = callmethod(func, format, va, 1);
2327 va_end(va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002328 return retval;
Guido van Rossume15dee51995-07-18 14:12:02 +00002329}
Guido van Rossum823649d2001-03-21 18:40:58 +00002330
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002331PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002332_PyObject_CallMethodId_SizeT(PyObject *o, _Py_Identifier *name,
2333 const char *format, ...)
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002334{
2335 va_list va;
2336 PyObject *func = NULL;
2337 PyObject *retval;
2338
2339 if (o == NULL || name == NULL)
2340 return null_error();
2341
2342 func = _PyObject_GetAttrId(o, name);
2343 if (func == NULL) {
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002344 return NULL;
2345 }
2346 va_start(va, format);
2347 retval = callmethod(func, format, va, 1);
2348 va_end(va);
2349 return retval;
2350}
Guido van Rossum823649d2001-03-21 18:40:58 +00002351
Fred Drakeb421b8c2001-10-26 16:21:32 +00002352static PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002353objargs_mktuple(va_list va)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002354{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002355 int i, n = 0;
2356 va_list countva;
2357 PyObject *result, *tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002358
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00002359 Py_VA_COPY(countva, va);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002360
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002361 while (((PyObject *)va_arg(countva, PyObject *)) != NULL)
2362 ++n;
2363 result = PyTuple_New(n);
2364 if (result != NULL && n > 0) {
2365 for (i = 0; i < n; ++i) {
2366 tmp = (PyObject *)va_arg(va, PyObject *);
2367 PyTuple_SET_ITEM(result, i, tmp);
2368 Py_INCREF(tmp);
2369 }
2370 }
2371 return result;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002372}
2373
2374PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002375PyObject_CallMethodObjArgs(PyObject *callable, PyObject *name, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002376{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002377 PyObject *args, *tmp;
2378 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002379
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002380 if (callable == NULL || name == NULL)
2381 return null_error();
Fred Drakeb421b8c2001-10-26 16:21:32 +00002382
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002383 callable = PyObject_GetAttr(callable, name);
2384 if (callable == NULL)
2385 return NULL;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002386
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002387 /* count the args */
2388 va_start(vargs, name);
2389 args = objargs_mktuple(vargs);
2390 va_end(vargs);
2391 if (args == NULL) {
2392 Py_DECREF(callable);
2393 return NULL;
2394 }
2395 tmp = PyObject_Call(callable, args, NULL);
2396 Py_DECREF(args);
2397 Py_DECREF(callable);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002398
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002399 return tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002400}
2401
2402PyObject *
Alexandre Vassalotti865eaa12013-05-02 10:44:04 -07002403_PyObject_CallMethodIdObjArgs(PyObject *callable,
Brett Cannonfd074152012-04-14 14:10:13 -04002404 struct _Py_Identifier *name, ...)
2405{
2406 PyObject *args, *tmp;
2407 va_list vargs;
2408
2409 if (callable == NULL || name == NULL)
2410 return null_error();
2411
2412 callable = _PyObject_GetAttrId(callable, name);
2413 if (callable == NULL)
2414 return NULL;
2415
2416 /* count the args */
2417 va_start(vargs, name);
2418 args = objargs_mktuple(vargs);
2419 va_end(vargs);
2420 if (args == NULL) {
2421 Py_DECREF(callable);
2422 return NULL;
2423 }
2424 tmp = PyObject_Call(callable, args, NULL);
2425 Py_DECREF(args);
2426 Py_DECREF(callable);
2427
2428 return tmp;
2429}
2430
2431PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002432PyObject_CallFunctionObjArgs(PyObject *callable, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002433{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002434 PyObject *args, *tmp;
2435 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002436
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002437 if (callable == NULL)
2438 return null_error();
Fred Drakeb421b8c2001-10-26 16:21:32 +00002439
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002440 /* count the args */
2441 va_start(vargs, callable);
2442 args = objargs_mktuple(vargs);
2443 va_end(vargs);
2444 if (args == NULL)
2445 return NULL;
2446 tmp = PyObject_Call(callable, args, NULL);
2447 Py_DECREF(args);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002448
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002449 return tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002450}
2451
2452
Guido van Rossum823649d2001-03-21 18:40:58 +00002453/* isinstance(), issubclass() */
2454
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002455/* abstract_get_bases() has logically 4 return states:
Barry Warsawf16951c2002-04-23 22:45:44 +00002456 *
Barry Warsawf16951c2002-04-23 22:45:44 +00002457 * 1. getattr(cls, '__bases__') could raise an AttributeError
2458 * 2. getattr(cls, '__bases__') could raise some other exception
2459 * 3. getattr(cls, '__bases__') could return a tuple
2460 * 4. getattr(cls, '__bases__') could return something other than a tuple
2461 *
2462 * Only state #3 is a non-error state and only it returns a non-NULL object
2463 * (it returns the retrieved tuple).
2464 *
2465 * Any raised AttributeErrors are masked by clearing the exception and
2466 * returning NULL. If an object other than a tuple comes out of __bases__,
2467 * then again, the return value is NULL. So yes, these two situations
2468 * produce exactly the same results: NULL is returned and no error is set.
2469 *
2470 * If some exception other than AttributeError is raised, then NULL is also
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002471 * returned, but the exception is not cleared. That's because we want the
Barry Warsawf16951c2002-04-23 22:45:44 +00002472 * exception to be propagated along.
2473 *
2474 * Callers are expected to test for PyErr_Occurred() when the return value
2475 * is NULL to decide whether a valid exception should be propagated or not.
2476 * When there's no exception to propagate, it's customary for the caller to
2477 * set a TypeError.
2478 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002479static PyObject *
2480abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002481{
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002482 _Py_IDENTIFIER(__bases__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002483 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002484
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002485 Py_ALLOW_RECURSION
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002486 bases = _PyObject_GetAttrId(cls, &PyId___bases__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002487 Py_END_ALLOW_RECURSION
2488 if (bases == NULL) {
2489 if (PyErr_ExceptionMatches(PyExc_AttributeError))
2490 PyErr_Clear();
2491 return NULL;
2492 }
2493 if (!PyTuple_Check(bases)) {
2494 Py_DECREF(bases);
2495 return NULL;
2496 }
2497 return bases;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002498}
2499
2500
2501static int
2502abstract_issubclass(PyObject *derived, PyObject *cls)
2503{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002504 PyObject *bases = NULL;
2505 Py_ssize_t i, n;
2506 int r = 0;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002507
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002508 while (1) {
2509 if (derived == cls)
2510 return 1;
2511 bases = abstract_get_bases(derived);
2512 if (bases == NULL) {
2513 if (PyErr_Occurred())
2514 return -1;
2515 return 0;
2516 }
2517 n = PyTuple_GET_SIZE(bases);
2518 if (n == 0) {
2519 Py_DECREF(bases);
2520 return 0;
2521 }
2522 /* Avoid recursivity in the single inheritance case */
2523 if (n == 1) {
2524 derived = PyTuple_GET_ITEM(bases, 0);
2525 Py_DECREF(bases);
2526 continue;
2527 }
2528 for (i = 0; i < n; i++) {
2529 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
2530 if (r != 0)
2531 break;
2532 }
2533 Py_DECREF(bases);
2534 return r;
2535 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002536}
2537
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002538static int
2539check_class(PyObject *cls, const char *error)
2540{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002541 PyObject *bases = abstract_get_bases(cls);
2542 if (bases == NULL) {
2543 /* Do not mask errors. */
2544 if (!PyErr_Occurred())
2545 PyErr_SetString(PyExc_TypeError, error);
2546 return 0;
2547 }
2548 Py_DECREF(bases);
2549 return -1;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002550}
2551
Brett Cannon4f653312004-03-20 22:52:14 +00002552static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002553recursive_isinstance(PyObject *inst, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002554{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002555 PyObject *icls;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002556 int retval = 0;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002557 _Py_IDENTIFIER(__class__);
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002558
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002559 if (PyType_Check(cls)) {
2560 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
2561 if (retval == 0) {
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002562 PyObject *c = _PyObject_GetAttrId(inst, &PyId___class__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002563 if (c == NULL) {
Benjamin Peterson72288d42010-11-20 17:21:08 +00002564 if (PyErr_ExceptionMatches(PyExc_AttributeError))
R. David Murray6bb99892010-11-20 16:33:30 +00002565 PyErr_Clear();
Benjamin Peterson72288d42010-11-20 17:21:08 +00002566 else
R. David Murray6bb99892010-11-20 16:33:30 +00002567 retval = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002568 }
2569 else {
2570 if (c != (PyObject *)(inst->ob_type) &&
2571 PyType_Check(c))
2572 retval = PyType_IsSubtype(
2573 (PyTypeObject *)c,
2574 (PyTypeObject *)cls);
2575 Py_DECREF(c);
2576 }
2577 }
2578 }
2579 else {
2580 if (!check_class(cls,
Benjamin Petersone893af52010-06-28 19:43:42 +00002581 "isinstance() arg 2 must be a type or tuple of types"))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002582 return -1;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002583 icls = _PyObject_GetAttrId(inst, &PyId___class__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002584 if (icls == NULL) {
Benjamin Peterson72288d42010-11-20 17:21:08 +00002585 if (PyErr_ExceptionMatches(PyExc_AttributeError))
R. David Murray6bb99892010-11-20 16:33:30 +00002586 PyErr_Clear();
Benjamin Peterson72288d42010-11-20 17:21:08 +00002587 else
R. David Murray6bb99892010-11-20 16:33:30 +00002588 retval = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002589 }
2590 else {
2591 retval = abstract_issubclass(icls, cls);
2592 Py_DECREF(icls);
2593 }
2594 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002595
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002596 return retval;
Guido van Rossum823649d2001-03-21 18:40:58 +00002597}
2598
2599int
Brett Cannon4f653312004-03-20 22:52:14 +00002600PyObject_IsInstance(PyObject *inst, PyObject *cls)
2601{
Benjamin Petersonce798522012-01-22 11:24:29 -05002602 _Py_IDENTIFIER(__instancecheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002603 PyObject *checker;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002604
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002605 /* Quick test for an exact match */
2606 if (Py_TYPE(inst) == (PyTypeObject *)cls)
2607 return 1;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002608
Georg Brandl72b8a802014-10-03 09:26:37 +02002609 /* We know what type's __instancecheck__ does. */
2610 if (PyType_CheckExact(cls)) {
2611 return recursive_isinstance(inst, cls);
2612 }
2613
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002614 if (PyTuple_Check(cls)) {
2615 Py_ssize_t i;
2616 Py_ssize_t n;
2617 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002618
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002619 if (Py_EnterRecursiveCall(" in __instancecheck__"))
2620 return -1;
2621 n = PyTuple_GET_SIZE(cls);
2622 for (i = 0; i < n; ++i) {
2623 PyObject *item = PyTuple_GET_ITEM(cls, i);
2624 r = PyObject_IsInstance(inst, item);
2625 if (r != 0)
2626 /* either found it, or got an error */
2627 break;
2628 }
2629 Py_LeaveRecursiveCall();
2630 return r;
2631 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002632
Benjamin Petersonce798522012-01-22 11:24:29 -05002633 checker = _PyObject_LookupSpecial(cls, &PyId___instancecheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002634 if (checker != NULL) {
2635 PyObject *res;
2636 int ok = -1;
2637 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2638 Py_DECREF(checker);
2639 return ok;
2640 }
2641 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
2642 Py_LeaveRecursiveCall();
2643 Py_DECREF(checker);
2644 if (res != NULL) {
2645 ok = PyObject_IsTrue(res);
2646 Py_DECREF(res);
2647 }
2648 return ok;
2649 }
2650 else if (PyErr_Occurred())
2651 return -1;
Georg Brandl72b8a802014-10-03 09:26:37 +02002652 /* Probably never reached anymore. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002653 return recursive_isinstance(inst, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002654}
2655
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002656static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002657recursive_issubclass(PyObject *derived, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002658{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002659 if (PyType_Check(cls) && PyType_Check(derived)) {
2660 /* Fast path (non-recursive) */
2661 return PyType_IsSubtype((PyTypeObject *)derived, (PyTypeObject *)cls);
2662 }
2663 if (!check_class(derived,
2664 "issubclass() arg 1 must be a class"))
2665 return -1;
2666 if (!check_class(cls,
2667 "issubclass() arg 2 must be a class"
2668 " or tuple of classes"))
2669 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002670
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002671 return abstract_issubclass(derived, cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002672}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002673
Brett Cannon4f653312004-03-20 22:52:14 +00002674int
2675PyObject_IsSubclass(PyObject *derived, PyObject *cls)
2676{
Benjamin Petersonce798522012-01-22 11:24:29 -05002677 _Py_IDENTIFIER(__subclasscheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002678 PyObject *checker;
Georg Brandldcfe8e42009-05-17 08:22:45 +00002679
Georg Brandl72b8a802014-10-03 09:26:37 +02002680 /* We know what type's __subclasscheck__ does. */
2681 if (PyType_CheckExact(cls)) {
2682 /* Quick test for an exact match */
2683 if (derived == cls)
2684 return 1;
2685 return recursive_issubclass(derived, cls);
2686 }
2687
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002688 if (PyTuple_Check(cls)) {
2689 Py_ssize_t i;
2690 Py_ssize_t n;
2691 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002692
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002693 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
2694 return -1;
2695 n = PyTuple_GET_SIZE(cls);
2696 for (i = 0; i < n; ++i) {
2697 PyObject *item = PyTuple_GET_ITEM(cls, i);
2698 r = PyObject_IsSubclass(derived, item);
2699 if (r != 0)
2700 /* either found it, or got an error */
2701 break;
2702 }
2703 Py_LeaveRecursiveCall();
2704 return r;
2705 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002706
Benjamin Petersonce798522012-01-22 11:24:29 -05002707 checker = _PyObject_LookupSpecial(cls, &PyId___subclasscheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002708 if (checker != NULL) {
2709 PyObject *res;
2710 int ok = -1;
2711 if (Py_EnterRecursiveCall(" in __subclasscheck__")) {
2712 Py_DECREF(checker);
2713 return ok;
2714 }
2715 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
2716 Py_LeaveRecursiveCall();
2717 Py_DECREF(checker);
2718 if (res != NULL) {
2719 ok = PyObject_IsTrue(res);
2720 Py_DECREF(res);
2721 }
2722 return ok;
2723 }
2724 else if (PyErr_Occurred())
2725 return -1;
Georg Brandl72b8a802014-10-03 09:26:37 +02002726 /* Probably never reached anymore. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002727 return recursive_issubclass(derived, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00002728}
2729
2730int
2731_PyObject_RealIsInstance(PyObject *inst, PyObject *cls)
2732{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002733 return recursive_isinstance(inst, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00002734}
2735
2736int
2737_PyObject_RealIsSubclass(PyObject *derived, PyObject *cls)
2738{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002739 return recursive_issubclass(derived, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002740}
2741
2742
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002743PyObject *
2744PyObject_GetIter(PyObject *o)
2745{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002746 PyTypeObject *t = o->ob_type;
2747 getiterfunc f = NULL;
2748 f = t->tp_iter;
2749 if (f == NULL) {
2750 if (PySequence_Check(o))
2751 return PySeqIter_New(o);
2752 return type_error("'%.200s' object is not iterable", o);
2753 }
2754 else {
2755 PyObject *res = (*f)(o);
2756 if (res != NULL && !PyIter_Check(res)) {
2757 PyErr_Format(PyExc_TypeError,
2758 "iter() returned non-iterator "
2759 "of type '%.100s'",
2760 res->ob_type->tp_name);
2761 Py_DECREF(res);
2762 res = NULL;
2763 }
2764 return res;
2765 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00002766}
2767
Tim Petersf4848da2001-05-05 00:14:56 +00002768/* Return next item.
2769 * If an error occurs, return NULL. PyErr_Occurred() will be true.
2770 * If the iteration terminates normally, return NULL and clear the
2771 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
2772 * will be false.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002773 * Else return the next object. PyErr_Occurred() will be false.
Tim Petersf4848da2001-05-05 00:14:56 +00002774 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002775PyObject *
2776PyIter_Next(PyObject *iter)
2777{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002778 PyObject *result;
2779 result = (*iter->ob_type->tp_iternext)(iter);
2780 if (result == NULL &&
2781 PyErr_Occurred() &&
2782 PyErr_ExceptionMatches(PyExc_StopIteration))
2783 PyErr_Clear();
2784 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002785}
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002786
2787
2788/*
2789 * Flatten a sequence of bytes() objects into a C array of
2790 * NULL terminated string pointers with a NULL char* terminating the array.
2791 * (ie: an argv or env list)
2792 *
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002793 * Memory allocated for the returned list is allocated using PyMem_Malloc()
2794 * and MUST be freed by _Py_FreeCharPArray().
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002795 */
2796char *const *
2797_PySequence_BytesToCharpArray(PyObject* self)
2798{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002799 char **array;
2800 Py_ssize_t i, argc;
2801 PyObject *item = NULL;
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002802 Py_ssize_t size;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002803
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002804 argc = PySequence_Size(self);
2805 if (argc == -1)
2806 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002807
Stefan Krah7cacd2e2012-08-21 08:16:09 +02002808 assert(argc >= 0);
2809
2810 if ((size_t)argc > (PY_SSIZE_T_MAX-sizeof(char *)) / sizeof(char *)) {
2811 PyErr_NoMemory();
2812 return NULL;
2813 }
2814
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002815 array = PyMem_Malloc((argc + 1) * sizeof(char *));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002816 if (array == NULL) {
2817 PyErr_NoMemory();
2818 return NULL;
2819 }
2820 for (i = 0; i < argc; ++i) {
2821 char *data;
2822 item = PySequence_GetItem(self, i);
Stefan Krahfd24f9e2012-08-20 11:04:24 +02002823 if (item == NULL) {
2824 /* NULL terminate before freeing. */
2825 array[i] = NULL;
2826 goto fail;
2827 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002828 data = PyBytes_AsString(item);
2829 if (data == NULL) {
2830 /* NULL terminate before freeing. */
2831 array[i] = NULL;
2832 goto fail;
2833 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002834 size = PyBytes_GET_SIZE(item) + 1;
2835 array[i] = PyMem_Malloc(size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002836 if (!array[i]) {
2837 PyErr_NoMemory();
2838 goto fail;
2839 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002840 memcpy(array[i], data, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002841 Py_DECREF(item);
2842 }
2843 array[argc] = NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002844
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002845 return array;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002846
2847fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002848 Py_XDECREF(item);
2849 _Py_FreeCharPArray(array);
2850 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002851}
2852
2853
2854/* Free's a NULL terminated char** array of C strings. */
2855void
2856_Py_FreeCharPArray(char *const array[])
2857{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002858 Py_ssize_t i;
2859 for (i = 0; array[i] != NULL; ++i) {
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002860 PyMem_Free(array[i]);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002861 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002862 PyMem_Free((void*)array);
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002863}