blob: 5e9613816a834f6b73f508c092dc81f6d42a3c6e [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,
308 "expected an object with a writable buffer interface");
309 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,
Victor Stinner0a5f65a2011-03-22 01:09:21 +0100327 "'%.100s' does not support the buffer interface",
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
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000340 if (view->ndim == 0) return 1;
341 if (view->strides == NULL) return (view->ndim == 1);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000342
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000343 sd = view->itemsize;
344 if (view->ndim == 1) return (view->shape[0] == 1 ||
345 sd == view->strides[0]);
346 for (i=0; i<view->ndim; i++) {
347 dim = view->shape[i];
348 if (dim == 0) return 1;
349 if (view->strides[i] != sd) return 0;
350 sd *= dim;
351 }
352 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000353}
354
355static int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100356_IsCContiguous(const Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000357{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000358 Py_ssize_t sd, dim;
359 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000360
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000361 if (view->ndim == 0) return 1;
362 if (view->strides == NULL) return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000363
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000364 sd = view->itemsize;
365 if (view->ndim == 1) return (view->shape[0] == 1 ||
366 sd == view->strides[0]);
367 for (i=view->ndim-1; i>=0; i--) {
368 dim = view->shape[i];
369 if (dim == 0) return 1;
370 if (view->strides[i] != sd) return 0;
371 sd *= dim;
372 }
373 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000374}
375
376int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100377PyBuffer_IsContiguous(const Py_buffer *view, char order)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000378{
379
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000380 if (view->suboffsets != NULL) return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000381
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100382 if (order == 'C')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000383 return _IsCContiguous(view);
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100384 else if (order == 'F')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000385 return _IsFortranContiguous(view);
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100386 else if (order == 'A')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000387 return (_IsCContiguous(view) || _IsFortranContiguous(view));
388 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000389}
390
391
Guido van Rossum98297ee2007-11-06 21:34:58 +0000392void*
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000393PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000394{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000395 char* pointer;
396 int i;
397 pointer = (char *)view->buf;
398 for (i = 0; i < view->ndim; i++) {
399 pointer += view->strides[i]*indices[i];
400 if ((view->suboffsets != NULL) && (view->suboffsets[i] >= 0)) {
401 pointer = *((char**)pointer) + view->suboffsets[i];
402 }
403 }
404 return (void*)pointer;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000405}
406
407
Guido van Rossum98297ee2007-11-06 21:34:58 +0000408void
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000409_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 +0000410{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000411 int k;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000412
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000413 for (k=0; k<nd; k++) {
414 if (index[k] < shape[k]-1) {
415 index[k]++;
416 break;
417 }
418 else {
419 index[k] = 0;
420 }
421 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000422}
423
Guido van Rossum98297ee2007-11-06 21:34:58 +0000424void
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000425_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 +0000426{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000427 int k;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000428
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000429 for (k=nd-1; k>=0; k--) {
430 if (index[k] < shape[k]-1) {
431 index[k]++;
432 break;
433 }
434 else {
435 index[k] = 0;
436 }
437 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000438}
439
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000440int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000441PyBuffer_FromContiguous(Py_buffer *view, void *buf, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000442{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000443 int k;
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000444 void (*addone)(int, Py_ssize_t *, const Py_ssize_t *);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000445 Py_ssize_t *indices, elements;
446 char *src, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000447
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000448 if (len > view->len) {
449 len = view->len;
450 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000451
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000452 if (PyBuffer_IsContiguous(view, fort)) {
453 /* simplest copy is all that is needed */
454 memcpy(view->buf, buf, len);
455 return 0;
456 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000457
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000458 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000459
Stefan Krah7213fcc2015-02-01 16:19:23 +0100460 /* view->ndim <= 64 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000461 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
462 if (indices == NULL) {
463 PyErr_NoMemory();
464 return -1;
465 }
466 for (k=0; k<view->ndim;k++) {
467 indices[k] = 0;
468 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000469
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000470 if (fort == 'F') {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000471 addone = _Py_add_one_to_index_F;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000472 }
473 else {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000474 addone = _Py_add_one_to_index_C;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000475 }
476 src = buf;
477 /* XXX : This is not going to be the fastest code in the world
478 several optimizations are possible.
479 */
480 elements = len / view->itemsize;
481 while (elements--) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000482 ptr = PyBuffer_GetPointer(view, indices);
483 memcpy(ptr, src, view->itemsize);
484 src += view->itemsize;
Stefan Krah7213fcc2015-02-01 16:19:23 +0100485 addone(view->ndim, indices, view->shape);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000486 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000487
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000488 PyMem_Free(indices);
489 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000490}
491
Guido van Rossum98297ee2007-11-06 21:34:58 +0000492int PyObject_CopyData(PyObject *dest, PyObject *src)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000493{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000494 Py_buffer view_dest, view_src;
495 int k;
496 Py_ssize_t *indices, elements;
497 char *dptr, *sptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000498
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000499 if (!PyObject_CheckBuffer(dest) ||
500 !PyObject_CheckBuffer(src)) {
501 PyErr_SetString(PyExc_TypeError,
502 "both destination and source must have the "\
503 "buffer interface");
504 return -1;
505 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000506
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000507 if (PyObject_GetBuffer(dest, &view_dest, PyBUF_FULL) != 0) return -1;
508 if (PyObject_GetBuffer(src, &view_src, PyBUF_FULL_RO) != 0) {
509 PyBuffer_Release(&view_dest);
510 return -1;
511 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000512
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000513 if (view_dest.len < view_src.len) {
514 PyErr_SetString(PyExc_BufferError,
515 "destination is too small to receive data from source");
516 PyBuffer_Release(&view_dest);
517 PyBuffer_Release(&view_src);
518 return -1;
519 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000520
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000521 if ((PyBuffer_IsContiguous(&view_dest, 'C') &&
522 PyBuffer_IsContiguous(&view_src, 'C')) ||
523 (PyBuffer_IsContiguous(&view_dest, 'F') &&
524 PyBuffer_IsContiguous(&view_src, 'F'))) {
525 /* simplest copy is all that is needed */
526 memcpy(view_dest.buf, view_src.buf, view_src.len);
527 PyBuffer_Release(&view_dest);
528 PyBuffer_Release(&view_src);
529 return 0;
530 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000531
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000532 /* Otherwise a more elaborate copy scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000533
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000534 /* XXX(nnorwitz): need to check for overflow! */
535 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*view_src.ndim);
536 if (indices == NULL) {
537 PyErr_NoMemory();
538 PyBuffer_Release(&view_dest);
539 PyBuffer_Release(&view_src);
540 return -1;
541 }
542 for (k=0; k<view_src.ndim;k++) {
543 indices[k] = 0;
544 }
545 elements = 1;
546 for (k=0; k<view_src.ndim; k++) {
547 /* XXX(nnorwitz): can this overflow? */
548 elements *= view_src.shape[k];
549 }
550 while (elements--) {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000551 _Py_add_one_to_index_C(view_src.ndim, indices, view_src.shape);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000552 dptr = PyBuffer_GetPointer(&view_dest, indices);
553 sptr = PyBuffer_GetPointer(&view_src, indices);
554 memcpy(dptr, sptr, view_src.itemsize);
555 }
556 PyMem_Free(indices);
557 PyBuffer_Release(&view_dest);
558 PyBuffer_Release(&view_src);
559 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000560}
561
562void
563PyBuffer_FillContiguousStrides(int nd, Py_ssize_t *shape,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000564 Py_ssize_t *strides, int itemsize,
565 char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000566{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000567 int k;
568 Py_ssize_t sd;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000569
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000570 sd = itemsize;
571 if (fort == 'F') {
572 for (k=0; k<nd; k++) {
573 strides[k] = sd;
574 sd *= shape[k];
575 }
576 }
577 else {
578 for (k=nd-1; k>=0; k--) {
579 strides[k] = sd;
580 sd *= shape[k];
581 }
582 }
583 return;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000584}
585
586int
Martin v. Löwis423be952008-08-13 15:53:07 +0000587PyBuffer_FillInfo(Py_buffer *view, PyObject *obj, void *buf, Py_ssize_t len,
Stefan Krah4e141742012-03-06 15:27:31 +0100588 int readonly, int flags)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000589{
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100590 if (view == NULL) return 0; /* XXX why not -1? */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000591 if (((flags & PyBUF_WRITABLE) == PyBUF_WRITABLE) &&
592 (readonly == 1)) {
593 PyErr_SetString(PyExc_BufferError,
594 "Object is not writable.");
595 return -1;
596 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000597
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000598 view->obj = obj;
599 if (obj)
600 Py_INCREF(obj);
601 view->buf = buf;
602 view->len = len;
603 view->readonly = readonly;
604 view->itemsize = 1;
605 view->format = NULL;
606 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT)
607 view->format = "B";
608 view->ndim = 1;
609 view->shape = NULL;
610 if ((flags & PyBUF_ND) == PyBUF_ND)
611 view->shape = &(view->len);
612 view->strides = NULL;
613 if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES)
614 view->strides = &(view->itemsize);
615 view->suboffsets = NULL;
616 view->internal = NULL;
617 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000618}
619
Martin v. Löwis423be952008-08-13 15:53:07 +0000620void
621PyBuffer_Release(Py_buffer *view)
622{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000623 PyObject *obj = view->obj;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200624 PyBufferProcs *pb;
625 if (obj == NULL)
626 return;
627 pb = Py_TYPE(obj)->tp_as_buffer;
628 if (pb && pb->bf_releasebuffer)
629 pb->bf_releasebuffer(obj, view);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000630 view->obj = NULL;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200631 Py_DECREF(obj);
Martin v. Löwis423be952008-08-13 15:53:07 +0000632}
633
Eric Smith8fd3eba2008-02-17 19:48:00 +0000634PyObject *
635PyObject_Format(PyObject *obj, PyObject *format_spec)
636{
Eric Smith8fd3eba2008-02-17 19:48:00 +0000637 PyObject *meth;
638 PyObject *empty = NULL;
639 PyObject *result = NULL;
Benjamin Petersonce798522012-01-22 11:24:29 -0500640 _Py_IDENTIFIER(__format__);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000641
642 /* If no format_spec is provided, use an empty string */
643 if (format_spec == NULL) {
Victor Stinner9d3b93b2011-11-22 02:27:30 +0100644 empty = PyUnicode_New(0, 0);
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000645 format_spec = empty;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000646 }
647
Eric Smith8fd3eba2008-02-17 19:48:00 +0000648 /* Find the (unbound!) __format__ method (a borrowed reference) */
Benjamin Petersonce798522012-01-22 11:24:29 -0500649 meth = _PyObject_LookupSpecial(obj, &PyId___format__);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000650 if (meth == NULL) {
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000651 if (!PyErr_Occurred())
652 PyErr_Format(PyExc_TypeError,
653 "Type %.100s doesn't define __format__",
654 Py_TYPE(obj)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000655 goto done;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000656 }
657
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000658 /* And call it. */
659 result = PyObject_CallFunctionObjArgs(meth, format_spec, NULL);
Benjamin Peterson6f889ad32010-06-05 02:11:45 +0000660 Py_DECREF(meth);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000661
662 if (result && !PyUnicode_Check(result)) {
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000663 PyErr_SetString(PyExc_TypeError,
664 "__format__ method did not return string");
665 Py_DECREF(result);
666 result = NULL;
667 goto done;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000668 }
669
670done:
671 Py_XDECREF(empty);
672 return result;
673}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000674/* Operations on numbers */
675
676int
Fred Drake79912472000-07-09 04:06:11 +0000677PyNumber_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +0000678{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000679 return o && o->ob_type->tp_as_number &&
680 (o->ob_type->tp_as_number->nb_int ||
681 o->ob_type->tp_as_number->nb_float);
Guido van Rossume15dee51995-07-18 14:12:02 +0000682}
683
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000684/* Binary operators */
Guido van Rossume15dee51995-07-18 14:12:02 +0000685
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000686#define NB_SLOT(x) offsetof(PyNumberMethods, x)
687#define NB_BINOP(nb_methods, slot) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000688 (*(binaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000689#define NB_TERNOP(nb_methods, slot) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000690 (*(ternaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000691
692/*
693 Calling scheme used for binary operations:
694
Neal Norwitz4886cc32006-08-21 17:06:07 +0000695 Order operations are tried until either a valid result or error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000696 w.op(v,w)[*], v.op(v,w), w.op(v,w)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000697
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000698 [*] only when v->ob_type != w->ob_type && w->ob_type is a subclass of
699 v->ob_type
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000700 */
701
702static PyObject *
703binary_op1(PyObject *v, PyObject *w, const int op_slot)
Guido van Rossume15dee51995-07-18 14:12:02 +0000704{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000705 PyObject *x;
706 binaryfunc slotv = NULL;
707 binaryfunc slotw = NULL;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000708
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000709 if (v->ob_type->tp_as_number != NULL)
710 slotv = NB_BINOP(v->ob_type->tp_as_number, op_slot);
711 if (w->ob_type != v->ob_type &&
712 w->ob_type->tp_as_number != NULL) {
713 slotw = NB_BINOP(w->ob_type->tp_as_number, op_slot);
714 if (slotw == slotv)
715 slotw = NULL;
716 }
717 if (slotv) {
718 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
719 x = slotw(v, w);
720 if (x != Py_NotImplemented)
721 return x;
722 Py_DECREF(x); /* can't do it */
723 slotw = NULL;
724 }
725 x = slotv(v, w);
726 if (x != Py_NotImplemented)
727 return x;
728 Py_DECREF(x); /* can't do it */
729 }
730 if (slotw) {
731 x = slotw(v, w);
732 if (x != Py_NotImplemented)
733 return x;
734 Py_DECREF(x); /* can't do it */
735 }
Brian Curtindfc80e32011-08-10 20:28:54 -0500736 Py_RETURN_NOTIMPLEMENTED;
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000737}
Guido van Rossum77660912002-04-16 16:32:50 +0000738
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000739static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000740binop_type_error(PyObject *v, PyObject *w, const char *op_name)
741{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000742 PyErr_Format(PyExc_TypeError,
743 "unsupported operand type(s) for %.100s: "
744 "'%.100s' and '%.100s'",
745 op_name,
746 v->ob_type->tp_name,
747 w->ob_type->tp_name);
748 return NULL;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000749}
750
751static PyObject *
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000752binary_op(PyObject *v, PyObject *w, const int op_slot, const char *op_name)
753{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000754 PyObject *result = binary_op1(v, w, op_slot);
755 if (result == Py_NotImplemented) {
756 Py_DECREF(result);
757 return binop_type_error(v, w, op_name);
758 }
759 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000760}
761
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000762
763/*
764 Calling scheme used for ternary operations:
765
Neal Norwitz4886cc32006-08-21 17:06:07 +0000766 Order operations are tried until either a valid result or error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000767 v.op(v,w,z), w.op(v,w,z), z.op(v,w,z)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000768 */
769
770static PyObject *
771ternary_op(PyObject *v,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000772 PyObject *w,
773 PyObject *z,
774 const int op_slot,
775 const char *op_name)
Guido van Rossume15dee51995-07-18 14:12:02 +0000776{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000777 PyNumberMethods *mv, *mw, *mz;
778 PyObject *x = NULL;
779 ternaryfunc slotv = NULL;
780 ternaryfunc slotw = NULL;
781 ternaryfunc slotz = NULL;
Guido van Rossum77660912002-04-16 16:32:50 +0000782
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000783 mv = v->ob_type->tp_as_number;
784 mw = w->ob_type->tp_as_number;
785 if (mv != NULL)
786 slotv = NB_TERNOP(mv, op_slot);
787 if (w->ob_type != v->ob_type &&
788 mw != NULL) {
789 slotw = NB_TERNOP(mw, op_slot);
790 if (slotw == slotv)
791 slotw = NULL;
792 }
793 if (slotv) {
794 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
795 x = slotw(v, w, z);
796 if (x != Py_NotImplemented)
797 return x;
798 Py_DECREF(x); /* can't do it */
799 slotw = NULL;
800 }
801 x = slotv(v, w, z);
802 if (x != Py_NotImplemented)
803 return x;
804 Py_DECREF(x); /* can't do it */
805 }
806 if (slotw) {
807 x = slotw(v, w, z);
808 if (x != Py_NotImplemented)
809 return x;
810 Py_DECREF(x); /* can't do it */
811 }
812 mz = z->ob_type->tp_as_number;
813 if (mz != NULL) {
814 slotz = NB_TERNOP(mz, op_slot);
815 if (slotz == slotv || slotz == slotw)
816 slotz = NULL;
817 if (slotz) {
818 x = slotz(v, w, z);
819 if (x != Py_NotImplemented)
820 return x;
821 Py_DECREF(x); /* can't do it */
822 }
823 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000824
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000825 if (z == Py_None)
826 PyErr_Format(
827 PyExc_TypeError,
828 "unsupported operand type(s) for ** or pow(): "
829 "'%.100s' and '%.100s'",
830 v->ob_type->tp_name,
831 w->ob_type->tp_name);
832 else
833 PyErr_Format(
834 PyExc_TypeError,
835 "unsupported operand type(s) for pow(): "
836 "'%.100s', '%.100s', '%.100s'",
837 v->ob_type->tp_name,
838 w->ob_type->tp_name,
839 z->ob_type->tp_name);
840 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000841}
842
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000843#define BINARY_FUNC(func, op, op_name) \
844 PyObject * \
845 func(PyObject *v, PyObject *w) { \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000846 return binary_op(v, w, NB_SLOT(op), op_name); \
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000847 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000848
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000849BINARY_FUNC(PyNumber_Or, nb_or, "|")
850BINARY_FUNC(PyNumber_Xor, nb_xor, "^")
851BINARY_FUNC(PyNumber_And, nb_and, "&")
852BINARY_FUNC(PyNumber_Lshift, nb_lshift, "<<")
853BINARY_FUNC(PyNumber_Rshift, nb_rshift, ">>")
854BINARY_FUNC(PyNumber_Subtract, nb_subtract, "-")
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000855BINARY_FUNC(PyNumber_Divmod, nb_divmod, "divmod()")
Guido van Rossume15dee51995-07-18 14:12:02 +0000856
857PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000858PyNumber_Add(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000859{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000860 PyObject *result = binary_op1(v, w, NB_SLOT(nb_add));
861 if (result == Py_NotImplemented) {
862 PySequenceMethods *m = v->ob_type->tp_as_sequence;
863 Py_DECREF(result);
864 if (m && m->sq_concat) {
865 return (*m->sq_concat)(v, w);
866 }
867 result = binop_type_error(v, w, "+");
868 }
869 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000870}
871
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000872static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000873sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000874{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000875 Py_ssize_t count;
876 if (PyIndex_Check(n)) {
877 count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
878 if (count == -1 && PyErr_Occurred())
879 return NULL;
880 }
881 else {
882 return type_error("can't multiply sequence by "
883 "non-int of type '%.200s'", n);
884 }
885 return (*repeatfunc)(seq, count);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000886}
887
888PyObject *
889PyNumber_Multiply(PyObject *v, PyObject *w)
890{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000891 PyObject *result = binary_op1(v, w, NB_SLOT(nb_multiply));
892 if (result == Py_NotImplemented) {
893 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
894 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
895 Py_DECREF(result);
896 if (mv && mv->sq_repeat) {
897 return sequence_repeat(mv->sq_repeat, v, w);
898 }
899 else if (mw && mw->sq_repeat) {
900 return sequence_repeat(mw->sq_repeat, w, v);
901 }
902 result = binop_type_error(v, w, "*");
903 }
904 return result;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000905}
906
Guido van Rossume15dee51995-07-18 14:12:02 +0000907PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +0000908PyNumber_FloorDivide(PyObject *v, PyObject *w)
909{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000910 return binary_op(v, w, NB_SLOT(nb_floor_divide), "//");
Guido van Rossum4668b002001-08-08 05:00:18 +0000911}
912
913PyObject *
914PyNumber_TrueDivide(PyObject *v, PyObject *w)
915{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000916 return binary_op(v, w, NB_SLOT(nb_true_divide), "/");
Guido van Rossum4668b002001-08-08 05:00:18 +0000917}
918
919PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000920PyNumber_Remainder(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000921{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000922 return binary_op(v, w, NB_SLOT(nb_remainder), "%");
Guido van Rossume15dee51995-07-18 14:12:02 +0000923}
924
925PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000926PyNumber_Power(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossume15dee51995-07-18 14:12:02 +0000927{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000928 return ternary_op(v, w, z, NB_SLOT(nb_power), "** or pow()");
Guido van Rossume15dee51995-07-18 14:12:02 +0000929}
930
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000931/* Binary in-place operators */
932
933/* The in-place operators are defined to fall back to the 'normal',
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000934 non in-place operations, if the in-place methods are not in place.
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000935
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000936 - If the left hand object has the appropriate struct members, and
937 they are filled, call the appropriate function and return the
938 result. No coercion is done on the arguments; the left-hand object
939 is the one the operation is performed on, and it's up to the
940 function to deal with the right-hand object.
Guido van Rossum77660912002-04-16 16:32:50 +0000941
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000942 - Otherwise, in-place modification is not supported. Handle it exactly as
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000943 a non in-place operation of the same kind.
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000944
945 */
946
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000947static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000948binary_iop1(PyObject *v, PyObject *w, const int iop_slot, const int op_slot)
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000949{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000950 PyNumberMethods *mv = v->ob_type->tp_as_number;
951 if (mv != NULL) {
952 binaryfunc slot = NB_BINOP(mv, iop_slot);
953 if (slot) {
954 PyObject *x = (slot)(v, w);
955 if (x != Py_NotImplemented) {
956 return x;
957 }
958 Py_DECREF(x);
959 }
960 }
961 return binary_op1(v, w, op_slot);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000962}
963
964static PyObject *
965binary_iop(PyObject *v, PyObject *w, const int iop_slot, const int op_slot,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000966 const char *op_name)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000967{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000968 PyObject *result = binary_iop1(v, w, iop_slot, op_slot);
969 if (result == Py_NotImplemented) {
970 Py_DECREF(result);
971 return binop_type_error(v, w, op_name);
972 }
973 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000974}
975
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000976#define INPLACE_BINOP(func, iop, op, op_name) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000977 PyObject * \
978 func(PyObject *v, PyObject *w) { \
979 return binary_iop(v, w, NB_SLOT(iop), NB_SLOT(op), op_name); \
980 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000981
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000982INPLACE_BINOP(PyNumber_InPlaceOr, nb_inplace_or, nb_or, "|=")
983INPLACE_BINOP(PyNumber_InPlaceXor, nb_inplace_xor, nb_xor, "^=")
984INPLACE_BINOP(PyNumber_InPlaceAnd, nb_inplace_and, nb_and, "&=")
985INPLACE_BINOP(PyNumber_InPlaceLshift, nb_inplace_lshift, nb_lshift, "<<=")
986INPLACE_BINOP(PyNumber_InPlaceRshift, nb_inplace_rshift, nb_rshift, ">>=")
987INPLACE_BINOP(PyNumber_InPlaceSubtract, nb_inplace_subtract, nb_subtract, "-=")
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000988
989PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +0000990PyNumber_InPlaceFloorDivide(PyObject *v, PyObject *w)
991{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000992 return binary_iop(v, w, NB_SLOT(nb_inplace_floor_divide),
993 NB_SLOT(nb_floor_divide), "//=");
Guido van Rossum4668b002001-08-08 05:00:18 +0000994}
995
996PyObject *
997PyNumber_InPlaceTrueDivide(PyObject *v, PyObject *w)
998{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000999 return binary_iop(v, w, NB_SLOT(nb_inplace_true_divide),
1000 NB_SLOT(nb_true_divide), "/=");
Guido van Rossum4668b002001-08-08 05:00:18 +00001001}
1002
1003PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001004PyNumber_InPlaceAdd(PyObject *v, PyObject *w)
1005{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001006 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_add),
1007 NB_SLOT(nb_add));
1008 if (result == Py_NotImplemented) {
1009 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1010 Py_DECREF(result);
1011 if (m != NULL) {
1012 binaryfunc f = NULL;
1013 f = m->sq_inplace_concat;
1014 if (f == NULL)
1015 f = m->sq_concat;
1016 if (f != NULL)
1017 return (*f)(v, w);
1018 }
1019 result = binop_type_error(v, w, "+=");
1020 }
1021 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001022}
1023
1024PyObject *
1025PyNumber_InPlaceMultiply(PyObject *v, PyObject *w)
1026{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001027 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_multiply),
1028 NB_SLOT(nb_multiply));
1029 if (result == Py_NotImplemented) {
1030 ssizeargfunc f = NULL;
1031 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1032 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1033 Py_DECREF(result);
1034 if (mv != NULL) {
1035 f = mv->sq_inplace_repeat;
1036 if (f == NULL)
1037 f = mv->sq_repeat;
1038 if (f != NULL)
1039 return sequence_repeat(f, v, w);
1040 }
1041 else if (mw != NULL) {
1042 /* Note that the right hand operand should not be
1043 * mutated in this case so sq_inplace_repeat is not
1044 * used. */
1045 if (mw->sq_repeat)
1046 return sequence_repeat(mw->sq_repeat, w, v);
1047 }
1048 result = binop_type_error(v, w, "*=");
1049 }
1050 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001051}
1052
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001053PyObject *
1054PyNumber_InPlaceRemainder(PyObject *v, PyObject *w)
1055{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001056 return binary_iop(v, w, NB_SLOT(nb_inplace_remainder),
1057 NB_SLOT(nb_remainder), "%=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001058}
1059
1060PyObject *
1061PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
1062{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001063 if (v->ob_type->tp_as_number &&
1064 v->ob_type->tp_as_number->nb_inplace_power != NULL) {
1065 return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
1066 }
1067 else {
1068 return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
1069 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001070}
1071
1072
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001073/* Unary operators and functions */
Guido van Rossume15dee51995-07-18 14:12:02 +00001074
1075PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001076PyNumber_Negative(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001077{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001078 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001079
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001080 if (o == NULL)
1081 return null_error();
1082 m = o->ob_type->tp_as_number;
1083 if (m && m->nb_negative)
1084 return (*m->nb_negative)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001085
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001086 return type_error("bad operand type for unary -: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001087}
1088
1089PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001090PyNumber_Positive(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001091{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001092 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001093
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001094 if (o == NULL)
1095 return null_error();
1096 m = o->ob_type->tp_as_number;
1097 if (m && m->nb_positive)
1098 return (*m->nb_positive)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001099
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001100 return type_error("bad operand type for unary +: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001101}
1102
1103PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001104PyNumber_Invert(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001105{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001106 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001107
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001108 if (o == NULL)
1109 return null_error();
1110 m = o->ob_type->tp_as_number;
1111 if (m && m->nb_invert)
1112 return (*m->nb_invert)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001113
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001114 return type_error("bad operand type for unary ~: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001115}
1116
1117PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001118PyNumber_Absolute(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001119{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001120 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001121
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001122 if (o == NULL)
1123 return null_error();
1124 m = o->ob_type->tp_as_number;
1125 if (m && m->nb_absolute)
1126 return m->nb_absolute(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001127
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001128 return type_error("bad operand type for abs(): '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001129}
1130
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001131/* Return a Python int from the object item.
Serhiy Storchaka95949422013-08-27 19:40:23 +03001132 Raise TypeError if the result is not an int
Guido van Rossum98297ee2007-11-06 21:34:58 +00001133 or if the object cannot be interpreted as an index.
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001134*/
1135PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001136PyNumber_Index(PyObject *item)
1137{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001138 PyObject *result = NULL;
1139 if (item == NULL)
1140 return null_error();
1141 if (PyLong_Check(item)) {
1142 Py_INCREF(item);
1143 return item;
1144 }
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001145 if (!PyIndex_Check(item)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001146 PyErr_Format(PyExc_TypeError,
1147 "'%.200s' object cannot be interpreted "
1148 "as an integer", item->ob_type->tp_name);
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001149 return NULL;
1150 }
1151 result = item->ob_type->tp_as_number->nb_index(item);
1152 if (!result || PyLong_CheckExact(result))
1153 return result;
1154 if (!PyLong_Check(result)) {
1155 PyErr_Format(PyExc_TypeError,
1156 "__index__ returned non-int (type %.200s)",
1157 result->ob_type->tp_name);
1158 Py_DECREF(result);
1159 return NULL;
1160 }
1161 /* Issue #17576: warn if 'result' not of exact type int. */
1162 if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
1163 "__index__ returned non-int (type %.200s). "
1164 "The ability to return an instance of a strict subclass of int "
1165 "is deprecated, and may be removed in a future version of Python.",
1166 result->ob_type->tp_name)) {
1167 Py_DECREF(result);
1168 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001169 }
1170 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001171}
1172
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001173/* Return an error on Overflow only if err is not NULL*/
1174
1175Py_ssize_t
1176PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1177{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001178 Py_ssize_t result;
1179 PyObject *runerr;
1180 PyObject *value = PyNumber_Index(item);
1181 if (value == NULL)
1182 return -1;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001184 /* We're done if PyLong_AsSsize_t() returns without error. */
1185 result = PyLong_AsSsize_t(value);
1186 if (result != -1 || !(runerr = PyErr_Occurred()))
1187 goto finish;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001188
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001189 /* Error handling code -- only manage OverflowError differently */
1190 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
1191 goto finish;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001192
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001193 PyErr_Clear();
1194 /* If no error-handling desired then the default clipping
1195 is sufficient.
1196 */
1197 if (!err) {
1198 assert(PyLong_Check(value));
1199 /* Whether or not it is less than or equal to
1200 zero is determined by the sign of ob_size
1201 */
1202 if (_PyLong_Sign(value) < 0)
1203 result = PY_SSIZE_T_MIN;
1204 else
1205 result = PY_SSIZE_T_MAX;
1206 }
1207 else {
1208 /* Otherwise replace the error with caller's error object. */
1209 PyErr_Format(err,
1210 "cannot fit '%.200s' into an index-sized integer",
1211 item->ob_type->tp_name);
1212 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001213
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001214 finish:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001215 Py_DECREF(value);
1216 return result;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001217}
1218
1219
Guido van Rossume15dee51995-07-18 14:12:02 +00001220PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001221PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001222{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001223 PyNumberMethods *m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001224 PyObject *trunc_func;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001225 Py_buffer view;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04001226 _Py_IDENTIFIER(__trunc__);
Christian Heimes15ebc882008-02-04 18:48:49 +00001227
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001228 if (o == NULL)
1229 return null_error();
1230 if (PyLong_CheckExact(o)) {
1231 Py_INCREF(o);
1232 return o;
1233 }
1234 m = o->ob_type->tp_as_number;
1235 if (m && m->nb_int) { /* This should include subclasses of int */
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001236 return (PyObject *)_PyLong_FromNbInt(o);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001237 }
Benjamin Peterson1b1a8e72012-03-20 23:48:11 -04001238 trunc_func = _PyObject_LookupSpecial(o, &PyId___trunc__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001239 if (trunc_func) {
1240 PyObject *truncated = PyEval_CallObject(trunc_func, NULL);
1241 PyObject *int_instance;
1242 Py_DECREF(trunc_func);
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001243 if (truncated == NULL || PyLong_Check(truncated))
1244 return truncated;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 /* __trunc__ is specified to return an Integral type,
Martin Panter7462b6492015-11-02 03:37:02 +00001246 but int() needs to return an int. */
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001247 m = truncated->ob_type->tp_as_number;
1248 if (m == NULL || m->nb_int == NULL) {
1249 PyErr_Format(
1250 PyExc_TypeError,
1251 "__trunc__ returned non-Integral (type %.200s)",
1252 truncated->ob_type->tp_name);
1253 Py_DECREF(truncated);
1254 return NULL;
1255 }
1256 int_instance = (PyObject *)_PyLong_FromNbInt(truncated);
1257 Py_DECREF(truncated);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001258 return int_instance;
1259 }
Benjamin Peterson1b1a8e72012-03-20 23:48:11 -04001260 if (PyErr_Occurred())
1261 return NULL;
Christian Heimes15ebc882008-02-04 18:48:49 +00001262
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001263 if (PyUnicode_Check(o))
1264 /* The below check is done in PyLong_FromUnicode(). */
1265 return PyLong_FromUnicodeObject(o, 10);
1266
Martin Pantereeb896c2015-11-07 02:32:21 +00001267 if (PyBytes_Check(o))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001268 /* need to do extra error checking that PyLong_FromString()
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03001269 * doesn't do. In particular int('9\x005') must raise an
1270 * exception, not truncate at the null.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001271 */
Martin Pantereeb896c2015-11-07 02:32:21 +00001272 return _PyLong_FromBytes(PyBytes_AS_STRING(o),
1273 PyBytes_GET_SIZE(o), 10);
1274
1275 if (PyByteArray_Check(o))
1276 return _PyLong_FromBytes(PyByteArray_AS_STRING(o),
1277 PyByteArray_GET_SIZE(o), 10);
1278
1279 if (PyObject_GetBuffer(o, &view, PyBUF_SIMPLE) == 0) {
1280 PyObject *result, *bytes;
1281
1282 /* Copy to NUL-terminated buffer. */
1283 bytes = PyBytes_FromStringAndSize((const char *)view.buf, view.len);
1284 if (bytes == NULL) {
1285 PyBuffer_Release(&view);
1286 return NULL;
1287 }
1288 result = _PyLong_FromBytes(PyBytes_AS_STRING(bytes),
1289 PyBytes_GET_SIZE(bytes), 10);
1290 Py_DECREF(bytes);
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001291 PyBuffer_Release(&view);
1292 return result;
1293 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001294
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001295 return type_error("int() argument must be a string, a bytes-like object "
1296 "or a number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001297}
1298
1299PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001300PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001301{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001302 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001303
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001304 if (o == NULL)
1305 return null_error();
1306 m = o->ob_type->tp_as_number;
1307 if (m && m->nb_float) { /* This should include subclasses of float */
1308 PyObject *res = m->nb_float(o);
1309 if (res && !PyFloat_Check(res)) {
1310 PyErr_Format(PyExc_TypeError,
1311 "__float__ returned non-float (type %.200s)",
1312 res->ob_type->tp_name);
1313 Py_DECREF(res);
1314 return NULL;
1315 }
1316 return res;
1317 }
1318 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
1319 PyFloatObject *po = (PyFloatObject *)o;
1320 return PyFloat_FromDouble(po->ob_fval);
1321 }
1322 return PyFloat_FromString(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001323}
1324
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001325
1326PyObject *
1327PyNumber_ToBase(PyObject *n, int base)
1328{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001329 PyObject *res = NULL;
1330 PyObject *index = PyNumber_Index(n);
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001331
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001332 if (!index)
1333 return NULL;
1334 if (PyLong_Check(index))
1335 res = _PyLong_Format(index, base);
1336 else
1337 /* It should not be possible to get here, as
1338 PyNumber_Index already has a check for the same
1339 condition */
Serhiy Storchaka95949422013-08-27 19:40:23 +03001340 PyErr_SetString(PyExc_ValueError, "PyNumber_ToBase: index not int");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001341 Py_DECREF(index);
1342 return res;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001343}
1344
1345
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001346/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001347
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001348int
Fred Drake79912472000-07-09 04:06:11 +00001349PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001350{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001351 if (PyDict_Check(s))
1352 return 0;
1353 return s != NULL && s->ob_type->tp_as_sequence &&
1354 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001355}
1356
Martin v. Löwis18e16552006-02-15 17:27:45 +00001357Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001358PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001359{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001360 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001361
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001362 if (s == NULL) {
1363 null_error();
1364 return -1;
1365 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001366
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001367 m = s->ob_type->tp_as_sequence;
1368 if (m && m->sq_length)
1369 return m->sq_length(s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001370
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001371 type_error("object of type '%.200s' has no len()", s);
1372 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001373}
1374
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001375#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001376Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001377PySequence_Length(PyObject *s)
1378{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001379 return PySequence_Size(s);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001380}
1381#define PySequence_Length PySequence_Size
1382
Guido van Rossume15dee51995-07-18 14:12:02 +00001383PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001384PySequence_Concat(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001385{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001386 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001387
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001388 if (s == NULL || o == NULL)
1389 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001390
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001391 m = s->ob_type->tp_as_sequence;
1392 if (m && m->sq_concat)
1393 return m->sq_concat(s, o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001394
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001395 /* Instances of user classes defining an __add__() method only
1396 have an nb_add slot, not an sq_concat slot. So we fall back
1397 to nb_add if both arguments appear to be sequences. */
1398 if (PySequence_Check(s) && PySequence_Check(o)) {
1399 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1400 if (result != Py_NotImplemented)
1401 return result;
1402 Py_DECREF(result);
1403 }
1404 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001405}
1406
1407PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001408PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001409{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001410 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001411
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001412 if (o == NULL)
1413 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001414
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001415 m = o->ob_type->tp_as_sequence;
1416 if (m && m->sq_repeat)
1417 return m->sq_repeat(o, count);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001418
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001419 /* Instances of user classes defining a __mul__() method only
1420 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1421 to nb_multiply if o appears to be a sequence. */
1422 if (PySequence_Check(o)) {
1423 PyObject *n, *result;
1424 n = PyLong_FromSsize_t(count);
1425 if (n == NULL)
1426 return NULL;
1427 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1428 Py_DECREF(n);
1429 if (result != Py_NotImplemented)
1430 return result;
1431 Py_DECREF(result);
1432 }
1433 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001434}
1435
1436PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001437PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1438{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001439 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001440
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001441 if (s == NULL || o == NULL)
1442 return null_error();
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001444 m = s->ob_type->tp_as_sequence;
1445 if (m && m->sq_inplace_concat)
1446 return m->sq_inplace_concat(s, o);
1447 if (m && m->sq_concat)
1448 return m->sq_concat(s, o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001449
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001450 if (PySequence_Check(s) && PySequence_Check(o)) {
1451 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1452 NB_SLOT(nb_add));
1453 if (result != Py_NotImplemented)
1454 return result;
1455 Py_DECREF(result);
1456 }
1457 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001458}
1459
1460PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001461PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001462{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001463 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001464
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001465 if (o == NULL)
1466 return null_error();
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001467
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001468 m = o->ob_type->tp_as_sequence;
1469 if (m && m->sq_inplace_repeat)
1470 return m->sq_inplace_repeat(o, count);
1471 if (m && m->sq_repeat)
1472 return m->sq_repeat(o, count);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001474 if (PySequence_Check(o)) {
1475 PyObject *n, *result;
1476 n = PyLong_FromSsize_t(count);
1477 if (n == NULL)
1478 return NULL;
1479 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1480 NB_SLOT(nb_multiply));
1481 Py_DECREF(n);
1482 if (result != Py_NotImplemented)
1483 return result;
1484 Py_DECREF(result);
1485 }
1486 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001487}
1488
1489PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001490PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001491{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001492 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001493
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001494 if (s == NULL)
1495 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001496
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001497 m = s->ob_type->tp_as_sequence;
1498 if (m && m->sq_item) {
1499 if (i < 0) {
1500 if (m->sq_length) {
1501 Py_ssize_t l = (*m->sq_length)(s);
1502 if (l < 0)
1503 return NULL;
1504 i += l;
1505 }
1506 }
1507 return m->sq_item(s, i);
1508 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001510 return type_error("'%.200s' object does not support indexing", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001511}
1512
1513PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001514PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00001515{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001516 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001517
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001518 if (!s) return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001519
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001520 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001521 if (mp && mp->mp_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001522 PyObject *res;
1523 PyObject *slice = _PySlice_FromIndices(i1, i2);
1524 if (!slice)
1525 return NULL;
1526 res = mp->mp_subscript(s, slice);
1527 Py_DECREF(slice);
1528 return res;
1529 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001530
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001531 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001532}
1533
1534int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001535PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
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 null_error();
1541 return -1;
1542 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001543
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001544 m = s->ob_type->tp_as_sequence;
1545 if (m && m->sq_ass_item) {
1546 if (i < 0) {
1547 if (m->sq_length) {
1548 Py_ssize_t l = (*m->sq_length)(s);
1549 if (l < 0)
1550 return -1;
1551 i += l;
1552 }
1553 }
1554 return m->sq_ass_item(s, i, o);
1555 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001556
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001557 type_error("'%.200s' object does not support item assignment", s);
1558 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001559}
1560
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001561int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001562PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001563{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001564 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001565
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001566 if (s == NULL) {
1567 null_error();
1568 return -1;
1569 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001570
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001571 m = s->ob_type->tp_as_sequence;
1572 if (m && m->sq_ass_item) {
1573 if (i < 0) {
1574 if (m->sq_length) {
1575 Py_ssize_t l = (*m->sq_length)(s);
1576 if (l < 0)
1577 return -1;
1578 i += l;
1579 }
1580 }
1581 return m->sq_ass_item(s, i, (PyObject *)NULL);
1582 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001583
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001584 type_error("'%.200s' object doesn't support item deletion", s);
1585 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001586}
1587
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001588int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001589PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001590{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001591 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001592
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001593 if (s == NULL) {
1594 null_error();
1595 return -1;
1596 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001597
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001598 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001599 if (mp && mp->mp_ass_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001600 int res;
1601 PyObject *slice = _PySlice_FromIndices(i1, i2);
1602 if (!slice)
1603 return -1;
1604 res = mp->mp_ass_subscript(s, slice, o);
1605 Py_DECREF(slice);
1606 return res;
1607 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00001608
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001609 type_error("'%.200s' object doesn't support slice assignment", s);
1610 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001611}
1612
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001613int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001614PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001615{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001616 PyMappingMethods *mp;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001617
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001618 if (s == NULL) {
1619 null_error();
1620 return -1;
1621 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001622
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001623 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001624 if (mp && mp->mp_ass_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001625 int res;
1626 PyObject *slice = _PySlice_FromIndices(i1, i2);
1627 if (!slice)
1628 return -1;
1629 res = mp->mp_ass_subscript(s, slice, NULL);
1630 Py_DECREF(slice);
1631 return res;
1632 }
1633 type_error("'%.200s' object doesn't support slice deletion", s);
1634 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001635}
1636
Guido van Rossume15dee51995-07-18 14:12:02 +00001637PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001638PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00001639{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001640 PyObject *it; /* iter(v) */
1641 Py_ssize_t n; /* guess for result tuple size */
1642 PyObject *result = NULL;
1643 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00001644
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001645 if (v == NULL)
1646 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001647
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001648 /* Special-case the common tuple and list cases, for efficiency. */
1649 if (PyTuple_CheckExact(v)) {
1650 /* Note that we can't know whether it's safe to return
1651 a tuple *subclass* instance as-is, hence the restriction
1652 to exact tuples here. In contrast, lists always make
1653 a copy, so there's no need for exactness below. */
1654 Py_INCREF(v);
1655 return v;
1656 }
Raymond Hettinger610a51f2015-05-17 14:45:58 -07001657 if (PyList_CheckExact(v))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001658 return PyList_AsTuple(v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001659
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001660 /* Get iterator. */
1661 it = PyObject_GetIter(v);
1662 if (it == NULL)
1663 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001664
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001665 /* Guess result size and allocate space. */
Armin Ronacheraa9a79d2012-10-06 14:03:24 +02001666 n = PyObject_LengthHint(v, 10);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001667 if (n == -1)
1668 goto Fail;
1669 result = PyTuple_New(n);
1670 if (result == NULL)
1671 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001672
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001673 /* Fill the tuple. */
1674 for (j = 0; ; ++j) {
1675 PyObject *item = PyIter_Next(it);
1676 if (item == NULL) {
1677 if (PyErr_Occurred())
1678 goto Fail;
1679 break;
1680 }
1681 if (j >= n) {
1682 Py_ssize_t oldn = n;
1683 /* The over-allocation strategy can grow a bit faster
1684 than for lists because unlike lists the
1685 over-allocation isn't permanent -- we reclaim
1686 the excess before the end of this routine.
1687 So, grow by ten and then add 25%.
1688 */
1689 n += 10;
1690 n += n >> 2;
1691 if (n < oldn) {
1692 /* Check for overflow */
1693 PyErr_NoMemory();
1694 Py_DECREF(item);
1695 goto Fail;
1696 }
1697 if (_PyTuple_Resize(&result, n) != 0) {
1698 Py_DECREF(item);
1699 goto Fail;
1700 }
1701 }
1702 PyTuple_SET_ITEM(result, j, item);
1703 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001704
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001705 /* Cut tuple back if guess was too large. */
1706 if (j < n &&
1707 _PyTuple_Resize(&result, j) != 0)
1708 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001709
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001710 Py_DECREF(it);
1711 return result;
Tim Peters6912d4d2001-05-05 03:56:37 +00001712
1713Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001714 Py_XDECREF(result);
1715 Py_DECREF(it);
1716 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001717}
1718
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001719PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001720PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001721{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001722 PyObject *result; /* result list */
1723 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00001724
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001725 if (v == NULL)
1726 return null_error();
Guido van Rossum5dba9e81998-07-10 18:03:50 +00001727
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001728 result = PyList_New(0);
1729 if (result == NULL)
1730 return NULL;
Tim Petersf553f892001-05-01 20:45:31 +00001731
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001732 rv = _PyList_Extend((PyListObject *)result, v);
1733 if (rv == NULL) {
1734 Py_DECREF(result);
1735 return NULL;
1736 }
1737 Py_DECREF(rv);
1738 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001739}
1740
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001741PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001742PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001743{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001744 PyObject *it;
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001745
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001746 if (v == NULL)
1747 return null_error();
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001748
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001749 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
1750 Py_INCREF(v);
1751 return v;
1752 }
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001753
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001754 it = PyObject_GetIter(v);
1755 if (it == NULL) {
1756 if (PyErr_ExceptionMatches(PyExc_TypeError))
1757 PyErr_SetString(PyExc_TypeError, m);
1758 return NULL;
1759 }
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001760
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001761 v = PySequence_List(it);
1762 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001763
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001764 return v;
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001765}
1766
Tim Peters16a77ad2001-09-08 04:00:12 +00001767/* Iterate over seq. Result depends on the operation:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001768 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
1769 PY_ITERSEARCH_INDEX: 0-based index of first occurrence of obj in seq;
1770 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00001771 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
1772*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001773Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001774_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00001775{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001776 Py_ssize_t n;
1777 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
1778 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00001779
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001780 if (seq == NULL || obj == NULL) {
1781 null_error();
1782 return -1;
1783 }
Tim Peters75f8e352001-05-05 11:33:43 +00001784
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001785 it = PyObject_GetIter(seq);
1786 if (it == NULL) {
1787 type_error("argument of type '%.200s' is not iterable", seq);
1788 return -1;
1789 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001790
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001791 n = wrapped = 0;
1792 for (;;) {
1793 int cmp;
1794 PyObject *item = PyIter_Next(it);
1795 if (item == NULL) {
1796 if (PyErr_Occurred())
1797 goto Fail;
1798 break;
1799 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001800
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001801 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
1802 Py_DECREF(item);
1803 if (cmp < 0)
1804 goto Fail;
1805 if (cmp > 0) {
1806 switch (operation) {
1807 case PY_ITERSEARCH_COUNT:
1808 if (n == PY_SSIZE_T_MAX) {
1809 PyErr_SetString(PyExc_OverflowError,
1810 "count exceeds C integer size");
1811 goto Fail;
1812 }
1813 ++n;
1814 break;
Tim Peters16a77ad2001-09-08 04:00:12 +00001815
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001816 case PY_ITERSEARCH_INDEX:
1817 if (wrapped) {
1818 PyErr_SetString(PyExc_OverflowError,
1819 "index exceeds C integer size");
1820 goto Fail;
1821 }
1822 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001823
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001824 case PY_ITERSEARCH_CONTAINS:
1825 n = 1;
1826 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001827
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001828 default:
1829 assert(!"unknown operation");
1830 }
1831 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001832
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001833 if (operation == PY_ITERSEARCH_INDEX) {
1834 if (n == PY_SSIZE_T_MAX)
1835 wrapped = 1;
1836 ++n;
1837 }
1838 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001839
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001840 if (operation != PY_ITERSEARCH_INDEX)
1841 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001842
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001843 PyErr_SetString(PyExc_ValueError,
1844 "sequence.index(x): x not in sequence");
1845 /* fall into failure code */
Tim Peters16a77ad2001-09-08 04:00:12 +00001846Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001847 n = -1;
1848 /* fall through */
Tim Peters16a77ad2001-09-08 04:00:12 +00001849Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001850 Py_DECREF(it);
1851 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00001852
Guido van Rossume15dee51995-07-18 14:12:02 +00001853}
1854
Tim Peters16a77ad2001-09-08 04:00:12 +00001855/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001856Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001857PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001858{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001859 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00001860}
1861
Tim Peterscb8d3682001-05-05 21:05:01 +00001862/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00001863 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00001864 */
1865int
1866PySequence_Contains(PyObject *seq, PyObject *ob)
1867{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001868 Py_ssize_t result;
1869 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
1870 if (sqm != NULL && sqm->sq_contains != NULL)
1871 return (*sqm->sq_contains)(seq, ob);
1872 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
1873 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00001874}
1875
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001876/* Backwards compatibility */
1877#undef PySequence_In
1878int
Fred Drake79912472000-07-09 04:06:11 +00001879PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001880{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001881 return PySequence_Contains(w, v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001882}
1883
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001884Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00001885PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001886{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001887 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00001888}
1889
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001890/* Operations on mappings */
1891
1892int
Fred Drake79912472000-07-09 04:06:11 +00001893PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001894{
Benjamin Peterson21992272011-12-28 12:01:31 -06001895 return o && o->ob_type->tp_as_mapping &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001896 o->ob_type->tp_as_mapping->mp_subscript;
Guido van Rossume15dee51995-07-18 14:12:02 +00001897}
1898
Martin v. Löwis18e16552006-02-15 17:27:45 +00001899Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001900PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001901{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001902 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001903
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001904 if (o == NULL) {
1905 null_error();
1906 return -1;
1907 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001908
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001909 m = o->ob_type->tp_as_mapping;
1910 if (m && m->mp_length)
1911 return m->mp_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001912
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001913 type_error("object of type '%.200s' has no len()", o);
1914 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001915}
1916
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001917#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001918Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001919PyMapping_Length(PyObject *o)
1920{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001921 return PyMapping_Size(o);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001922}
1923#define PyMapping_Length PyMapping_Size
1924
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001925PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +03001926PyMapping_GetItemString(PyObject *o, const char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001927{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001928 PyObject *okey, *r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001929
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001930 if (key == NULL)
1931 return null_error();
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001932
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001933 okey = PyUnicode_FromString(key);
1934 if (okey == NULL)
1935 return NULL;
1936 r = PyObject_GetItem(o, okey);
1937 Py_DECREF(okey);
1938 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001939}
1940
1941int
Serhiy Storchakac6792272013-10-19 21:03:34 +03001942PyMapping_SetItemString(PyObject *o, const char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001943{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001944 PyObject *okey;
1945 int r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001946
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001947 if (key == NULL) {
1948 null_error();
1949 return -1;
1950 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001951
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001952 okey = PyUnicode_FromString(key);
1953 if (okey == NULL)
1954 return -1;
1955 r = PyObject_SetItem(o, okey, value);
1956 Py_DECREF(okey);
1957 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001958}
1959
1960int
Serhiy Storchakac6792272013-10-19 21:03:34 +03001961PyMapping_HasKeyString(PyObject *o, const char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00001962{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001963 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00001964
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001965 v = PyMapping_GetItemString(o, key);
1966 if (v) {
1967 Py_DECREF(v);
1968 return 1;
1969 }
1970 PyErr_Clear();
1971 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00001972}
1973
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001974int
Fred Drake79912472000-07-09 04:06:11 +00001975PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00001976{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001977 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00001978
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001979 v = PyObject_GetItem(o, key);
1980 if (v) {
1981 Py_DECREF(v);
1982 return 1;
1983 }
1984 PyErr_Clear();
1985 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00001986}
1987
Guido van Rossumcc2b0162007-02-11 06:12:03 +00001988PyObject *
1989PyMapping_Keys(PyObject *o)
1990{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001991 PyObject *keys;
1992 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02001993 _Py_IDENTIFIER(keys);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00001994
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001995 if (PyDict_CheckExact(o))
1996 return PyDict_Keys(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02001997 keys = _PyObject_CallMethodId(o, &PyId_keys, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001998 if (keys == NULL)
1999 return NULL;
2000 fast = PySequence_Fast(keys, "o.keys() are not iterable");
2001 Py_DECREF(keys);
2002 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002003}
2004
2005PyObject *
2006PyMapping_Items(PyObject *o)
2007{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002008 PyObject *items;
2009 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002010 _Py_IDENTIFIER(items);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002011
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002012 if (PyDict_CheckExact(o))
2013 return PyDict_Items(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002014 items = _PyObject_CallMethodId(o, &PyId_items, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002015 if (items == NULL)
2016 return NULL;
2017 fast = PySequence_Fast(items, "o.items() are not iterable");
2018 Py_DECREF(items);
2019 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002020}
2021
2022PyObject *
2023PyMapping_Values(PyObject *o)
2024{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002025 PyObject *values;
2026 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002027 _Py_IDENTIFIER(values);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002028
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002029 if (PyDict_CheckExact(o))
2030 return PyDict_Values(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002031 values = _PyObject_CallMethodId(o, &PyId_values, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002032 if (values == NULL)
2033 return NULL;
2034 fast = PySequence_Fast(values, "o.values() are not iterable");
2035 Py_DECREF(values);
2036 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002037}
2038
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002039/* Operations on callable objects */
2040
2041/* XXX PyCallable_Check() is in object.c */
2042
Guido van Rossume15dee51995-07-18 14:12:02 +00002043PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002044PyObject_CallObject(PyObject *o, PyObject *a)
Guido van Rossume15dee51995-07-18 14:12:02 +00002045{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002046 return PyEval_CallObjectWithKeywords(o, a, NULL);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002047}
Guido van Rossume15dee51995-07-18 14:12:02 +00002048
2049PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002050PyObject_Call(PyObject *func, PyObject *arg, PyObject *kw)
2051{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002052 ternaryfunc call;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002053
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002054 if ((call = func->ob_type->tp_call) != NULL) {
2055 PyObject *result;
2056 if (Py_EnterRecursiveCall(" while calling a Python object"))
2057 return NULL;
2058 result = (*call)(func, arg, kw);
2059 Py_LeaveRecursiveCall();
Victor Stinner3de58692013-07-15 17:50:07 +02002060#ifdef NDEBUG
2061 if (result == NULL && !PyErr_Occurred()) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002062 PyErr_SetString(
2063 PyExc_SystemError,
2064 "NULL result without error in PyObject_Call");
Victor Stinner3de58692013-07-15 17:50:07 +02002065 }
2066#else
Victor Stinner4ac9c002013-12-19 13:47:35 +01002067 assert((result != NULL && !PyErr_Occurred())
2068 || (result == NULL && PyErr_Occurred()));
Victor Stinner3de58692013-07-15 17:50:07 +02002069#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002070 return result;
2071 }
2072 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
2073 func->ob_type->tp_name);
2074 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002075}
2076
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002077static PyObject*
2078call_function_tail(PyObject *callable, PyObject *args)
2079{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002080 PyObject *retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002081
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002082 if (args == NULL)
2083 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002084
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002085 if (!PyTuple_Check(args)) {
2086 PyObject *a;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002087
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002088 a = PyTuple_New(1);
2089 if (a == NULL) {
2090 Py_DECREF(args);
2091 return NULL;
2092 }
2093 PyTuple_SET_ITEM(a, 0, args);
2094 args = a;
2095 }
2096 retval = PyObject_Call(callable, args, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002097
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002098 Py_DECREF(args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002099
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002100 return retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002101}
2102
Tim Peters6d6c1a32001-08-02 04:15:00 +00002103PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002104PyObject_CallFunction(PyObject *callable, const char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002105{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002106 va_list va;
2107 PyObject *args;
Guido van Rossume15dee51995-07-18 14:12:02 +00002108
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002109 if (callable == NULL)
2110 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002111
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002112 if (format && *format) {
2113 va_start(va, format);
2114 args = Py_VaBuildValue(format, va);
2115 va_end(va);
2116 }
2117 else
2118 args = PyTuple_New(0);
Victor Stinner0b0c8672013-10-29 19:29:52 +01002119 if (args == NULL)
2120 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002121
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002122 return call_function_tail(callable, args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002123}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002124
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002125PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002126_PyObject_CallFunction_SizeT(PyObject *callable, const char *format, ...)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002127{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002128 va_list va;
2129 PyObject *args;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002130
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002131 if (callable == NULL)
2132 return null_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002133
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002134 if (format && *format) {
2135 va_start(va, format);
2136 args = _Py_VaBuildValue_SizeT(format, va);
2137 va_end(va);
2138 }
2139 else
2140 args = PyTuple_New(0);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002141
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002142 return call_function_tail(callable, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002143}
2144
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002145static PyObject*
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002146callmethod(PyObject* func, const char *format, va_list va, int is_size_t)
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002147{
2148 PyObject *retval = NULL;
2149 PyObject *args;
2150
2151 if (!PyCallable_Check(func)) {
2152 type_error("attribute of type '%.200s' is not callable", func);
2153 goto exit;
2154 }
2155
2156 if (format && *format) {
2157 if (is_size_t)
2158 args = _Py_VaBuildValue_SizeT(format, va);
2159 else
2160 args = Py_VaBuildValue(format, va);
2161 }
2162 else
2163 args = PyTuple_New(0);
2164
2165 retval = call_function_tail(func, args);
2166
2167 exit:
2168 /* args gets consumed in call_function_tail */
2169 Py_XDECREF(func);
2170
2171 return retval;
2172}
2173
Guido van Rossume15dee51995-07-18 14:12:02 +00002174PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002175PyObject_CallMethod(PyObject *o, const char *name, const char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002176{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002177 va_list va;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002178 PyObject *func = NULL;
2179 PyObject *retval = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002180
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002181 if (o == NULL || name == NULL)
2182 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002184 func = PyObject_GetAttrString(o, name);
Benjamin Peterson1791c222014-06-26 23:29:13 -07002185 if (func == NULL)
2186 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002187
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002188 va_start(va, format);
2189 retval = callmethod(func, format, va, 0);
2190 va_end(va);
2191 return retval;
2192}
2193
2194PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002195_PyObject_CallMethodId(PyObject *o, _Py_Identifier *name,
2196 const char *format, ...)
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002197{
2198 va_list va;
2199 PyObject *func = NULL;
2200 PyObject *retval = NULL;
2201
2202 if (o == NULL || name == NULL)
2203 return null_error();
2204
2205 func = _PyObject_GetAttrId(o, name);
Benjamin Peterson1791c222014-06-26 23:29:13 -07002206 if (func == NULL)
2207 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002208
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002209 va_start(va, format);
2210 retval = callmethod(func, format, va, 0);
2211 va_end(va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002212 return retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002213}
2214
2215PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002216_PyObject_CallMethod_SizeT(PyObject *o, const char *name,
2217 const char *format, ...)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002218{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002219 va_list va;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002220 PyObject *func = NULL;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002221 PyObject *retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002222
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002223 if (o == NULL || name == NULL)
2224 return null_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002225
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002226 func = PyObject_GetAttrString(o, name);
Benjamin Peterson1791c222014-06-26 23:29:13 -07002227 if (func == NULL)
2228 return NULL;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002229 va_start(va, format);
2230 retval = callmethod(func, format, va, 1);
2231 va_end(va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002232 return retval;
Guido van Rossume15dee51995-07-18 14:12:02 +00002233}
Guido van Rossum823649d2001-03-21 18:40:58 +00002234
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002235PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002236_PyObject_CallMethodId_SizeT(PyObject *o, _Py_Identifier *name,
2237 const char *format, ...)
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002238{
2239 va_list va;
2240 PyObject *func = NULL;
2241 PyObject *retval;
2242
2243 if (o == NULL || name == NULL)
2244 return null_error();
2245
2246 func = _PyObject_GetAttrId(o, name);
2247 if (func == NULL) {
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002248 return NULL;
2249 }
2250 va_start(va, format);
2251 retval = callmethod(func, format, va, 1);
2252 va_end(va);
2253 return retval;
2254}
Guido van Rossum823649d2001-03-21 18:40:58 +00002255
Fred Drakeb421b8c2001-10-26 16:21:32 +00002256static PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002257objargs_mktuple(va_list va)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002258{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002259 int i, n = 0;
2260 va_list countva;
2261 PyObject *result, *tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002262
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00002263 Py_VA_COPY(countva, va);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002264
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002265 while (((PyObject *)va_arg(countva, PyObject *)) != NULL)
2266 ++n;
2267 result = PyTuple_New(n);
2268 if (result != NULL && n > 0) {
2269 for (i = 0; i < n; ++i) {
2270 tmp = (PyObject *)va_arg(va, PyObject *);
2271 PyTuple_SET_ITEM(result, i, tmp);
2272 Py_INCREF(tmp);
2273 }
2274 }
2275 return result;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002276}
2277
2278PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002279PyObject_CallMethodObjArgs(PyObject *callable, PyObject *name, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002280{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002281 PyObject *args, *tmp;
2282 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002283
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002284 if (callable == NULL || name == NULL)
2285 return null_error();
Fred Drakeb421b8c2001-10-26 16:21:32 +00002286
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002287 callable = PyObject_GetAttr(callable, name);
2288 if (callable == NULL)
2289 return NULL;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002290
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002291 /* count the args */
2292 va_start(vargs, name);
2293 args = objargs_mktuple(vargs);
2294 va_end(vargs);
2295 if (args == NULL) {
2296 Py_DECREF(callable);
2297 return NULL;
2298 }
2299 tmp = PyObject_Call(callable, args, NULL);
2300 Py_DECREF(args);
2301 Py_DECREF(callable);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002302
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002303 return tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002304}
2305
2306PyObject *
Alexandre Vassalotti865eaa12013-05-02 10:44:04 -07002307_PyObject_CallMethodIdObjArgs(PyObject *callable,
Brett Cannonfd074152012-04-14 14:10:13 -04002308 struct _Py_Identifier *name, ...)
2309{
2310 PyObject *args, *tmp;
2311 va_list vargs;
2312
2313 if (callable == NULL || name == NULL)
2314 return null_error();
2315
2316 callable = _PyObject_GetAttrId(callable, name);
2317 if (callable == NULL)
2318 return NULL;
2319
2320 /* count the args */
2321 va_start(vargs, name);
2322 args = objargs_mktuple(vargs);
2323 va_end(vargs);
2324 if (args == NULL) {
2325 Py_DECREF(callable);
2326 return NULL;
2327 }
2328 tmp = PyObject_Call(callable, args, NULL);
2329 Py_DECREF(args);
2330 Py_DECREF(callable);
2331
2332 return tmp;
2333}
2334
2335PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002336PyObject_CallFunctionObjArgs(PyObject *callable, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002337{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002338 PyObject *args, *tmp;
2339 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002340
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002341 if (callable == NULL)
2342 return null_error();
Fred Drakeb421b8c2001-10-26 16:21:32 +00002343
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002344 /* count the args */
2345 va_start(vargs, callable);
2346 args = objargs_mktuple(vargs);
2347 va_end(vargs);
2348 if (args == NULL)
2349 return NULL;
2350 tmp = PyObject_Call(callable, args, NULL);
2351 Py_DECREF(args);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002352
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002353 return tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002354}
2355
2356
Guido van Rossum823649d2001-03-21 18:40:58 +00002357/* isinstance(), issubclass() */
2358
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002359/* abstract_get_bases() has logically 4 return states:
Barry Warsawf16951c2002-04-23 22:45:44 +00002360 *
Barry Warsawf16951c2002-04-23 22:45:44 +00002361 * 1. getattr(cls, '__bases__') could raise an AttributeError
2362 * 2. getattr(cls, '__bases__') could raise some other exception
2363 * 3. getattr(cls, '__bases__') could return a tuple
2364 * 4. getattr(cls, '__bases__') could return something other than a tuple
2365 *
2366 * Only state #3 is a non-error state and only it returns a non-NULL object
2367 * (it returns the retrieved tuple).
2368 *
2369 * Any raised AttributeErrors are masked by clearing the exception and
2370 * returning NULL. If an object other than a tuple comes out of __bases__,
2371 * then again, the return value is NULL. So yes, these two situations
2372 * produce exactly the same results: NULL is returned and no error is set.
2373 *
2374 * If some exception other than AttributeError is raised, then NULL is also
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002375 * returned, but the exception is not cleared. That's because we want the
Barry Warsawf16951c2002-04-23 22:45:44 +00002376 * exception to be propagated along.
2377 *
2378 * Callers are expected to test for PyErr_Occurred() when the return value
2379 * is NULL to decide whether a valid exception should be propagated or not.
2380 * When there's no exception to propagate, it's customary for the caller to
2381 * set a TypeError.
2382 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002383static PyObject *
2384abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002385{
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002386 _Py_IDENTIFIER(__bases__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002387 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002388
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002389 Py_ALLOW_RECURSION
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002390 bases = _PyObject_GetAttrId(cls, &PyId___bases__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002391 Py_END_ALLOW_RECURSION
2392 if (bases == NULL) {
2393 if (PyErr_ExceptionMatches(PyExc_AttributeError))
2394 PyErr_Clear();
2395 return NULL;
2396 }
2397 if (!PyTuple_Check(bases)) {
2398 Py_DECREF(bases);
2399 return NULL;
2400 }
2401 return bases;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002402}
2403
2404
2405static int
2406abstract_issubclass(PyObject *derived, PyObject *cls)
2407{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002408 PyObject *bases = NULL;
2409 Py_ssize_t i, n;
2410 int r = 0;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002411
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002412 while (1) {
2413 if (derived == cls)
2414 return 1;
2415 bases = abstract_get_bases(derived);
2416 if (bases == NULL) {
2417 if (PyErr_Occurred())
2418 return -1;
2419 return 0;
2420 }
2421 n = PyTuple_GET_SIZE(bases);
2422 if (n == 0) {
2423 Py_DECREF(bases);
2424 return 0;
2425 }
2426 /* Avoid recursivity in the single inheritance case */
2427 if (n == 1) {
2428 derived = PyTuple_GET_ITEM(bases, 0);
2429 Py_DECREF(bases);
2430 continue;
2431 }
2432 for (i = 0; i < n; i++) {
2433 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
2434 if (r != 0)
2435 break;
2436 }
2437 Py_DECREF(bases);
2438 return r;
2439 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002440}
2441
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002442static int
2443check_class(PyObject *cls, const char *error)
2444{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002445 PyObject *bases = abstract_get_bases(cls);
2446 if (bases == NULL) {
2447 /* Do not mask errors. */
2448 if (!PyErr_Occurred())
2449 PyErr_SetString(PyExc_TypeError, error);
2450 return 0;
2451 }
2452 Py_DECREF(bases);
2453 return -1;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002454}
2455
Brett Cannon4f653312004-03-20 22:52:14 +00002456static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002457recursive_isinstance(PyObject *inst, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002458{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002459 PyObject *icls;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002460 int retval = 0;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002461 _Py_IDENTIFIER(__class__);
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002462
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002463 if (PyType_Check(cls)) {
2464 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
2465 if (retval == 0) {
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002466 PyObject *c = _PyObject_GetAttrId(inst, &PyId___class__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002467 if (c == NULL) {
Benjamin Peterson72288d42010-11-20 17:21:08 +00002468 if (PyErr_ExceptionMatches(PyExc_AttributeError))
R. David Murray6bb99892010-11-20 16:33:30 +00002469 PyErr_Clear();
Benjamin Peterson72288d42010-11-20 17:21:08 +00002470 else
R. David Murray6bb99892010-11-20 16:33:30 +00002471 retval = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002472 }
2473 else {
2474 if (c != (PyObject *)(inst->ob_type) &&
2475 PyType_Check(c))
2476 retval = PyType_IsSubtype(
2477 (PyTypeObject *)c,
2478 (PyTypeObject *)cls);
2479 Py_DECREF(c);
2480 }
2481 }
2482 }
2483 else {
2484 if (!check_class(cls,
Benjamin Petersone893af52010-06-28 19:43:42 +00002485 "isinstance() arg 2 must be a type or tuple of types"))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002486 return -1;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002487 icls = _PyObject_GetAttrId(inst, &PyId___class__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002488 if (icls == NULL) {
Benjamin Peterson72288d42010-11-20 17:21:08 +00002489 if (PyErr_ExceptionMatches(PyExc_AttributeError))
R. David Murray6bb99892010-11-20 16:33:30 +00002490 PyErr_Clear();
Benjamin Peterson72288d42010-11-20 17:21:08 +00002491 else
R. David Murray6bb99892010-11-20 16:33:30 +00002492 retval = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002493 }
2494 else {
2495 retval = abstract_issubclass(icls, cls);
2496 Py_DECREF(icls);
2497 }
2498 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002499
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002500 return retval;
Guido van Rossum823649d2001-03-21 18:40:58 +00002501}
2502
2503int
Brett Cannon4f653312004-03-20 22:52:14 +00002504PyObject_IsInstance(PyObject *inst, PyObject *cls)
2505{
Benjamin Petersonce798522012-01-22 11:24:29 -05002506 _Py_IDENTIFIER(__instancecheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002507 PyObject *checker;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002508
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002509 /* Quick test for an exact match */
2510 if (Py_TYPE(inst) == (PyTypeObject *)cls)
2511 return 1;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002512
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002513 if (PyTuple_Check(cls)) {
2514 Py_ssize_t i;
2515 Py_ssize_t n;
2516 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002517
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002518 if (Py_EnterRecursiveCall(" in __instancecheck__"))
2519 return -1;
2520 n = PyTuple_GET_SIZE(cls);
2521 for (i = 0; i < n; ++i) {
2522 PyObject *item = PyTuple_GET_ITEM(cls, i);
2523 r = PyObject_IsInstance(inst, item);
2524 if (r != 0)
2525 /* either found it, or got an error */
2526 break;
2527 }
2528 Py_LeaveRecursiveCall();
2529 return r;
2530 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002531
Benjamin Petersonce798522012-01-22 11:24:29 -05002532 checker = _PyObject_LookupSpecial(cls, &PyId___instancecheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002533 if (checker != NULL) {
2534 PyObject *res;
2535 int ok = -1;
2536 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2537 Py_DECREF(checker);
2538 return ok;
2539 }
2540 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
2541 Py_LeaveRecursiveCall();
2542 Py_DECREF(checker);
2543 if (res != NULL) {
2544 ok = PyObject_IsTrue(res);
2545 Py_DECREF(res);
2546 }
2547 return ok;
2548 }
2549 else if (PyErr_Occurred())
2550 return -1;
2551 return recursive_isinstance(inst, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002552}
2553
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002554static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002555recursive_issubclass(PyObject *derived, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002556{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002557 if (PyType_Check(cls) && PyType_Check(derived)) {
2558 /* Fast path (non-recursive) */
2559 return PyType_IsSubtype((PyTypeObject *)derived, (PyTypeObject *)cls);
2560 }
2561 if (!check_class(derived,
2562 "issubclass() arg 1 must be a class"))
2563 return -1;
2564 if (!check_class(cls,
2565 "issubclass() arg 2 must be a class"
2566 " or tuple of classes"))
2567 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002568
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002569 return abstract_issubclass(derived, cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002570}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002571
Brett Cannon4f653312004-03-20 22:52:14 +00002572int
2573PyObject_IsSubclass(PyObject *derived, PyObject *cls)
2574{
Benjamin Petersonce798522012-01-22 11:24:29 -05002575 _Py_IDENTIFIER(__subclasscheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002576 PyObject *checker;
Georg Brandldcfe8e42009-05-17 08:22:45 +00002577
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002578 if (PyTuple_Check(cls)) {
2579 Py_ssize_t i;
2580 Py_ssize_t n;
2581 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002582
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002583 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
2584 return -1;
2585 n = PyTuple_GET_SIZE(cls);
2586 for (i = 0; i < n; ++i) {
2587 PyObject *item = PyTuple_GET_ITEM(cls, i);
2588 r = PyObject_IsSubclass(derived, item);
2589 if (r != 0)
2590 /* either found it, or got an error */
2591 break;
2592 }
2593 Py_LeaveRecursiveCall();
2594 return r;
2595 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002596
Benjamin Petersonce798522012-01-22 11:24:29 -05002597 checker = _PyObject_LookupSpecial(cls, &PyId___subclasscheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002598 if (checker != NULL) {
2599 PyObject *res;
2600 int ok = -1;
2601 if (Py_EnterRecursiveCall(" in __subclasscheck__")) {
2602 Py_DECREF(checker);
2603 return ok;
2604 }
2605 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
2606 Py_LeaveRecursiveCall();
2607 Py_DECREF(checker);
2608 if (res != NULL) {
2609 ok = PyObject_IsTrue(res);
2610 Py_DECREF(res);
2611 }
2612 return ok;
2613 }
2614 else if (PyErr_Occurred())
2615 return -1;
2616 return recursive_issubclass(derived, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00002617}
2618
2619int
2620_PyObject_RealIsInstance(PyObject *inst, PyObject *cls)
2621{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002622 return recursive_isinstance(inst, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00002623}
2624
2625int
2626_PyObject_RealIsSubclass(PyObject *derived, PyObject *cls)
2627{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002628 return recursive_issubclass(derived, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002629}
2630
2631
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002632PyObject *
2633PyObject_GetIter(PyObject *o)
2634{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002635 PyTypeObject *t = o->ob_type;
2636 getiterfunc f = NULL;
2637 f = t->tp_iter;
2638 if (f == NULL) {
2639 if (PySequence_Check(o))
2640 return PySeqIter_New(o);
2641 return type_error("'%.200s' object is not iterable", o);
2642 }
2643 else {
2644 PyObject *res = (*f)(o);
2645 if (res != NULL && !PyIter_Check(res)) {
2646 PyErr_Format(PyExc_TypeError,
2647 "iter() returned non-iterator "
2648 "of type '%.100s'",
2649 res->ob_type->tp_name);
2650 Py_DECREF(res);
2651 res = NULL;
2652 }
2653 return res;
2654 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00002655}
2656
Tim Petersf4848da2001-05-05 00:14:56 +00002657/* Return next item.
2658 * If an error occurs, return NULL. PyErr_Occurred() will be true.
2659 * If the iteration terminates normally, return NULL and clear the
2660 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
2661 * will be false.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002662 * Else return the next object. PyErr_Occurred() will be false.
Tim Petersf4848da2001-05-05 00:14:56 +00002663 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002664PyObject *
2665PyIter_Next(PyObject *iter)
2666{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002667 PyObject *result;
2668 result = (*iter->ob_type->tp_iternext)(iter);
2669 if (result == NULL &&
2670 PyErr_Occurred() &&
2671 PyErr_ExceptionMatches(PyExc_StopIteration))
2672 PyErr_Clear();
2673 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002674}
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002675
2676
2677/*
2678 * Flatten a sequence of bytes() objects into a C array of
2679 * NULL terminated string pointers with a NULL char* terminating the array.
2680 * (ie: an argv or env list)
2681 *
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002682 * Memory allocated for the returned list is allocated using PyMem_Malloc()
2683 * and MUST be freed by _Py_FreeCharPArray().
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002684 */
2685char *const *
2686_PySequence_BytesToCharpArray(PyObject* self)
2687{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002688 char **array;
2689 Py_ssize_t i, argc;
2690 PyObject *item = NULL;
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002691 Py_ssize_t size;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002692
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002693 argc = PySequence_Size(self);
2694 if (argc == -1)
2695 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002696
Stefan Krah7cacd2e2012-08-21 08:16:09 +02002697 assert(argc >= 0);
2698
2699 if ((size_t)argc > (PY_SSIZE_T_MAX-sizeof(char *)) / sizeof(char *)) {
2700 PyErr_NoMemory();
2701 return NULL;
2702 }
2703
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002704 array = PyMem_Malloc((argc + 1) * sizeof(char *));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002705 if (array == NULL) {
2706 PyErr_NoMemory();
2707 return NULL;
2708 }
2709 for (i = 0; i < argc; ++i) {
2710 char *data;
2711 item = PySequence_GetItem(self, i);
Stefan Krahfd24f9e2012-08-20 11:04:24 +02002712 if (item == NULL) {
2713 /* NULL terminate before freeing. */
2714 array[i] = NULL;
2715 goto fail;
2716 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002717 data = PyBytes_AsString(item);
2718 if (data == NULL) {
2719 /* NULL terminate before freeing. */
2720 array[i] = NULL;
2721 goto fail;
2722 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002723 size = PyBytes_GET_SIZE(item) + 1;
2724 array[i] = PyMem_Malloc(size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002725 if (!array[i]) {
2726 PyErr_NoMemory();
2727 goto fail;
2728 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002729 memcpy(array[i], data, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002730 Py_DECREF(item);
2731 }
2732 array[argc] = NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002733
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002734 return array;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002735
2736fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002737 Py_XDECREF(item);
2738 _Py_FreeCharPArray(array);
2739 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002740}
2741
2742
2743/* Free's a NULL terminated char** array of C strings. */
2744void
2745_Py_FreeCharPArray(char *const array[])
2746{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002747 Py_ssize_t i;
2748 for (i = 0; array[i] != NULL; ++i) {
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002749 PyMem_Free(array[i]);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002750 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002751 PyMem_Free((void*)array);
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002752}