blob: d838856d452872e714c5472c6b95303c43c1862a [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
Victor Stinner71aea8e2016-08-19 16:59:55 +020035 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000036 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +020037 }
38
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000039 v = (PyObject *)o->ob_type;
40 Py_INCREF(v);
41 return v;
Guido van Rossume15dee51995-07-18 14:12:02 +000042}
43
Martin v. Löwis18e16552006-02-15 17:27:45 +000044Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +000045PyObject_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +000046{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000047 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +000048
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000049 if (o == NULL) {
50 null_error();
51 return -1;
52 }
Guido van Rossume15dee51995-07-18 14:12:02 +000053
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000054 m = o->ob_type->tp_as_sequence;
55 if (m && m->sq_length)
56 return m->sq_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +000057
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000058 return PyMapping_Size(o);
Guido van Rossume15dee51995-07-18 14:12:02 +000059}
60
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000061#undef PyObject_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +000062Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000063PyObject_Length(PyObject *o)
64{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000065 return PyObject_Size(o);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000066}
67#define PyObject_Length PyObject_Size
68
Armin Ronacheraa9a79d2012-10-06 14:03:24 +020069int
70_PyObject_HasLen(PyObject *o) {
71 return (Py_TYPE(o)->tp_as_sequence && Py_TYPE(o)->tp_as_sequence->sq_length) ||
72 (Py_TYPE(o)->tp_as_mapping && Py_TYPE(o)->tp_as_mapping->mp_length);
73}
Raymond Hettinger6b27cda2005-09-24 21:23:05 +000074
Christian Heimes255f53b2007-12-08 15:33:56 +000075/* The length hint function returns a non-negative value from o.__len__()
Armin Ronacher74b38b12012-10-07 10:29:32 +020076 or o.__length_hint__(). If those methods aren't found the defaultvalue is
77 returned. If one of the calls fails with an exception other than TypeError
78 this function returns -1.
Christian Heimes255f53b2007-12-08 15:33:56 +000079*/
80
81Py_ssize_t
Armin Ronacheraa9a79d2012-10-06 14:03:24 +020082PyObject_LengthHint(PyObject *o, Py_ssize_t defaultvalue)
Christian Heimes255f53b2007-12-08 15:33:56 +000083{
Christian Heimesb70e8a12012-10-06 17:16:39 +020084 PyObject *hint, *result;
Christian Heimes6314d162012-10-06 17:13:29 +020085 Py_ssize_t res;
Benjamin Petersonce798522012-01-22 11:24:29 -050086 _Py_IDENTIFIER(__length_hint__);
Serhiy Storchakaf740d462013-10-24 23:19:51 +030087 if (_PyObject_HasLen(o)) {
88 res = PyObject_Length(o);
89 if (res < 0 && PyErr_Occurred()) {
90 if (!PyErr_ExceptionMatches(PyExc_TypeError)) {
91 return -1;
92 }
93 PyErr_Clear();
Armin Ronacheraa9a79d2012-10-06 14:03:24 +020094 }
Serhiy Storchakaf740d462013-10-24 23:19:51 +030095 else {
96 return res;
97 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000098 }
Christian Heimes6314d162012-10-06 17:13:29 +020099 hint = _PyObject_LookupSpecial(o, &PyId___length_hint__);
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200100 if (hint == NULL) {
101 if (PyErr_Occurred()) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000102 return -1;
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200103 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000104 return defaultvalue;
105 }
Christian Heimesb70e8a12012-10-06 17:16:39 +0200106 result = PyObject_CallFunctionObjArgs(hint, NULL);
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200107 Py_DECREF(hint);
108 if (result == NULL) {
109 if (PyErr_ExceptionMatches(PyExc_TypeError)) {
110 PyErr_Clear();
111 return defaultvalue;
112 }
113 return -1;
114 }
115 else if (result == Py_NotImplemented) {
116 Py_DECREF(result);
117 return defaultvalue;
118 }
119 if (!PyLong_Check(result)) {
Armin Ronacher74b38b12012-10-07 10:29:32 +0200120 PyErr_Format(PyExc_TypeError, "__length_hint__ must be an integer, not %.100s",
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200121 Py_TYPE(result)->tp_name);
122 Py_DECREF(result);
123 return -1;
124 }
Armin Ronacher74b38b12012-10-07 10:29:32 +0200125 res = PyLong_AsSsize_t(result);
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200126 Py_DECREF(result);
Armin Ronacher74b38b12012-10-07 10:29:32 +0200127 if (res < 0 && PyErr_Occurred()) {
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200128 return -1;
129 }
Armin Ronacher74b38b12012-10-07 10:29:32 +0200130 if (res < 0) {
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200131 PyErr_Format(PyExc_ValueError, "__length_hint__() should return >= 0");
132 return -1;
133 }
Armin Ronacher74b38b12012-10-07 10:29:32 +0200134 return res;
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000135}
136
Guido van Rossume15dee51995-07-18 14:12:02 +0000137PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000138PyObject_GetItem(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +0000139{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000140 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000141
Victor Stinner71aea8e2016-08-19 16:59:55 +0200142 if (o == NULL || key == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000143 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +0200144 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000145
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000146 m = o->ob_type->tp_as_mapping;
Victor Stinnere20310f2015-11-05 13:56:58 +0100147 if (m && m->mp_subscript) {
148 PyObject *item = m->mp_subscript(o, key);
149 assert((item != NULL) ^ (PyErr_Occurred() != NULL));
150 return item;
151 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000152
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000153 if (o->ob_type->tp_as_sequence) {
154 if (PyIndex_Check(key)) {
155 Py_ssize_t key_value;
156 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
157 if (key_value == -1 && PyErr_Occurred())
158 return NULL;
159 return PySequence_GetItem(o, key_value);
160 }
161 else if (o->ob_type->tp_as_sequence->sq_item)
162 return type_error("sequence index must "
163 "be integer, not '%.200s'", key);
164 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000165
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000166 return type_error("'%.200s' object is not subscriptable", o);
Guido van Rossume15dee51995-07-18 14:12:02 +0000167}
168
169int
Fred Drake79912472000-07-09 04:06:11 +0000170PyObject_SetItem(PyObject *o, PyObject *key, PyObject *value)
Guido van Rossume15dee51995-07-18 14:12:02 +0000171{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000172 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000173
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000174 if (o == NULL || key == NULL || value == NULL) {
175 null_error();
176 return -1;
177 }
178 m = o->ob_type->tp_as_mapping;
179 if (m && m->mp_ass_subscript)
180 return m->mp_ass_subscript(o, key, value);
Guido van Rossume15dee51995-07-18 14:12:02 +0000181
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000182 if (o->ob_type->tp_as_sequence) {
183 if (PyIndex_Check(key)) {
184 Py_ssize_t key_value;
185 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
186 if (key_value == -1 && PyErr_Occurred())
187 return -1;
188 return PySequence_SetItem(o, key_value, value);
189 }
190 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
191 type_error("sequence index must be "
192 "integer, not '%.200s'", key);
193 return -1;
194 }
195 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000196
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000197 type_error("'%.200s' object does not support item assignment", o);
198 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +0000199}
200
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000201int
Fred Drake79912472000-07-09 04:06:11 +0000202PyObject_DelItem(PyObject *o, PyObject *key)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000203{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000204 PyMappingMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000205
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000206 if (o == NULL || key == NULL) {
207 null_error();
208 return -1;
209 }
210 m = o->ob_type->tp_as_mapping;
211 if (m && m->mp_ass_subscript)
212 return m->mp_ass_subscript(o, key, (PyObject*)NULL);
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000213
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000214 if (o->ob_type->tp_as_sequence) {
215 if (PyIndex_Check(key)) {
216 Py_ssize_t key_value;
217 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
218 if (key_value == -1 && PyErr_Occurred())
219 return -1;
220 return PySequence_DelItem(o, key_value);
221 }
222 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
223 type_error("sequence index must be "
224 "integer, not '%.200s'", key);
225 return -1;
226 }
227 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000228
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000229 type_error("'%.200s' object does not support item deletion", o);
230 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000231}
232
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000233int
Serhiy Storchakac6792272013-10-19 21:03:34 +0300234PyObject_DelItemString(PyObject *o, const char *key)
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000235{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000236 PyObject *okey;
237 int ret;
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000238
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000239 if (o == NULL || key == NULL) {
240 null_error();
241 return -1;
242 }
243 okey = PyUnicode_FromString(key);
244 if (okey == NULL)
245 return -1;
246 ret = PyObject_DelItem(o, okey);
247 Py_DECREF(okey);
248 return ret;
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000249}
250
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000251/* We release the buffer right after use of this function which could
Guido van Rossum98297ee2007-11-06 21:34:58 +0000252 cause issues later on. Don't use these functions in new code.
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000253 */
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000254int
255PyObject_AsCharBuffer(PyObject *obj,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000256 const char **buffer,
257 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000258{
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200259 return PyObject_AsReadBuffer(obj, (const void **)buffer, buffer_len);
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000260}
Guido van Rossum4c08d552000-03-10 22:55:18 +0000261
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000262int
263PyObject_CheckReadBuffer(PyObject *obj)
264{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000265 PyBufferProcs *pb = obj->ob_type->tp_as_buffer;
266 Py_buffer view;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000267
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000268 if (pb == NULL ||
269 pb->bf_getbuffer == NULL)
270 return 0;
271 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE) == -1) {
272 PyErr_Clear();
273 return 0;
274 }
275 PyBuffer_Release(&view);
276 return 1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000277}
278
279int PyObject_AsReadBuffer(PyObject *obj,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000280 const void **buffer,
281 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000282{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000283 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000284
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000285 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
286 null_error();
287 return -1;
288 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200289 if (PyObject_GetBuffer(obj, &view, PyBUF_SIMPLE) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000290 return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000291
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000292 *buffer = view.buf;
293 *buffer_len = view.len;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200294 PyBuffer_Release(&view);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000295 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000296}
297
298int PyObject_AsWriteBuffer(PyObject *obj,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000299 void **buffer,
300 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000301{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000302 PyBufferProcs *pb;
303 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000304
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000305 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
306 null_error();
307 return -1;
308 }
309 pb = obj->ob_type->tp_as_buffer;
310 if (pb == NULL ||
311 pb->bf_getbuffer == NULL ||
312 ((*pb->bf_getbuffer)(obj, &view, PyBUF_WRITABLE) != 0)) {
313 PyErr_SetString(PyExc_TypeError,
R David Murray861470c2014-10-05 11:47:01 -0400314 "expected a writable bytes-like object");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000315 return -1;
316 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000317
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000318 *buffer = view.buf;
319 *buffer_len = view.len;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200320 PyBuffer_Release(&view);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000321 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000322}
323
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000324/* Buffer C-API for Python 3.0 */
325
326int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000327PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000328{
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200329 PyBufferProcs *pb = obj->ob_type->tp_as_buffer;
330
331 if (pb == NULL || pb->bf_getbuffer == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000332 PyErr_Format(PyExc_TypeError,
R David Murray861470c2014-10-05 11:47:01 -0400333 "a bytes-like object is required, not '%.100s'",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000334 Py_TYPE(obj)->tp_name);
335 return -1;
336 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200337 return (*pb->bf_getbuffer)(obj, view, flags);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000338}
339
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000340static int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100341_IsFortranContiguous(const Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000342{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000343 Py_ssize_t sd, dim;
344 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000345
Stefan Krah363af442015-02-01 14:53:54 +0100346 /* 1) len = product(shape) * itemsize
347 2) itemsize > 0
348 3) len = 0 <==> exists i: shape[i] = 0 */
349 if (view->len == 0) return 1;
350 if (view->strides == NULL) { /* C-contiguous by definition */
351 /* Trivially F-contiguous */
352 if (view->ndim <= 1) return 1;
353
354 /* ndim > 1 implies shape != NULL */
355 assert(view->shape != NULL);
356
357 /* Effectively 1-d */
358 sd = 0;
359 for (i=0; i<view->ndim; i++) {
360 if (view->shape[i] > 1) sd += 1;
361 }
362 return sd <= 1;
363 }
364
365 /* strides != NULL implies both of these */
366 assert(view->ndim > 0);
367 assert(view->shape != NULL);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000368
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000369 sd = view->itemsize;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000370 for (i=0; i<view->ndim; i++) {
371 dim = view->shape[i];
Stefan Krah363af442015-02-01 14:53:54 +0100372 if (dim > 1 && view->strides[i] != sd) {
373 return 0;
374 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000375 sd *= dim;
376 }
377 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000378}
379
380static int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100381_IsCContiguous(const Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000382{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000383 Py_ssize_t sd, dim;
384 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000385
Stefan Krah363af442015-02-01 14:53:54 +0100386 /* 1) len = product(shape) * itemsize
387 2) itemsize > 0
388 3) len = 0 <==> exists i: shape[i] = 0 */
389 if (view->len == 0) return 1;
390 if (view->strides == NULL) return 1; /* C-contiguous by definition */
391
392 /* strides != NULL implies both of these */
393 assert(view->ndim > 0);
394 assert(view->shape != NULL);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000395
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000396 sd = view->itemsize;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000397 for (i=view->ndim-1; i>=0; i--) {
398 dim = view->shape[i];
Stefan Krah363af442015-02-01 14:53:54 +0100399 if (dim > 1 && view->strides[i] != sd) {
400 return 0;
401 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000402 sd *= dim;
403 }
404 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000405}
406
407int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100408PyBuffer_IsContiguous(const Py_buffer *view, char order)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000409{
410
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000411 if (view->suboffsets != NULL) return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000412
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100413 if (order == 'C')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000414 return _IsCContiguous(view);
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100415 else if (order == 'F')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000416 return _IsFortranContiguous(view);
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100417 else if (order == 'A')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000418 return (_IsCContiguous(view) || _IsFortranContiguous(view));
419 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000420}
421
422
Guido van Rossum98297ee2007-11-06 21:34:58 +0000423void*
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000424PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000425{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000426 char* pointer;
427 int i;
428 pointer = (char *)view->buf;
429 for (i = 0; i < view->ndim; i++) {
430 pointer += view->strides[i]*indices[i];
431 if ((view->suboffsets != NULL) && (view->suboffsets[i] >= 0)) {
432 pointer = *((char**)pointer) + view->suboffsets[i];
433 }
434 }
435 return (void*)pointer;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000436}
437
438
Guido van Rossum98297ee2007-11-06 21:34:58 +0000439void
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000440_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 +0000441{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000442 int k;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000444 for (k=0; k<nd; k++) {
445 if (index[k] < shape[k]-1) {
446 index[k]++;
447 break;
448 }
449 else {
450 index[k] = 0;
451 }
452 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000453}
454
Guido van Rossum98297ee2007-11-06 21:34:58 +0000455void
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000456_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 +0000457{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000458 int k;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000460 for (k=nd-1; k>=0; k--) {
461 if (index[k] < shape[k]-1) {
462 index[k]++;
463 break;
464 }
465 else {
466 index[k] = 0;
467 }
468 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000469}
470
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000471int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000472PyBuffer_FromContiguous(Py_buffer *view, void *buf, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000473{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000474 int k;
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000475 void (*addone)(int, Py_ssize_t *, const Py_ssize_t *);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000476 Py_ssize_t *indices, elements;
477 char *src, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000478
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000479 if (len > view->len) {
480 len = view->len;
481 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000482
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000483 if (PyBuffer_IsContiguous(view, fort)) {
484 /* simplest copy is all that is needed */
485 memcpy(view->buf, buf, len);
486 return 0;
487 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000488
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000489 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000490
Stefan Krah7213fcc2015-02-01 16:19:23 +0100491 /* view->ndim <= 64 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000492 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
493 if (indices == NULL) {
494 PyErr_NoMemory();
495 return -1;
496 }
497 for (k=0; k<view->ndim;k++) {
498 indices[k] = 0;
499 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000500
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000501 if (fort == 'F') {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000502 addone = _Py_add_one_to_index_F;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000503 }
504 else {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000505 addone = _Py_add_one_to_index_C;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000506 }
507 src = buf;
508 /* XXX : This is not going to be the fastest code in the world
509 several optimizations are possible.
510 */
511 elements = len / view->itemsize;
512 while (elements--) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000513 ptr = PyBuffer_GetPointer(view, indices);
514 memcpy(ptr, src, view->itemsize);
515 src += view->itemsize;
Stefan Krah7213fcc2015-02-01 16:19:23 +0100516 addone(view->ndim, indices, view->shape);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000517 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000518
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000519 PyMem_Free(indices);
520 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000521}
522
Guido van Rossum98297ee2007-11-06 21:34:58 +0000523int PyObject_CopyData(PyObject *dest, PyObject *src)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000524{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000525 Py_buffer view_dest, view_src;
526 int k;
527 Py_ssize_t *indices, elements;
528 char *dptr, *sptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000529
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000530 if (!PyObject_CheckBuffer(dest) ||
531 !PyObject_CheckBuffer(src)) {
532 PyErr_SetString(PyExc_TypeError,
R David Murray861470c2014-10-05 11:47:01 -0400533 "both destination and source must be "\
534 "bytes-like objects");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000535 return -1;
536 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000537
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000538 if (PyObject_GetBuffer(dest, &view_dest, PyBUF_FULL) != 0) return -1;
539 if (PyObject_GetBuffer(src, &view_src, PyBUF_FULL_RO) != 0) {
540 PyBuffer_Release(&view_dest);
541 return -1;
542 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000543
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000544 if (view_dest.len < view_src.len) {
545 PyErr_SetString(PyExc_BufferError,
546 "destination is too small to receive data from source");
547 PyBuffer_Release(&view_dest);
548 PyBuffer_Release(&view_src);
549 return -1;
550 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000551
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000552 if ((PyBuffer_IsContiguous(&view_dest, 'C') &&
553 PyBuffer_IsContiguous(&view_src, 'C')) ||
554 (PyBuffer_IsContiguous(&view_dest, 'F') &&
555 PyBuffer_IsContiguous(&view_src, 'F'))) {
556 /* simplest copy is all that is needed */
557 memcpy(view_dest.buf, view_src.buf, view_src.len);
558 PyBuffer_Release(&view_dest);
559 PyBuffer_Release(&view_src);
560 return 0;
561 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000562
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000563 /* Otherwise a more elaborate copy scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000564
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000565 /* XXX(nnorwitz): need to check for overflow! */
566 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*view_src.ndim);
567 if (indices == NULL) {
568 PyErr_NoMemory();
569 PyBuffer_Release(&view_dest);
570 PyBuffer_Release(&view_src);
571 return -1;
572 }
573 for (k=0; k<view_src.ndim;k++) {
574 indices[k] = 0;
575 }
576 elements = 1;
577 for (k=0; k<view_src.ndim; k++) {
578 /* XXX(nnorwitz): can this overflow? */
579 elements *= view_src.shape[k];
580 }
581 while (elements--) {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000582 _Py_add_one_to_index_C(view_src.ndim, indices, view_src.shape);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000583 dptr = PyBuffer_GetPointer(&view_dest, indices);
584 sptr = PyBuffer_GetPointer(&view_src, indices);
585 memcpy(dptr, sptr, view_src.itemsize);
586 }
587 PyMem_Free(indices);
588 PyBuffer_Release(&view_dest);
589 PyBuffer_Release(&view_src);
590 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000591}
592
593void
594PyBuffer_FillContiguousStrides(int nd, Py_ssize_t *shape,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000595 Py_ssize_t *strides, int itemsize,
596 char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000597{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000598 int k;
599 Py_ssize_t sd;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000600
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000601 sd = itemsize;
602 if (fort == 'F') {
603 for (k=0; k<nd; k++) {
604 strides[k] = sd;
605 sd *= shape[k];
606 }
607 }
608 else {
609 for (k=nd-1; k>=0; k--) {
610 strides[k] = sd;
611 sd *= shape[k];
612 }
613 }
614 return;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000615}
616
617int
Martin v. Löwis423be952008-08-13 15:53:07 +0000618PyBuffer_FillInfo(Py_buffer *view, PyObject *obj, void *buf, Py_ssize_t len,
Stefan Krah4e141742012-03-06 15:27:31 +0100619 int readonly, int flags)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000620{
Stefan Krah5178d912015-02-03 16:57:21 +0100621 if (view == NULL) {
622 PyErr_SetString(PyExc_BufferError,
623 "PyBuffer_FillInfo: view==NULL argument is obsolete");
624 return -1;
625 }
626
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000627 if (((flags & PyBUF_WRITABLE) == PyBUF_WRITABLE) &&
628 (readonly == 1)) {
629 PyErr_SetString(PyExc_BufferError,
630 "Object is not writable.");
631 return -1;
632 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000633
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000634 view->obj = obj;
635 if (obj)
636 Py_INCREF(obj);
637 view->buf = buf;
638 view->len = len;
639 view->readonly = readonly;
640 view->itemsize = 1;
641 view->format = NULL;
642 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT)
643 view->format = "B";
644 view->ndim = 1;
645 view->shape = NULL;
646 if ((flags & PyBUF_ND) == PyBUF_ND)
647 view->shape = &(view->len);
648 view->strides = NULL;
649 if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES)
650 view->strides = &(view->itemsize);
651 view->suboffsets = NULL;
652 view->internal = NULL;
653 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000654}
655
Martin v. Löwis423be952008-08-13 15:53:07 +0000656void
657PyBuffer_Release(Py_buffer *view)
658{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000659 PyObject *obj = view->obj;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200660 PyBufferProcs *pb;
661 if (obj == NULL)
662 return;
663 pb = Py_TYPE(obj)->tp_as_buffer;
664 if (pb && pb->bf_releasebuffer)
665 pb->bf_releasebuffer(obj, view);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000666 view->obj = NULL;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200667 Py_DECREF(obj);
Martin v. Löwis423be952008-08-13 15:53:07 +0000668}
669
Eric Smith8fd3eba2008-02-17 19:48:00 +0000670PyObject *
671PyObject_Format(PyObject *obj, PyObject *format_spec)
672{
Eric Smith8fd3eba2008-02-17 19:48:00 +0000673 PyObject *meth;
674 PyObject *empty = NULL;
675 PyObject *result = NULL;
Benjamin Petersonce798522012-01-22 11:24:29 -0500676 _Py_IDENTIFIER(__format__);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000677
Serhiy Storchakaea525a22016-09-06 22:07:53 +0300678 if (format_spec != NULL && !PyUnicode_Check(format_spec)) {
679 PyErr_Format(PyExc_SystemError,
680 "Format specifier must be a string, not %.200s",
681 Py_TYPE(format_spec)->tp_name);
682 return NULL;
683 }
684
685 /* Fast path for common types. */
686 if (format_spec == NULL || PyUnicode_GET_LENGTH(format_spec) == 0) {
687 if (PyUnicode_CheckExact(obj)) {
688 Py_INCREF(obj);
689 return obj;
690 }
691 if (PyLong_CheckExact(obj)) {
692 return PyObject_Str(obj);
693 }
694 }
695
Eric Smith8fd3eba2008-02-17 19:48:00 +0000696 /* If no format_spec is provided, use an empty string */
697 if (format_spec == NULL) {
Victor Stinner9d3b93b2011-11-22 02:27:30 +0100698 empty = PyUnicode_New(0, 0);
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000699 format_spec = empty;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000700 }
701
Serhiy Storchakaea525a22016-09-06 22:07:53 +0300702 /* Find the (unbound!) __format__ method */
Benjamin Petersonce798522012-01-22 11:24:29 -0500703 meth = _PyObject_LookupSpecial(obj, &PyId___format__);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000704 if (meth == NULL) {
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000705 if (!PyErr_Occurred())
706 PyErr_Format(PyExc_TypeError,
707 "Type %.100s doesn't define __format__",
708 Py_TYPE(obj)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000709 goto done;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000710 }
711
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000712 /* And call it. */
713 result = PyObject_CallFunctionObjArgs(meth, format_spec, NULL);
Benjamin Peterson6f889ad32010-06-05 02:11:45 +0000714 Py_DECREF(meth);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000715
716 if (result && !PyUnicode_Check(result)) {
Ethan Furmanb95b5612015-01-23 20:05:18 -0800717 PyErr_Format(PyExc_TypeError,
718 "__format__ must return a str, not %.200s",
719 Py_TYPE(result)->tp_name);
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000720 Py_DECREF(result);
721 result = NULL;
722 goto done;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000723 }
724
725done:
726 Py_XDECREF(empty);
727 return result;
728}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000729/* Operations on numbers */
730
731int
Fred Drake79912472000-07-09 04:06:11 +0000732PyNumber_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +0000733{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000734 return o && o->ob_type->tp_as_number &&
735 (o->ob_type->tp_as_number->nb_int ||
736 o->ob_type->tp_as_number->nb_float);
Guido van Rossume15dee51995-07-18 14:12:02 +0000737}
738
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000739/* Binary operators */
Guido van Rossume15dee51995-07-18 14:12:02 +0000740
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000741#define NB_SLOT(x) offsetof(PyNumberMethods, x)
742#define NB_BINOP(nb_methods, slot) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000743 (*(binaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000744#define NB_TERNOP(nb_methods, slot) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000745 (*(ternaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000746
747/*
748 Calling scheme used for binary operations:
749
Neal Norwitz4886cc32006-08-21 17:06:07 +0000750 Order operations are tried until either a valid result or error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000751 w.op(v,w)[*], v.op(v,w), w.op(v,w)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000752
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000753 [*] only when v->ob_type != w->ob_type && w->ob_type is a subclass of
754 v->ob_type
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000755 */
756
757static PyObject *
758binary_op1(PyObject *v, PyObject *w, const int op_slot)
Guido van Rossume15dee51995-07-18 14:12:02 +0000759{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000760 PyObject *x;
761 binaryfunc slotv = NULL;
762 binaryfunc slotw = NULL;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000763
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000764 if (v->ob_type->tp_as_number != NULL)
765 slotv = NB_BINOP(v->ob_type->tp_as_number, op_slot);
766 if (w->ob_type != v->ob_type &&
767 w->ob_type->tp_as_number != NULL) {
768 slotw = NB_BINOP(w->ob_type->tp_as_number, op_slot);
769 if (slotw == slotv)
770 slotw = NULL;
771 }
772 if (slotv) {
773 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
774 x = slotw(v, w);
775 if (x != Py_NotImplemented)
776 return x;
777 Py_DECREF(x); /* can't do it */
778 slotw = NULL;
779 }
780 x = slotv(v, w);
781 if (x != Py_NotImplemented)
782 return x;
783 Py_DECREF(x); /* can't do it */
784 }
785 if (slotw) {
786 x = slotw(v, w);
787 if (x != Py_NotImplemented)
788 return x;
789 Py_DECREF(x); /* can't do it */
790 }
Brian Curtindfc80e32011-08-10 20:28:54 -0500791 Py_RETURN_NOTIMPLEMENTED;
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000792}
Guido van Rossum77660912002-04-16 16:32:50 +0000793
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000794static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000795binop_type_error(PyObject *v, PyObject *w, const char *op_name)
796{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000797 PyErr_Format(PyExc_TypeError,
798 "unsupported operand type(s) for %.100s: "
799 "'%.100s' and '%.100s'",
800 op_name,
801 v->ob_type->tp_name,
802 w->ob_type->tp_name);
803 return NULL;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000804}
805
806static PyObject *
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000807binary_op(PyObject *v, PyObject *w, const int op_slot, const char *op_name)
808{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000809 PyObject *result = binary_op1(v, w, op_slot);
810 if (result == Py_NotImplemented) {
811 Py_DECREF(result);
812 return binop_type_error(v, w, op_name);
813 }
814 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000815}
816
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000817
818/*
819 Calling scheme used for ternary operations:
820
Neal Norwitz4886cc32006-08-21 17:06:07 +0000821 Order operations are tried until either a valid result or error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000822 v.op(v,w,z), w.op(v,w,z), z.op(v,w,z)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000823 */
824
825static PyObject *
826ternary_op(PyObject *v,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000827 PyObject *w,
828 PyObject *z,
829 const int op_slot,
830 const char *op_name)
Guido van Rossume15dee51995-07-18 14:12:02 +0000831{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000832 PyNumberMethods *mv, *mw, *mz;
833 PyObject *x = NULL;
834 ternaryfunc slotv = NULL;
835 ternaryfunc slotw = NULL;
836 ternaryfunc slotz = NULL;
Guido van Rossum77660912002-04-16 16:32:50 +0000837
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000838 mv = v->ob_type->tp_as_number;
839 mw = w->ob_type->tp_as_number;
840 if (mv != NULL)
841 slotv = NB_TERNOP(mv, op_slot);
842 if (w->ob_type != v->ob_type &&
843 mw != NULL) {
844 slotw = NB_TERNOP(mw, op_slot);
845 if (slotw == slotv)
846 slotw = NULL;
847 }
848 if (slotv) {
849 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
850 x = slotw(v, w, z);
851 if (x != Py_NotImplemented)
852 return x;
853 Py_DECREF(x); /* can't do it */
854 slotw = NULL;
855 }
856 x = slotv(v, w, z);
857 if (x != Py_NotImplemented)
858 return x;
859 Py_DECREF(x); /* can't do it */
860 }
861 if (slotw) {
862 x = slotw(v, w, z);
863 if (x != Py_NotImplemented)
864 return x;
865 Py_DECREF(x); /* can't do it */
866 }
867 mz = z->ob_type->tp_as_number;
868 if (mz != NULL) {
869 slotz = NB_TERNOP(mz, op_slot);
870 if (slotz == slotv || slotz == slotw)
871 slotz = NULL;
872 if (slotz) {
873 x = slotz(v, w, z);
874 if (x != Py_NotImplemented)
875 return x;
876 Py_DECREF(x); /* can't do it */
877 }
878 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000879
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000880 if (z == Py_None)
881 PyErr_Format(
882 PyExc_TypeError,
883 "unsupported operand type(s) for ** or pow(): "
884 "'%.100s' and '%.100s'",
885 v->ob_type->tp_name,
886 w->ob_type->tp_name);
887 else
888 PyErr_Format(
889 PyExc_TypeError,
890 "unsupported operand type(s) for pow(): "
891 "'%.100s', '%.100s', '%.100s'",
892 v->ob_type->tp_name,
893 w->ob_type->tp_name,
894 z->ob_type->tp_name);
895 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000896}
897
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000898#define BINARY_FUNC(func, op, op_name) \
899 PyObject * \
900 func(PyObject *v, PyObject *w) { \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000901 return binary_op(v, w, NB_SLOT(op), op_name); \
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000902 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000903
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000904BINARY_FUNC(PyNumber_Or, nb_or, "|")
905BINARY_FUNC(PyNumber_Xor, nb_xor, "^")
906BINARY_FUNC(PyNumber_And, nb_and, "&")
907BINARY_FUNC(PyNumber_Lshift, nb_lshift, "<<")
908BINARY_FUNC(PyNumber_Rshift, nb_rshift, ">>")
909BINARY_FUNC(PyNumber_Subtract, nb_subtract, "-")
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000910BINARY_FUNC(PyNumber_Divmod, nb_divmod, "divmod()")
Guido van Rossume15dee51995-07-18 14:12:02 +0000911
912PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000913PyNumber_Add(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000914{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000915 PyObject *result = binary_op1(v, w, NB_SLOT(nb_add));
916 if (result == Py_NotImplemented) {
917 PySequenceMethods *m = v->ob_type->tp_as_sequence;
918 Py_DECREF(result);
919 if (m && m->sq_concat) {
920 return (*m->sq_concat)(v, w);
921 }
922 result = binop_type_error(v, w, "+");
923 }
924 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000925}
926
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000927static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000928sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000929{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000930 Py_ssize_t count;
931 if (PyIndex_Check(n)) {
932 count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
933 if (count == -1 && PyErr_Occurred())
934 return NULL;
935 }
936 else {
937 return type_error("can't multiply sequence by "
938 "non-int of type '%.200s'", n);
939 }
940 return (*repeatfunc)(seq, count);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000941}
942
943PyObject *
944PyNumber_Multiply(PyObject *v, PyObject *w)
945{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000946 PyObject *result = binary_op1(v, w, NB_SLOT(nb_multiply));
947 if (result == Py_NotImplemented) {
948 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
949 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
950 Py_DECREF(result);
951 if (mv && mv->sq_repeat) {
952 return sequence_repeat(mv->sq_repeat, v, w);
953 }
954 else if (mw && mw->sq_repeat) {
955 return sequence_repeat(mw->sq_repeat, w, v);
956 }
957 result = binop_type_error(v, w, "*");
958 }
959 return result;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000960}
961
Guido van Rossume15dee51995-07-18 14:12:02 +0000962PyObject *
Benjamin Petersond51374e2014-04-09 23:55:56 -0400963PyNumber_MatrixMultiply(PyObject *v, PyObject *w)
964{
965 return binary_op(v, w, NB_SLOT(nb_matrix_multiply), "@");
966}
967
968PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +0000969PyNumber_FloorDivide(PyObject *v, PyObject *w)
970{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000971 return binary_op(v, w, NB_SLOT(nb_floor_divide), "//");
Guido van Rossum4668b002001-08-08 05:00:18 +0000972}
973
974PyObject *
975PyNumber_TrueDivide(PyObject *v, PyObject *w)
976{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000977 return binary_op(v, w, NB_SLOT(nb_true_divide), "/");
Guido van Rossum4668b002001-08-08 05:00:18 +0000978}
979
980PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000981PyNumber_Remainder(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000982{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000983 return binary_op(v, w, NB_SLOT(nb_remainder), "%");
Guido van Rossume15dee51995-07-18 14:12:02 +0000984}
985
986PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000987PyNumber_Power(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossume15dee51995-07-18 14:12:02 +0000988{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000989 return ternary_op(v, w, z, NB_SLOT(nb_power), "** or pow()");
Guido van Rossume15dee51995-07-18 14:12:02 +0000990}
991
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000992/* Binary in-place operators */
993
994/* The in-place operators are defined to fall back to the 'normal',
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000995 non in-place operations, if the in-place methods are not in place.
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000996
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000997 - If the left hand object has the appropriate struct members, and
998 they are filled, call the appropriate function and return the
999 result. No coercion is done on the arguments; the left-hand object
1000 is the one the operation is performed on, and it's up to the
1001 function to deal with the right-hand object.
Guido van Rossum77660912002-04-16 16:32:50 +00001002
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001003 - Otherwise, in-place modification is not supported. Handle it exactly as
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001004 a non in-place operation of the same kind.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001005
1006 */
1007
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001008static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001009binary_iop1(PyObject *v, PyObject *w, const int iop_slot, const int op_slot)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001010{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001011 PyNumberMethods *mv = v->ob_type->tp_as_number;
1012 if (mv != NULL) {
1013 binaryfunc slot = NB_BINOP(mv, iop_slot);
1014 if (slot) {
1015 PyObject *x = (slot)(v, w);
1016 if (x != Py_NotImplemented) {
1017 return x;
1018 }
1019 Py_DECREF(x);
1020 }
1021 }
1022 return binary_op1(v, w, op_slot);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001023}
1024
1025static PyObject *
1026binary_iop(PyObject *v, PyObject *w, const int iop_slot, const int op_slot,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001027 const char *op_name)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001028{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001029 PyObject *result = binary_iop1(v, w, iop_slot, op_slot);
1030 if (result == Py_NotImplemented) {
1031 Py_DECREF(result);
1032 return binop_type_error(v, w, op_name);
1033 }
1034 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001035}
1036
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001037#define INPLACE_BINOP(func, iop, op, op_name) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001038 PyObject * \
1039 func(PyObject *v, PyObject *w) { \
1040 return binary_iop(v, w, NB_SLOT(iop), NB_SLOT(op), op_name); \
1041 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001042
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001043INPLACE_BINOP(PyNumber_InPlaceOr, nb_inplace_or, nb_or, "|=")
1044INPLACE_BINOP(PyNumber_InPlaceXor, nb_inplace_xor, nb_xor, "^=")
1045INPLACE_BINOP(PyNumber_InPlaceAnd, nb_inplace_and, nb_and, "&=")
1046INPLACE_BINOP(PyNumber_InPlaceLshift, nb_inplace_lshift, nb_lshift, "<<=")
1047INPLACE_BINOP(PyNumber_InPlaceRshift, nb_inplace_rshift, nb_rshift, ">>=")
1048INPLACE_BINOP(PyNumber_InPlaceSubtract, nb_inplace_subtract, nb_subtract, "-=")
Benjamin Petersond51374e2014-04-09 23:55:56 -04001049INPLACE_BINOP(PyNumber_InMatrixMultiply, nb_inplace_matrix_multiply, nb_matrix_multiply, "@=")
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001050
1051PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001052PyNumber_InPlaceFloorDivide(PyObject *v, PyObject *w)
1053{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001054 return binary_iop(v, w, NB_SLOT(nb_inplace_floor_divide),
1055 NB_SLOT(nb_floor_divide), "//=");
Guido van Rossum4668b002001-08-08 05:00:18 +00001056}
1057
1058PyObject *
1059PyNumber_InPlaceTrueDivide(PyObject *v, PyObject *w)
1060{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001061 return binary_iop(v, w, NB_SLOT(nb_inplace_true_divide),
1062 NB_SLOT(nb_true_divide), "/=");
Guido van Rossum4668b002001-08-08 05:00:18 +00001063}
1064
1065PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001066PyNumber_InPlaceAdd(PyObject *v, PyObject *w)
1067{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001068 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_add),
1069 NB_SLOT(nb_add));
1070 if (result == Py_NotImplemented) {
1071 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1072 Py_DECREF(result);
1073 if (m != NULL) {
1074 binaryfunc f = NULL;
1075 f = m->sq_inplace_concat;
1076 if (f == NULL)
1077 f = m->sq_concat;
1078 if (f != NULL)
1079 return (*f)(v, w);
1080 }
1081 result = binop_type_error(v, w, "+=");
1082 }
1083 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001084}
1085
1086PyObject *
1087PyNumber_InPlaceMultiply(PyObject *v, PyObject *w)
1088{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001089 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_multiply),
1090 NB_SLOT(nb_multiply));
1091 if (result == Py_NotImplemented) {
1092 ssizeargfunc f = NULL;
1093 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1094 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1095 Py_DECREF(result);
1096 if (mv != NULL) {
1097 f = mv->sq_inplace_repeat;
1098 if (f == NULL)
1099 f = mv->sq_repeat;
1100 if (f != NULL)
1101 return sequence_repeat(f, v, w);
1102 }
1103 else if (mw != NULL) {
1104 /* Note that the right hand operand should not be
1105 * mutated in this case so sq_inplace_repeat is not
1106 * used. */
1107 if (mw->sq_repeat)
1108 return sequence_repeat(mw->sq_repeat, w, v);
1109 }
1110 result = binop_type_error(v, w, "*=");
1111 }
1112 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001113}
1114
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001115PyObject *
Benjamin Petersond51374e2014-04-09 23:55:56 -04001116PyNumber_InPlaceMatrixMultiply(PyObject *v, PyObject *w)
1117{
1118 return binary_iop(v, w, NB_SLOT(nb_inplace_matrix_multiply),
1119 NB_SLOT(nb_matrix_multiply), "@=");
1120}
1121
1122PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001123PyNumber_InPlaceRemainder(PyObject *v, PyObject *w)
1124{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001125 return binary_iop(v, w, NB_SLOT(nb_inplace_remainder),
1126 NB_SLOT(nb_remainder), "%=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001127}
1128
1129PyObject *
1130PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
1131{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001132 if (v->ob_type->tp_as_number &&
1133 v->ob_type->tp_as_number->nb_inplace_power != NULL) {
1134 return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
1135 }
1136 else {
1137 return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
1138 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001139}
1140
1141
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001142/* Unary operators and functions */
Guido van Rossume15dee51995-07-18 14:12:02 +00001143
1144PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001145PyNumber_Negative(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001146{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001147 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001148
Victor Stinner71aea8e2016-08-19 16:59:55 +02001149 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001150 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001151 }
1152
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001153 m = o->ob_type->tp_as_number;
1154 if (m && m->nb_negative)
1155 return (*m->nb_negative)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001156
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001157 return type_error("bad operand type for unary -: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001158}
1159
1160PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001161PyNumber_Positive(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001162{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001163 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001164
Victor Stinner71aea8e2016-08-19 16:59:55 +02001165 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001166 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001167 }
1168
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001169 m = o->ob_type->tp_as_number;
1170 if (m && m->nb_positive)
1171 return (*m->nb_positive)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001172
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001173 return type_error("bad operand type for unary +: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001174}
1175
1176PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001177PyNumber_Invert(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001178{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001179 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001180
Victor Stinner71aea8e2016-08-19 16:59:55 +02001181 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001182 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001183 }
1184
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001185 m = o->ob_type->tp_as_number;
1186 if (m && m->nb_invert)
1187 return (*m->nb_invert)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001188
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001189 return type_error("bad operand type for unary ~: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001190}
1191
1192PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001193PyNumber_Absolute(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001194{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001195 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001196
Victor Stinner71aea8e2016-08-19 16:59:55 +02001197 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001198 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001199 }
1200
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001201 m = o->ob_type->tp_as_number;
1202 if (m && m->nb_absolute)
1203 return m->nb_absolute(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001204
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001205 return type_error("bad operand type for abs(): '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001206}
1207
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001208/* Return a Python int from the object item.
Serhiy Storchaka95949422013-08-27 19:40:23 +03001209 Raise TypeError if the result is not an int
Guido van Rossum98297ee2007-11-06 21:34:58 +00001210 or if the object cannot be interpreted as an index.
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001211*/
1212PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001213PyNumber_Index(PyObject *item)
1214{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001215 PyObject *result = NULL;
Victor Stinner71aea8e2016-08-19 16:59:55 +02001216 if (item == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001217 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001218 }
1219
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001220 if (PyLong_Check(item)) {
1221 Py_INCREF(item);
1222 return item;
1223 }
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001224 if (!PyIndex_Check(item)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001225 PyErr_Format(PyExc_TypeError,
1226 "'%.200s' object cannot be interpreted "
1227 "as an integer", item->ob_type->tp_name);
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001228 return NULL;
1229 }
1230 result = item->ob_type->tp_as_number->nb_index(item);
1231 if (!result || PyLong_CheckExact(result))
1232 return result;
1233 if (!PyLong_Check(result)) {
1234 PyErr_Format(PyExc_TypeError,
1235 "__index__ returned non-int (type %.200s)",
1236 result->ob_type->tp_name);
1237 Py_DECREF(result);
1238 return NULL;
1239 }
1240 /* Issue #17576: warn if 'result' not of exact type int. */
1241 if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
1242 "__index__ returned non-int (type %.200s). "
1243 "The ability to return an instance of a strict subclass of int "
1244 "is deprecated, and may be removed in a future version of Python.",
1245 result->ob_type->tp_name)) {
1246 Py_DECREF(result);
1247 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001248 }
1249 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001250}
1251
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001252/* Return an error on Overflow only if err is not NULL*/
1253
1254Py_ssize_t
1255PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1256{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001257 Py_ssize_t result;
1258 PyObject *runerr;
1259 PyObject *value = PyNumber_Index(item);
1260 if (value == NULL)
1261 return -1;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001262
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001263 /* We're done if PyLong_AsSsize_t() returns without error. */
1264 result = PyLong_AsSsize_t(value);
1265 if (result != -1 || !(runerr = PyErr_Occurred()))
1266 goto finish;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001267
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001268 /* Error handling code -- only manage OverflowError differently */
1269 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
1270 goto finish;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001271
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001272 PyErr_Clear();
1273 /* If no error-handling desired then the default clipping
1274 is sufficient.
1275 */
1276 if (!err) {
1277 assert(PyLong_Check(value));
1278 /* Whether or not it is less than or equal to
1279 zero is determined by the sign of ob_size
1280 */
1281 if (_PyLong_Sign(value) < 0)
1282 result = PY_SSIZE_T_MIN;
1283 else
1284 result = PY_SSIZE_T_MAX;
1285 }
1286 else {
1287 /* Otherwise replace the error with caller's error object. */
1288 PyErr_Format(err,
1289 "cannot fit '%.200s' into an index-sized integer",
1290 item->ob_type->tp_name);
1291 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001292
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001293 finish:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001294 Py_DECREF(value);
1295 return result;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001296}
1297
1298
Guido van Rossume15dee51995-07-18 14:12:02 +00001299PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001300PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001301{
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001302 PyObject *result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001303 PyNumberMethods *m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001304 PyObject *trunc_func;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001305 Py_buffer view;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04001306 _Py_IDENTIFIER(__trunc__);
Christian Heimes15ebc882008-02-04 18:48:49 +00001307
Victor Stinner71aea8e2016-08-19 16:59:55 +02001308 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001309 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001310 }
1311
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001312 if (PyLong_CheckExact(o)) {
1313 Py_INCREF(o);
1314 return o;
1315 }
1316 m = o->ob_type->tp_as_number;
1317 if (m && m->nb_int) { /* This should include subclasses of int */
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001318 result = (PyObject *)_PyLong_FromNbInt(o);
1319 if (result != NULL && !PyLong_CheckExact(result)) {
1320 Py_SETREF(result, _PyLong_Copy((PyLongObject *)result));
1321 }
1322 return result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001323 }
Benjamin Peterson1b1a8e72012-03-20 23:48:11 -04001324 trunc_func = _PyObject_LookupSpecial(o, &PyId___trunc__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001325 if (trunc_func) {
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001326 result = PyEval_CallObject(trunc_func, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001327 Py_DECREF(trunc_func);
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001328 if (result == NULL || PyLong_CheckExact(result)) {
1329 return result;
1330 }
1331 if (PyLong_Check(result)) {
1332 Py_SETREF(result, _PyLong_Copy((PyLongObject *)result));
1333 return result;
1334 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001335 /* __trunc__ is specified to return an Integral type,
Martin Panter7462b6492015-11-02 03:37:02 +00001336 but int() needs to return an int. */
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001337 m = result->ob_type->tp_as_number;
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001338 if (m == NULL || m->nb_int == NULL) {
1339 PyErr_Format(
1340 PyExc_TypeError,
1341 "__trunc__ returned non-Integral (type %.200s)",
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001342 result->ob_type->tp_name);
1343 Py_DECREF(result);
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001344 return NULL;
1345 }
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001346 Py_SETREF(result, (PyObject *)_PyLong_FromNbInt(result));
1347 if (result != NULL && !PyLong_CheckExact(result)) {
1348 Py_SETREF(result, _PyLong_Copy((PyLongObject *)result));
1349 }
1350 return result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001351 }
Benjamin Peterson1b1a8e72012-03-20 23:48:11 -04001352 if (PyErr_Occurred())
1353 return NULL;
Christian Heimes15ebc882008-02-04 18:48:49 +00001354
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001355 if (PyUnicode_Check(o))
1356 /* The below check is done in PyLong_FromUnicode(). */
1357 return PyLong_FromUnicodeObject(o, 10);
1358
Martin Pantereeb896c2015-11-07 02:32:21 +00001359 if (PyBytes_Check(o))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001360 /* need to do extra error checking that PyLong_FromString()
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03001361 * doesn't do. In particular int('9\x005') must raise an
1362 * exception, not truncate at the null.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001363 */
Martin Pantereeb896c2015-11-07 02:32:21 +00001364 return _PyLong_FromBytes(PyBytes_AS_STRING(o),
1365 PyBytes_GET_SIZE(o), 10);
1366
1367 if (PyByteArray_Check(o))
1368 return _PyLong_FromBytes(PyByteArray_AS_STRING(o),
1369 PyByteArray_GET_SIZE(o), 10);
1370
1371 if (PyObject_GetBuffer(o, &view, PyBUF_SIMPLE) == 0) {
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001372 PyObject *bytes;
Martin Pantereeb896c2015-11-07 02:32:21 +00001373
1374 /* Copy to NUL-terminated buffer. */
1375 bytes = PyBytes_FromStringAndSize((const char *)view.buf, view.len);
1376 if (bytes == NULL) {
1377 PyBuffer_Release(&view);
1378 return NULL;
1379 }
1380 result = _PyLong_FromBytes(PyBytes_AS_STRING(bytes),
1381 PyBytes_GET_SIZE(bytes), 10);
1382 Py_DECREF(bytes);
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001383 PyBuffer_Release(&view);
1384 return result;
1385 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001386
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001387 return type_error("int() argument must be a string, a bytes-like object "
1388 "or a number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001389}
1390
1391PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001392PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001393{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001394 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001395
Victor Stinner71aea8e2016-08-19 16:59:55 +02001396 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001397 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001398 }
1399
Serhiy Storchaka16931c32016-06-03 21:42:55 +03001400 if (PyFloat_CheckExact(o)) {
1401 Py_INCREF(o);
1402 return o;
1403 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001404 m = o->ob_type->tp_as_number;
1405 if (m && m->nb_float) { /* This should include subclasses of float */
1406 PyObject *res = m->nb_float(o);
Serhiy Storchaka16931c32016-06-03 21:42:55 +03001407 double val;
1408 if (!res || PyFloat_CheckExact(res)) {
1409 return res;
1410 }
1411 if (!PyFloat_Check(res)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001412 PyErr_Format(PyExc_TypeError,
Serhiy Storchaka16931c32016-06-03 21:42:55 +03001413 "%.50s.__float__ returned non-float (type %.50s)",
1414 o->ob_type->tp_name, res->ob_type->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001415 Py_DECREF(res);
1416 return NULL;
1417 }
Serhiy Storchaka16931c32016-06-03 21:42:55 +03001418 /* Issue #26983: warn if 'res' not of exact type float. */
1419 if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
1420 "%.50s.__float__ returned non-float (type %.50s). "
1421 "The ability to return an instance of a strict subclass of float "
1422 "is deprecated, and may be removed in a future version of Python.",
1423 o->ob_type->tp_name, res->ob_type->tp_name)) {
1424 Py_DECREF(res);
1425 return NULL;
1426 }
1427 val = PyFloat_AS_DOUBLE(res);
1428 Py_DECREF(res);
1429 return PyFloat_FromDouble(val);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001430 }
1431 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
Serhiy Storchaka16931c32016-06-03 21:42:55 +03001432 return PyFloat_FromDouble(PyFloat_AS_DOUBLE(o));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001433 }
1434 return PyFloat_FromString(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001435}
1436
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001437
1438PyObject *
1439PyNumber_ToBase(PyObject *n, int base)
1440{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001441 PyObject *res = NULL;
1442 PyObject *index = PyNumber_Index(n);
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001444 if (!index)
1445 return NULL;
1446 if (PyLong_Check(index))
1447 res = _PyLong_Format(index, base);
1448 else
1449 /* It should not be possible to get here, as
1450 PyNumber_Index already has a check for the same
1451 condition */
Serhiy Storchaka95949422013-08-27 19:40:23 +03001452 PyErr_SetString(PyExc_ValueError, "PyNumber_ToBase: index not int");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001453 Py_DECREF(index);
1454 return res;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001455}
1456
1457
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001458/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001459
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001460int
Fred Drake79912472000-07-09 04:06:11 +00001461PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001462{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001463 if (PyDict_Check(s))
1464 return 0;
1465 return s != NULL && s->ob_type->tp_as_sequence &&
1466 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001467}
1468
Martin v. Löwis18e16552006-02-15 17:27:45 +00001469Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001470PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001471{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001472 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001474 if (s == NULL) {
1475 null_error();
1476 return -1;
1477 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001478
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001479 m = s->ob_type->tp_as_sequence;
1480 if (m && m->sq_length)
1481 return m->sq_length(s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001482
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001483 type_error("object of type '%.200s' has no len()", s);
1484 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001485}
1486
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001487#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001488Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001489PySequence_Length(PyObject *s)
1490{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001491 return PySequence_Size(s);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001492}
1493#define PySequence_Length PySequence_Size
1494
Guido van Rossume15dee51995-07-18 14:12:02 +00001495PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001496PySequence_Concat(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001497{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001498 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001499
Victor Stinner71aea8e2016-08-19 16:59:55 +02001500 if (s == NULL || o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001501 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001502 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001503
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001504 m = s->ob_type->tp_as_sequence;
1505 if (m && m->sq_concat)
1506 return m->sq_concat(s, o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001507
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001508 /* Instances of user classes defining an __add__() method only
1509 have an nb_add slot, not an sq_concat slot. So we fall back
1510 to nb_add if both arguments appear to be sequences. */
1511 if (PySequence_Check(s) && PySequence_Check(o)) {
1512 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1513 if (result != Py_NotImplemented)
1514 return result;
1515 Py_DECREF(result);
1516 }
1517 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001518}
1519
1520PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001521PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001522{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001523 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001524
Victor Stinner71aea8e2016-08-19 16:59:55 +02001525 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001526 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001527 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001528
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001529 m = o->ob_type->tp_as_sequence;
1530 if (m && m->sq_repeat)
1531 return m->sq_repeat(o, count);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001532
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001533 /* Instances of user classes defining a __mul__() method only
1534 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1535 to nb_multiply if o appears to be a sequence. */
1536 if (PySequence_Check(o)) {
1537 PyObject *n, *result;
1538 n = PyLong_FromSsize_t(count);
1539 if (n == NULL)
1540 return NULL;
1541 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1542 Py_DECREF(n);
1543 if (result != Py_NotImplemented)
1544 return result;
1545 Py_DECREF(result);
1546 }
1547 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001548}
1549
1550PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001551PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1552{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001553 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001554
Victor Stinner71aea8e2016-08-19 16:59:55 +02001555 if (s == NULL || o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001556 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001557 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001558
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001559 m = s->ob_type->tp_as_sequence;
1560 if (m && m->sq_inplace_concat)
1561 return m->sq_inplace_concat(s, o);
1562 if (m && m->sq_concat)
1563 return m->sq_concat(s, o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001564
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001565 if (PySequence_Check(s) && PySequence_Check(o)) {
1566 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1567 NB_SLOT(nb_add));
1568 if (result != Py_NotImplemented)
1569 return result;
1570 Py_DECREF(result);
1571 }
1572 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001573}
1574
1575PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001576PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001577{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001578 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001579
Victor Stinner71aea8e2016-08-19 16:59:55 +02001580 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001581 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001582 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001583
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001584 m = o->ob_type->tp_as_sequence;
1585 if (m && m->sq_inplace_repeat)
1586 return m->sq_inplace_repeat(o, count);
1587 if (m && m->sq_repeat)
1588 return m->sq_repeat(o, count);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001589
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001590 if (PySequence_Check(o)) {
1591 PyObject *n, *result;
1592 n = PyLong_FromSsize_t(count);
1593 if (n == NULL)
1594 return NULL;
1595 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1596 NB_SLOT(nb_multiply));
1597 Py_DECREF(n);
1598 if (result != Py_NotImplemented)
1599 return result;
1600 Py_DECREF(result);
1601 }
1602 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001603}
1604
1605PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001606PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001607{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001608 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001609
Victor Stinner71aea8e2016-08-19 16:59:55 +02001610 if (s == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001611 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001612 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001613
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001614 m = s->ob_type->tp_as_sequence;
1615 if (m && m->sq_item) {
1616 if (i < 0) {
1617 if (m->sq_length) {
1618 Py_ssize_t l = (*m->sq_length)(s);
Victor Stinnere20310f2015-11-05 13:56:58 +01001619 if (l < 0) {
1620 assert(PyErr_Occurred());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001621 return NULL;
Victor Stinnere20310f2015-11-05 13:56:58 +01001622 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001623 i += l;
1624 }
1625 }
1626 return m->sq_item(s, i);
1627 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001628
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001629 return type_error("'%.200s' object does not support indexing", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001630}
1631
1632PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001633PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00001634{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001635 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001636
Victor Stinner71aea8e2016-08-19 16:59:55 +02001637 if (!s) {
1638 return null_error();
1639 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001640
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001641 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001642 if (mp && mp->mp_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001643 PyObject *res;
1644 PyObject *slice = _PySlice_FromIndices(i1, i2);
1645 if (!slice)
1646 return NULL;
1647 res = mp->mp_subscript(s, slice);
1648 Py_DECREF(slice);
1649 return res;
1650 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001651
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001652 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001653}
1654
1655int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001656PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001657{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001658 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001659
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001660 if (s == NULL) {
1661 null_error();
1662 return -1;
1663 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001664
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001665 m = s->ob_type->tp_as_sequence;
1666 if (m && m->sq_ass_item) {
1667 if (i < 0) {
1668 if (m->sq_length) {
1669 Py_ssize_t l = (*m->sq_length)(s);
1670 if (l < 0)
1671 return -1;
1672 i += l;
1673 }
1674 }
1675 return m->sq_ass_item(s, i, o);
1676 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001677
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001678 type_error("'%.200s' object does not support item assignment", s);
1679 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001680}
1681
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001682int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001683PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001684{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001685 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001686
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001687 if (s == NULL) {
1688 null_error();
1689 return -1;
1690 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001691
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001692 m = s->ob_type->tp_as_sequence;
1693 if (m && m->sq_ass_item) {
1694 if (i < 0) {
1695 if (m->sq_length) {
1696 Py_ssize_t l = (*m->sq_length)(s);
1697 if (l < 0)
1698 return -1;
1699 i += l;
1700 }
1701 }
1702 return m->sq_ass_item(s, i, (PyObject *)NULL);
1703 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001704
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001705 type_error("'%.200s' object doesn't support item deletion", s);
1706 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001707}
1708
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001709int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001710PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001711{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001712 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001713
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001714 if (s == NULL) {
1715 null_error();
1716 return -1;
1717 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001718
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001719 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001720 if (mp && mp->mp_ass_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001721 int res;
1722 PyObject *slice = _PySlice_FromIndices(i1, i2);
1723 if (!slice)
1724 return -1;
1725 res = mp->mp_ass_subscript(s, slice, o);
1726 Py_DECREF(slice);
1727 return res;
1728 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00001729
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001730 type_error("'%.200s' object doesn't support slice assignment", s);
1731 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001732}
1733
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001734int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001735PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001736{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001737 PyMappingMethods *mp;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001738
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001739 if (s == NULL) {
1740 null_error();
1741 return -1;
1742 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001743
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001744 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001745 if (mp && mp->mp_ass_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001746 int res;
1747 PyObject *slice = _PySlice_FromIndices(i1, i2);
1748 if (!slice)
1749 return -1;
1750 res = mp->mp_ass_subscript(s, slice, NULL);
1751 Py_DECREF(slice);
1752 return res;
1753 }
1754 type_error("'%.200s' object doesn't support slice deletion", s);
1755 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001756}
1757
Guido van Rossume15dee51995-07-18 14:12:02 +00001758PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001759PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00001760{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001761 PyObject *it; /* iter(v) */
1762 Py_ssize_t n; /* guess for result tuple size */
1763 PyObject *result = NULL;
1764 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00001765
Victor Stinner71aea8e2016-08-19 16:59:55 +02001766 if (v == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001767 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001768 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001769
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001770 /* Special-case the common tuple and list cases, for efficiency. */
1771 if (PyTuple_CheckExact(v)) {
1772 /* Note that we can't know whether it's safe to return
1773 a tuple *subclass* instance as-is, hence the restriction
1774 to exact tuples here. In contrast, lists always make
1775 a copy, so there's no need for exactness below. */
1776 Py_INCREF(v);
1777 return v;
1778 }
Raymond Hettinger610a51f2015-05-17 14:45:58 -07001779 if (PyList_CheckExact(v))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001780 return PyList_AsTuple(v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001781
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001782 /* Get iterator. */
1783 it = PyObject_GetIter(v);
1784 if (it == NULL)
1785 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001786
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001787 /* Guess result size and allocate space. */
Armin Ronacheraa9a79d2012-10-06 14:03:24 +02001788 n = PyObject_LengthHint(v, 10);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001789 if (n == -1)
1790 goto Fail;
1791 result = PyTuple_New(n);
1792 if (result == NULL)
1793 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001794
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001795 /* Fill the tuple. */
1796 for (j = 0; ; ++j) {
1797 PyObject *item = PyIter_Next(it);
1798 if (item == NULL) {
1799 if (PyErr_Occurred())
1800 goto Fail;
1801 break;
1802 }
1803 if (j >= n) {
Martin Pantere8db8612016-07-25 02:30:05 +00001804 size_t newn = (size_t)n;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001805 /* The over-allocation strategy can grow a bit faster
1806 than for lists because unlike lists the
1807 over-allocation isn't permanent -- we reclaim
1808 the excess before the end of this routine.
1809 So, grow by ten and then add 25%.
1810 */
Martin Pantere8db8612016-07-25 02:30:05 +00001811 newn += 10u;
1812 newn += newn >> 2;
1813 if (newn > PY_SSIZE_T_MAX) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001814 /* Check for overflow */
1815 PyErr_NoMemory();
1816 Py_DECREF(item);
1817 goto Fail;
1818 }
Martin Pantere8db8612016-07-25 02:30:05 +00001819 n = (Py_ssize_t)newn;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001820 if (_PyTuple_Resize(&result, n) != 0) {
1821 Py_DECREF(item);
1822 goto Fail;
1823 }
1824 }
1825 PyTuple_SET_ITEM(result, j, item);
1826 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001827
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001828 /* Cut tuple back if guess was too large. */
1829 if (j < n &&
1830 _PyTuple_Resize(&result, j) != 0)
1831 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001832
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001833 Py_DECREF(it);
1834 return result;
Tim Peters6912d4d2001-05-05 03:56:37 +00001835
1836Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001837 Py_XDECREF(result);
1838 Py_DECREF(it);
1839 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001840}
1841
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001842PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001843PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001844{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001845 PyObject *result; /* result list */
1846 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00001847
Victor Stinner71aea8e2016-08-19 16:59:55 +02001848 if (v == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001849 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001850 }
Guido van Rossum5dba9e81998-07-10 18:03:50 +00001851
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001852 result = PyList_New(0);
1853 if (result == NULL)
1854 return NULL;
Tim Petersf553f892001-05-01 20:45:31 +00001855
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001856 rv = _PyList_Extend((PyListObject *)result, v);
1857 if (rv == NULL) {
1858 Py_DECREF(result);
1859 return NULL;
1860 }
1861 Py_DECREF(rv);
1862 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001863}
1864
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001865PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001866PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001867{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001868 PyObject *it;
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001869
Victor Stinner71aea8e2016-08-19 16:59:55 +02001870 if (v == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001871 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001872 }
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001873
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001874 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
1875 Py_INCREF(v);
1876 return v;
1877 }
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001878
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001879 it = PyObject_GetIter(v);
1880 if (it == NULL) {
1881 if (PyErr_ExceptionMatches(PyExc_TypeError))
1882 PyErr_SetString(PyExc_TypeError, m);
1883 return NULL;
1884 }
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001885
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001886 v = PySequence_List(it);
1887 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001888
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001889 return v;
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001890}
1891
Tim Peters16a77ad2001-09-08 04:00:12 +00001892/* Iterate over seq. Result depends on the operation:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001893 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
1894 PY_ITERSEARCH_INDEX: 0-based index of first occurrence of obj in seq;
1895 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00001896 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
1897*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001898Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001899_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00001900{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001901 Py_ssize_t n;
1902 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
1903 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00001904
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001905 if (seq == NULL || obj == NULL) {
1906 null_error();
1907 return -1;
1908 }
Tim Peters75f8e352001-05-05 11:33:43 +00001909
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001910 it = PyObject_GetIter(seq);
1911 if (it == NULL) {
1912 type_error("argument of type '%.200s' is not iterable", seq);
1913 return -1;
1914 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001915
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001916 n = wrapped = 0;
1917 for (;;) {
1918 int cmp;
1919 PyObject *item = PyIter_Next(it);
1920 if (item == NULL) {
1921 if (PyErr_Occurred())
1922 goto Fail;
1923 break;
1924 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001925
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001926 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
1927 Py_DECREF(item);
1928 if (cmp < 0)
1929 goto Fail;
1930 if (cmp > 0) {
1931 switch (operation) {
1932 case PY_ITERSEARCH_COUNT:
1933 if (n == PY_SSIZE_T_MAX) {
1934 PyErr_SetString(PyExc_OverflowError,
1935 "count exceeds C integer size");
1936 goto Fail;
1937 }
1938 ++n;
1939 break;
Tim Peters16a77ad2001-09-08 04:00:12 +00001940
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001941 case PY_ITERSEARCH_INDEX:
1942 if (wrapped) {
1943 PyErr_SetString(PyExc_OverflowError,
1944 "index exceeds C integer size");
1945 goto Fail;
1946 }
1947 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001948
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001949 case PY_ITERSEARCH_CONTAINS:
1950 n = 1;
1951 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001952
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001953 default:
1954 assert(!"unknown operation");
1955 }
1956 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001957
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001958 if (operation == PY_ITERSEARCH_INDEX) {
1959 if (n == PY_SSIZE_T_MAX)
1960 wrapped = 1;
1961 ++n;
1962 }
1963 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001964
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001965 if (operation != PY_ITERSEARCH_INDEX)
1966 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001967
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001968 PyErr_SetString(PyExc_ValueError,
1969 "sequence.index(x): x not in sequence");
1970 /* fall into failure code */
Tim Peters16a77ad2001-09-08 04:00:12 +00001971Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001972 n = -1;
1973 /* fall through */
Tim Peters16a77ad2001-09-08 04:00:12 +00001974Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001975 Py_DECREF(it);
1976 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00001977
Guido van Rossume15dee51995-07-18 14:12:02 +00001978}
1979
Tim Peters16a77ad2001-09-08 04:00:12 +00001980/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001981Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001982PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001983{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001984 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00001985}
1986
Tim Peterscb8d3682001-05-05 21:05:01 +00001987/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00001988 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00001989 */
1990int
1991PySequence_Contains(PyObject *seq, PyObject *ob)
1992{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001993 Py_ssize_t result;
1994 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
1995 if (sqm != NULL && sqm->sq_contains != NULL)
1996 return (*sqm->sq_contains)(seq, ob);
1997 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
1998 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00001999}
2000
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002001/* Backwards compatibility */
2002#undef PySequence_In
2003int
Fred Drake79912472000-07-09 04:06:11 +00002004PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002005{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002006 return PySequence_Contains(w, v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002007}
2008
Neal Norwitz1fc4b772006-03-04 18:49:58 +00002009Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00002010PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002011{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002012 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00002013}
2014
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002015/* Operations on mappings */
2016
2017int
Fred Drake79912472000-07-09 04:06:11 +00002018PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002019{
Benjamin Peterson21992272011-12-28 12:01:31 -06002020 return o && o->ob_type->tp_as_mapping &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002021 o->ob_type->tp_as_mapping->mp_subscript;
Guido van Rossume15dee51995-07-18 14:12:02 +00002022}
2023
Martin v. Löwis18e16552006-02-15 17:27:45 +00002024Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00002025PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002026{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002027 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00002028
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002029 if (o == NULL) {
2030 null_error();
2031 return -1;
2032 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002033
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002034 m = o->ob_type->tp_as_mapping;
2035 if (m && m->mp_length)
2036 return m->mp_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00002037
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002038 type_error("object of type '%.200s' has no len()", o);
2039 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00002040}
2041
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002042#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00002043Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002044PyMapping_Length(PyObject *o)
2045{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002046 return PyMapping_Size(o);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002047}
2048#define PyMapping_Length PyMapping_Size
2049
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002050PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +03002051PyMapping_GetItemString(PyObject *o, const char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002052{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002053 PyObject *okey, *r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002054
Victor Stinner71aea8e2016-08-19 16:59:55 +02002055 if (key == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002056 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02002057 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002058
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002059 okey = PyUnicode_FromString(key);
2060 if (okey == NULL)
2061 return NULL;
2062 r = PyObject_GetItem(o, okey);
2063 Py_DECREF(okey);
2064 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002065}
2066
2067int
Serhiy Storchakac6792272013-10-19 21:03:34 +03002068PyMapping_SetItemString(PyObject *o, const char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002069{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002070 PyObject *okey;
2071 int r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002072
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002073 if (key == NULL) {
2074 null_error();
2075 return -1;
2076 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002077
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002078 okey = PyUnicode_FromString(key);
2079 if (okey == NULL)
2080 return -1;
2081 r = PyObject_SetItem(o, okey, value);
2082 Py_DECREF(okey);
2083 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002084}
2085
2086int
Serhiy Storchakac6792272013-10-19 21:03:34 +03002087PyMapping_HasKeyString(PyObject *o, const char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002088{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002089 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002090
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002091 v = PyMapping_GetItemString(o, key);
2092 if (v) {
2093 Py_DECREF(v);
2094 return 1;
2095 }
2096 PyErr_Clear();
2097 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002098}
2099
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002100int
Fred Drake79912472000-07-09 04:06:11 +00002101PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002102{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002103 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002104
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002105 v = PyObject_GetItem(o, key);
2106 if (v) {
2107 Py_DECREF(v);
2108 return 1;
2109 }
2110 PyErr_Clear();
2111 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002112}
2113
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002114PyObject *
2115PyMapping_Keys(PyObject *o)
2116{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002117 PyObject *keys;
2118 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002119 _Py_IDENTIFIER(keys);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002120
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002121 if (PyDict_CheckExact(o))
2122 return PyDict_Keys(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002123 keys = _PyObject_CallMethodId(o, &PyId_keys, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002124 if (keys == NULL)
2125 return NULL;
2126 fast = PySequence_Fast(keys, "o.keys() are not iterable");
2127 Py_DECREF(keys);
2128 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002129}
2130
2131PyObject *
2132PyMapping_Items(PyObject *o)
2133{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002134 PyObject *items;
2135 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002136 _Py_IDENTIFIER(items);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002137
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002138 if (PyDict_CheckExact(o))
2139 return PyDict_Items(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002140 items = _PyObject_CallMethodId(o, &PyId_items, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002141 if (items == NULL)
2142 return NULL;
2143 fast = PySequence_Fast(items, "o.items() are not iterable");
2144 Py_DECREF(items);
2145 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002146}
2147
2148PyObject *
2149PyMapping_Values(PyObject *o)
2150{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002151 PyObject *values;
2152 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002153 _Py_IDENTIFIER(values);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002154
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002155 if (PyDict_CheckExact(o))
2156 return PyDict_Values(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002157 values = _PyObject_CallMethodId(o, &PyId_values, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002158 if (values == NULL)
2159 return NULL;
2160 fast = PySequence_Fast(values, "o.values() are not iterable");
2161 Py_DECREF(values);
2162 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002163}
2164
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002165/* Operations on callable objects */
2166
2167/* XXX PyCallable_Check() is in object.c */
2168
Guido van Rossume15dee51995-07-18 14:12:02 +00002169PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002170PyObject_CallObject(PyObject *o, PyObject *a)
Guido van Rossume15dee51995-07-18 14:12:02 +00002171{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002172 return PyEval_CallObjectWithKeywords(o, a, NULL);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002173}
Guido van Rossume15dee51995-07-18 14:12:02 +00002174
Victor Stinner4a7cc882015-03-06 23:35:27 +01002175PyObject*
Victor Stinnerefde1462015-03-21 15:04:43 +01002176_Py_CheckFunctionResult(PyObject *func, PyObject *result, const char *where)
Victor Stinner4a7cc882015-03-06 23:35:27 +01002177{
2178 int err_occurred = (PyErr_Occurred() != NULL);
2179
Victor Stinnerefde1462015-03-21 15:04:43 +01002180 assert((func != NULL) ^ (where != NULL));
2181
Victor Stinner4a7cc882015-03-06 23:35:27 +01002182 if (result == NULL) {
2183 if (!err_occurred) {
Victor Stinnerefde1462015-03-21 15:04:43 +01002184 if (func)
2185 PyErr_Format(PyExc_SystemError,
2186 "%R returned NULL without setting an error",
2187 func);
2188 else
2189 PyErr_Format(PyExc_SystemError,
2190 "%s returned NULL without setting an error",
2191 where);
Victor Stinner944fbcc2015-03-24 16:28:52 +01002192#ifdef Py_DEBUG
Serhiy Storchaka5697c4b2016-06-12 17:02:10 +03002193 /* Ensure that the bug is caught in debug mode */
Victor Stinner944fbcc2015-03-24 16:28:52 +01002194 Py_FatalError("a function returned NULL without setting an error");
2195#endif
2196 return NULL;
Victor Stinner4a7cc882015-03-06 23:35:27 +01002197 }
2198 }
2199 else {
2200 if (err_occurred) {
Victor Stinner4a7cc882015-03-06 23:35:27 +01002201 Py_DECREF(result);
2202
Serhiy Storchaka467ab192016-10-21 17:09:17 +03002203 if (func) {
2204 _PyErr_FormatFromCause(PyExc_SystemError,
2205 "%R returned a result with an error set",
2206 func);
2207 }
2208 else {
2209 _PyErr_FormatFromCause(PyExc_SystemError,
2210 "%s returned a result with an error set",
2211 where);
2212 }
Victor Stinner944fbcc2015-03-24 16:28:52 +01002213#ifdef Py_DEBUG
Martin Panter2275e622016-06-20 07:52:50 +00002214 /* Ensure that the bug is caught in debug mode */
Victor Stinner944fbcc2015-03-24 16:28:52 +01002215 Py_FatalError("a function returned a result with an error set");
2216#endif
2217 return NULL;
Victor Stinner4a7cc882015-03-06 23:35:27 +01002218 }
2219 }
2220 return result;
2221}
2222
Guido van Rossume15dee51995-07-18 14:12:02 +00002223PyObject *
Victor Stinner8a31c822016-08-19 17:12:23 +02002224PyObject_Call(PyObject *func, PyObject *args, PyObject *kwargs)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002225{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002226 ternaryfunc call;
Victor Stinner4a7cc882015-03-06 23:35:27 +01002227 PyObject *result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002228
Victor Stinner8f4ec8d2014-09-05 01:10:29 +02002229 /* PyObject_Call() must not be called with an exception set,
2230 because it may clear it (directly or indirectly) and so the
Martin Panterec1aa5c2015-10-07 11:03:53 +00002231 caller loses its exception */
Victor Stinner8f4ec8d2014-09-05 01:10:29 +02002232 assert(!PyErr_Occurred());
Victor Stinner8a31c822016-08-19 17:12:23 +02002233 assert(PyTuple_Check(args));
2234 assert(kwargs == NULL || PyDict_Check(kwargs));
Victor Stinner8f4ec8d2014-09-05 01:10:29 +02002235
Victor Stinner4a7cc882015-03-06 23:35:27 +01002236 call = func->ob_type->tp_call;
2237 if (call == NULL) {
2238 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
2239 func->ob_type->tp_name);
2240 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002241 }
Victor Stinner4a7cc882015-03-06 23:35:27 +01002242
2243 if (Py_EnterRecursiveCall(" while calling a Python object"))
2244 return NULL;
2245
Victor Stinner8a31c822016-08-19 17:12:23 +02002246 result = (*call)(func, args, kwargs);
Victor Stinner4a7cc882015-03-06 23:35:27 +01002247
2248 Py_LeaveRecursiveCall();
2249
Victor Stinnerefde1462015-03-21 15:04:43 +01002250 return _Py_CheckFunctionResult(func, result, NULL);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002251}
2252
Victor Stinner9be7e7b2016-08-19 16:11:43 +02002253PyObject*
2254_PyStack_AsTuple(PyObject **stack, Py_ssize_t nargs)
2255{
2256 PyObject *args;
2257 Py_ssize_t i;
2258
2259 args = PyTuple_New(nargs);
2260 if (args == NULL) {
2261 return NULL;
2262 }
2263
2264 for (i=0; i < nargs; i++) {
2265 PyObject *item = stack[i];
2266 Py_INCREF(item);
2267 PyTuple_SET_ITEM(args, i, item);
2268 }
2269
2270 return args;
2271}
2272
2273PyObject *
Victor Stinner74319ae2016-08-25 00:04:09 +02002274_PyObject_FastCallDict(PyObject *func, PyObject **args, Py_ssize_t nargs,
Victor Stinnerb9009392016-08-22 23:15:44 +02002275 PyObject *kwargs)
Victor Stinner9be7e7b2016-08-19 16:11:43 +02002276{
2277 ternaryfunc call;
2278 PyObject *result = NULL;
2279
Victor Stinner559bb6a2016-08-22 22:48:54 +02002280 /* _PyObject_FastCallDict() must not be called with an exception set,
Victor Stinner9be7e7b2016-08-19 16:11:43 +02002281 because it may clear it (directly or indirectly) and so the
2282 caller loses its exception */
2283 assert(!PyErr_Occurred());
2284
2285 assert(func != NULL);
2286 assert(nargs >= 0);
2287 assert(nargs == 0 || args != NULL);
Victor Stinnerb9009392016-08-22 23:15:44 +02002288 assert(kwargs == NULL || PyDict_Check(kwargs));
Victor Stinner9be7e7b2016-08-19 16:11:43 +02002289
2290 if (Py_EnterRecursiveCall(" while calling a Python object")) {
2291 return NULL;
2292 }
2293
2294 if (PyFunction_Check(func)) {
Victor Stinnerb9009392016-08-22 23:15:44 +02002295 result = _PyFunction_FastCallDict(func, args, nargs, kwargs);
Victor Stinner9be7e7b2016-08-19 16:11:43 +02002296 }
2297 else if (PyCFunction_Check(func)) {
Victor Stinnerb9009392016-08-22 23:15:44 +02002298 result = _PyCFunction_FastCallDict(func, args, nargs, kwargs);
Victor Stinner9be7e7b2016-08-19 16:11:43 +02002299 }
2300 else {
2301 PyObject *tuple;
2302
2303 /* Slow-path: build a temporary tuple */
2304 call = func->ob_type->tp_call;
2305 if (call == NULL) {
2306 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
2307 func->ob_type->tp_name);
2308 goto exit;
2309 }
2310
2311 tuple = _PyStack_AsTuple(args, nargs);
2312 if (tuple == NULL) {
2313 goto exit;
2314 }
2315
2316 result = (*call)(func, tuple, kwargs);
2317 Py_DECREF(tuple);
Victor Stinner9be7e7b2016-08-19 16:11:43 +02002318
Victor Stinner53cb4892016-08-25 00:39:34 +02002319 result = _Py_CheckFunctionResult(func, result, NULL);
2320 }
Victor Stinner9be7e7b2016-08-19 16:11:43 +02002321
2322exit:
2323 Py_LeaveRecursiveCall();
2324
2325 return result;
2326}
2327
Martin Panter186b2042016-12-10 05:32:55 +00002328/* Positional arguments are obj followed by args. */
Victor Stinner3f1057a2016-08-25 01:04:14 +02002329PyObject *
2330_PyObject_Call_Prepend(PyObject *func,
2331 PyObject *obj, PyObject *args, PyObject *kwargs)
2332{
2333 PyObject *small_stack[8];
2334 PyObject **stack;
2335 Py_ssize_t argcount;
2336 PyObject *result;
2337
2338 assert(PyTuple_Check(args));
2339
2340 argcount = PyTuple_GET_SIZE(args);
2341 if (argcount + 1 <= (Py_ssize_t)Py_ARRAY_LENGTH(small_stack)) {
2342 stack = small_stack;
2343 }
2344 else {
2345 stack = PyMem_Malloc((argcount + 1) * sizeof(PyObject *));
2346 if (stack == NULL) {
2347 PyErr_NoMemory();
2348 return NULL;
2349 }
2350 }
2351
2352 /* use borrowed references */
2353 stack[0] = obj;
Christian Heimesf051e432016-09-13 20:22:02 +02002354 memcpy(&stack[1],
Victor Stinner3f1057a2016-08-25 01:04:14 +02002355 &PyTuple_GET_ITEM(args, 0),
2356 argcount * sizeof(PyObject *));
2357
2358 result = _PyObject_FastCallDict(func,
2359 stack, argcount + 1,
2360 kwargs);
2361 if (stack != small_stack) {
2362 PyMem_Free(stack);
2363 }
2364 return result;
2365}
2366
Victor Stinnerae8b69c2016-09-09 14:07:44 -07002367PyObject *
Victor Stinnerb8d768b2016-09-12 13:30:02 +02002368_PyStack_AsDict(PyObject **values, PyObject *kwnames)
Victor Stinnerd8735722016-09-09 12:36:44 -07002369{
Victor Stinnerb8d768b2016-09-12 13:30:02 +02002370 Py_ssize_t nkwargs = PyTuple_GET_SIZE(kwnames);
Victor Stinnerd8735722016-09-09 12:36:44 -07002371 PyObject *kwdict;
2372 Py_ssize_t i;
2373
2374 kwdict = PyDict_New();
2375 if (kwdict == NULL) {
2376 return NULL;
2377 }
2378
Victor Stinnerb8d768b2016-09-12 13:30:02 +02002379 for (i = 0; i < nkwargs; i++) {
Victor Stinnerd8735722016-09-09 12:36:44 -07002380 PyObject *key = PyTuple_GET_ITEM(kwnames, i);
2381 PyObject *value = *values++;
Victor Stinnerb8d768b2016-09-12 13:30:02 +02002382 assert(PyUnicode_CheckExact(key));
2383 assert(PyDict_GetItem(kwdict, key) == NULL);
2384 if (PyDict_SetItem(kwdict, key, value)) {
Victor Stinnerd8735722016-09-09 12:36:44 -07002385 Py_DECREF(kwdict);
2386 return NULL;
2387 }
2388 }
2389 return kwdict;
2390}
2391
Victor Stinnera9efb2f2016-09-09 17:40:22 -07002392PyObject **
2393_PyStack_UnpackDict(PyObject **args, Py_ssize_t nargs, PyObject *kwargs,
2394 PyObject **p_kwnames, PyObject *func)
2395{
2396 PyObject **stack, **kwstack;
2397 Py_ssize_t nkwargs;
2398 Py_ssize_t pos, i;
2399 PyObject *key, *value;
2400 PyObject *kwnames;
2401
2402 assert(nargs >= 0);
2403 assert(kwargs == NULL || PyDict_CheckExact(kwargs));
2404
2405 nkwargs = (kwargs != NULL) ? PyDict_Size(kwargs) : 0;
2406 if (!nkwargs) {
2407 *p_kwnames = NULL;
2408 return args;
2409 }
2410
2411 if ((size_t)nargs > PY_SSIZE_T_MAX / sizeof(stack[0]) - (size_t)nkwargs) {
2412 PyErr_NoMemory();
2413 return NULL;
2414 }
2415
2416 stack = PyMem_Malloc((nargs + nkwargs) * sizeof(stack[0]));
2417 if (stack == NULL) {
2418 PyErr_NoMemory();
2419 return NULL;
2420 }
2421
2422 kwnames = PyTuple_New(nkwargs);
2423 if (kwnames == NULL) {
2424 PyMem_Free(stack);
2425 return NULL;
2426 }
2427
2428 /* Copy position arguments (borrowed references) */
Christian Heimesf051e432016-09-13 20:22:02 +02002429 memcpy(stack, args, nargs * sizeof(stack[0]));
Victor Stinnera9efb2f2016-09-09 17:40:22 -07002430
2431 kwstack = stack + nargs;
2432 pos = i = 0;
2433 /* This loop doesn't support lookup function mutating the dictionary
2434 to change its size. It's a deliberate choice for speed, this function is
2435 called in the performance critical hot code. */
2436 while (PyDict_Next(kwargs, &pos, &key, &value)) {
2437 Py_INCREF(key);
2438 PyTuple_SET_ITEM(kwnames, i, key);
2439 /* The stack contains borrowed references */
2440 kwstack[i] = value;
2441 i++;
2442 }
2443
2444 *p_kwnames = kwnames;
2445 return stack;
2446}
2447
Victor Stinnerd8735722016-09-09 12:36:44 -07002448PyObject *
2449_PyObject_FastCallKeywords(PyObject *func, PyObject **stack, Py_ssize_t nargs,
2450 PyObject *kwnames)
2451{
2452 PyObject *kwdict, *result;
2453 Py_ssize_t nkwargs = (kwnames == NULL) ? 0 : PyTuple_GET_SIZE(kwnames);
2454
2455 assert(nargs >= 0);
2456 assert(kwnames == NULL || PyTuple_CheckExact(kwnames));
2457 assert((nargs == 0 && nkwargs == 0) || stack != NULL);
Victor Stinner57f91ac2016-09-12 13:37:07 +02002458 /* kwnames must only contains str strings, no subclass, and all keys must
2459 be unique: these are implemented in Python/ceval.c and
2460 _PyArg_ParseStack(). */
Victor Stinnerd8735722016-09-09 12:36:44 -07002461
2462 if (PyFunction_Check(func)) {
Victor Stinnerd8735722016-09-09 12:36:44 -07002463 return _PyFunction_FastCallKeywords(func, stack, nargs, kwnames);
2464 }
2465
Victor Stinnerae8b69c2016-09-09 14:07:44 -07002466 if (PyCFunction_Check(func)) {
2467 return _PyCFunction_FastCallKeywords(func, stack, nargs, kwnames);
2468 }
2469
Victor Stinnerd8735722016-09-09 12:36:44 -07002470 if (nkwargs > 0) {
Victor Stinnerb8d768b2016-09-12 13:30:02 +02002471 kwdict = _PyStack_AsDict(stack + nargs, kwnames);
Victor Stinnerd8735722016-09-09 12:36:44 -07002472 if (kwdict == NULL) {
2473 return NULL;
2474 }
2475 }
2476 else {
2477 kwdict = NULL;
2478 }
2479
2480 result = _PyObject_FastCallDict(func, stack, nargs, kwdict);
2481 Py_XDECREF(kwdict);
2482 return result;
2483}
2484
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002485static PyObject*
2486call_function_tail(PyObject *callable, PyObject *args)
2487{
Victor Stinner88807082016-08-19 16:44:19 +02002488 PyObject *result;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002489
Victor Stinner64faad62016-08-19 16:50:49 +02002490 assert(args != NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002491
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002492 if (!PyTuple_Check(args)) {
Victor Stinner559bb6a2016-08-22 22:48:54 +02002493 result = _PyObject_CallArg1(callable, args);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002494 }
Victor Stinner88807082016-08-19 16:44:19 +02002495 else {
2496 result = PyObject_Call(callable, args, NULL);
2497 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002498
Victor Stinner88807082016-08-19 16:44:19 +02002499 return result;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002500}
2501
Tim Peters6d6c1a32001-08-02 04:15:00 +00002502PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002503PyObject_CallFunction(PyObject *callable, const char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002504{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002505 va_list va;
Victor Stinner64faad62016-08-19 16:50:49 +02002506 PyObject *args, *result;
Guido van Rossume15dee51995-07-18 14:12:02 +00002507
Victor Stinner71aea8e2016-08-19 16:59:55 +02002508 if (callable == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002509 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02002510 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002511
Victor Stinner0d1a7992016-08-19 17:04:54 +02002512 if (!format || !*format) {
Victor Stinner559bb6a2016-08-22 22:48:54 +02002513 return _PyObject_CallNoArg(callable);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002514 }
Victor Stinner0d1a7992016-08-19 17:04:54 +02002515
2516 va_start(va, format);
2517 args = Py_VaBuildValue(format, va);
2518 va_end(va);
Victor Stinner64faad62016-08-19 16:50:49 +02002519 if (args == NULL) {
Victor Stinner0b0c8672013-10-29 19:29:52 +01002520 return NULL;
Victor Stinner64faad62016-08-19 16:50:49 +02002521 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002522
Victor Stinner64faad62016-08-19 16:50:49 +02002523 result = call_function_tail(callable, args);
2524 Py_DECREF(args);
2525 return result;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002526}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002527
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002528PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002529_PyObject_CallFunction_SizeT(PyObject *callable, const char *format, ...)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002530{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002531 va_list va;
Victor Stinner64faad62016-08-19 16:50:49 +02002532 PyObject *args, *result;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002533
Victor Stinner71aea8e2016-08-19 16:59:55 +02002534 if (callable == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002535 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02002536 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002537
Victor Stinner0d1a7992016-08-19 17:04:54 +02002538 if (!format || !*format) {
Victor Stinner559bb6a2016-08-22 22:48:54 +02002539 return _PyObject_CallNoArg(callable);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002540 }
Victor Stinner0d1a7992016-08-19 17:04:54 +02002541
2542 va_start(va, format);
2543 args = _Py_VaBuildValue_SizeT(format, va);
2544 va_end(va);
Victor Stinner64faad62016-08-19 16:50:49 +02002545 if (args == NULL) {
2546 return NULL;
2547 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002548
Victor Stinner64faad62016-08-19 16:50:49 +02002549 result = call_function_tail(callable, args);
2550 Py_DECREF(args);
2551 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +00002552}
2553
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002554static PyObject*
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002555callmethod(PyObject* func, const char *format, va_list va, int is_size_t)
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002556{
Victor Stinner64faad62016-08-19 16:50:49 +02002557 PyObject *args, *result;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002558
Victor Stinnerd042f1f2016-08-19 16:56:49 +02002559 assert(func != NULL);
2560
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002561 if (!PyCallable_Check(func)) {
2562 type_error("attribute of type '%.200s' is not callable", func);
Victor Stinner64faad62016-08-19 16:50:49 +02002563 return NULL;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002564 }
2565
Victor Stinner0d1a7992016-08-19 17:04:54 +02002566 if (!format || !*format) {
Victor Stinner559bb6a2016-08-22 22:48:54 +02002567 return _PyObject_CallNoArg(func);
Victor Stinner0d1a7992016-08-19 17:04:54 +02002568 }
2569
2570 if (is_size_t) {
2571 args = _Py_VaBuildValue_SizeT(format, va);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002572 }
Victor Stinner64faad62016-08-19 16:50:49 +02002573 else {
Victor Stinner0d1a7992016-08-19 17:04:54 +02002574 args = Py_VaBuildValue(format, va);
Victor Stinner64faad62016-08-19 16:50:49 +02002575 }
2576 if (args == NULL) {
2577 return NULL;
2578 }
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002579
Victor Stinner64faad62016-08-19 16:50:49 +02002580 result = call_function_tail(func, args);
Victor Stinner64faad62016-08-19 16:50:49 +02002581 Py_DECREF(args);
2582 return result;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002583}
2584
Guido van Rossume15dee51995-07-18 14:12:02 +00002585PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002586PyObject_CallMethod(PyObject *o, const char *name, const char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002587{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002588 va_list va;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002589 PyObject *func = NULL;
2590 PyObject *retval = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002591
Victor Stinner71aea8e2016-08-19 16:59:55 +02002592 if (o == NULL || name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002593 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02002594 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002595
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002596 func = PyObject_GetAttrString(o, name);
Benjamin Peterson1791c222014-06-26 23:29:13 -07002597 if (func == NULL)
2598 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002599
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002600 va_start(va, format);
2601 retval = callmethod(func, format, va, 0);
2602 va_end(va);
Victor Stinnerd042f1f2016-08-19 16:56:49 +02002603 Py_DECREF(func);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002604 return retval;
2605}
2606
2607PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002608_PyObject_CallMethodId(PyObject *o, _Py_Identifier *name,
2609 const char *format, ...)
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002610{
2611 va_list va;
2612 PyObject *func = NULL;
2613 PyObject *retval = NULL;
2614
Victor Stinner71aea8e2016-08-19 16:59:55 +02002615 if (o == NULL || name == NULL) {
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002616 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02002617 }
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002618
2619 func = _PyObject_GetAttrId(o, name);
Benjamin Peterson1791c222014-06-26 23:29:13 -07002620 if (func == NULL)
2621 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002622
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002623 va_start(va, format);
2624 retval = callmethod(func, format, va, 0);
2625 va_end(va);
Victor Stinnerd042f1f2016-08-19 16:56:49 +02002626 Py_DECREF(func);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002627 return retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002628}
2629
2630PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002631_PyObject_CallMethod_SizeT(PyObject *o, const char *name,
2632 const char *format, ...)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002633{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002634 va_list va;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002635 PyObject *func = NULL;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002636 PyObject *retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002637
Victor Stinner71aea8e2016-08-19 16:59:55 +02002638 if (o == NULL || name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002639 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02002640 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002641
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002642 func = PyObject_GetAttrString(o, name);
Benjamin Peterson1791c222014-06-26 23:29:13 -07002643 if (func == NULL)
2644 return NULL;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002645 va_start(va, format);
2646 retval = callmethod(func, format, va, 1);
2647 va_end(va);
Victor Stinnerd042f1f2016-08-19 16:56:49 +02002648 Py_DECREF(func);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002649 return retval;
Guido van Rossume15dee51995-07-18 14:12:02 +00002650}
Guido van Rossum823649d2001-03-21 18:40:58 +00002651
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002652PyObject *
Serhiy Storchaka1cfebc72013-05-29 18:50:54 +03002653_PyObject_CallMethodId_SizeT(PyObject *o, _Py_Identifier *name,
2654 const char *format, ...)
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002655{
2656 va_list va;
2657 PyObject *func = NULL;
2658 PyObject *retval;
2659
Victor Stinner71aea8e2016-08-19 16:59:55 +02002660 if (o == NULL || name == NULL) {
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002661 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02002662 }
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002663
2664 func = _PyObject_GetAttrId(o, name);
2665 if (func == NULL) {
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002666 return NULL;
2667 }
2668 va_start(va, format);
2669 retval = callmethod(func, format, va, 1);
2670 va_end(va);
Victor Stinnerd042f1f2016-08-19 16:56:49 +02002671 Py_DECREF(func);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002672 return retval;
2673}
Guido van Rossum823649d2001-03-21 18:40:58 +00002674
Victor Stinnerdd695642016-08-24 01:14:54 +02002675static PyObject **
2676objargs_mkstack(PyObject **small_stack, Py_ssize_t small_stack_size,
2677 va_list va, Py_ssize_t *p_nargs)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002678{
Victor Stinnerdd695642016-08-24 01:14:54 +02002679 Py_ssize_t i, n;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002680 va_list countva;
Victor Stinnerdd695642016-08-24 01:14:54 +02002681 PyObject **stack;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002682
Victor Stinnerdd695642016-08-24 01:14:54 +02002683 /* Count the number of arguments */
Benjamin Peterson0c212142016-09-20 20:39:33 -07002684 va_copy(countva, va);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002685
Victor Stinnerdd695642016-08-24 01:14:54 +02002686 n = 0;
2687 while (1) {
Benjamin Peterson7b7228a2016-09-22 23:39:59 -07002688 PyObject *arg = va_arg(countva, PyObject *);
Victor Stinnerdd695642016-08-24 01:14:54 +02002689 if (arg == NULL) {
2690 break;
2691 }
2692 n++;
2693 }
2694 *p_nargs = n;
2695
2696 /* Copy arguments */
2697 if (n <= small_stack_size) {
2698 stack = small_stack;
2699 }
2700 else {
2701 stack = PyMem_Malloc(n * sizeof(stack[0]));
2702 if (stack == NULL) {
Christian Heimes2f2fee12016-09-21 11:37:27 +02002703 va_end(countva);
Victor Stinnerdd695642016-08-24 01:14:54 +02002704 PyErr_NoMemory();
2705 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002706 }
2707 }
Victor Stinnerdd695642016-08-24 01:14:54 +02002708
2709 for (i = 0; i < n; ++i) {
2710 stack[i] = va_arg(va, PyObject *);
2711 }
Christian Heimes2f2fee12016-09-21 11:37:27 +02002712 va_end(countva);
Victor Stinnerdd695642016-08-24 01:14:54 +02002713 return stack;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002714}
2715
2716PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002717PyObject_CallMethodObjArgs(PyObject *callable, PyObject *name, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002718{
Victor Stinnerdd695642016-08-24 01:14:54 +02002719 PyObject *small_stack[5];
2720 PyObject **stack;
2721 Py_ssize_t nargs;
2722 PyObject *result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002723 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002724
Victor Stinner71aea8e2016-08-19 16:59:55 +02002725 if (callable == NULL || name == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002726 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02002727 }
Fred Drakeb421b8c2001-10-26 16:21:32 +00002728
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002729 callable = PyObject_GetAttr(callable, name);
2730 if (callable == NULL)
2731 return NULL;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002732
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002733 /* count the args */
2734 va_start(vargs, name);
Victor Stinnerdd695642016-08-24 01:14:54 +02002735 stack = objargs_mkstack(small_stack, Py_ARRAY_LENGTH(small_stack),
2736 vargs, &nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002737 va_end(vargs);
Victor Stinnerdd695642016-08-24 01:14:54 +02002738 if (stack == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002739 Py_DECREF(callable);
2740 return NULL;
2741 }
Victor Stinnere62b8522016-08-24 00:01:56 +02002742
Victor Stinnerdd695642016-08-24 01:14:54 +02002743 result = _PyObject_FastCall(callable, stack, nargs);
2744 Py_DECREF(callable);
2745 if (stack != small_stack) {
2746 PyMem_Free(stack);
2747 }
2748
2749 return result;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002750}
2751
2752PyObject *
Alexandre Vassalotti865eaa12013-05-02 10:44:04 -07002753_PyObject_CallMethodIdObjArgs(PyObject *callable,
Brett Cannonfd074152012-04-14 14:10:13 -04002754 struct _Py_Identifier *name, ...)
2755{
Victor Stinnerdd695642016-08-24 01:14:54 +02002756 PyObject *small_stack[5];
2757 PyObject **stack;
2758 Py_ssize_t nargs;
2759 PyObject *result;
Brett Cannonfd074152012-04-14 14:10:13 -04002760 va_list vargs;
2761
Victor Stinner71aea8e2016-08-19 16:59:55 +02002762 if (callable == NULL || name == NULL) {
Brett Cannonfd074152012-04-14 14:10:13 -04002763 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02002764 }
Brett Cannonfd074152012-04-14 14:10:13 -04002765
2766 callable = _PyObject_GetAttrId(callable, name);
2767 if (callable == NULL)
2768 return NULL;
2769
2770 /* count the args */
2771 va_start(vargs, name);
Victor Stinnerdd695642016-08-24 01:14:54 +02002772 stack = objargs_mkstack(small_stack, Py_ARRAY_LENGTH(small_stack),
2773 vargs, &nargs);
Brett Cannonfd074152012-04-14 14:10:13 -04002774 va_end(vargs);
Victor Stinnerdd695642016-08-24 01:14:54 +02002775 if (stack == NULL) {
Brett Cannonfd074152012-04-14 14:10:13 -04002776 Py_DECREF(callable);
2777 return NULL;
2778 }
Victor Stinnere62b8522016-08-24 00:01:56 +02002779
Victor Stinnerdd695642016-08-24 01:14:54 +02002780 result = _PyObject_FastCall(callable, stack, nargs);
2781 Py_DECREF(callable);
2782 if (stack != small_stack) {
2783 PyMem_Free(stack);
2784 }
2785
2786 return result;
Brett Cannonfd074152012-04-14 14:10:13 -04002787}
2788
2789PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002790PyObject_CallFunctionObjArgs(PyObject *callable, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002791{
Victor Stinnerdd695642016-08-24 01:14:54 +02002792 PyObject *small_stack[5];
2793 PyObject **stack;
2794 Py_ssize_t nargs;
2795 PyObject *result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002796 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002797
Victor Stinner71aea8e2016-08-19 16:59:55 +02002798 if (callable == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002799 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02002800 }
Fred Drakeb421b8c2001-10-26 16:21:32 +00002801
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002802 /* count the args */
2803 va_start(vargs, callable);
Victor Stinnerdd695642016-08-24 01:14:54 +02002804 stack = objargs_mkstack(small_stack, Py_ARRAY_LENGTH(small_stack),
2805 vargs, &nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002806 va_end(vargs);
Victor Stinnerdd695642016-08-24 01:14:54 +02002807 if (stack == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002808 return NULL;
Victor Stinnerdd695642016-08-24 01:14:54 +02002809 }
Fred Drakeb421b8c2001-10-26 16:21:32 +00002810
Victor Stinnerdd695642016-08-24 01:14:54 +02002811 result = _PyObject_FastCall(callable, stack, nargs);
2812 if (stack != small_stack) {
2813 PyMem_Free(stack);
2814 }
2815
2816 return result;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002817}
2818
2819
Guido van Rossum823649d2001-03-21 18:40:58 +00002820/* isinstance(), issubclass() */
2821
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002822/* abstract_get_bases() has logically 4 return states:
Barry Warsawf16951c2002-04-23 22:45:44 +00002823 *
Barry Warsawf16951c2002-04-23 22:45:44 +00002824 * 1. getattr(cls, '__bases__') could raise an AttributeError
2825 * 2. getattr(cls, '__bases__') could raise some other exception
2826 * 3. getattr(cls, '__bases__') could return a tuple
2827 * 4. getattr(cls, '__bases__') could return something other than a tuple
2828 *
2829 * Only state #3 is a non-error state and only it returns a non-NULL object
2830 * (it returns the retrieved tuple).
2831 *
2832 * Any raised AttributeErrors are masked by clearing the exception and
2833 * returning NULL. If an object other than a tuple comes out of __bases__,
2834 * then again, the return value is NULL. So yes, these two situations
2835 * produce exactly the same results: NULL is returned and no error is set.
2836 *
2837 * If some exception other than AttributeError is raised, then NULL is also
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002838 * returned, but the exception is not cleared. That's because we want the
Barry Warsawf16951c2002-04-23 22:45:44 +00002839 * exception to be propagated along.
2840 *
2841 * Callers are expected to test for PyErr_Occurred() when the return value
2842 * is NULL to decide whether a valid exception should be propagated or not.
2843 * When there's no exception to propagate, it's customary for the caller to
2844 * set a TypeError.
2845 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002846static PyObject *
2847abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002848{
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002849 _Py_IDENTIFIER(__bases__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002850 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002851
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002852 Py_ALLOW_RECURSION
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002853 bases = _PyObject_GetAttrId(cls, &PyId___bases__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002854 Py_END_ALLOW_RECURSION
2855 if (bases == NULL) {
2856 if (PyErr_ExceptionMatches(PyExc_AttributeError))
2857 PyErr_Clear();
2858 return NULL;
2859 }
2860 if (!PyTuple_Check(bases)) {
2861 Py_DECREF(bases);
2862 return NULL;
2863 }
2864 return bases;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002865}
2866
2867
2868static int
2869abstract_issubclass(PyObject *derived, PyObject *cls)
2870{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002871 PyObject *bases = NULL;
2872 Py_ssize_t i, n;
2873 int r = 0;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002874
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002875 while (1) {
2876 if (derived == cls)
2877 return 1;
2878 bases = abstract_get_bases(derived);
2879 if (bases == NULL) {
2880 if (PyErr_Occurred())
2881 return -1;
2882 return 0;
2883 }
2884 n = PyTuple_GET_SIZE(bases);
2885 if (n == 0) {
2886 Py_DECREF(bases);
2887 return 0;
2888 }
2889 /* Avoid recursivity in the single inheritance case */
2890 if (n == 1) {
2891 derived = PyTuple_GET_ITEM(bases, 0);
2892 Py_DECREF(bases);
2893 continue;
2894 }
2895 for (i = 0; i < n; i++) {
2896 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
2897 if (r != 0)
2898 break;
2899 }
2900 Py_DECREF(bases);
2901 return r;
2902 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002903}
2904
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002905static int
2906check_class(PyObject *cls, const char *error)
2907{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002908 PyObject *bases = abstract_get_bases(cls);
2909 if (bases == NULL) {
2910 /* Do not mask errors. */
2911 if (!PyErr_Occurred())
2912 PyErr_SetString(PyExc_TypeError, error);
2913 return 0;
2914 }
2915 Py_DECREF(bases);
2916 return -1;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002917}
2918
Brett Cannon4f653312004-03-20 22:52:14 +00002919static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002920recursive_isinstance(PyObject *inst, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002921{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002922 PyObject *icls;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002923 int retval = 0;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002924 _Py_IDENTIFIER(__class__);
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002925
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002926 if (PyType_Check(cls)) {
2927 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
2928 if (retval == 0) {
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002929 PyObject *c = _PyObject_GetAttrId(inst, &PyId___class__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002930 if (c == NULL) {
Benjamin Peterson72288d42010-11-20 17:21:08 +00002931 if (PyErr_ExceptionMatches(PyExc_AttributeError))
R. David Murray6bb99892010-11-20 16:33:30 +00002932 PyErr_Clear();
Benjamin Peterson72288d42010-11-20 17:21:08 +00002933 else
R. David Murray6bb99892010-11-20 16:33:30 +00002934 retval = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002935 }
2936 else {
2937 if (c != (PyObject *)(inst->ob_type) &&
2938 PyType_Check(c))
2939 retval = PyType_IsSubtype(
2940 (PyTypeObject *)c,
2941 (PyTypeObject *)cls);
2942 Py_DECREF(c);
2943 }
2944 }
2945 }
2946 else {
2947 if (!check_class(cls,
Benjamin Petersone893af52010-06-28 19:43:42 +00002948 "isinstance() arg 2 must be a type or tuple of types"))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002949 return -1;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002950 icls = _PyObject_GetAttrId(inst, &PyId___class__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002951 if (icls == NULL) {
Benjamin Peterson72288d42010-11-20 17:21:08 +00002952 if (PyErr_ExceptionMatches(PyExc_AttributeError))
R. David Murray6bb99892010-11-20 16:33:30 +00002953 PyErr_Clear();
Benjamin Peterson72288d42010-11-20 17:21:08 +00002954 else
R. David Murray6bb99892010-11-20 16:33:30 +00002955 retval = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002956 }
2957 else {
2958 retval = abstract_issubclass(icls, cls);
2959 Py_DECREF(icls);
2960 }
2961 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002962
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002963 return retval;
Guido van Rossum823649d2001-03-21 18:40:58 +00002964}
2965
2966int
Brett Cannon4f653312004-03-20 22:52:14 +00002967PyObject_IsInstance(PyObject *inst, PyObject *cls)
2968{
Benjamin Petersonce798522012-01-22 11:24:29 -05002969 _Py_IDENTIFIER(__instancecheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002970 PyObject *checker;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002971
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002972 /* Quick test for an exact match */
2973 if (Py_TYPE(inst) == (PyTypeObject *)cls)
2974 return 1;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002975
Georg Brandl72b8a802014-10-03 09:26:37 +02002976 /* We know what type's __instancecheck__ does. */
2977 if (PyType_CheckExact(cls)) {
2978 return recursive_isinstance(inst, cls);
2979 }
2980
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002981 if (PyTuple_Check(cls)) {
2982 Py_ssize_t i;
2983 Py_ssize_t n;
2984 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002985
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002986 if (Py_EnterRecursiveCall(" in __instancecheck__"))
2987 return -1;
2988 n = PyTuple_GET_SIZE(cls);
2989 for (i = 0; i < n; ++i) {
2990 PyObject *item = PyTuple_GET_ITEM(cls, i);
2991 r = PyObject_IsInstance(inst, item);
2992 if (r != 0)
2993 /* either found it, or got an error */
2994 break;
2995 }
2996 Py_LeaveRecursiveCall();
2997 return r;
2998 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002999
Benjamin Petersonce798522012-01-22 11:24:29 -05003000 checker = _PyObject_LookupSpecial(cls, &PyId___instancecheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003001 if (checker != NULL) {
3002 PyObject *res;
3003 int ok = -1;
3004 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
3005 Py_DECREF(checker);
3006 return ok;
3007 }
3008 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
3009 Py_LeaveRecursiveCall();
3010 Py_DECREF(checker);
3011 if (res != NULL) {
3012 ok = PyObject_IsTrue(res);
3013 Py_DECREF(res);
3014 }
3015 return ok;
3016 }
3017 else if (PyErr_Occurred())
3018 return -1;
Georg Brandl72b8a802014-10-03 09:26:37 +02003019 /* Probably never reached anymore. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003020 return recursive_isinstance(inst, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00003021}
3022
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003023static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00003024recursive_issubclass(PyObject *derived, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00003025{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003026 if (PyType_Check(cls) && PyType_Check(derived)) {
3027 /* Fast path (non-recursive) */
3028 return PyType_IsSubtype((PyTypeObject *)derived, (PyTypeObject *)cls);
3029 }
3030 if (!check_class(derived,
3031 "issubclass() arg 1 must be a class"))
3032 return -1;
3033 if (!check_class(cls,
3034 "issubclass() arg 2 must be a class"
3035 " or tuple of classes"))
3036 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00003037
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003038 return abstract_issubclass(derived, cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00003039}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00003040
Brett Cannon4f653312004-03-20 22:52:14 +00003041int
3042PyObject_IsSubclass(PyObject *derived, PyObject *cls)
3043{
Benjamin Petersonce798522012-01-22 11:24:29 -05003044 _Py_IDENTIFIER(__subclasscheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003045 PyObject *checker;
Georg Brandldcfe8e42009-05-17 08:22:45 +00003046
Georg Brandl72b8a802014-10-03 09:26:37 +02003047 /* We know what type's __subclasscheck__ does. */
3048 if (PyType_CheckExact(cls)) {
3049 /* Quick test for an exact match */
3050 if (derived == cls)
3051 return 1;
3052 return recursive_issubclass(derived, cls);
3053 }
3054
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003055 if (PyTuple_Check(cls)) {
3056 Py_ssize_t i;
3057 Py_ssize_t n;
3058 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00003059
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003060 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
3061 return -1;
3062 n = PyTuple_GET_SIZE(cls);
3063 for (i = 0; i < n; ++i) {
3064 PyObject *item = PyTuple_GET_ITEM(cls, i);
3065 r = PyObject_IsSubclass(derived, item);
3066 if (r != 0)
3067 /* either found it, or got an error */
3068 break;
3069 }
3070 Py_LeaveRecursiveCall();
3071 return r;
3072 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00003073
Benjamin Petersonce798522012-01-22 11:24:29 -05003074 checker = _PyObject_LookupSpecial(cls, &PyId___subclasscheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003075 if (checker != NULL) {
3076 PyObject *res;
3077 int ok = -1;
3078 if (Py_EnterRecursiveCall(" in __subclasscheck__")) {
3079 Py_DECREF(checker);
3080 return ok;
3081 }
3082 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
3083 Py_LeaveRecursiveCall();
3084 Py_DECREF(checker);
3085 if (res != NULL) {
3086 ok = PyObject_IsTrue(res);
3087 Py_DECREF(res);
3088 }
3089 return ok;
3090 }
3091 else if (PyErr_Occurred())
3092 return -1;
Georg Brandl72b8a802014-10-03 09:26:37 +02003093 /* Probably never reached anymore. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003094 return recursive_issubclass(derived, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00003095}
3096
3097int
3098_PyObject_RealIsInstance(PyObject *inst, PyObject *cls)
3099{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003100 return recursive_isinstance(inst, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00003101}
3102
3103int
3104_PyObject_RealIsSubclass(PyObject *derived, PyObject *cls)
3105{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003106 return recursive_issubclass(derived, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00003107}
3108
3109
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00003110PyObject *
3111PyObject_GetIter(PyObject *o)
3112{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003113 PyTypeObject *t = o->ob_type;
3114 getiterfunc f = NULL;
3115 f = t->tp_iter;
3116 if (f == NULL) {
3117 if (PySequence_Check(o))
3118 return PySeqIter_New(o);
3119 return type_error("'%.200s' object is not iterable", o);
3120 }
3121 else {
3122 PyObject *res = (*f)(o);
3123 if (res != NULL && !PyIter_Check(res)) {
3124 PyErr_Format(PyExc_TypeError,
3125 "iter() returned non-iterator "
3126 "of type '%.100s'",
3127 res->ob_type->tp_name);
3128 Py_DECREF(res);
3129 res = NULL;
3130 }
3131 return res;
3132 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00003133}
3134
Tim Petersf4848da2001-05-05 00:14:56 +00003135/* Return next item.
3136 * If an error occurs, return NULL. PyErr_Occurred() will be true.
3137 * If the iteration terminates normally, return NULL and clear the
3138 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
3139 * will be false.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003140 * Else return the next object. PyErr_Occurred() will be false.
Tim Petersf4848da2001-05-05 00:14:56 +00003141 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00003142PyObject *
3143PyIter_Next(PyObject *iter)
3144{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003145 PyObject *result;
3146 result = (*iter->ob_type->tp_iternext)(iter);
3147 if (result == NULL &&
3148 PyErr_Occurred() &&
3149 PyErr_ExceptionMatches(PyExc_StopIteration))
3150 PyErr_Clear();
3151 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00003152}
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00003153
3154
3155/*
3156 * Flatten a sequence of bytes() objects into a C array of
3157 * NULL terminated string pointers with a NULL char* terminating the array.
3158 * (ie: an argv or env list)
3159 *
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02003160 * Memory allocated for the returned list is allocated using PyMem_Malloc()
3161 * and MUST be freed by _Py_FreeCharPArray().
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00003162 */
3163char *const *
3164_PySequence_BytesToCharpArray(PyObject* self)
3165{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003166 char **array;
3167 Py_ssize_t i, argc;
3168 PyObject *item = NULL;
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02003169 Py_ssize_t size;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00003170
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003171 argc = PySequence_Size(self);
3172 if (argc == -1)
3173 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00003174
Stefan Krah7cacd2e2012-08-21 08:16:09 +02003175 assert(argc >= 0);
3176
3177 if ((size_t)argc > (PY_SSIZE_T_MAX-sizeof(char *)) / sizeof(char *)) {
3178 PyErr_NoMemory();
3179 return NULL;
3180 }
3181
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02003182 array = PyMem_Malloc((argc + 1) * sizeof(char *));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003183 if (array == NULL) {
3184 PyErr_NoMemory();
3185 return NULL;
3186 }
3187 for (i = 0; i < argc; ++i) {
3188 char *data;
3189 item = PySequence_GetItem(self, i);
Stefan Krahfd24f9e2012-08-20 11:04:24 +02003190 if (item == NULL) {
3191 /* NULL terminate before freeing. */
3192 array[i] = NULL;
3193 goto fail;
3194 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003195 data = PyBytes_AsString(item);
3196 if (data == NULL) {
3197 /* NULL terminate before freeing. */
3198 array[i] = NULL;
3199 goto fail;
3200 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02003201 size = PyBytes_GET_SIZE(item) + 1;
3202 array[i] = PyMem_Malloc(size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003203 if (!array[i]) {
3204 PyErr_NoMemory();
3205 goto fail;
3206 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02003207 memcpy(array[i], data, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003208 Py_DECREF(item);
3209 }
3210 array[argc] = NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00003211
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003212 return array;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00003213
3214fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003215 Py_XDECREF(item);
3216 _Py_FreeCharPArray(array);
3217 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00003218}
3219
3220
3221/* Free's a NULL terminated char** array of C strings. */
3222void
3223_Py_FreeCharPArray(char *const array[])
3224{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003225 Py_ssize_t i;
3226 for (i = 0; array[i] != NULL; ++i) {
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02003227 PyMem_Free(array[i]);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003228 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02003229 PyMem_Free((void*)array);
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00003230}