blob: 585992d189e9272c4bdbf3134f86b864a9e4784a [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) {
1727 Py_ssize_t oldn = n;
1728 /* 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 */
1734 n += 10;
1735 n += n >> 2;
1736 if (n < oldn) {
1737 /* Check for overflow */
1738 PyErr_NoMemory();
1739 Py_DECREF(item);
1740 goto Fail;
1741 }
1742 if (_PyTuple_Resize(&result, n) != 0) {
1743 Py_DECREF(item);
1744 goto Fail;
1745 }
1746 }
1747 PyTuple_SET_ITEM(result, j, item);
1748 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001749
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001750 /* Cut tuple back if guess was too large. */
1751 if (j < n &&
1752 _PyTuple_Resize(&result, j) != 0)
1753 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001754
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001755 Py_DECREF(it);
1756 return result;
Tim Peters6912d4d2001-05-05 03:56:37 +00001757
1758Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001759 Py_XDECREF(result);
1760 Py_DECREF(it);
1761 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001762}
1763
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001764PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001765PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001766{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001767 PyObject *result; /* result list */
1768 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00001769
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001770 if (v == NULL)
1771 return null_error();
Guido van Rossum5dba9e81998-07-10 18:03:50 +00001772
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001773 result = PyList_New(0);
1774 if (result == NULL)
1775 return NULL;
Tim Petersf553f892001-05-01 20:45:31 +00001776
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001777 rv = _PyList_Extend((PyListObject *)result, v);
1778 if (rv == NULL) {
1779 Py_DECREF(result);
1780 return NULL;
1781 }
1782 Py_DECREF(rv);
1783 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001784}
1785
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001786PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001787PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001788{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001789 PyObject *it;
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001790
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001791 if (v == NULL)
1792 return null_error();
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001793
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001794 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
1795 Py_INCREF(v);
1796 return v;
1797 }
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001798
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001799 it = PyObject_GetIter(v);
1800 if (it == NULL) {
1801 if (PyErr_ExceptionMatches(PyExc_TypeError))
1802 PyErr_SetString(PyExc_TypeError, m);
1803 return NULL;
1804 }
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001805
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001806 v = PySequence_List(it);
1807 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001808
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001809 return v;
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001810}
1811
Tim Peters16a77ad2001-09-08 04:00:12 +00001812/* Iterate over seq. Result depends on the operation:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001813 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
1814 PY_ITERSEARCH_INDEX: 0-based index of first occurrence of obj in seq;
1815 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00001816 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
1817*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001818Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001819_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00001820{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001821 Py_ssize_t n;
1822 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
1823 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00001824
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001825 if (seq == NULL || obj == NULL) {
1826 null_error();
1827 return -1;
1828 }
Tim Peters75f8e352001-05-05 11:33:43 +00001829
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001830 it = PyObject_GetIter(seq);
1831 if (it == NULL) {
1832 type_error("argument of type '%.200s' is not iterable", seq);
1833 return -1;
1834 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001835
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001836 n = wrapped = 0;
1837 for (;;) {
1838 int cmp;
1839 PyObject *item = PyIter_Next(it);
1840 if (item == NULL) {
1841 if (PyErr_Occurred())
1842 goto Fail;
1843 break;
1844 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001845
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001846 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
1847 Py_DECREF(item);
1848 if (cmp < 0)
1849 goto Fail;
1850 if (cmp > 0) {
1851 switch (operation) {
1852 case PY_ITERSEARCH_COUNT:
1853 if (n == PY_SSIZE_T_MAX) {
1854 PyErr_SetString(PyExc_OverflowError,
1855 "count exceeds C integer size");
1856 goto Fail;
1857 }
1858 ++n;
1859 break;
Tim Peters16a77ad2001-09-08 04:00:12 +00001860
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001861 case PY_ITERSEARCH_INDEX:
1862 if (wrapped) {
1863 PyErr_SetString(PyExc_OverflowError,
1864 "index exceeds C integer size");
1865 goto Fail;
1866 }
1867 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001868
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001869 case PY_ITERSEARCH_CONTAINS:
1870 n = 1;
1871 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001872
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001873 default:
1874 assert(!"unknown operation");
1875 }
1876 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001877
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001878 if (operation == PY_ITERSEARCH_INDEX) {
1879 if (n == PY_SSIZE_T_MAX)
1880 wrapped = 1;
1881 ++n;
1882 }
1883 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001884
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001885 if (operation != PY_ITERSEARCH_INDEX)
1886 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001887
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001888 PyErr_SetString(PyExc_ValueError,
1889 "sequence.index(x): x not in sequence");
1890 /* fall into failure code */
Tim Peters16a77ad2001-09-08 04:00:12 +00001891Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001892 n = -1;
1893 /* fall through */
Tim Peters16a77ad2001-09-08 04:00:12 +00001894Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001895 Py_DECREF(it);
1896 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00001897
Guido van Rossume15dee51995-07-18 14:12:02 +00001898}
1899
Tim Peters16a77ad2001-09-08 04:00:12 +00001900/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001901Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001902PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001903{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001904 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00001905}
1906
Tim Peterscb8d3682001-05-05 21:05:01 +00001907/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00001908 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00001909 */
1910int
1911PySequence_Contains(PyObject *seq, PyObject *ob)
1912{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001913 Py_ssize_t result;
1914 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
1915 if (sqm != NULL && sqm->sq_contains != NULL)
1916 return (*sqm->sq_contains)(seq, ob);
1917 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
1918 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00001919}
1920
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001921/* Backwards compatibility */
1922#undef PySequence_In
1923int
Fred Drake79912472000-07-09 04:06:11 +00001924PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001925{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001926 return PySequence_Contains(w, v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001927}
1928
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001929Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00001930PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001931{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001932 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00001933}
1934
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001935/* Operations on mappings */
1936
1937int
Fred Drake79912472000-07-09 04:06:11 +00001938PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001939{
Benjamin Peterson21992272011-12-28 12:01:31 -06001940 return o && o->ob_type->tp_as_mapping &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001941 o->ob_type->tp_as_mapping->mp_subscript;
Guido van Rossume15dee51995-07-18 14:12:02 +00001942}
1943
Martin v. Löwis18e16552006-02-15 17:27:45 +00001944Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001945PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001946{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001947 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001948
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001949 if (o == NULL) {
1950 null_error();
1951 return -1;
1952 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001953
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001954 m = o->ob_type->tp_as_mapping;
1955 if (m && m->mp_length)
1956 return m->mp_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001957
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001958 type_error("object of type '%.200s' has no len()", o);
1959 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001960}
1961
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001962#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001963Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001964PyMapping_Length(PyObject *o)
1965{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001966 return PyMapping_Size(o);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001967}
1968#define PyMapping_Length PyMapping_Size
1969
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001970PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +03001971PyMapping_GetItemString(PyObject *o, const char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001972{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001973 PyObject *okey, *r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001974
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001975 if (key == NULL)
1976 return null_error();
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001977
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001978 okey = PyUnicode_FromString(key);
1979 if (okey == NULL)
1980 return NULL;
1981 r = PyObject_GetItem(o, okey);
1982 Py_DECREF(okey);
1983 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001984}
1985
1986int
Serhiy Storchakac6792272013-10-19 21:03:34 +03001987PyMapping_SetItemString(PyObject *o, const char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001988{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001989 PyObject *okey;
1990 int r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001991
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001992 if (key == NULL) {
1993 null_error();
1994 return -1;
1995 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001996
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001997 okey = PyUnicode_FromString(key);
1998 if (okey == NULL)
1999 return -1;
2000 r = PyObject_SetItem(o, okey, value);
2001 Py_DECREF(okey);
2002 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002003}
2004
2005int
Serhiy Storchakac6792272013-10-19 21:03:34 +03002006PyMapping_HasKeyString(PyObject *o, const char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002007{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002008 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002009
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002010 v = PyMapping_GetItemString(o, key);
2011 if (v) {
2012 Py_DECREF(v);
2013 return 1;
2014 }
2015 PyErr_Clear();
2016 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002017}
2018
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002019int
Fred Drake79912472000-07-09 04:06:11 +00002020PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002021{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002022 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002023
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002024 v = PyObject_GetItem(o, key);
2025 if (v) {
2026 Py_DECREF(v);
2027 return 1;
2028 }
2029 PyErr_Clear();
2030 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002031}
2032
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002033PyObject *
2034PyMapping_Keys(PyObject *o)
2035{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002036 PyObject *keys;
2037 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002038 _Py_IDENTIFIER(keys);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002039
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002040 if (PyDict_CheckExact(o))
2041 return PyDict_Keys(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002042 keys = _PyObject_CallMethodId(o, &PyId_keys, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002043 if (keys == NULL)
2044 return NULL;
2045 fast = PySequence_Fast(keys, "o.keys() are not iterable");
2046 Py_DECREF(keys);
2047 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002048}
2049
2050PyObject *
2051PyMapping_Items(PyObject *o)
2052{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002053 PyObject *items;
2054 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002055 _Py_IDENTIFIER(items);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002056
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002057 if (PyDict_CheckExact(o))
2058 return PyDict_Items(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002059 items = _PyObject_CallMethodId(o, &PyId_items, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002060 if (items == NULL)
2061 return NULL;
2062 fast = PySequence_Fast(items, "o.items() are not iterable");
2063 Py_DECREF(items);
2064 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002065}
2066
2067PyObject *
2068PyMapping_Values(PyObject *o)
2069{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002070 PyObject *values;
2071 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002072 _Py_IDENTIFIER(values);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002073
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002074 if (PyDict_CheckExact(o))
2075 return PyDict_Values(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002076 values = _PyObject_CallMethodId(o, &PyId_values, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002077 if (values == NULL)
2078 return NULL;
2079 fast = PySequence_Fast(values, "o.values() are not iterable");
2080 Py_DECREF(values);
2081 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002082}
2083
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002084/* Operations on callable objects */
2085
2086/* XXX PyCallable_Check() is in object.c */
2087
Guido van Rossume15dee51995-07-18 14:12:02 +00002088PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002089PyObject_CallObject(PyObject *o, PyObject *a)
Guido van Rossume15dee51995-07-18 14:12:02 +00002090{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002091 return PyEval_CallObjectWithKeywords(o, a, NULL);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002092}
Guido van Rossume15dee51995-07-18 14:12:02 +00002093
Victor Stinner4a7cc882015-03-06 23:35:27 +01002094PyObject*
Victor Stinnerefde1462015-03-21 15:04:43 +01002095_Py_CheckFunctionResult(PyObject *func, PyObject *result, const char *where)
Victor Stinner4a7cc882015-03-06 23:35:27 +01002096{
2097 int err_occurred = (PyErr_Occurred() != NULL);
2098
Victor Stinnerefde1462015-03-21 15:04:43 +01002099 assert((func != NULL) ^ (where != NULL));
2100
Victor Stinner4a7cc882015-03-06 23:35:27 +01002101 if (result == NULL) {
2102 if (!err_occurred) {
Victor Stinnerefde1462015-03-21 15:04:43 +01002103 if (func)
2104 PyErr_Format(PyExc_SystemError,
2105 "%R returned NULL without setting an error",
2106 func);
2107 else
2108 PyErr_Format(PyExc_SystemError,
2109 "%s returned NULL without setting an error",
2110 where);
Victor Stinner944fbcc2015-03-24 16:28:52 +01002111#ifdef Py_DEBUG
Martin Panter2275e622016-06-20 07:52:50 +00002112 /* Ensure that the bug is caught in debug mode */
Victor Stinner944fbcc2015-03-24 16:28:52 +01002113 Py_FatalError("a function returned NULL without setting an error");
2114#endif
2115 return NULL;
Victor Stinner4a7cc882015-03-06 23:35:27 +01002116 }
2117 }
2118 else {
2119 if (err_occurred) {
2120 PyObject *exc, *val, *tb;
2121 PyErr_Fetch(&exc, &val, &tb);
2122
2123 Py_DECREF(result);
2124
Victor Stinnerefde1462015-03-21 15:04:43 +01002125 if (func)
2126 PyErr_Format(PyExc_SystemError,
2127 "%R returned a result with an error set",
2128 func);
2129 else
2130 PyErr_Format(PyExc_SystemError,
2131 "%s returned a result with an error set",
2132 where);
Victor Stinner4a7cc882015-03-06 23:35:27 +01002133 _PyErr_ChainExceptions(exc, val, tb);
Victor Stinner944fbcc2015-03-24 16:28:52 +01002134#ifdef Py_DEBUG
Martin Panter2275e622016-06-20 07:52:50 +00002135 /* Ensure that the bug is caught in debug mode */
Victor Stinner944fbcc2015-03-24 16:28:52 +01002136 Py_FatalError("a function returned a result with an error set");
2137#endif
2138 return NULL;
Victor Stinner4a7cc882015-03-06 23:35:27 +01002139 }
2140 }
2141 return result;
2142}
2143
Guido van Rossume15dee51995-07-18 14:12:02 +00002144PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002145PyObject_Call(PyObject *func, PyObject *arg, PyObject *kw)
2146{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002147 ternaryfunc call;
Victor Stinner4a7cc882015-03-06 23:35:27 +01002148 PyObject *result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002149
Victor Stinner8f4ec8d2014-09-05 01:10:29 +02002150 /* PyObject_Call() must not be called with an exception set,
2151 because it may clear it (directly or indirectly) and so the
Martin Panterec1aa5c2015-10-07 11:03:53 +00002152 caller loses its exception */
Victor Stinner8f4ec8d2014-09-05 01:10:29 +02002153 assert(!PyErr_Occurred());
2154
Victor Stinner4a7cc882015-03-06 23:35:27 +01002155 call = func->ob_type->tp_call;
2156 if (call == NULL) {
2157 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
2158 func->ob_type->tp_name);
2159 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002160 }
Victor Stinner4a7cc882015-03-06 23:35:27 +01002161
2162 if (Py_EnterRecursiveCall(" while calling a Python object"))
2163 return NULL;
2164
2165 result = (*call)(func, arg, kw);
2166
2167 Py_LeaveRecursiveCall();
2168
Victor Stinnerefde1462015-03-21 15:04:43 +01002169 return _Py_CheckFunctionResult(func, result, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002170}
2171
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002172static PyObject*
2173call_function_tail(PyObject *callable, PyObject *args)
2174{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002175 PyObject *retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002176
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002177 if (args == NULL)
2178 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002179
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002180 if (!PyTuple_Check(args)) {
2181 PyObject *a;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002182
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002183 a = PyTuple_New(1);
2184 if (a == NULL) {
2185 Py_DECREF(args);
2186 return NULL;
2187 }
2188 PyTuple_SET_ITEM(a, 0, args);
2189 args = a;
2190 }
2191 retval = PyObject_Call(callable, args, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002192
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002193 Py_DECREF(args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002194
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002195 return retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002196}
2197
Tim Peters6d6c1a32001-08-02 04:15:00 +00002198PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002199PyObject_CallFunction(PyObject *callable, const char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002200{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002201 va_list va;
2202 PyObject *args;
Guido van Rossume15dee51995-07-18 14:12:02 +00002203
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002204 if (callable == NULL)
2205 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002206
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002207 if (format && *format) {
2208 va_start(va, format);
2209 args = Py_VaBuildValue(format, va);
2210 va_end(va);
2211 }
2212 else
2213 args = PyTuple_New(0);
Victor Stinner0b0c8672013-10-29 19:29:52 +01002214 if (args == NULL)
2215 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002216
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002217 return call_function_tail(callable, args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002218}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002219
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002220PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002221_PyObject_CallFunction_SizeT(PyObject *callable, const char *format, ...)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002222{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002223 va_list va;
2224 PyObject *args;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002225
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002226 if (callable == NULL)
2227 return null_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002228
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002229 if (format && *format) {
2230 va_start(va, format);
2231 args = _Py_VaBuildValue_SizeT(format, va);
2232 va_end(va);
2233 }
2234 else
2235 args = PyTuple_New(0);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002236
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002237 return call_function_tail(callable, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002238}
2239
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002240static PyObject*
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002241callmethod(PyObject* func, const char *format, va_list va, int is_size_t)
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002242{
2243 PyObject *retval = NULL;
2244 PyObject *args;
2245
2246 if (!PyCallable_Check(func)) {
2247 type_error("attribute of type '%.200s' is not callable", func);
2248 goto exit;
2249 }
2250
2251 if (format && *format) {
2252 if (is_size_t)
2253 args = _Py_VaBuildValue_SizeT(format, va);
2254 else
2255 args = Py_VaBuildValue(format, va);
2256 }
2257 else
2258 args = PyTuple_New(0);
2259
2260 retval = call_function_tail(func, args);
2261
2262 exit:
2263 /* args gets consumed in call_function_tail */
2264 Py_XDECREF(func);
2265
2266 return retval;
2267}
2268
Guido van Rossume15dee51995-07-18 14:12:02 +00002269PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002270PyObject_CallMethod(PyObject *o, const char *name, const char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002271{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002272 va_list va;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002273 PyObject *func = NULL;
2274 PyObject *retval = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002275
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002276 if (o == NULL || name == NULL)
2277 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002278
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002279 func = PyObject_GetAttrString(o, name);
Benjamin Peterson1791c222014-06-26 23:29:13 -07002280 if (func == NULL)
2281 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002282
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002283 va_start(va, format);
2284 retval = callmethod(func, format, va, 0);
2285 va_end(va);
2286 return retval;
2287}
2288
2289PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002290_PyObject_CallMethodId(PyObject *o, _Py_Identifier *name,
2291 const char *format, ...)
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002292{
2293 va_list va;
2294 PyObject *func = NULL;
2295 PyObject *retval = NULL;
2296
2297 if (o == NULL || name == NULL)
2298 return null_error();
2299
2300 func = _PyObject_GetAttrId(o, name);
Benjamin Peterson1791c222014-06-26 23:29:13 -07002301 if (func == NULL)
2302 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002303
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002304 va_start(va, format);
2305 retval = callmethod(func, format, va, 0);
2306 va_end(va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002307 return retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002308}
2309
2310PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002311_PyObject_CallMethod_SizeT(PyObject *o, const char *name,
2312 const char *format, ...)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002313{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002314 va_list va;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002315 PyObject *func = NULL;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002316 PyObject *retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002317
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002318 if (o == NULL || name == NULL)
2319 return null_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002320
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002321 func = PyObject_GetAttrString(o, name);
Benjamin Peterson1791c222014-06-26 23:29:13 -07002322 if (func == NULL)
2323 return NULL;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002324 va_start(va, format);
2325 retval = callmethod(func, format, va, 1);
2326 va_end(va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002327 return retval;
Guido van Rossume15dee51995-07-18 14:12:02 +00002328}
Guido van Rossum823649d2001-03-21 18:40:58 +00002329
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002330PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002331_PyObject_CallMethodId_SizeT(PyObject *o, _Py_Identifier *name,
2332 const char *format, ...)
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002333{
2334 va_list va;
2335 PyObject *func = NULL;
2336 PyObject *retval;
2337
2338 if (o == NULL || name == NULL)
2339 return null_error();
2340
2341 func = _PyObject_GetAttrId(o, name);
2342 if (func == NULL) {
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002343 return NULL;
2344 }
2345 va_start(va, format);
2346 retval = callmethod(func, format, va, 1);
2347 va_end(va);
2348 return retval;
2349}
Guido van Rossum823649d2001-03-21 18:40:58 +00002350
Fred Drakeb421b8c2001-10-26 16:21:32 +00002351static PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002352objargs_mktuple(va_list va)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002353{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002354 int i, n = 0;
2355 va_list countva;
2356 PyObject *result, *tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002357
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00002358 Py_VA_COPY(countva, va);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002359
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002360 while (((PyObject *)va_arg(countva, PyObject *)) != NULL)
2361 ++n;
2362 result = PyTuple_New(n);
2363 if (result != NULL && n > 0) {
2364 for (i = 0; i < n; ++i) {
2365 tmp = (PyObject *)va_arg(va, PyObject *);
2366 PyTuple_SET_ITEM(result, i, tmp);
2367 Py_INCREF(tmp);
2368 }
2369 }
2370 return result;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002371}
2372
2373PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002374PyObject_CallMethodObjArgs(PyObject *callable, PyObject *name, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002375{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002376 PyObject *args, *tmp;
2377 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002378
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002379 if (callable == NULL || name == NULL)
2380 return null_error();
Fred Drakeb421b8c2001-10-26 16:21:32 +00002381
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002382 callable = PyObject_GetAttr(callable, name);
2383 if (callable == NULL)
2384 return NULL;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002385
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002386 /* count the args */
2387 va_start(vargs, name);
2388 args = objargs_mktuple(vargs);
2389 va_end(vargs);
2390 if (args == NULL) {
2391 Py_DECREF(callable);
2392 return NULL;
2393 }
2394 tmp = PyObject_Call(callable, args, NULL);
2395 Py_DECREF(args);
2396 Py_DECREF(callable);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002397
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002398 return tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002399}
2400
2401PyObject *
Alexandre Vassalotti865eaa12013-05-02 10:44:04 -07002402_PyObject_CallMethodIdObjArgs(PyObject *callable,
Brett Cannonfd074152012-04-14 14:10:13 -04002403 struct _Py_Identifier *name, ...)
2404{
2405 PyObject *args, *tmp;
2406 va_list vargs;
2407
2408 if (callable == NULL || name == NULL)
2409 return null_error();
2410
2411 callable = _PyObject_GetAttrId(callable, name);
2412 if (callable == NULL)
2413 return NULL;
2414
2415 /* count the args */
2416 va_start(vargs, name);
2417 args = objargs_mktuple(vargs);
2418 va_end(vargs);
2419 if (args == NULL) {
2420 Py_DECREF(callable);
2421 return NULL;
2422 }
2423 tmp = PyObject_Call(callable, args, NULL);
2424 Py_DECREF(args);
2425 Py_DECREF(callable);
2426
2427 return tmp;
2428}
2429
2430PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002431PyObject_CallFunctionObjArgs(PyObject *callable, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002432{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002433 PyObject *args, *tmp;
2434 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002436 if (callable == NULL)
2437 return null_error();
Fred Drakeb421b8c2001-10-26 16:21:32 +00002438
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002439 /* count the args */
2440 va_start(vargs, callable);
2441 args = objargs_mktuple(vargs);
2442 va_end(vargs);
2443 if (args == NULL)
2444 return NULL;
2445 tmp = PyObject_Call(callable, args, NULL);
2446 Py_DECREF(args);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002447
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002448 return tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002449}
2450
2451
Guido van Rossum823649d2001-03-21 18:40:58 +00002452/* isinstance(), issubclass() */
2453
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002454/* abstract_get_bases() has logically 4 return states:
Barry Warsawf16951c2002-04-23 22:45:44 +00002455 *
Barry Warsawf16951c2002-04-23 22:45:44 +00002456 * 1. getattr(cls, '__bases__') could raise an AttributeError
2457 * 2. getattr(cls, '__bases__') could raise some other exception
2458 * 3. getattr(cls, '__bases__') could return a tuple
2459 * 4. getattr(cls, '__bases__') could return something other than a tuple
2460 *
2461 * Only state #3 is a non-error state and only it returns a non-NULL object
2462 * (it returns the retrieved tuple).
2463 *
2464 * Any raised AttributeErrors are masked by clearing the exception and
2465 * returning NULL. If an object other than a tuple comes out of __bases__,
2466 * then again, the return value is NULL. So yes, these two situations
2467 * produce exactly the same results: NULL is returned and no error is set.
2468 *
2469 * If some exception other than AttributeError is raised, then NULL is also
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002470 * returned, but the exception is not cleared. That's because we want the
Barry Warsawf16951c2002-04-23 22:45:44 +00002471 * exception to be propagated along.
2472 *
2473 * Callers are expected to test for PyErr_Occurred() when the return value
2474 * is NULL to decide whether a valid exception should be propagated or not.
2475 * When there's no exception to propagate, it's customary for the caller to
2476 * set a TypeError.
2477 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002478static PyObject *
2479abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002480{
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002481 _Py_IDENTIFIER(__bases__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002482 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002483
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002484 Py_ALLOW_RECURSION
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002485 bases = _PyObject_GetAttrId(cls, &PyId___bases__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002486 Py_END_ALLOW_RECURSION
2487 if (bases == NULL) {
2488 if (PyErr_ExceptionMatches(PyExc_AttributeError))
2489 PyErr_Clear();
2490 return NULL;
2491 }
2492 if (!PyTuple_Check(bases)) {
2493 Py_DECREF(bases);
2494 return NULL;
2495 }
2496 return bases;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002497}
2498
2499
2500static int
2501abstract_issubclass(PyObject *derived, PyObject *cls)
2502{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002503 PyObject *bases = NULL;
2504 Py_ssize_t i, n;
2505 int r = 0;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002506
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002507 while (1) {
2508 if (derived == cls)
2509 return 1;
2510 bases = abstract_get_bases(derived);
2511 if (bases == NULL) {
2512 if (PyErr_Occurred())
2513 return -1;
2514 return 0;
2515 }
2516 n = PyTuple_GET_SIZE(bases);
2517 if (n == 0) {
2518 Py_DECREF(bases);
2519 return 0;
2520 }
2521 /* Avoid recursivity in the single inheritance case */
2522 if (n == 1) {
2523 derived = PyTuple_GET_ITEM(bases, 0);
2524 Py_DECREF(bases);
2525 continue;
2526 }
2527 for (i = 0; i < n; i++) {
2528 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
2529 if (r != 0)
2530 break;
2531 }
2532 Py_DECREF(bases);
2533 return r;
2534 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002535}
2536
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002537static int
2538check_class(PyObject *cls, const char *error)
2539{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002540 PyObject *bases = abstract_get_bases(cls);
2541 if (bases == NULL) {
2542 /* Do not mask errors. */
2543 if (!PyErr_Occurred())
2544 PyErr_SetString(PyExc_TypeError, error);
2545 return 0;
2546 }
2547 Py_DECREF(bases);
2548 return -1;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002549}
2550
Brett Cannon4f653312004-03-20 22:52:14 +00002551static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002552recursive_isinstance(PyObject *inst, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002553{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002554 PyObject *icls;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002555 int retval = 0;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002556 _Py_IDENTIFIER(__class__);
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002557
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002558 if (PyType_Check(cls)) {
2559 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
2560 if (retval == 0) {
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002561 PyObject *c = _PyObject_GetAttrId(inst, &PyId___class__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002562 if (c == NULL) {
Benjamin Peterson72288d42010-11-20 17:21:08 +00002563 if (PyErr_ExceptionMatches(PyExc_AttributeError))
R. David Murray6bb99892010-11-20 16:33:30 +00002564 PyErr_Clear();
Benjamin Peterson72288d42010-11-20 17:21:08 +00002565 else
R. David Murray6bb99892010-11-20 16:33:30 +00002566 retval = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002567 }
2568 else {
2569 if (c != (PyObject *)(inst->ob_type) &&
2570 PyType_Check(c))
2571 retval = PyType_IsSubtype(
2572 (PyTypeObject *)c,
2573 (PyTypeObject *)cls);
2574 Py_DECREF(c);
2575 }
2576 }
2577 }
2578 else {
2579 if (!check_class(cls,
Benjamin Petersone893af52010-06-28 19:43:42 +00002580 "isinstance() arg 2 must be a type or tuple of types"))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002581 return -1;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002582 icls = _PyObject_GetAttrId(inst, &PyId___class__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002583 if (icls == NULL) {
Benjamin Peterson72288d42010-11-20 17:21:08 +00002584 if (PyErr_ExceptionMatches(PyExc_AttributeError))
R. David Murray6bb99892010-11-20 16:33:30 +00002585 PyErr_Clear();
Benjamin Peterson72288d42010-11-20 17:21:08 +00002586 else
R. David Murray6bb99892010-11-20 16:33:30 +00002587 retval = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002588 }
2589 else {
2590 retval = abstract_issubclass(icls, cls);
2591 Py_DECREF(icls);
2592 }
2593 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002594
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002595 return retval;
Guido van Rossum823649d2001-03-21 18:40:58 +00002596}
2597
2598int
Brett Cannon4f653312004-03-20 22:52:14 +00002599PyObject_IsInstance(PyObject *inst, PyObject *cls)
2600{
Benjamin Petersonce798522012-01-22 11:24:29 -05002601 _Py_IDENTIFIER(__instancecheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002602 PyObject *checker;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002603
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002604 /* Quick test for an exact match */
2605 if (Py_TYPE(inst) == (PyTypeObject *)cls)
2606 return 1;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002607
Georg Brandl72b8a802014-10-03 09:26:37 +02002608 /* We know what type's __instancecheck__ does. */
2609 if (PyType_CheckExact(cls)) {
2610 return recursive_isinstance(inst, cls);
2611 }
2612
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002613 if (PyTuple_Check(cls)) {
2614 Py_ssize_t i;
2615 Py_ssize_t n;
2616 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002617
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002618 if (Py_EnterRecursiveCall(" in __instancecheck__"))
2619 return -1;
2620 n = PyTuple_GET_SIZE(cls);
2621 for (i = 0; i < n; ++i) {
2622 PyObject *item = PyTuple_GET_ITEM(cls, i);
2623 r = PyObject_IsInstance(inst, item);
2624 if (r != 0)
2625 /* either found it, or got an error */
2626 break;
2627 }
2628 Py_LeaveRecursiveCall();
2629 return r;
2630 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002631
Benjamin Petersonce798522012-01-22 11:24:29 -05002632 checker = _PyObject_LookupSpecial(cls, &PyId___instancecheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002633 if (checker != NULL) {
2634 PyObject *res;
2635 int ok = -1;
2636 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2637 Py_DECREF(checker);
2638 return ok;
2639 }
2640 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
2641 Py_LeaveRecursiveCall();
2642 Py_DECREF(checker);
2643 if (res != NULL) {
2644 ok = PyObject_IsTrue(res);
2645 Py_DECREF(res);
2646 }
2647 return ok;
2648 }
2649 else if (PyErr_Occurred())
2650 return -1;
Georg Brandl72b8a802014-10-03 09:26:37 +02002651 /* Probably never reached anymore. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002652 return recursive_isinstance(inst, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002653}
2654
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002655static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002656recursive_issubclass(PyObject *derived, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002657{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002658 if (PyType_Check(cls) && PyType_Check(derived)) {
2659 /* Fast path (non-recursive) */
2660 return PyType_IsSubtype((PyTypeObject *)derived, (PyTypeObject *)cls);
2661 }
2662 if (!check_class(derived,
2663 "issubclass() arg 1 must be a class"))
2664 return -1;
2665 if (!check_class(cls,
2666 "issubclass() arg 2 must be a class"
2667 " or tuple of classes"))
2668 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002669
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002670 return abstract_issubclass(derived, cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002671}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002672
Brett Cannon4f653312004-03-20 22:52:14 +00002673int
2674PyObject_IsSubclass(PyObject *derived, PyObject *cls)
2675{
Benjamin Petersonce798522012-01-22 11:24:29 -05002676 _Py_IDENTIFIER(__subclasscheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002677 PyObject *checker;
Georg Brandldcfe8e42009-05-17 08:22:45 +00002678
Georg Brandl72b8a802014-10-03 09:26:37 +02002679 /* We know what type's __subclasscheck__ does. */
2680 if (PyType_CheckExact(cls)) {
2681 /* Quick test for an exact match */
2682 if (derived == cls)
2683 return 1;
2684 return recursive_issubclass(derived, cls);
2685 }
2686
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002687 if (PyTuple_Check(cls)) {
2688 Py_ssize_t i;
2689 Py_ssize_t n;
2690 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002691
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002692 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
2693 return -1;
2694 n = PyTuple_GET_SIZE(cls);
2695 for (i = 0; i < n; ++i) {
2696 PyObject *item = PyTuple_GET_ITEM(cls, i);
2697 r = PyObject_IsSubclass(derived, item);
2698 if (r != 0)
2699 /* either found it, or got an error */
2700 break;
2701 }
2702 Py_LeaveRecursiveCall();
2703 return r;
2704 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002705
Benjamin Petersonce798522012-01-22 11:24:29 -05002706 checker = _PyObject_LookupSpecial(cls, &PyId___subclasscheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002707 if (checker != NULL) {
2708 PyObject *res;
2709 int ok = -1;
2710 if (Py_EnterRecursiveCall(" in __subclasscheck__")) {
2711 Py_DECREF(checker);
2712 return ok;
2713 }
2714 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
2715 Py_LeaveRecursiveCall();
2716 Py_DECREF(checker);
2717 if (res != NULL) {
2718 ok = PyObject_IsTrue(res);
2719 Py_DECREF(res);
2720 }
2721 return ok;
2722 }
2723 else if (PyErr_Occurred())
2724 return -1;
Georg Brandl72b8a802014-10-03 09:26:37 +02002725 /* Probably never reached anymore. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002726 return recursive_issubclass(derived, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00002727}
2728
2729int
2730_PyObject_RealIsInstance(PyObject *inst, PyObject *cls)
2731{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002732 return recursive_isinstance(inst, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00002733}
2734
2735int
2736_PyObject_RealIsSubclass(PyObject *derived, PyObject *cls)
2737{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002738 return recursive_issubclass(derived, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002739}
2740
2741
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002742PyObject *
2743PyObject_GetIter(PyObject *o)
2744{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002745 PyTypeObject *t = o->ob_type;
2746 getiterfunc f = NULL;
2747 f = t->tp_iter;
2748 if (f == NULL) {
2749 if (PySequence_Check(o))
2750 return PySeqIter_New(o);
2751 return type_error("'%.200s' object is not iterable", o);
2752 }
2753 else {
2754 PyObject *res = (*f)(o);
2755 if (res != NULL && !PyIter_Check(res)) {
2756 PyErr_Format(PyExc_TypeError,
2757 "iter() returned non-iterator "
2758 "of type '%.100s'",
2759 res->ob_type->tp_name);
2760 Py_DECREF(res);
2761 res = NULL;
2762 }
2763 return res;
2764 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00002765}
2766
Tim Petersf4848da2001-05-05 00:14:56 +00002767/* Return next item.
2768 * If an error occurs, return NULL. PyErr_Occurred() will be true.
2769 * If the iteration terminates normally, return NULL and clear the
2770 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
2771 * will be false.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002772 * Else return the next object. PyErr_Occurred() will be false.
Tim Petersf4848da2001-05-05 00:14:56 +00002773 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002774PyObject *
2775PyIter_Next(PyObject *iter)
2776{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002777 PyObject *result;
2778 result = (*iter->ob_type->tp_iternext)(iter);
2779 if (result == NULL &&
2780 PyErr_Occurred() &&
2781 PyErr_ExceptionMatches(PyExc_StopIteration))
2782 PyErr_Clear();
2783 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002784}
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002785
2786
2787/*
2788 * Flatten a sequence of bytes() objects into a C array of
2789 * NULL terminated string pointers with a NULL char* terminating the array.
2790 * (ie: an argv or env list)
2791 *
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002792 * Memory allocated for the returned list is allocated using PyMem_Malloc()
2793 * and MUST be freed by _Py_FreeCharPArray().
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002794 */
2795char *const *
2796_PySequence_BytesToCharpArray(PyObject* self)
2797{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002798 char **array;
2799 Py_ssize_t i, argc;
2800 PyObject *item = NULL;
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002801 Py_ssize_t size;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002802
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002803 argc = PySequence_Size(self);
2804 if (argc == -1)
2805 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002806
Stefan Krah7cacd2e2012-08-21 08:16:09 +02002807 assert(argc >= 0);
2808
2809 if ((size_t)argc > (PY_SSIZE_T_MAX-sizeof(char *)) / sizeof(char *)) {
2810 PyErr_NoMemory();
2811 return NULL;
2812 }
2813
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002814 array = PyMem_Malloc((argc + 1) * sizeof(char *));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002815 if (array == NULL) {
2816 PyErr_NoMemory();
2817 return NULL;
2818 }
2819 for (i = 0; i < argc; ++i) {
2820 char *data;
2821 item = PySequence_GetItem(self, i);
Stefan Krahfd24f9e2012-08-20 11:04:24 +02002822 if (item == NULL) {
2823 /* NULL terminate before freeing. */
2824 array[i] = NULL;
2825 goto fail;
2826 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002827 data = PyBytes_AsString(item);
2828 if (data == NULL) {
2829 /* NULL terminate before freeing. */
2830 array[i] = NULL;
2831 goto fail;
2832 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002833 size = PyBytes_GET_SIZE(item) + 1;
2834 array[i] = PyMem_Malloc(size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002835 if (!array[i]) {
2836 PyErr_NoMemory();
2837 goto fail;
2838 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002839 memcpy(array[i], data, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002840 Py_DECREF(item);
2841 }
2842 array[argc] = NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002843
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002844 return array;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002845
2846fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002847 Py_XDECREF(item);
2848 _Py_FreeCharPArray(array);
2849 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002850}
2851
2852
2853/* Free's a NULL terminated char** array of C strings. */
2854void
2855_Py_FreeCharPArray(char *const array[])
2856{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002857 Py_ssize_t i;
2858 for (i = 0; array[i] != NULL; ++i) {
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002859 PyMem_Free(array[i]);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002860 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002861 PyMem_Free((void*)array);
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002862}