blob: a2737dd5f4fb2910213cb822df770cc21779b376 [file] [log] [blame]
Guido van Rossume15dee51995-07-18 14:12:02 +00001/* Abstract Object Interface (many thanks to Jim Fulton) */
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002
Guido van Rossume15dee51995-07-18 14:12:02 +00003#include "Python.h"
Guido van Rossumfa0b6ab1998-05-22 15:23:36 +00004#include <ctype.h>
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00005#include "structmember.h" /* we need the offsetof() macro from there */
Tim Peters64b5ce32001-09-10 20:52:51 +00006#include "longintrepr.h"
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00007
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00008
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00009
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000010/* Shorthands to return certain errors */
Guido van Rossume15dee51995-07-18 14:12:02 +000011
12static PyObject *
Thomas Wouters0e3f5912006-08-11 14:57:12 +000013type_error(const char *msg, PyObject *obj)
Guido van Rossume15dee51995-07-18 14:12:02 +000014{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000015 PyErr_Format(PyExc_TypeError, msg, obj->ob_type->tp_name);
16 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +000017}
18
Guido van Rossum052b7e11996-11-11 15:08:19 +000019static PyObject *
Fred Drake79912472000-07-09 04:06:11 +000020null_error(void)
Guido van Rossume15dee51995-07-18 14:12:02 +000021{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000022 if (!PyErr_Occurred())
23 PyErr_SetString(PyExc_SystemError,
24 "null argument to internal routine");
25 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +000026}
27
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000028/* Operations on any object */
29
Guido van Rossume15dee51995-07-18 14:12:02 +000030PyObject *
Fred Drake79912472000-07-09 04:06:11 +000031PyObject_Type(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +000032{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000033 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +000034
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000035 if (o == NULL)
36 return null_error();
37 v = (PyObject *)o->ob_type;
38 Py_INCREF(v);
39 return v;
Guido van Rossume15dee51995-07-18 14:12:02 +000040}
41
Martin v. Löwis18e16552006-02-15 17:27:45 +000042Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +000043PyObject_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +000044{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000045 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +000046
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000047 if (o == NULL) {
48 null_error();
49 return -1;
50 }
Guido van Rossume15dee51995-07-18 14:12:02 +000051
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000052 m = o->ob_type->tp_as_sequence;
53 if (m && m->sq_length)
54 return m->sq_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +000055
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000056 return PyMapping_Size(o);
Guido van Rossume15dee51995-07-18 14:12:02 +000057}
58
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000059#undef PyObject_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +000060Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000061PyObject_Length(PyObject *o)
62{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000063 return PyObject_Size(o);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000064}
65#define PyObject_Length PyObject_Size
66
Raymond Hettinger6b27cda2005-09-24 21:23:05 +000067
Christian Heimes255f53b2007-12-08 15:33:56 +000068/* The length hint function returns a non-negative value from o.__len__()
69 or o.__length_hint__(). If those methods aren't found or return a negative
Raymond Hettingere8364232009-02-02 22:55:09 +000070 value, then the defaultvalue is returned. If one of the calls fails,
71 this function returns -1.
Christian Heimes255f53b2007-12-08 15:33:56 +000072*/
73
74Py_ssize_t
75_PyObject_LengthHint(PyObject *o, Py_ssize_t defaultvalue)
76{
Benjamin Petersonce798522012-01-22 11:24:29 -050077 _Py_IDENTIFIER(__length_hint__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000078 PyObject *ro, *hintmeth;
79 Py_ssize_t rv;
Christian Heimes255f53b2007-12-08 15:33:56 +000080
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000081 /* try o.__len__() */
82 rv = PyObject_Size(o);
83 if (rv >= 0)
84 return rv;
85 if (PyErr_Occurred()) {
86 if (!PyErr_ExceptionMatches(PyExc_TypeError))
87 return -1;
88 PyErr_Clear();
89 }
Christian Heimes255f53b2007-12-08 15:33:56 +000090
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000091 /* try o.__length_hint__() */
Benjamin Petersonce798522012-01-22 11:24:29 -050092 hintmeth = _PyObject_LookupSpecial(o, &PyId___length_hint__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000093 if (hintmeth == NULL) {
94 if (PyErr_Occurred())
95 return -1;
96 else
97 return defaultvalue;
98 }
99 ro = PyObject_CallFunctionObjArgs(hintmeth, NULL);
100 Py_DECREF(hintmeth);
101 if (ro == NULL) {
102 if (!PyErr_ExceptionMatches(PyExc_TypeError))
103 return -1;
104 PyErr_Clear();
105 return defaultvalue;
106 }
107 rv = PyLong_Check(ro) ? PyLong_AsSsize_t(ro) : defaultvalue;
108 Py_DECREF(ro);
109 return rv;
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000110}
111
Guido van Rossume15dee51995-07-18 14:12:02 +0000112PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000113PyObject_GetItem(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +0000114{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000115 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000116
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000117 if (o == NULL || key == NULL)
118 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +0000119
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000120 m = o->ob_type->tp_as_mapping;
121 if (m && m->mp_subscript)
122 return m->mp_subscript(o, key);
Guido van Rossume15dee51995-07-18 14:12:02 +0000123
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000124 if (o->ob_type->tp_as_sequence) {
125 if (PyIndex_Check(key)) {
126 Py_ssize_t key_value;
127 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
128 if (key_value == -1 && PyErr_Occurred())
129 return NULL;
130 return PySequence_GetItem(o, key_value);
131 }
132 else if (o->ob_type->tp_as_sequence->sq_item)
133 return type_error("sequence index must "
134 "be integer, not '%.200s'", key);
135 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000136
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000137 return type_error("'%.200s' object is not subscriptable", o);
Guido van Rossume15dee51995-07-18 14:12:02 +0000138}
139
140int
Fred Drake79912472000-07-09 04:06:11 +0000141PyObject_SetItem(PyObject *o, PyObject *key, PyObject *value)
Guido van Rossume15dee51995-07-18 14:12:02 +0000142{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000143 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000144
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000145 if (o == NULL || key == NULL || value == NULL) {
146 null_error();
147 return -1;
148 }
149 m = o->ob_type->tp_as_mapping;
150 if (m && m->mp_ass_subscript)
151 return m->mp_ass_subscript(o, key, value);
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 -1;
159 return PySequence_SetItem(o, key_value, value);
160 }
161 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
162 type_error("sequence index must be "
163 "integer, not '%.200s'", key);
164 return -1;
165 }
166 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000167
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000168 type_error("'%.200s' object does not support item assignment", o);
169 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +0000170}
171
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000172int
Fred Drake79912472000-07-09 04:06:11 +0000173PyObject_DelItem(PyObject *o, PyObject *key)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000174{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000175 PyMappingMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000176
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000177 if (o == NULL || key == NULL) {
178 null_error();
179 return -1;
180 }
181 m = o->ob_type->tp_as_mapping;
182 if (m && m->mp_ass_subscript)
183 return m->mp_ass_subscript(o, key, (PyObject*)NULL);
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000184
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000185 if (o->ob_type->tp_as_sequence) {
186 if (PyIndex_Check(key)) {
187 Py_ssize_t key_value;
188 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
189 if (key_value == -1 && PyErr_Occurred())
190 return -1;
191 return PySequence_DelItem(o, key_value);
192 }
193 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
194 type_error("sequence index must be "
195 "integer, not '%.200s'", key);
196 return -1;
197 }
198 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000199
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000200 type_error("'%.200s' object does not support item deletion", o);
201 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000202}
203
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000204int
205PyObject_DelItemString(PyObject *o, char *key)
206{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000207 PyObject *okey;
208 int ret;
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000209
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000210 if (o == NULL || key == NULL) {
211 null_error();
212 return -1;
213 }
214 okey = PyUnicode_FromString(key);
215 if (okey == NULL)
216 return -1;
217 ret = PyObject_DelItem(o, okey);
218 Py_DECREF(okey);
219 return ret;
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000220}
221
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000222/* We release the buffer right after use of this function which could
Guido van Rossum98297ee2007-11-06 21:34:58 +0000223 cause issues later on. Don't use these functions in new code.
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000224 */
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000225int
226PyObject_AsCharBuffer(PyObject *obj,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000227 const char **buffer,
228 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000229{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000230 PyBufferProcs *pb;
231 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000232
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000233 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
234 null_error();
235 return -1;
236 }
237 pb = obj->ob_type->tp_as_buffer;
238 if (pb == NULL || pb->bf_getbuffer == NULL) {
239 PyErr_SetString(PyExc_TypeError,
Victor Stinnerf2a94212011-05-30 23:21:30 +0200240 "expected bytes, bytearray "
241 "or buffer compatible object");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000242 return -1;
243 }
244 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE)) return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000245
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000246 *buffer = view.buf;
247 *buffer_len = view.len;
248 if (pb->bf_releasebuffer != NULL)
249 (*pb->bf_releasebuffer)(obj, &view);
250 Py_XDECREF(view.obj);
251 return 0;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000252}
Guido van Rossum4c08d552000-03-10 22:55:18 +0000253
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000254int
255PyObject_CheckReadBuffer(PyObject *obj)
256{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000257 PyBufferProcs *pb = obj->ob_type->tp_as_buffer;
258 Py_buffer view;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000259
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000260 if (pb == NULL ||
261 pb->bf_getbuffer == NULL)
262 return 0;
263 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE) == -1) {
264 PyErr_Clear();
265 return 0;
266 }
267 PyBuffer_Release(&view);
268 return 1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000269}
270
271int PyObject_AsReadBuffer(PyObject *obj,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000272 const void **buffer,
273 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000274{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000275 PyBufferProcs *pb;
276 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000277
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000278 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
279 null_error();
280 return -1;
281 }
282 pb = obj->ob_type->tp_as_buffer;
283 if (pb == NULL ||
284 pb->bf_getbuffer == NULL) {
285 PyErr_SetString(PyExc_TypeError,
286 "expected an object with a buffer interface");
287 return -1;
288 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000289
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000290 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE)) 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;
294 if (pb->bf_releasebuffer != NULL)
295 (*pb->bf_releasebuffer)(obj, &view);
296 Py_XDECREF(view.obj);
297 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000298}
299
300int PyObject_AsWriteBuffer(PyObject *obj,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000301 void **buffer,
302 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000303{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000304 PyBufferProcs *pb;
305 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000306
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000307 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
308 null_error();
309 return -1;
310 }
311 pb = obj->ob_type->tp_as_buffer;
312 if (pb == NULL ||
313 pb->bf_getbuffer == NULL ||
314 ((*pb->bf_getbuffer)(obj, &view, PyBUF_WRITABLE) != 0)) {
315 PyErr_SetString(PyExc_TypeError,
316 "expected an object with a writable buffer interface");
317 return -1;
318 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000319
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000320 *buffer = view.buf;
321 *buffer_len = view.len;
322 if (pb->bf_releasebuffer != NULL)
323 (*pb->bf_releasebuffer)(obj, &view);
324 Py_XDECREF(view.obj);
325 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000326}
327
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000328/* Buffer C-API for Python 3.0 */
329
330int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000331PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000332{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000333 if (!PyObject_CheckBuffer(obj)) {
334 PyErr_Format(PyExc_TypeError,
Victor Stinner0a5f65a2011-03-22 01:09:21 +0100335 "'%.100s' does not support the buffer interface",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000336 Py_TYPE(obj)->tp_name);
337 return -1;
338 }
339 return (*(obj->ob_type->tp_as_buffer->bf_getbuffer))(obj, view, flags);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000340}
341
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000342static int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100343_IsFortranContiguous(const Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000344{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000345 Py_ssize_t sd, dim;
346 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000347
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000348 if (view->ndim == 0) return 1;
349 if (view->strides == NULL) return (view->ndim == 1);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000350
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000351 sd = view->itemsize;
352 if (view->ndim == 1) return (view->shape[0] == 1 ||
353 sd == view->strides[0]);
354 for (i=0; i<view->ndim; i++) {
355 dim = view->shape[i];
356 if (dim == 0) return 1;
357 if (view->strides[i] != sd) return 0;
358 sd *= dim;
359 }
360 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000361}
362
363static int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100364_IsCContiguous(const Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000365{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000366 Py_ssize_t sd, dim;
367 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000368
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000369 if (view->ndim == 0) return 1;
370 if (view->strides == NULL) return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000372 sd = view->itemsize;
373 if (view->ndim == 1) return (view->shape[0] == 1 ||
374 sd == view->strides[0]);
375 for (i=view->ndim-1; i>=0; i--) {
376 dim = view->shape[i];
377 if (dim == 0) return 1;
378 if (view->strides[i] != sd) return 0;
379 sd *= dim;
380 }
381 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000382}
383
384int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100385PyBuffer_IsContiguous(const Py_buffer *view, char order)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000386{
387
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000388 if (view->suboffsets != NULL) return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000389
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100390 if (order == 'C')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000391 return _IsCContiguous(view);
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100392 else if (order == 'F')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000393 return _IsFortranContiguous(view);
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100394 else if (order == 'A')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000395 return (_IsCContiguous(view) || _IsFortranContiguous(view));
396 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000397}
398
399
Guido van Rossum98297ee2007-11-06 21:34:58 +0000400void*
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000401PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000402{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000403 char* pointer;
404 int i;
405 pointer = (char *)view->buf;
406 for (i = 0; i < view->ndim; i++) {
407 pointer += view->strides[i]*indices[i];
408 if ((view->suboffsets != NULL) && (view->suboffsets[i] >= 0)) {
409 pointer = *((char**)pointer) + view->suboffsets[i];
410 }
411 }
412 return (void*)pointer;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000413}
414
415
Guido van Rossum98297ee2007-11-06 21:34:58 +0000416void
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000417_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 +0000418{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000419 int k;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000420
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000421 for (k=0; k<nd; k++) {
422 if (index[k] < shape[k]-1) {
423 index[k]++;
424 break;
425 }
426 else {
427 index[k] = 0;
428 }
429 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000430}
431
Guido van Rossum98297ee2007-11-06 21:34:58 +0000432void
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000433_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 +0000434{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000435 int k;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000436
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000437 for (k=nd-1; k>=0; k--) {
438 if (index[k] < shape[k]-1) {
439 index[k]++;
440 break;
441 }
442 else {
443 index[k] = 0;
444 }
445 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000446}
447
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000448int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000449PyBuffer_FromContiguous(Py_buffer *view, void *buf, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000450{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000451 int k;
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000452 void (*addone)(int, Py_ssize_t *, const Py_ssize_t *);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000453 Py_ssize_t *indices, elements;
454 char *src, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000455
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000456 if (len > view->len) {
457 len = view->len;
458 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000460 if (PyBuffer_IsContiguous(view, fort)) {
461 /* simplest copy is all that is needed */
462 memcpy(view->buf, buf, len);
463 return 0;
464 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000466 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000467
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000468 /* XXX(nnorwitz): need to check for overflow! */
469 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
470 if (indices == NULL) {
471 PyErr_NoMemory();
472 return -1;
473 }
474 for (k=0; k<view->ndim;k++) {
475 indices[k] = 0;
476 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000477
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000478 if (fort == 'F') {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000479 addone = _Py_add_one_to_index_F;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000480 }
481 else {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000482 addone = _Py_add_one_to_index_C;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000483 }
484 src = buf;
485 /* XXX : This is not going to be the fastest code in the world
486 several optimizations are possible.
487 */
488 elements = len / view->itemsize;
489 while (elements--) {
490 addone(view->ndim, indices, view->shape);
491 ptr = PyBuffer_GetPointer(view, indices);
492 memcpy(ptr, src, view->itemsize);
493 src += view->itemsize;
494 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000495
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000496 PyMem_Free(indices);
497 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000498}
499
Guido van Rossum98297ee2007-11-06 21:34:58 +0000500int PyObject_CopyData(PyObject *dest, PyObject *src)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000501{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000502 Py_buffer view_dest, view_src;
503 int k;
504 Py_ssize_t *indices, elements;
505 char *dptr, *sptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000506
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000507 if (!PyObject_CheckBuffer(dest) ||
508 !PyObject_CheckBuffer(src)) {
509 PyErr_SetString(PyExc_TypeError,
510 "both destination and source must have the "\
511 "buffer interface");
512 return -1;
513 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000514
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000515 if (PyObject_GetBuffer(dest, &view_dest, PyBUF_FULL) != 0) return -1;
516 if (PyObject_GetBuffer(src, &view_src, PyBUF_FULL_RO) != 0) {
517 PyBuffer_Release(&view_dest);
518 return -1;
519 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000520
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000521 if (view_dest.len < view_src.len) {
522 PyErr_SetString(PyExc_BufferError,
523 "destination is too small to receive data from source");
524 PyBuffer_Release(&view_dest);
525 PyBuffer_Release(&view_src);
526 return -1;
527 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000528
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000529 if ((PyBuffer_IsContiguous(&view_dest, 'C') &&
530 PyBuffer_IsContiguous(&view_src, 'C')) ||
531 (PyBuffer_IsContiguous(&view_dest, 'F') &&
532 PyBuffer_IsContiguous(&view_src, 'F'))) {
533 /* simplest copy is all that is needed */
534 memcpy(view_dest.buf, view_src.buf, view_src.len);
535 PyBuffer_Release(&view_dest);
536 PyBuffer_Release(&view_src);
537 return 0;
538 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000539
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000540 /* Otherwise a more elaborate copy scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000541
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000542 /* XXX(nnorwitz): need to check for overflow! */
543 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*view_src.ndim);
544 if (indices == NULL) {
545 PyErr_NoMemory();
546 PyBuffer_Release(&view_dest);
547 PyBuffer_Release(&view_src);
548 return -1;
549 }
550 for (k=0; k<view_src.ndim;k++) {
551 indices[k] = 0;
552 }
553 elements = 1;
554 for (k=0; k<view_src.ndim; k++) {
555 /* XXX(nnorwitz): can this overflow? */
556 elements *= view_src.shape[k];
557 }
558 while (elements--) {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000559 _Py_add_one_to_index_C(view_src.ndim, indices, view_src.shape);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000560 dptr = PyBuffer_GetPointer(&view_dest, indices);
561 sptr = PyBuffer_GetPointer(&view_src, indices);
562 memcpy(dptr, sptr, view_src.itemsize);
563 }
564 PyMem_Free(indices);
565 PyBuffer_Release(&view_dest);
566 PyBuffer_Release(&view_src);
567 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000568}
569
570void
571PyBuffer_FillContiguousStrides(int nd, Py_ssize_t *shape,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000572 Py_ssize_t *strides, int itemsize,
573 char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000574{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000575 int k;
576 Py_ssize_t sd;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000577
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000578 sd = itemsize;
579 if (fort == 'F') {
580 for (k=0; k<nd; k++) {
581 strides[k] = sd;
582 sd *= shape[k];
583 }
584 }
585 else {
586 for (k=nd-1; k>=0; k--) {
587 strides[k] = sd;
588 sd *= shape[k];
589 }
590 }
591 return;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000592}
593
594int
Martin v. Löwis423be952008-08-13 15:53:07 +0000595PyBuffer_FillInfo(Py_buffer *view, PyObject *obj, void *buf, Py_ssize_t len,
Stefan Krah4e141742012-03-06 15:27:31 +0100596 int readonly, int flags)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000597{
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100598 if (view == NULL) return 0; /* XXX why not -1? */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000599 if (((flags & PyBUF_WRITABLE) == PyBUF_WRITABLE) &&
600 (readonly == 1)) {
601 PyErr_SetString(PyExc_BufferError,
602 "Object is not writable.");
603 return -1;
604 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000605
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000606 view->obj = obj;
607 if (obj)
608 Py_INCREF(obj);
609 view->buf = buf;
610 view->len = len;
611 view->readonly = readonly;
612 view->itemsize = 1;
613 view->format = NULL;
614 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT)
615 view->format = "B";
616 view->ndim = 1;
617 view->shape = NULL;
618 if ((flags & PyBUF_ND) == PyBUF_ND)
619 view->shape = &(view->len);
620 view->strides = NULL;
621 if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES)
622 view->strides = &(view->itemsize);
623 view->suboffsets = NULL;
624 view->internal = NULL;
625 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000626}
627
Martin v. Löwis423be952008-08-13 15:53:07 +0000628void
629PyBuffer_Release(Py_buffer *view)
630{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000631 PyObject *obj = view->obj;
632 if (obj && Py_TYPE(obj)->tp_as_buffer && Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer)
633 Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer(obj, view);
634 Py_XDECREF(obj);
635 view->obj = NULL;
Martin v. Löwis423be952008-08-13 15:53:07 +0000636}
637
Eric Smith8fd3eba2008-02-17 19:48:00 +0000638PyObject *
639PyObject_Format(PyObject *obj, PyObject *format_spec)
640{
Eric Smith8fd3eba2008-02-17 19:48:00 +0000641 PyObject *meth;
642 PyObject *empty = NULL;
643 PyObject *result = NULL;
Benjamin Petersonce798522012-01-22 11:24:29 -0500644 _Py_IDENTIFIER(__format__);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000645
646 /* If no format_spec is provided, use an empty string */
647 if (format_spec == NULL) {
Victor Stinner9d3b93b2011-11-22 02:27:30 +0100648 empty = PyUnicode_New(0, 0);
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000649 format_spec = empty;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000650 }
651
Eric Smith8fd3eba2008-02-17 19:48:00 +0000652 /* Find the (unbound!) __format__ method (a borrowed reference) */
Benjamin Petersonce798522012-01-22 11:24:29 -0500653 meth = _PyObject_LookupSpecial(obj, &PyId___format__);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000654 if (meth == NULL) {
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000655 if (!PyErr_Occurred())
656 PyErr_Format(PyExc_TypeError,
657 "Type %.100s doesn't define __format__",
658 Py_TYPE(obj)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000659 goto done;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000660 }
661
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000662 /* And call it. */
663 result = PyObject_CallFunctionObjArgs(meth, format_spec, NULL);
Benjamin Peterson6f889ad32010-06-05 02:11:45 +0000664 Py_DECREF(meth);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000665
666 if (result && !PyUnicode_Check(result)) {
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000667 PyErr_SetString(PyExc_TypeError,
668 "__format__ method did not return string");
669 Py_DECREF(result);
670 result = NULL;
671 goto done;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000672 }
673
674done:
675 Py_XDECREF(empty);
676 return result;
677}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000678/* Operations on numbers */
679
680int
Fred Drake79912472000-07-09 04:06:11 +0000681PyNumber_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +0000682{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000683 return o && o->ob_type->tp_as_number &&
684 (o->ob_type->tp_as_number->nb_int ||
685 o->ob_type->tp_as_number->nb_float);
Guido van Rossume15dee51995-07-18 14:12:02 +0000686}
687
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000688/* Binary operators */
Guido van Rossume15dee51995-07-18 14:12:02 +0000689
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000690#define NB_SLOT(x) offsetof(PyNumberMethods, x)
691#define NB_BINOP(nb_methods, slot) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000692 (*(binaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000693#define NB_TERNOP(nb_methods, slot) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000694 (*(ternaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000695
696/*
697 Calling scheme used for binary operations:
698
Neal Norwitz4886cc32006-08-21 17:06:07 +0000699 Order operations are tried until either a valid result or error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000700 w.op(v,w)[*], v.op(v,w), w.op(v,w)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000701
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000702 [*] only when v->ob_type != w->ob_type && w->ob_type is a subclass of
703 v->ob_type
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000704 */
705
706static PyObject *
707binary_op1(PyObject *v, PyObject *w, const int op_slot)
Guido van Rossume15dee51995-07-18 14:12:02 +0000708{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000709 PyObject *x;
710 binaryfunc slotv = NULL;
711 binaryfunc slotw = NULL;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000712
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000713 if (v->ob_type->tp_as_number != NULL)
714 slotv = NB_BINOP(v->ob_type->tp_as_number, op_slot);
715 if (w->ob_type != v->ob_type &&
716 w->ob_type->tp_as_number != NULL) {
717 slotw = NB_BINOP(w->ob_type->tp_as_number, op_slot);
718 if (slotw == slotv)
719 slotw = NULL;
720 }
721 if (slotv) {
722 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
723 x = slotw(v, w);
724 if (x != Py_NotImplemented)
725 return x;
726 Py_DECREF(x); /* can't do it */
727 slotw = NULL;
728 }
729 x = slotv(v, w);
730 if (x != Py_NotImplemented)
731 return x;
732 Py_DECREF(x); /* can't do it */
733 }
734 if (slotw) {
735 x = slotw(v, w);
736 if (x != Py_NotImplemented)
737 return x;
738 Py_DECREF(x); /* can't do it */
739 }
Brian Curtindfc80e32011-08-10 20:28:54 -0500740 Py_RETURN_NOTIMPLEMENTED;
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000741}
Guido van Rossum77660912002-04-16 16:32:50 +0000742
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000743static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000744binop_type_error(PyObject *v, PyObject *w, const char *op_name)
745{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000746 PyErr_Format(PyExc_TypeError,
747 "unsupported operand type(s) for %.100s: "
748 "'%.100s' and '%.100s'",
749 op_name,
750 v->ob_type->tp_name,
751 w->ob_type->tp_name);
752 return NULL;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000753}
754
755static PyObject *
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000756binary_op(PyObject *v, PyObject *w, const int op_slot, const char *op_name)
757{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000758 PyObject *result = binary_op1(v, w, op_slot);
759 if (result == Py_NotImplemented) {
760 Py_DECREF(result);
761 return binop_type_error(v, w, op_name);
762 }
763 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000764}
765
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000766
767/*
768 Calling scheme used for ternary operations:
769
Neal Norwitz4886cc32006-08-21 17:06:07 +0000770 Order operations are tried until either a valid result or error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000771 v.op(v,w,z), w.op(v,w,z), z.op(v,w,z)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000772 */
773
774static PyObject *
775ternary_op(PyObject *v,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000776 PyObject *w,
777 PyObject *z,
778 const int op_slot,
779 const char *op_name)
Guido van Rossume15dee51995-07-18 14:12:02 +0000780{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000781 PyNumberMethods *mv, *mw, *mz;
782 PyObject *x = NULL;
783 ternaryfunc slotv = NULL;
784 ternaryfunc slotw = NULL;
785 ternaryfunc slotz = NULL;
Guido van Rossum77660912002-04-16 16:32:50 +0000786
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 mv = v->ob_type->tp_as_number;
788 mw = w->ob_type->tp_as_number;
789 if (mv != NULL)
790 slotv = NB_TERNOP(mv, op_slot);
791 if (w->ob_type != v->ob_type &&
792 mw != NULL) {
793 slotw = NB_TERNOP(mw, op_slot);
794 if (slotw == slotv)
795 slotw = NULL;
796 }
797 if (slotv) {
798 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
799 x = slotw(v, w, z);
800 if (x != Py_NotImplemented)
801 return x;
802 Py_DECREF(x); /* can't do it */
803 slotw = NULL;
804 }
805 x = slotv(v, w, z);
806 if (x != Py_NotImplemented)
807 return x;
808 Py_DECREF(x); /* can't do it */
809 }
810 if (slotw) {
811 x = slotw(v, w, z);
812 if (x != Py_NotImplemented)
813 return x;
814 Py_DECREF(x); /* can't do it */
815 }
816 mz = z->ob_type->tp_as_number;
817 if (mz != NULL) {
818 slotz = NB_TERNOP(mz, op_slot);
819 if (slotz == slotv || slotz == slotw)
820 slotz = NULL;
821 if (slotz) {
822 x = slotz(v, w, z);
823 if (x != Py_NotImplemented)
824 return x;
825 Py_DECREF(x); /* can't do it */
826 }
827 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000828
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000829 if (z == Py_None)
830 PyErr_Format(
831 PyExc_TypeError,
832 "unsupported operand type(s) for ** or pow(): "
833 "'%.100s' and '%.100s'",
834 v->ob_type->tp_name,
835 w->ob_type->tp_name);
836 else
837 PyErr_Format(
838 PyExc_TypeError,
839 "unsupported operand type(s) for pow(): "
840 "'%.100s', '%.100s', '%.100s'",
841 v->ob_type->tp_name,
842 w->ob_type->tp_name,
843 z->ob_type->tp_name);
844 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000845}
846
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000847#define BINARY_FUNC(func, op, op_name) \
848 PyObject * \
849 func(PyObject *v, PyObject *w) { \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000850 return binary_op(v, w, NB_SLOT(op), op_name); \
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000851 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000852
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000853BINARY_FUNC(PyNumber_Or, nb_or, "|")
854BINARY_FUNC(PyNumber_Xor, nb_xor, "^")
855BINARY_FUNC(PyNumber_And, nb_and, "&")
856BINARY_FUNC(PyNumber_Lshift, nb_lshift, "<<")
857BINARY_FUNC(PyNumber_Rshift, nb_rshift, ">>")
858BINARY_FUNC(PyNumber_Subtract, nb_subtract, "-")
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000859BINARY_FUNC(PyNumber_Divmod, nb_divmod, "divmod()")
Guido van Rossume15dee51995-07-18 14:12:02 +0000860
861PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000862PyNumber_Add(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000863{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000864 PyObject *result = binary_op1(v, w, NB_SLOT(nb_add));
865 if (result == Py_NotImplemented) {
866 PySequenceMethods *m = v->ob_type->tp_as_sequence;
867 Py_DECREF(result);
868 if (m && m->sq_concat) {
869 return (*m->sq_concat)(v, w);
870 }
871 result = binop_type_error(v, w, "+");
872 }
873 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000874}
875
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000876static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000877sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000878{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000879 Py_ssize_t count;
880 if (PyIndex_Check(n)) {
881 count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
882 if (count == -1 && PyErr_Occurred())
883 return NULL;
884 }
885 else {
886 return type_error("can't multiply sequence by "
887 "non-int of type '%.200s'", n);
888 }
889 return (*repeatfunc)(seq, count);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000890}
891
892PyObject *
893PyNumber_Multiply(PyObject *v, PyObject *w)
894{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000895 PyObject *result = binary_op1(v, w, NB_SLOT(nb_multiply));
896 if (result == Py_NotImplemented) {
897 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
898 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
899 Py_DECREF(result);
900 if (mv && mv->sq_repeat) {
901 return sequence_repeat(mv->sq_repeat, v, w);
902 }
903 else if (mw && mw->sq_repeat) {
904 return sequence_repeat(mw->sq_repeat, w, v);
905 }
906 result = binop_type_error(v, w, "*");
907 }
908 return result;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000909}
910
Guido van Rossume15dee51995-07-18 14:12:02 +0000911PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +0000912PyNumber_FloorDivide(PyObject *v, PyObject *w)
913{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000914 return binary_op(v, w, NB_SLOT(nb_floor_divide), "//");
Guido van Rossum4668b002001-08-08 05:00:18 +0000915}
916
917PyObject *
918PyNumber_TrueDivide(PyObject *v, PyObject *w)
919{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000920 return binary_op(v, w, NB_SLOT(nb_true_divide), "/");
Guido van Rossum4668b002001-08-08 05:00:18 +0000921}
922
923PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000924PyNumber_Remainder(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000925{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000926 return binary_op(v, w, NB_SLOT(nb_remainder), "%");
Guido van Rossume15dee51995-07-18 14:12:02 +0000927}
928
929PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000930PyNumber_Power(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossume15dee51995-07-18 14:12:02 +0000931{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000932 return ternary_op(v, w, z, NB_SLOT(nb_power), "** or pow()");
Guido van Rossume15dee51995-07-18 14:12:02 +0000933}
934
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000935/* Binary in-place operators */
936
937/* The in-place operators are defined to fall back to the 'normal',
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000938 non in-place operations, if the in-place methods are not in place.
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000939
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000940 - If the left hand object has the appropriate struct members, and
941 they are filled, call the appropriate function and return the
942 result. No coercion is done on the arguments; the left-hand object
943 is the one the operation is performed on, and it's up to the
944 function to deal with the right-hand object.
Guido van Rossum77660912002-04-16 16:32:50 +0000945
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000946 - Otherwise, in-place modification is not supported. Handle it exactly as
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000947 a non in-place operation of the same kind.
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000948
949 */
950
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000951static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000952binary_iop1(PyObject *v, PyObject *w, const int iop_slot, const int op_slot)
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000953{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000954 PyNumberMethods *mv = v->ob_type->tp_as_number;
955 if (mv != NULL) {
956 binaryfunc slot = NB_BINOP(mv, iop_slot);
957 if (slot) {
958 PyObject *x = (slot)(v, w);
959 if (x != Py_NotImplemented) {
960 return x;
961 }
962 Py_DECREF(x);
963 }
964 }
965 return binary_op1(v, w, op_slot);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000966}
967
968static PyObject *
969binary_iop(PyObject *v, PyObject *w, const int iop_slot, const int op_slot,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000970 const char *op_name)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000971{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000972 PyObject *result = binary_iop1(v, w, iop_slot, op_slot);
973 if (result == Py_NotImplemented) {
974 Py_DECREF(result);
975 return binop_type_error(v, w, op_name);
976 }
977 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000978}
979
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000980#define INPLACE_BINOP(func, iop, op, op_name) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000981 PyObject * \
982 func(PyObject *v, PyObject *w) { \
983 return binary_iop(v, w, NB_SLOT(iop), NB_SLOT(op), op_name); \
984 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000985
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000986INPLACE_BINOP(PyNumber_InPlaceOr, nb_inplace_or, nb_or, "|=")
987INPLACE_BINOP(PyNumber_InPlaceXor, nb_inplace_xor, nb_xor, "^=")
988INPLACE_BINOP(PyNumber_InPlaceAnd, nb_inplace_and, nb_and, "&=")
989INPLACE_BINOP(PyNumber_InPlaceLshift, nb_inplace_lshift, nb_lshift, "<<=")
990INPLACE_BINOP(PyNumber_InPlaceRshift, nb_inplace_rshift, nb_rshift, ">>=")
991INPLACE_BINOP(PyNumber_InPlaceSubtract, nb_inplace_subtract, nb_subtract, "-=")
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000992
993PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +0000994PyNumber_InPlaceFloorDivide(PyObject *v, PyObject *w)
995{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000996 return binary_iop(v, w, NB_SLOT(nb_inplace_floor_divide),
997 NB_SLOT(nb_floor_divide), "//=");
Guido van Rossum4668b002001-08-08 05:00:18 +0000998}
999
1000PyObject *
1001PyNumber_InPlaceTrueDivide(PyObject *v, PyObject *w)
1002{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001003 return binary_iop(v, w, NB_SLOT(nb_inplace_true_divide),
1004 NB_SLOT(nb_true_divide), "/=");
Guido van Rossum4668b002001-08-08 05:00:18 +00001005}
1006
1007PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001008PyNumber_InPlaceAdd(PyObject *v, PyObject *w)
1009{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001010 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_add),
1011 NB_SLOT(nb_add));
1012 if (result == Py_NotImplemented) {
1013 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1014 Py_DECREF(result);
1015 if (m != NULL) {
1016 binaryfunc f = NULL;
1017 f = m->sq_inplace_concat;
1018 if (f == NULL)
1019 f = m->sq_concat;
1020 if (f != NULL)
1021 return (*f)(v, w);
1022 }
1023 result = binop_type_error(v, w, "+=");
1024 }
1025 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001026}
1027
1028PyObject *
1029PyNumber_InPlaceMultiply(PyObject *v, PyObject *w)
1030{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001031 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_multiply),
1032 NB_SLOT(nb_multiply));
1033 if (result == Py_NotImplemented) {
1034 ssizeargfunc f = NULL;
1035 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1036 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1037 Py_DECREF(result);
1038 if (mv != NULL) {
1039 f = mv->sq_inplace_repeat;
1040 if (f == NULL)
1041 f = mv->sq_repeat;
1042 if (f != NULL)
1043 return sequence_repeat(f, v, w);
1044 }
1045 else if (mw != NULL) {
1046 /* Note that the right hand operand should not be
1047 * mutated in this case so sq_inplace_repeat is not
1048 * used. */
1049 if (mw->sq_repeat)
1050 return sequence_repeat(mw->sq_repeat, w, v);
1051 }
1052 result = binop_type_error(v, w, "*=");
1053 }
1054 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001055}
1056
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001057PyObject *
1058PyNumber_InPlaceRemainder(PyObject *v, PyObject *w)
1059{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001060 return binary_iop(v, w, NB_SLOT(nb_inplace_remainder),
1061 NB_SLOT(nb_remainder), "%=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001062}
1063
1064PyObject *
1065PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
1066{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001067 if (v->ob_type->tp_as_number &&
1068 v->ob_type->tp_as_number->nb_inplace_power != NULL) {
1069 return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
1070 }
1071 else {
1072 return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
1073 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001074}
1075
1076
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001077/* Unary operators and functions */
Guido van Rossume15dee51995-07-18 14:12:02 +00001078
1079PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001080PyNumber_Negative(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001081{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001082 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001083
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001084 if (o == NULL)
1085 return null_error();
1086 m = o->ob_type->tp_as_number;
1087 if (m && m->nb_negative)
1088 return (*m->nb_negative)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001089
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001090 return type_error("bad operand type for unary -: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001091}
1092
1093PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001094PyNumber_Positive(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001095{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001096 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001097
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001098 if (o == NULL)
1099 return null_error();
1100 m = o->ob_type->tp_as_number;
1101 if (m && m->nb_positive)
1102 return (*m->nb_positive)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001103
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001104 return type_error("bad operand type for unary +: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001105}
1106
1107PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001108PyNumber_Invert(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001109{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001110 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001111
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001112 if (o == NULL)
1113 return null_error();
1114 m = o->ob_type->tp_as_number;
1115 if (m && m->nb_invert)
1116 return (*m->nb_invert)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001117
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001118 return type_error("bad operand type for unary ~: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001119}
1120
1121PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001122PyNumber_Absolute(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001123{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001124 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001125
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001126 if (o == NULL)
1127 return null_error();
1128 m = o->ob_type->tp_as_number;
1129 if (m && m->nb_absolute)
1130 return m->nb_absolute(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001131
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001132 return type_error("bad operand type for abs(): '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001133}
1134
Guido van Rossum98297ee2007-11-06 21:34:58 +00001135/* Return a Python Int or Long from the object item
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001136 Raise TypeError if the result is not an int-or-long
Guido van Rossum98297ee2007-11-06 21:34:58 +00001137 or if the object cannot be interpreted as an index.
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001138*/
1139PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001140PyNumber_Index(PyObject *item)
1141{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001142 PyObject *result = NULL;
1143 if (item == NULL)
1144 return null_error();
1145 if (PyLong_Check(item)) {
1146 Py_INCREF(item);
1147 return item;
1148 }
1149 if (PyIndex_Check(item)) {
1150 result = item->ob_type->tp_as_number->nb_index(item);
1151 if (result && !PyLong_Check(result)) {
1152 PyErr_Format(PyExc_TypeError,
1153 "__index__ returned non-int "
1154 "(type %.200s)",
1155 result->ob_type->tp_name);
1156 Py_DECREF(result);
1157 return NULL;
1158 }
1159 }
1160 else {
1161 PyErr_Format(PyExc_TypeError,
1162 "'%.200s' object cannot be interpreted "
1163 "as an integer", item->ob_type->tp_name);
1164 }
1165 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001166}
1167
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001168/* Return an error on Overflow only if err is not NULL*/
1169
1170Py_ssize_t
1171PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1172{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001173 Py_ssize_t result;
1174 PyObject *runerr;
1175 PyObject *value = PyNumber_Index(item);
1176 if (value == NULL)
1177 return -1;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001178
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001179 /* We're done if PyLong_AsSsize_t() returns without error. */
1180 result = PyLong_AsSsize_t(value);
1181 if (result != -1 || !(runerr = PyErr_Occurred()))
1182 goto finish;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001184 /* Error handling code -- only manage OverflowError differently */
1185 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
1186 goto finish;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001187
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001188 PyErr_Clear();
1189 /* If no error-handling desired then the default clipping
1190 is sufficient.
1191 */
1192 if (!err) {
1193 assert(PyLong_Check(value));
1194 /* Whether or not it is less than or equal to
1195 zero is determined by the sign of ob_size
1196 */
1197 if (_PyLong_Sign(value) < 0)
1198 result = PY_SSIZE_T_MIN;
1199 else
1200 result = PY_SSIZE_T_MAX;
1201 }
1202 else {
1203 /* Otherwise replace the error with caller's error object. */
1204 PyErr_Format(err,
1205 "cannot fit '%.200s' into an index-sized integer",
1206 item->ob_type->tp_name);
1207 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001208
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001209 finish:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001210 Py_DECREF(value);
1211 return result;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001212}
1213
1214
Benjamin Petersonb7f1da52012-03-21 14:44:43 -04001215/*
1216 Returns the Integral instance converted to an int. The instance is expected
1217 to be an int or have an __int__ method. Steals integral's
1218 reference. error_format will be used to create the TypeError if integral
1219 isn't actually an Integral instance. error_format should be a format string
Serhiy Storchaka278d03b2013-04-06 22:52:34 +03001220 that can accept a char* naming integral's type.
Benjamin Petersonb7f1da52012-03-21 14:44:43 -04001221*/
1222static PyObject *
1223convert_integral_to_int(PyObject *integral, const char *error_format)
Christian Heimes15ebc882008-02-04 18:48:49 +00001224{
Benjamin Petersond614e702012-03-21 14:38:11 -04001225 PyNumberMethods *nb;
1226 if (PyLong_Check(integral))
1227 return integral;
1228 nb = Py_TYPE(integral)->tp_as_number;
1229 if (nb->nb_int) {
1230 PyObject *as_int = nb->nb_int(integral);
Mark Dickinson3d783852012-09-27 19:38:59 +01001231 if (!as_int || PyLong_Check(as_int)) {
1232 Py_DECREF(integral);
Benjamin Petersond614e702012-03-21 14:38:11 -04001233 return as_int;
Mark Dickinson3d783852012-09-27 19:38:59 +01001234 }
Benjamin Petersond614e702012-03-21 14:38:11 -04001235 Py_DECREF(as_int);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001236 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001237 PyErr_Format(PyExc_TypeError, error_format, Py_TYPE(integral)->tp_name);
1238 Py_DECREF(integral);
Serhiy Storchaka278d03b2013-04-06 22:52:34 +03001239 return NULL;
Christian Heimes15ebc882008-02-04 18:48:49 +00001240}
1241
1242
Guido van Rossum9e896b32000-04-05 20:11:21 +00001243/* Add a check for embedded NULL-bytes in the argument. */
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001244static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001245long_from_string(const char *s, Py_ssize_t len)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001246{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001247 char *end;
1248 PyObject *x;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001249
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001250 x = PyLong_FromString((char*)s, &end, 10);
1251 if (x == NULL)
1252 return NULL;
1253 if (end != s + len) {
1254 PyErr_SetString(PyExc_ValueError,
1255 "null byte in argument for int()");
1256 Py_DECREF(x);
1257 return NULL;
1258 }
1259 return x;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001260}
1261
Guido van Rossume15dee51995-07-18 14:12:02 +00001262PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001263PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001264{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001265 PyNumberMethods *m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001266 PyObject *trunc_func;
1267 const char *buffer;
1268 Py_ssize_t buffer_len;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04001269 _Py_IDENTIFIER(__trunc__);
Christian Heimes15ebc882008-02-04 18:48:49 +00001270
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001271 if (o == NULL)
1272 return null_error();
1273 if (PyLong_CheckExact(o)) {
1274 Py_INCREF(o);
1275 return o;
1276 }
1277 m = o->ob_type->tp_as_number;
1278 if (m && m->nb_int) { /* This should include subclasses of int */
1279 PyObject *res = m->nb_int(o);
1280 if (res && !PyLong_Check(res)) {
1281 PyErr_Format(PyExc_TypeError,
1282 "__int__ returned non-int (type %.200s)",
1283 res->ob_type->tp_name);
1284 Py_DECREF(res);
1285 return NULL;
1286 }
1287 return res;
1288 }
1289 if (PyLong_Check(o)) /* An int subclass without nb_int */
1290 return _PyLong_Copy((PyLongObject *)o);
Benjamin Peterson1b1a8e72012-03-20 23:48:11 -04001291 trunc_func = _PyObject_LookupSpecial(o, &PyId___trunc__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001292 if (trunc_func) {
1293 PyObject *truncated = PyEval_CallObject(trunc_func, NULL);
1294 PyObject *int_instance;
1295 Py_DECREF(trunc_func);
1296 /* __trunc__ is specified to return an Integral type,
Benjamin Peterson520e8502012-03-21 14:51:14 -04001297 but int() needs to return a int. */
Benjamin Petersonb7f1da52012-03-21 14:44:43 -04001298 int_instance = convert_integral_to_int(truncated,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001299 "__trunc__ returned non-Integral (type %.200s)");
1300 return int_instance;
1301 }
Benjamin Peterson1b1a8e72012-03-20 23:48:11 -04001302 if (PyErr_Occurred())
1303 return NULL;
Christian Heimes15ebc882008-02-04 18:48:49 +00001304
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001305 if (PyBytes_Check(o))
1306 /* need to do extra error checking that PyLong_FromString()
Benjamin Peterson520e8502012-03-21 14:51:14 -04001307 * doesn't do. In particular int('9.5') must raise an
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001308 * exception, not truncate the float.
1309 */
1310 return long_from_string(PyBytes_AS_STRING(o),
1311 PyBytes_GET_SIZE(o));
1312 if (PyUnicode_Check(o))
1313 /* The above check is done in PyLong_FromUnicode(). */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001314 return PyLong_FromUnicodeObject(o, 10);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001315 if (!PyObject_AsCharBuffer(o, &buffer, &buffer_len))
1316 return long_from_string(buffer, buffer_len);
Guido van Rossume15dee51995-07-18 14:12:02 +00001317
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001318 return type_error("int() argument must be a string or a "
1319 "number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001320}
1321
1322PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001323PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001324{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001325 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001326
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001327 if (o == NULL)
1328 return null_error();
1329 m = o->ob_type->tp_as_number;
1330 if (m && m->nb_float) { /* This should include subclasses of float */
1331 PyObject *res = m->nb_float(o);
1332 if (res && !PyFloat_Check(res)) {
1333 PyErr_Format(PyExc_TypeError,
1334 "__float__ returned non-float (type %.200s)",
1335 res->ob_type->tp_name);
1336 Py_DECREF(res);
1337 return NULL;
1338 }
1339 return res;
1340 }
1341 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
1342 PyFloatObject *po = (PyFloatObject *)o;
1343 return PyFloat_FromDouble(po->ob_fval);
1344 }
1345 return PyFloat_FromString(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001346}
1347
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001348
1349PyObject *
1350PyNumber_ToBase(PyObject *n, int base)
1351{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001352 PyObject *res = NULL;
1353 PyObject *index = PyNumber_Index(n);
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001354
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001355 if (!index)
1356 return NULL;
1357 if (PyLong_Check(index))
1358 res = _PyLong_Format(index, base);
1359 else
1360 /* It should not be possible to get here, as
1361 PyNumber_Index already has a check for the same
1362 condition */
1363 PyErr_SetString(PyExc_ValueError, "PyNumber_ToBase: index not "
1364 "int or long");
1365 Py_DECREF(index);
1366 return res;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001367}
1368
1369
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001370/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001371
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001372int
Fred Drake79912472000-07-09 04:06:11 +00001373PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001374{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001375 if (PyDict_Check(s))
1376 return 0;
1377 return s != NULL && s->ob_type->tp_as_sequence &&
1378 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001379}
1380
Martin v. Löwis18e16552006-02-15 17:27:45 +00001381Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001382PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001383{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001384 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001385
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001386 if (s == NULL) {
1387 null_error();
1388 return -1;
1389 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001390
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001391 m = s->ob_type->tp_as_sequence;
1392 if (m && m->sq_length)
1393 return m->sq_length(s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001394
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001395 type_error("object of type '%.200s' has no len()", s);
1396 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001397}
1398
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001399#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001400Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001401PySequence_Length(PyObject *s)
1402{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001403 return PySequence_Size(s);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001404}
1405#define PySequence_Length PySequence_Size
1406
Guido van Rossume15dee51995-07-18 14:12:02 +00001407PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001408PySequence_Concat(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001409{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001410 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001411
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001412 if (s == NULL || o == NULL)
1413 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001414
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001415 m = s->ob_type->tp_as_sequence;
1416 if (m && m->sq_concat)
1417 return m->sq_concat(s, o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001418
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001419 /* Instances of user classes defining an __add__() method only
1420 have an nb_add slot, not an sq_concat slot. So we fall back
1421 to nb_add if both arguments appear to be sequences. */
1422 if (PySequence_Check(s) && PySequence_Check(o)) {
1423 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1424 if (result != Py_NotImplemented)
1425 return result;
1426 Py_DECREF(result);
1427 }
1428 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001429}
1430
1431PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001432PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001433{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001434 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001436 if (o == NULL)
1437 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001438
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001439 m = o->ob_type->tp_as_sequence;
1440 if (m && m->sq_repeat)
1441 return m->sq_repeat(o, count);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001442
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001443 /* Instances of user classes defining a __mul__() method only
1444 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1445 to nb_multiply if o appears to be a sequence. */
1446 if (PySequence_Check(o)) {
1447 PyObject *n, *result;
1448 n = PyLong_FromSsize_t(count);
1449 if (n == NULL)
1450 return NULL;
1451 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1452 Py_DECREF(n);
1453 if (result != Py_NotImplemented)
1454 return result;
1455 Py_DECREF(result);
1456 }
1457 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001458}
1459
1460PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001461PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1462{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001463 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001464
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001465 if (s == NULL || o == NULL)
1466 return null_error();
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001467
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001468 m = s->ob_type->tp_as_sequence;
1469 if (m && m->sq_inplace_concat)
1470 return m->sq_inplace_concat(s, o);
1471 if (m && m->sq_concat)
1472 return m->sq_concat(s, o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001473
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001474 if (PySequence_Check(s) && PySequence_Check(o)) {
1475 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1476 NB_SLOT(nb_add));
1477 if (result != Py_NotImplemented)
1478 return result;
1479 Py_DECREF(result);
1480 }
1481 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001482}
1483
1484PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001485PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001486{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001487 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001488
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001489 if (o == NULL)
1490 return null_error();
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001491
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001492 m = o->ob_type->tp_as_sequence;
1493 if (m && m->sq_inplace_repeat)
1494 return m->sq_inplace_repeat(o, count);
1495 if (m && m->sq_repeat)
1496 return m->sq_repeat(o, count);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001497
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001498 if (PySequence_Check(o)) {
1499 PyObject *n, *result;
1500 n = PyLong_FromSsize_t(count);
1501 if (n == NULL)
1502 return NULL;
1503 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1504 NB_SLOT(nb_multiply));
1505 Py_DECREF(n);
1506 if (result != Py_NotImplemented)
1507 return result;
1508 Py_DECREF(result);
1509 }
1510 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001511}
1512
1513PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001514PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001515{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001516 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001517
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001518 if (s == NULL)
1519 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001520
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001521 m = s->ob_type->tp_as_sequence;
1522 if (m && m->sq_item) {
1523 if (i < 0) {
1524 if (m->sq_length) {
1525 Py_ssize_t l = (*m->sq_length)(s);
1526 if (l < 0)
1527 return NULL;
1528 i += l;
1529 }
1530 }
1531 return m->sq_item(s, i);
1532 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001533
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001534 return type_error("'%.200s' object does not support indexing", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001535}
1536
1537PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001538PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00001539{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001540 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001541
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001542 if (!s) return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001543
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001544 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001545 if (mp && mp->mp_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001546 PyObject *res;
1547 PyObject *slice = _PySlice_FromIndices(i1, i2);
1548 if (!slice)
1549 return NULL;
1550 res = mp->mp_subscript(s, slice);
1551 Py_DECREF(slice);
1552 return res;
1553 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001554
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001555 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001556}
1557
1558int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001559PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001560{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001561 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001562
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001563 if (s == NULL) {
1564 null_error();
1565 return -1;
1566 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001567
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001568 m = s->ob_type->tp_as_sequence;
1569 if (m && m->sq_ass_item) {
1570 if (i < 0) {
1571 if (m->sq_length) {
1572 Py_ssize_t l = (*m->sq_length)(s);
1573 if (l < 0)
1574 return -1;
1575 i += l;
1576 }
1577 }
1578 return m->sq_ass_item(s, i, o);
1579 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001580
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001581 type_error("'%.200s' object does not support item assignment", s);
1582 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001583}
1584
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001585int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001586PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001587{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001588 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001589
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001590 if (s == NULL) {
1591 null_error();
1592 return -1;
1593 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001594
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001595 m = s->ob_type->tp_as_sequence;
1596 if (m && m->sq_ass_item) {
1597 if (i < 0) {
1598 if (m->sq_length) {
1599 Py_ssize_t l = (*m->sq_length)(s);
1600 if (l < 0)
1601 return -1;
1602 i += l;
1603 }
1604 }
1605 return m->sq_ass_item(s, i, (PyObject *)NULL);
1606 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001607
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001608 type_error("'%.200s' object doesn't support item deletion", s);
1609 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001610}
1611
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001612int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001613PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001614{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001616
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001617 if (s == NULL) {
1618 null_error();
1619 return -1;
1620 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001621
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001622 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001623 if (mp && mp->mp_ass_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 int res;
1625 PyObject *slice = _PySlice_FromIndices(i1, i2);
1626 if (!slice)
1627 return -1;
1628 res = mp->mp_ass_subscript(s, slice, o);
1629 Py_DECREF(slice);
1630 return res;
1631 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00001632
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001633 type_error("'%.200s' object doesn't support slice assignment", s);
1634 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001635}
1636
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001637int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001638PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001639{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001640 PyMappingMethods *mp;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001641
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001642 if (s == NULL) {
1643 null_error();
1644 return -1;
1645 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001646
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001647 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001648 if (mp && mp->mp_ass_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001649 int res;
1650 PyObject *slice = _PySlice_FromIndices(i1, i2);
1651 if (!slice)
1652 return -1;
1653 res = mp->mp_ass_subscript(s, slice, NULL);
1654 Py_DECREF(slice);
1655 return res;
1656 }
1657 type_error("'%.200s' object doesn't support slice deletion", s);
1658 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001659}
1660
Guido van Rossume15dee51995-07-18 14:12:02 +00001661PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001662PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00001663{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001664 PyObject *it; /* iter(v) */
1665 Py_ssize_t n; /* guess for result tuple size */
1666 PyObject *result = NULL;
1667 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00001668
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001669 if (v == NULL)
1670 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001671
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001672 /* Special-case the common tuple and list cases, for efficiency. */
1673 if (PyTuple_CheckExact(v)) {
1674 /* Note that we can't know whether it's safe to return
1675 a tuple *subclass* instance as-is, hence the restriction
1676 to exact tuples here. In contrast, lists always make
1677 a copy, so there's no need for exactness below. */
1678 Py_INCREF(v);
1679 return v;
1680 }
1681 if (PyList_Check(v))
1682 return PyList_AsTuple(v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001683
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001684 /* Get iterator. */
1685 it = PyObject_GetIter(v);
1686 if (it == NULL)
1687 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001688
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001689 /* Guess result size and allocate space. */
1690 n = _PyObject_LengthHint(v, 10);
1691 if (n == -1)
1692 goto Fail;
1693 result = PyTuple_New(n);
1694 if (result == NULL)
1695 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001696
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001697 /* Fill the tuple. */
1698 for (j = 0; ; ++j) {
1699 PyObject *item = PyIter_Next(it);
1700 if (item == NULL) {
1701 if (PyErr_Occurred())
1702 goto Fail;
1703 break;
1704 }
1705 if (j >= n) {
1706 Py_ssize_t oldn = n;
1707 /* The over-allocation strategy can grow a bit faster
1708 than for lists because unlike lists the
1709 over-allocation isn't permanent -- we reclaim
1710 the excess before the end of this routine.
1711 So, grow by ten and then add 25%.
1712 */
1713 n += 10;
1714 n += n >> 2;
1715 if (n < oldn) {
1716 /* Check for overflow */
1717 PyErr_NoMemory();
1718 Py_DECREF(item);
1719 goto Fail;
1720 }
1721 if (_PyTuple_Resize(&result, n) != 0) {
1722 Py_DECREF(item);
1723 goto Fail;
1724 }
1725 }
1726 PyTuple_SET_ITEM(result, j, item);
1727 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001728
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001729 /* Cut tuple back if guess was too large. */
1730 if (j < n &&
1731 _PyTuple_Resize(&result, j) != 0)
1732 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001733
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001734 Py_DECREF(it);
1735 return result;
Tim Peters6912d4d2001-05-05 03:56:37 +00001736
1737Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001738 Py_XDECREF(result);
1739 Py_DECREF(it);
1740 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001741}
1742
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001743PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001744PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001745{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001746 PyObject *result; /* result list */
1747 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00001748
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001749 if (v == NULL)
1750 return null_error();
Guido van Rossum5dba9e81998-07-10 18:03:50 +00001751
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001752 result = PyList_New(0);
1753 if (result == NULL)
1754 return NULL;
Tim Petersf553f892001-05-01 20:45:31 +00001755
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001756 rv = _PyList_Extend((PyListObject *)result, v);
1757 if (rv == NULL) {
1758 Py_DECREF(result);
1759 return NULL;
1760 }
1761 Py_DECREF(rv);
1762 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001763}
1764
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001765PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001766PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001767{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001768 PyObject *it;
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001769
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001770 if (v == NULL)
1771 return null_error();
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001772
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001773 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
1774 Py_INCREF(v);
1775 return v;
1776 }
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001777
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001778 it = PyObject_GetIter(v);
1779 if (it == NULL) {
1780 if (PyErr_ExceptionMatches(PyExc_TypeError))
1781 PyErr_SetString(PyExc_TypeError, m);
1782 return NULL;
1783 }
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001784
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001785 v = PySequence_List(it);
1786 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001787
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001788 return v;
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001789}
1790
Tim Peters16a77ad2001-09-08 04:00:12 +00001791/* Iterate over seq. Result depends on the operation:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001792 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
1793 PY_ITERSEARCH_INDEX: 0-based index of first occurrence of obj in seq;
1794 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00001795 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
1796*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001797Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001798_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00001799{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001800 Py_ssize_t n;
1801 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
1802 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00001803
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001804 if (seq == NULL || obj == NULL) {
1805 null_error();
1806 return -1;
1807 }
Tim Peters75f8e352001-05-05 11:33:43 +00001808
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001809 it = PyObject_GetIter(seq);
1810 if (it == NULL) {
1811 type_error("argument of type '%.200s' is not iterable", seq);
1812 return -1;
1813 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001814
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001815 n = wrapped = 0;
1816 for (;;) {
1817 int cmp;
1818 PyObject *item = PyIter_Next(it);
1819 if (item == NULL) {
1820 if (PyErr_Occurred())
1821 goto Fail;
1822 break;
1823 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001824
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001825 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
1826 Py_DECREF(item);
1827 if (cmp < 0)
1828 goto Fail;
1829 if (cmp > 0) {
1830 switch (operation) {
1831 case PY_ITERSEARCH_COUNT:
1832 if (n == PY_SSIZE_T_MAX) {
1833 PyErr_SetString(PyExc_OverflowError,
1834 "count exceeds C integer size");
1835 goto Fail;
1836 }
1837 ++n;
1838 break;
Tim Peters16a77ad2001-09-08 04:00:12 +00001839
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001840 case PY_ITERSEARCH_INDEX:
1841 if (wrapped) {
1842 PyErr_SetString(PyExc_OverflowError,
1843 "index exceeds C integer size");
1844 goto Fail;
1845 }
1846 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001847
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001848 case PY_ITERSEARCH_CONTAINS:
1849 n = 1;
1850 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001851
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001852 default:
1853 assert(!"unknown operation");
1854 }
1855 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001856
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001857 if (operation == PY_ITERSEARCH_INDEX) {
1858 if (n == PY_SSIZE_T_MAX)
1859 wrapped = 1;
1860 ++n;
1861 }
1862 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001863
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001864 if (operation != PY_ITERSEARCH_INDEX)
1865 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00001866
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001867 PyErr_SetString(PyExc_ValueError,
1868 "sequence.index(x): x not in sequence");
1869 /* fall into failure code */
Tim Peters16a77ad2001-09-08 04:00:12 +00001870Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001871 n = -1;
1872 /* fall through */
Tim Peters16a77ad2001-09-08 04:00:12 +00001873Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001874 Py_DECREF(it);
1875 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00001876
Guido van Rossume15dee51995-07-18 14:12:02 +00001877}
1878
Tim Peters16a77ad2001-09-08 04:00:12 +00001879/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001880Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001881PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001882{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001883 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00001884}
1885
Tim Peterscb8d3682001-05-05 21:05:01 +00001886/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00001887 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00001888 */
1889int
1890PySequence_Contains(PyObject *seq, PyObject *ob)
1891{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001892 Py_ssize_t result;
1893 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
1894 if (sqm != NULL && sqm->sq_contains != NULL)
1895 return (*sqm->sq_contains)(seq, ob);
1896 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
1897 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00001898}
1899
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001900/* Backwards compatibility */
1901#undef PySequence_In
1902int
Fred Drake79912472000-07-09 04:06:11 +00001903PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001904{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001905 return PySequence_Contains(w, v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001906}
1907
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001908Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00001909PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001910{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001911 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00001912}
1913
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001914/* Operations on mappings */
1915
1916int
Fred Drake79912472000-07-09 04:06:11 +00001917PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001918{
Benjamin Peterson21992272011-12-28 12:01:31 -06001919 return o && o->ob_type->tp_as_mapping &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001920 o->ob_type->tp_as_mapping->mp_subscript;
Guido van Rossume15dee51995-07-18 14:12:02 +00001921}
1922
Martin v. Löwis18e16552006-02-15 17:27:45 +00001923Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001924PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001925{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001926 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001927
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001928 if (o == NULL) {
1929 null_error();
1930 return -1;
1931 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001932
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001933 m = o->ob_type->tp_as_mapping;
1934 if (m && m->mp_length)
1935 return m->mp_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001936
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001937 type_error("object of type '%.200s' has no len()", o);
1938 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001939}
1940
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001941#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001942Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001943PyMapping_Length(PyObject *o)
1944{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001945 return PyMapping_Size(o);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001946}
1947#define PyMapping_Length PyMapping_Size
1948
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001949PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001950PyMapping_GetItemString(PyObject *o, char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001951{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001952 PyObject *okey, *r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001953
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001954 if (key == NULL)
1955 return null_error();
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001956
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001957 okey = PyUnicode_FromString(key);
1958 if (okey == NULL)
1959 return NULL;
1960 r = PyObject_GetItem(o, okey);
1961 Py_DECREF(okey);
1962 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001963}
1964
1965int
Fred Drake79912472000-07-09 04:06:11 +00001966PyMapping_SetItemString(PyObject *o, char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001967{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001968 PyObject *okey;
1969 int r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001970
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001971 if (key == NULL) {
1972 null_error();
1973 return -1;
1974 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001975
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001976 okey = PyUnicode_FromString(key);
1977 if (okey == NULL)
1978 return -1;
1979 r = PyObject_SetItem(o, okey, value);
1980 Py_DECREF(okey);
1981 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001982}
1983
1984int
Fred Drake79912472000-07-09 04:06:11 +00001985PyMapping_HasKeyString(PyObject *o, char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00001986{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001987 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00001988
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001989 v = PyMapping_GetItemString(o, key);
1990 if (v) {
1991 Py_DECREF(v);
1992 return 1;
1993 }
1994 PyErr_Clear();
1995 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00001996}
1997
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001998int
Fred Drake79912472000-07-09 04:06:11 +00001999PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002000{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002001 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002002
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002003 v = PyObject_GetItem(o, key);
2004 if (v) {
2005 Py_DECREF(v);
2006 return 1;
2007 }
2008 PyErr_Clear();
2009 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002010}
2011
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002012PyObject *
2013PyMapping_Keys(PyObject *o)
2014{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002015 PyObject *keys;
2016 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002017 _Py_IDENTIFIER(keys);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002018
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002019 if (PyDict_CheckExact(o))
2020 return PyDict_Keys(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002021 keys = _PyObject_CallMethodId(o, &PyId_keys, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002022 if (keys == NULL)
2023 return NULL;
2024 fast = PySequence_Fast(keys, "o.keys() are not iterable");
2025 Py_DECREF(keys);
2026 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002027}
2028
2029PyObject *
2030PyMapping_Items(PyObject *o)
2031{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002032 PyObject *items;
2033 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002034 _Py_IDENTIFIER(items);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002035
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002036 if (PyDict_CheckExact(o))
2037 return PyDict_Items(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002038 items = _PyObject_CallMethodId(o, &PyId_items, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002039 if (items == NULL)
2040 return NULL;
2041 fast = PySequence_Fast(items, "o.items() are not iterable");
2042 Py_DECREF(items);
2043 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002044}
2045
2046PyObject *
2047PyMapping_Values(PyObject *o)
2048{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002049 PyObject *values;
2050 PyObject *fast;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002051 _Py_IDENTIFIER(values);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002052
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002053 if (PyDict_CheckExact(o))
2054 return PyDict_Values(o);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002055 values = _PyObject_CallMethodId(o, &PyId_values, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002056 if (values == NULL)
2057 return NULL;
2058 fast = PySequence_Fast(values, "o.values() are not iterable");
2059 Py_DECREF(values);
2060 return fast;
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002061}
2062
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002063/* Operations on callable objects */
2064
2065/* XXX PyCallable_Check() is in object.c */
2066
Guido van Rossume15dee51995-07-18 14:12:02 +00002067PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002068PyObject_CallObject(PyObject *o, PyObject *a)
Guido van Rossume15dee51995-07-18 14:12:02 +00002069{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002070 return PyEval_CallObjectWithKeywords(o, a, NULL);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002071}
Guido van Rossume15dee51995-07-18 14:12:02 +00002072
2073PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002074PyObject_Call(PyObject *func, PyObject *arg, PyObject *kw)
2075{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002076 ternaryfunc call;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002077
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002078 if ((call = func->ob_type->tp_call) != NULL) {
2079 PyObject *result;
2080 if (Py_EnterRecursiveCall(" while calling a Python object"))
2081 return NULL;
2082 result = (*call)(func, arg, kw);
2083 Py_LeaveRecursiveCall();
2084 if (result == NULL && !PyErr_Occurred())
2085 PyErr_SetString(
2086 PyExc_SystemError,
2087 "NULL result without error in PyObject_Call");
2088 return result;
2089 }
2090 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
2091 func->ob_type->tp_name);
2092 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002093}
2094
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002095static PyObject*
2096call_function_tail(PyObject *callable, PyObject *args)
2097{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002098 PyObject *retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002099
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002100 if (args == NULL)
2101 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002103 if (!PyTuple_Check(args)) {
2104 PyObject *a;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002105
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002106 a = PyTuple_New(1);
2107 if (a == NULL) {
2108 Py_DECREF(args);
2109 return NULL;
2110 }
2111 PyTuple_SET_ITEM(a, 0, args);
2112 args = a;
2113 }
2114 retval = PyObject_Call(callable, args, NULL);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002115
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002116 Py_DECREF(args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002117
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002118 return retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002119}
2120
Tim Peters6d6c1a32001-08-02 04:15:00 +00002121PyObject *
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002122PyObject_CallFunction(PyObject *callable, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002123{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002124 va_list va;
2125 PyObject *args;
Guido van Rossume15dee51995-07-18 14:12:02 +00002126
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002127 if (callable == NULL)
2128 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002129
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002130 if (format && *format) {
2131 va_start(va, format);
2132 args = Py_VaBuildValue(format, va);
2133 va_end(va);
2134 }
2135 else
2136 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002137
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002138 return call_function_tail(callable, args);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002139}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002140
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002141PyObject *
2142_PyObject_CallFunction_SizeT(PyObject *callable, char *format, ...)
2143{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002144 va_list va;
2145 PyObject *args;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002146
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002147 if (callable == NULL)
2148 return null_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002149
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002150 if (format && *format) {
2151 va_start(va, format);
2152 args = _Py_VaBuildValue_SizeT(format, va);
2153 va_end(va);
2154 }
2155 else
2156 args = PyTuple_New(0);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002157
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002158 return call_function_tail(callable, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002159}
2160
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002161static PyObject*
2162callmethod(PyObject* func, char *format, va_list va, int is_size_t)
2163{
2164 PyObject *retval = NULL;
2165 PyObject *args;
2166
2167 if (!PyCallable_Check(func)) {
2168 type_error("attribute of type '%.200s' is not callable", func);
2169 goto exit;
2170 }
2171
2172 if (format && *format) {
2173 if (is_size_t)
2174 args = _Py_VaBuildValue_SizeT(format, va);
2175 else
2176 args = Py_VaBuildValue(format, va);
2177 }
2178 else
2179 args = PyTuple_New(0);
2180
2181 retval = call_function_tail(func, args);
2182
2183 exit:
2184 /* args gets consumed in call_function_tail */
2185 Py_XDECREF(func);
2186
2187 return retval;
2188}
2189
Guido van Rossume15dee51995-07-18 14:12:02 +00002190PyObject *
Guido van Rossume15dee51995-07-18 14:12:02 +00002191PyObject_CallMethod(PyObject *o, char *name, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002192{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002193 va_list va;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002194 PyObject *func = NULL;
2195 PyObject *retval = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002196
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002197 if (o == NULL || name == NULL)
2198 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002199
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002200 func = PyObject_GetAttrString(o, name);
2201 if (func == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002202 return 0;
2203 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002204
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002205 va_start(va, format);
2206 retval = callmethod(func, format, va, 0);
2207 va_end(va);
2208 return retval;
2209}
2210
2211PyObject *
2212_PyObject_CallMethodId(PyObject *o, _Py_Identifier *name, char *format, ...)
2213{
2214 va_list va;
2215 PyObject *func = NULL;
2216 PyObject *retval = NULL;
2217
2218 if (o == NULL || name == NULL)
2219 return null_error();
2220
2221 func = _PyObject_GetAttrId(o, name);
2222 if (func == NULL) {
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002223 return 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002224 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002225
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002226 va_start(va, format);
2227 retval = callmethod(func, format, va, 0);
2228 va_end(va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002229 return retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002230}
2231
2232PyObject *
2233_PyObject_CallMethod_SizeT(PyObject *o, char *name, char *format, ...)
2234{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002235 va_list va;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002236 PyObject *func = NULL;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002237 PyObject *retval;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002238
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002239 if (o == NULL || name == NULL)
2240 return null_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002241
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002242 func = PyObject_GetAttrString(o, name);
2243 if (func == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002244 return 0;
2245 }
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002246 va_start(va, format);
2247 retval = callmethod(func, format, va, 1);
2248 va_end(va);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002249 return retval;
Guido van Rossume15dee51995-07-18 14:12:02 +00002250}
Guido van Rossum823649d2001-03-21 18:40:58 +00002251
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002252PyObject *
2253_PyObject_CallMethodId_SizeT(PyObject *o, _Py_Identifier *name, char *format, ...)
2254{
2255 va_list va;
2256 PyObject *func = NULL;
2257 PyObject *retval;
2258
2259 if (o == NULL || name == NULL)
2260 return null_error();
2261
2262 func = _PyObject_GetAttrId(o, name);
2263 if (func == NULL) {
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002264 return NULL;
2265 }
2266 va_start(va, format);
2267 retval = callmethod(func, format, va, 1);
2268 va_end(va);
2269 return retval;
2270}
Guido van Rossum823649d2001-03-21 18:40:58 +00002271
Fred Drakeb421b8c2001-10-26 16:21:32 +00002272static PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002273objargs_mktuple(va_list va)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002274{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002275 int i, n = 0;
2276 va_list countva;
2277 PyObject *result, *tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002278
Alexander Belopolskyf0f45142010-08-11 17:31:17 +00002279 Py_VA_COPY(countva, va);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002280
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002281 while (((PyObject *)va_arg(countva, PyObject *)) != NULL)
2282 ++n;
2283 result = PyTuple_New(n);
2284 if (result != NULL && n > 0) {
2285 for (i = 0; i < n; ++i) {
2286 tmp = (PyObject *)va_arg(va, PyObject *);
2287 PyTuple_SET_ITEM(result, i, tmp);
2288 Py_INCREF(tmp);
2289 }
2290 }
2291 return result;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002292}
2293
2294PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002295PyObject_CallMethodObjArgs(PyObject *callable, PyObject *name, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002296{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002297 PyObject *args, *tmp;
2298 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002299
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002300 if (callable == NULL || name == NULL)
2301 return null_error();
Fred Drakeb421b8c2001-10-26 16:21:32 +00002302
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002303 callable = PyObject_GetAttr(callable, name);
2304 if (callable == NULL)
2305 return NULL;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002306
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002307 /* count the args */
2308 va_start(vargs, name);
2309 args = objargs_mktuple(vargs);
2310 va_end(vargs);
2311 if (args == NULL) {
2312 Py_DECREF(callable);
2313 return NULL;
2314 }
2315 tmp = PyObject_Call(callable, args, NULL);
2316 Py_DECREF(args);
2317 Py_DECREF(callable);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002318
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002319 return tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002320}
2321
2322PyObject *
Brett Cannonfd074152012-04-14 14:10:13 -04002323_PyObject_CallMethodObjIdArgs(PyObject *callable,
2324 struct _Py_Identifier *name, ...)
2325{
2326 PyObject *args, *tmp;
2327 va_list vargs;
2328
2329 if (callable == NULL || name == NULL)
2330 return null_error();
2331
2332 callable = _PyObject_GetAttrId(callable, name);
2333 if (callable == NULL)
2334 return NULL;
2335
2336 /* count the args */
2337 va_start(vargs, name);
2338 args = objargs_mktuple(vargs);
2339 va_end(vargs);
2340 if (args == NULL) {
2341 Py_DECREF(callable);
2342 return NULL;
2343 }
2344 tmp = PyObject_Call(callable, args, NULL);
2345 Py_DECREF(args);
2346 Py_DECREF(callable);
2347
2348 return tmp;
2349}
2350
2351PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002352PyObject_CallFunctionObjArgs(PyObject *callable, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002353{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002354 PyObject *args, *tmp;
2355 va_list vargs;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002356
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002357 if (callable == NULL)
2358 return null_error();
Fred Drakeb421b8c2001-10-26 16:21:32 +00002359
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002360 /* count the args */
2361 va_start(vargs, callable);
2362 args = objargs_mktuple(vargs);
2363 va_end(vargs);
2364 if (args == NULL)
2365 return NULL;
2366 tmp = PyObject_Call(callable, args, NULL);
2367 Py_DECREF(args);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002368
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002369 return tmp;
Fred Drakeb421b8c2001-10-26 16:21:32 +00002370}
2371
2372
Guido van Rossum823649d2001-03-21 18:40:58 +00002373/* isinstance(), issubclass() */
2374
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002375/* abstract_get_bases() has logically 4 return states:
Barry Warsawf16951c2002-04-23 22:45:44 +00002376 *
Barry Warsawf16951c2002-04-23 22:45:44 +00002377 * 1. getattr(cls, '__bases__') could raise an AttributeError
2378 * 2. getattr(cls, '__bases__') could raise some other exception
2379 * 3. getattr(cls, '__bases__') could return a tuple
2380 * 4. getattr(cls, '__bases__') could return something other than a tuple
2381 *
2382 * Only state #3 is a non-error state and only it returns a non-NULL object
2383 * (it returns the retrieved tuple).
2384 *
2385 * Any raised AttributeErrors are masked by clearing the exception and
2386 * returning NULL. If an object other than a tuple comes out of __bases__,
2387 * then again, the return value is NULL. So yes, these two situations
2388 * produce exactly the same results: NULL is returned and no error is set.
2389 *
2390 * If some exception other than AttributeError is raised, then NULL is also
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002391 * returned, but the exception is not cleared. That's because we want the
Barry Warsawf16951c2002-04-23 22:45:44 +00002392 * exception to be propagated along.
2393 *
2394 * Callers are expected to test for PyErr_Occurred() when the return value
2395 * is NULL to decide whether a valid exception should be propagated or not.
2396 * When there's no exception to propagate, it's customary for the caller to
2397 * set a TypeError.
2398 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002399static PyObject *
2400abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002401{
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002402 _Py_IDENTIFIER(__bases__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002403 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002404
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002405 Py_ALLOW_RECURSION
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002406 bases = _PyObject_GetAttrId(cls, &PyId___bases__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002407 Py_END_ALLOW_RECURSION
2408 if (bases == NULL) {
2409 if (PyErr_ExceptionMatches(PyExc_AttributeError))
2410 PyErr_Clear();
2411 return NULL;
2412 }
2413 if (!PyTuple_Check(bases)) {
2414 Py_DECREF(bases);
2415 return NULL;
2416 }
2417 return bases;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002418}
2419
2420
2421static int
2422abstract_issubclass(PyObject *derived, PyObject *cls)
2423{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002424 PyObject *bases = NULL;
2425 Py_ssize_t i, n;
2426 int r = 0;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002427
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002428 while (1) {
2429 if (derived == cls)
2430 return 1;
2431 bases = abstract_get_bases(derived);
2432 if (bases == NULL) {
2433 if (PyErr_Occurred())
2434 return -1;
2435 return 0;
2436 }
2437 n = PyTuple_GET_SIZE(bases);
2438 if (n == 0) {
2439 Py_DECREF(bases);
2440 return 0;
2441 }
2442 /* Avoid recursivity in the single inheritance case */
2443 if (n == 1) {
2444 derived = PyTuple_GET_ITEM(bases, 0);
2445 Py_DECREF(bases);
2446 continue;
2447 }
2448 for (i = 0; i < n; i++) {
2449 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
2450 if (r != 0)
2451 break;
2452 }
2453 Py_DECREF(bases);
2454 return r;
2455 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002456}
2457
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002458static int
2459check_class(PyObject *cls, const char *error)
2460{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002461 PyObject *bases = abstract_get_bases(cls);
2462 if (bases == NULL) {
2463 /* Do not mask errors. */
2464 if (!PyErr_Occurred())
2465 PyErr_SetString(PyExc_TypeError, error);
2466 return 0;
2467 }
2468 Py_DECREF(bases);
2469 return -1;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002470}
2471
Brett Cannon4f653312004-03-20 22:52:14 +00002472static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002473recursive_isinstance(PyObject *inst, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002474{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002475 PyObject *icls;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002476 int retval = 0;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002477 _Py_IDENTIFIER(__class__);
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002478
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002479 if (PyType_Check(cls)) {
2480 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
2481 if (retval == 0) {
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002482 PyObject *c = _PyObject_GetAttrId(inst, &PyId___class__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002483 if (c == NULL) {
Benjamin Peterson72288d42010-11-20 17:21:08 +00002484 if (PyErr_ExceptionMatches(PyExc_AttributeError))
R. David Murray6bb99892010-11-20 16:33:30 +00002485 PyErr_Clear();
Benjamin Peterson72288d42010-11-20 17:21:08 +00002486 else
R. David Murray6bb99892010-11-20 16:33:30 +00002487 retval = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002488 }
2489 else {
2490 if (c != (PyObject *)(inst->ob_type) &&
2491 PyType_Check(c))
2492 retval = PyType_IsSubtype(
2493 (PyTypeObject *)c,
2494 (PyTypeObject *)cls);
2495 Py_DECREF(c);
2496 }
2497 }
2498 }
2499 else {
2500 if (!check_class(cls,
Benjamin Petersone893af52010-06-28 19:43:42 +00002501 "isinstance() arg 2 must be a type or tuple of types"))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002502 return -1;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002503 icls = _PyObject_GetAttrId(inst, &PyId___class__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002504 if (icls == NULL) {
Benjamin Peterson72288d42010-11-20 17:21:08 +00002505 if (PyErr_ExceptionMatches(PyExc_AttributeError))
R. David Murray6bb99892010-11-20 16:33:30 +00002506 PyErr_Clear();
Benjamin Peterson72288d42010-11-20 17:21:08 +00002507 else
R. David Murray6bb99892010-11-20 16:33:30 +00002508 retval = -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002509 }
2510 else {
2511 retval = abstract_issubclass(icls, cls);
2512 Py_DECREF(icls);
2513 }
2514 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002515
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002516 return retval;
Guido van Rossum823649d2001-03-21 18:40:58 +00002517}
2518
2519int
Brett Cannon4f653312004-03-20 22:52:14 +00002520PyObject_IsInstance(PyObject *inst, PyObject *cls)
2521{
Benjamin Petersonce798522012-01-22 11:24:29 -05002522 _Py_IDENTIFIER(__instancecheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002523 PyObject *checker;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002524
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002525 /* Quick test for an exact match */
2526 if (Py_TYPE(inst) == (PyTypeObject *)cls)
2527 return 1;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002528
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002529 if (PyTuple_Check(cls)) {
2530 Py_ssize_t i;
2531 Py_ssize_t n;
2532 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002533
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002534 if (Py_EnterRecursiveCall(" in __instancecheck__"))
2535 return -1;
2536 n = PyTuple_GET_SIZE(cls);
2537 for (i = 0; i < n; ++i) {
2538 PyObject *item = PyTuple_GET_ITEM(cls, i);
2539 r = PyObject_IsInstance(inst, item);
2540 if (r != 0)
2541 /* either found it, or got an error */
2542 break;
2543 }
2544 Py_LeaveRecursiveCall();
2545 return r;
2546 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002547
Benjamin Petersonce798522012-01-22 11:24:29 -05002548 checker = _PyObject_LookupSpecial(cls, &PyId___instancecheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002549 if (checker != NULL) {
2550 PyObject *res;
2551 int ok = -1;
2552 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2553 Py_DECREF(checker);
2554 return ok;
2555 }
2556 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
2557 Py_LeaveRecursiveCall();
2558 Py_DECREF(checker);
2559 if (res != NULL) {
2560 ok = PyObject_IsTrue(res);
2561 Py_DECREF(res);
2562 }
2563 return ok;
2564 }
2565 else if (PyErr_Occurred())
2566 return -1;
2567 return recursive_isinstance(inst, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002568}
2569
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002570static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002571recursive_issubclass(PyObject *derived, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002572{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002573 if (PyType_Check(cls) && PyType_Check(derived)) {
2574 /* Fast path (non-recursive) */
2575 return PyType_IsSubtype((PyTypeObject *)derived, (PyTypeObject *)cls);
2576 }
2577 if (!check_class(derived,
2578 "issubclass() arg 1 must be a class"))
2579 return -1;
2580 if (!check_class(cls,
2581 "issubclass() arg 2 must be a class"
2582 " or tuple of classes"))
2583 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002584
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002585 return abstract_issubclass(derived, cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002586}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002587
Brett Cannon4f653312004-03-20 22:52:14 +00002588int
2589PyObject_IsSubclass(PyObject *derived, PyObject *cls)
2590{
Benjamin Petersonce798522012-01-22 11:24:29 -05002591 _Py_IDENTIFIER(__subclasscheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002592 PyObject *checker;
Georg Brandldcfe8e42009-05-17 08:22:45 +00002593
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002594 if (PyTuple_Check(cls)) {
2595 Py_ssize_t i;
2596 Py_ssize_t n;
2597 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002598
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002599 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
2600 return -1;
2601 n = PyTuple_GET_SIZE(cls);
2602 for (i = 0; i < n; ++i) {
2603 PyObject *item = PyTuple_GET_ITEM(cls, i);
2604 r = PyObject_IsSubclass(derived, item);
2605 if (r != 0)
2606 /* either found it, or got an error */
2607 break;
2608 }
2609 Py_LeaveRecursiveCall();
2610 return r;
2611 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002612
Benjamin Petersonce798522012-01-22 11:24:29 -05002613 checker = _PyObject_LookupSpecial(cls, &PyId___subclasscheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002614 if (checker != NULL) {
2615 PyObject *res;
2616 int ok = -1;
2617 if (Py_EnterRecursiveCall(" in __subclasscheck__")) {
2618 Py_DECREF(checker);
2619 return ok;
2620 }
2621 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
2622 Py_LeaveRecursiveCall();
2623 Py_DECREF(checker);
2624 if (res != NULL) {
2625 ok = PyObject_IsTrue(res);
2626 Py_DECREF(res);
2627 }
2628 return ok;
2629 }
2630 else if (PyErr_Occurred())
2631 return -1;
2632 return recursive_issubclass(derived, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00002633}
2634
2635int
2636_PyObject_RealIsInstance(PyObject *inst, PyObject *cls)
2637{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002638 return recursive_isinstance(inst, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00002639}
2640
2641int
2642_PyObject_RealIsSubclass(PyObject *derived, PyObject *cls)
2643{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002644 return recursive_issubclass(derived, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002645}
2646
2647
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002648PyObject *
2649PyObject_GetIter(PyObject *o)
2650{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002651 PyTypeObject *t = o->ob_type;
2652 getiterfunc f = NULL;
2653 f = t->tp_iter;
2654 if (f == NULL) {
2655 if (PySequence_Check(o))
2656 return PySeqIter_New(o);
2657 return type_error("'%.200s' object is not iterable", o);
2658 }
2659 else {
2660 PyObject *res = (*f)(o);
2661 if (res != NULL && !PyIter_Check(res)) {
2662 PyErr_Format(PyExc_TypeError,
2663 "iter() returned non-iterator "
2664 "of type '%.100s'",
2665 res->ob_type->tp_name);
2666 Py_DECREF(res);
2667 res = NULL;
2668 }
2669 return res;
2670 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00002671}
2672
Tim Petersf4848da2001-05-05 00:14:56 +00002673/* Return next item.
2674 * If an error occurs, return NULL. PyErr_Occurred() will be true.
2675 * If the iteration terminates normally, return NULL and clear the
2676 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
2677 * will be false.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002678 * Else return the next object. PyErr_Occurred() will be false.
Tim Petersf4848da2001-05-05 00:14:56 +00002679 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002680PyObject *
2681PyIter_Next(PyObject *iter)
2682{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002683 PyObject *result;
2684 result = (*iter->ob_type->tp_iternext)(iter);
2685 if (result == NULL &&
2686 PyErr_Occurred() &&
2687 PyErr_ExceptionMatches(PyExc_StopIteration))
2688 PyErr_Clear();
2689 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002690}
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002691
2692
2693/*
2694 * Flatten a sequence of bytes() objects into a C array of
2695 * NULL terminated string pointers with a NULL char* terminating the array.
2696 * (ie: an argv or env list)
2697 *
2698 * Memory allocated for the returned list is allocated using malloc() and MUST
2699 * be freed by the caller using a free() loop or _Py_FreeCharPArray().
2700 */
2701char *const *
2702_PySequence_BytesToCharpArray(PyObject* self)
2703{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002704 char **array;
2705 Py_ssize_t i, argc;
2706 PyObject *item = NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002707
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002708 argc = PySequence_Size(self);
2709 if (argc == -1)
2710 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002711
Stefan Krah7cacd2e2012-08-21 08:16:09 +02002712 assert(argc >= 0);
2713
2714 if ((size_t)argc > (PY_SSIZE_T_MAX-sizeof(char *)) / sizeof(char *)) {
2715 PyErr_NoMemory();
2716 return NULL;
2717 }
2718
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002719 array = malloc((argc + 1) * sizeof(char *));
2720 if (array == NULL) {
2721 PyErr_NoMemory();
2722 return NULL;
2723 }
2724 for (i = 0; i < argc; ++i) {
2725 char *data;
2726 item = PySequence_GetItem(self, i);
Stefan Krahfd24f9e2012-08-20 11:04:24 +02002727 if (item == NULL) {
2728 /* NULL terminate before freeing. */
2729 array[i] = NULL;
2730 goto fail;
2731 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002732 data = PyBytes_AsString(item);
2733 if (data == NULL) {
2734 /* NULL terminate before freeing. */
2735 array[i] = NULL;
2736 goto fail;
2737 }
2738 array[i] = strdup(data);
2739 if (!array[i]) {
2740 PyErr_NoMemory();
2741 goto fail;
2742 }
2743 Py_DECREF(item);
2744 }
2745 array[argc] = NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002746
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002747 return array;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002748
2749fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002750 Py_XDECREF(item);
2751 _Py_FreeCharPArray(array);
2752 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002753}
2754
2755
2756/* Free's a NULL terminated char** array of C strings. */
2757void
2758_Py_FreeCharPArray(char *const array[])
2759{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002760 Py_ssize_t i;
2761 for (i = 0; array[i] != NULL; ++i) {
2762 free(array[i]);
2763 }
2764 free((void*)array);
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002765}