blob: 1f988ecae57da80b3d682f972806ecc4230c4125 [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{
Thomas Wouters0e3f5912006-08-11 14:57:12 +000015 PyErr_Format(PyExc_TypeError, msg, obj->ob_type->tp_name);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000016 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{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +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
30int
Fred Drake79912472000-07-09 04:06:11 +000031PyObject_Cmp(PyObject *o1, PyObject *o2, int *result)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000032{
33 int r;
34
35 if (o1 == NULL || o2 == NULL) {
36 null_error();
37 return -1;
38 }
39 r = PyObject_Compare(o1, o2);
40 if (PyErr_Occurred())
41 return -1;
42 *result = r;
Guido van Rossume15dee51995-07-18 14:12:02 +000043 return 0;
44}
Guido van Rossume15dee51995-07-18 14:12:02 +000045
46PyObject *
Fred Drake79912472000-07-09 04:06:11 +000047PyObject_Type(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +000048{
49 PyObject *v;
50
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000051 if (o == NULL)
52 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +000053 v = (PyObject *)o->ob_type;
54 Py_INCREF(v);
55 return v;
56}
57
Martin v. Löwis18e16552006-02-15 17:27:45 +000058Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +000059PyObject_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +000060{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000061 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +000062
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000063 if (o == NULL) {
64 null_error();
65 return -1;
66 }
Guido van Rossume15dee51995-07-18 14:12:02 +000067
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000068 m = o->ob_type->tp_as_sequence;
69 if (m && m->sq_length)
70 return m->sq_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +000071
Jeremy Hylton6253f832000-07-12 12:56:19 +000072 return PyMapping_Size(o);
Guido van Rossume15dee51995-07-18 14:12:02 +000073}
74
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000075#undef PyObject_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +000076Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000077PyObject_Length(PyObject *o)
78{
79 return PyObject_Size(o);
80}
81#define PyObject_Length PyObject_Size
82
Raymond Hettinger6b27cda2005-09-24 21:23:05 +000083
Christian Heimes255f53b2007-12-08 15:33:56 +000084/* The length hint function returns a non-negative value from o.__len__()
85 or o.__length_hint__(). If those methods aren't found or return a negative
86 value, then the defaultvalue is returned. This function never fails.
87 Accordingly, it will mask exceptions raised in either method.
88*/
89
90Py_ssize_t
91_PyObject_LengthHint(PyObject *o, Py_ssize_t defaultvalue)
92{
93 static PyObject *hintstrobj = NULL;
94 PyObject *ro;
95 Py_ssize_t rv;
96
97 /* try o.__len__() */
98 rv = PyObject_Size(o);
99 if (rv >= 0)
100 return rv;
101 if (PyErr_Occurred())
102 PyErr_Clear();
103
104 /* cache a hashed version of the attribute string */
105 if (hintstrobj == NULL) {
106 hintstrobj = PyUnicode_InternFromString("__length_hint__");
107 if (hintstrobj == NULL)
108 goto defaultcase;
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000109 }
Christian Heimes255f53b2007-12-08 15:33:56 +0000110
111 /* try o.__length_hint__() */
112 ro = PyObject_CallMethodObjArgs(o, hintstrobj, NULL);
113 if (ro == NULL)
114 goto defaultcase;
115 rv = PyLong_AsSsize_t(ro);
116 Py_DECREF(ro);
117 if (rv >= 0)
118 return rv;
119
120defaultcase:
121 if (PyErr_Occurred())
122 PyErr_Clear();
123 return defaultvalue;
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000124}
125
Guido van Rossume15dee51995-07-18 14:12:02 +0000126PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000127PyObject_GetItem(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +0000128{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000129 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000130
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000131 if (o == NULL || key == NULL)
132 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +0000133
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000134 m = o->ob_type->tp_as_mapping;
135 if (m && m->mp_subscript)
136 return m->mp_subscript(o, key);
Guido van Rossume15dee51995-07-18 14:12:02 +0000137
Guido van Rossum21308241998-08-13 16:44:44 +0000138 if (o->ob_type->tp_as_sequence) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000139 if (PyIndex_Check(key)) {
140 Py_ssize_t key_value;
141 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
Andrew M. Kuchling0f223d22000-02-23 22:21:50 +0000142 if (key_value == -1 && PyErr_Occurred())
143 return NULL;
144 return PySequence_GetItem(o, key_value);
145 }
Guido van Rossum64585f62001-11-24 18:24:47 +0000146 else if (o->ob_type->tp_as_sequence->sq_item)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000147 return type_error("sequence index must "
148 "be integer, not '%.200s'", key);
Guido van Rossum21308241998-08-13 16:44:44 +0000149 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000150
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000151 return type_error("'%.200s' object is unsubscriptable", o);
Guido van Rossume15dee51995-07-18 14:12:02 +0000152}
153
154int
Fred Drake79912472000-07-09 04:06:11 +0000155PyObject_SetItem(PyObject *o, PyObject *key, PyObject *value)
Guido van Rossume15dee51995-07-18 14:12:02 +0000156{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000157 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000158
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000159 if (o == NULL || key == NULL || value == NULL) {
160 null_error();
161 return -1;
162 }
163 m = o->ob_type->tp_as_mapping;
164 if (m && m->mp_ass_subscript)
165 return m->mp_ass_subscript(o, key, value);
Guido van Rossume15dee51995-07-18 14:12:02 +0000166
Guido van Rossum21308241998-08-13 16:44:44 +0000167 if (o->ob_type->tp_as_sequence) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000168 if (PyIndex_Check(key)) {
169 Py_ssize_t key_value;
170 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
Andrew M. Kuchling0f223d22000-02-23 22:21:50 +0000171 if (key_value == -1 && PyErr_Occurred())
172 return -1;
173 return PySequence_SetItem(o, key_value, value);
174 }
Guido van Rossum64585f62001-11-24 18:24:47 +0000175 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000176 type_error("sequence index must be "
177 "integer, not '%.200s'", key);
Guido van Rossum64585f62001-11-24 18:24:47 +0000178 return -1;
179 }
Guido van Rossum21308241998-08-13 16:44:44 +0000180 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000181
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000182 type_error("'%.200s' object does not support item assignment", o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000183 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +0000184}
185
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000186int
Fred Drake79912472000-07-09 04:06:11 +0000187PyObject_DelItem(PyObject *o, PyObject *key)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000188{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000189 PyMappingMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000190
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000191 if (o == NULL || key == NULL) {
192 null_error();
193 return -1;
194 }
195 m = o->ob_type->tp_as_mapping;
196 if (m && m->mp_ass_subscript)
197 return m->mp_ass_subscript(o, key, (PyObject*)NULL);
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000198
Guido van Rossum21308241998-08-13 16:44:44 +0000199 if (o->ob_type->tp_as_sequence) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000200 if (PyIndex_Check(key)) {
201 Py_ssize_t key_value;
202 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
Andrew M. Kuchling0f223d22000-02-23 22:21:50 +0000203 if (key_value == -1 && PyErr_Occurred())
204 return -1;
205 return PySequence_DelItem(o, key_value);
206 }
Guido van Rossum64585f62001-11-24 18:24:47 +0000207 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000208 type_error("sequence index must be "
209 "integer, not '%.200s'", key);
Guido van Rossum64585f62001-11-24 18:24:47 +0000210 return -1;
211 }
Guido van Rossum21308241998-08-13 16:44:44 +0000212 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000213
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000214 type_error("'%.200s' object does not support item deletion", o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000215 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000216}
217
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000218int
219PyObject_DelItemString(PyObject *o, char *key)
220{
221 PyObject *okey;
222 int ret;
223
224 if (o == NULL || key == NULL) {
225 null_error();
226 return -1;
227 }
Martin v. Löwis5b222132007-06-10 09:51:05 +0000228 okey = PyUnicode_FromString(key);
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000229 if (okey == NULL)
230 return -1;
231 ret = PyObject_DelItem(o, okey);
232 Py_DECREF(okey);
233 return ret;
234}
235
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000236/* We release the buffer right after use of this function which could
Guido van Rossum98297ee2007-11-06 21:34:58 +0000237 cause issues later on. Don't use these functions in new code.
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000238 */
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000239int
240PyObject_AsCharBuffer(PyObject *obj,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000241 const char **buffer,
242 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000243{
244 PyBufferProcs *pb;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000245 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000246
247 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
248 null_error();
249 return -1;
250 }
251 pb = obj->ob_type->tp_as_buffer;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000252 if (pb == NULL || pb->bf_getbuffer == NULL) {
Guido van Rossum4c08d552000-03-10 22:55:18 +0000253 PyErr_SetString(PyExc_TypeError,
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000254 "expected an object with the buffer interface");
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000255 return -1;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000256 }
Travis E. Oliphantddacf962007-10-13 21:03:27 +0000257 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE)) return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000258
259 *buffer = view.buf;
260 *buffer_len = view.len;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000261 if (pb->bf_releasebuffer != NULL)
262 (*pb->bf_releasebuffer)(obj, &view);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +0000263 Py_XDECREF(view.obj);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000264 return 0;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000265}
Guido van Rossum4c08d552000-03-10 22:55:18 +0000266
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000267int
268PyObject_CheckReadBuffer(PyObject *obj)
269{
Guido van Rossum98297ee2007-11-06 21:34:58 +0000270 PyBufferProcs *pb = obj->ob_type->tp_as_buffer;
Benjamin Peterson60320cb2008-09-26 21:49:22 +0000271 Py_buffer view;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000272
273 if (pb == NULL ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000274 pb->bf_getbuffer == NULL)
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000275 return 0;
Benjamin Peterson60320cb2008-09-26 21:49:22 +0000276 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE) == -1) {
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000277 PyErr_Clear();
278 return 0;
279 }
Benjamin Peterson60320cb2008-09-26 21:49:22 +0000280 PyBuffer_Release(&view);
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000281 return 1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000282}
283
284int PyObject_AsReadBuffer(PyObject *obj,
285 const void **buffer,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000286 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000287{
288 PyBufferProcs *pb;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000289 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000290
291 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
292 null_error();
293 return -1;
294 }
295 pb = obj->ob_type->tp_as_buffer;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000296 if (pb == NULL ||
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000297 pb->bf_getbuffer == NULL) {
Guido van Rossum4c08d552000-03-10 22:55:18 +0000298 PyErr_SetString(PyExc_TypeError,
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000299 "expected an object with a buffer interface");
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000300 return -1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000301 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000302
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000303 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE)) return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000304
305 *buffer = view.buf;
306 *buffer_len = view.len;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000307 if (pb->bf_releasebuffer != NULL)
308 (*pb->bf_releasebuffer)(obj, &view);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +0000309 Py_XDECREF(view.obj);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000310 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000311}
312
313int PyObject_AsWriteBuffer(PyObject *obj,
314 void **buffer,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000315 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000316{
317 PyBufferProcs *pb;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000318 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000319
320 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
321 null_error();
322 return -1;
323 }
324 pb = obj->ob_type->tp_as_buffer;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000325 if (pb == NULL ||
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000326 pb->bf_getbuffer == NULL ||
327 ((*pb->bf_getbuffer)(obj, &view, PyBUF_WRITABLE) != 0)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000328 PyErr_SetString(PyExc_TypeError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000329 "expected an object with a writable buffer interface");
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000330 return -1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000331 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000332
333 *buffer = view.buf;
334 *buffer_len = view.len;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000335 if (pb->bf_releasebuffer != NULL)
336 (*pb->bf_releasebuffer)(obj, &view);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +0000337 Py_XDECREF(view.obj);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000338 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000339}
340
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000341/* Buffer C-API for Python 3.0 */
342
343int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000344PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000345{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000346 if (!PyObject_CheckBuffer(obj)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000347 PyErr_Format(PyExc_TypeError,
348 "'%100s' does not have the buffer interface",
Christian Heimes90aa7642007-12-19 02:45:37 +0000349 Py_TYPE(obj)->tp_name);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000350 return -1;
351 }
352 return (*(obj->ob_type->tp_as_buffer->bf_getbuffer))(obj, view, flags);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000353}
354
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000355static int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000356_IsFortranContiguous(Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000357{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000358 Py_ssize_t sd, dim;
359 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000360
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000361 if (view->ndim == 0) return 1;
362 if (view->strides == NULL) return (view->ndim == 1);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000363
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000364 sd = view->itemsize;
365 if (view->ndim == 1) return (view->shape[0] == 1 ||
366 sd == view->strides[0]);
367 for (i=0; i<view->ndim; i++) {
368 dim = view->shape[i];
369 if (dim == 0) return 1;
370 if (view->strides[i] != sd) return 0;
371 sd *= dim;
372 }
373 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000374}
375
376static int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000377_IsCContiguous(Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000378{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000379 Py_ssize_t sd, dim;
380 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000381
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000382 if (view->ndim == 0) return 1;
383 if (view->strides == NULL) return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000384
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000385 sd = view->itemsize;
386 if (view->ndim == 1) return (view->shape[0] == 1 ||
387 sd == view->strides[0]);
388 for (i=view->ndim-1; i>=0; i--) {
389 dim = view->shape[i];
390 if (dim == 0) return 1;
391 if (view->strides[i] != sd) return 0;
392 sd *= dim;
393 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000394 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000395}
396
397int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000398PyBuffer_IsContiguous(Py_buffer *view, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000399{
400
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000401 if (view->suboffsets != NULL) return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000402
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000403 if (fort == 'C')
404 return _IsCContiguous(view);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000405 else if (fort == 'F')
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000406 return _IsFortranContiguous(view);
407 else if (fort == 'A')
408 return (_IsCContiguous(view) || _IsFortranContiguous(view));
409 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000410}
411
412
Guido van Rossum98297ee2007-11-06 21:34:58 +0000413void*
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000414PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000415{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000416 char* pointer;
417 int i;
418 pointer = (char *)view->buf;
419 for (i = 0; i < view->ndim; i++) {
420 pointer += view->strides[i]*indices[i];
421 if ((view->suboffsets != NULL) && (view->suboffsets[i] >= 0)) {
422 pointer = *((char**)pointer) + view->suboffsets[i];
423 }
424 }
425 return (void*)pointer;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000426}
427
428
Guido van Rossum98297ee2007-11-06 21:34:58 +0000429void
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000430_add_one_to_index_F(int nd, Py_ssize_t *index, Py_ssize_t *shape)
431{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000432 int k;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000433
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000434 for (k=0; k<nd; k++) {
435 if (index[k] < shape[k]-1) {
436 index[k]++;
437 break;
438 }
439 else {
440 index[k] = 0;
441 }
442 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000443}
444
Guido van Rossum98297ee2007-11-06 21:34:58 +0000445void
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000446_add_one_to_index_C(int nd, Py_ssize_t *index, Py_ssize_t *shape)
447{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000448 int k;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000449
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000450 for (k=nd-1; k>=0; k--) {
451 if (index[k] < shape[k]-1) {
452 index[k]++;
453 break;
454 }
455 else {
456 index[k] = 0;
457 }
458 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000459}
460
461 /* view is not checked for consistency in either of these. It is
Guido van Rossum98297ee2007-11-06 21:34:58 +0000462 assumed that the size of the buffer is view->len in
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000463 view->len / view->itemsize elements.
464 */
465
Guido van Rossum98297ee2007-11-06 21:34:58 +0000466int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000467PyBuffer_ToContiguous(void *buf, Py_buffer *view, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000468{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000469 int k;
470 void (*addone)(int, Py_ssize_t *, Py_ssize_t *);
471 Py_ssize_t *indices, elements;
472 char *dest, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000473
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000474 if (len > view->len) {
475 len = view->len;
476 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000477
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000478 if (PyBuffer_IsContiguous(view, fort)) {
479 /* simplest copy is all that is needed */
480 memcpy(buf, view->buf, len);
481 return 0;
482 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000483
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000484 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000485
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000486 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000487 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
488 if (indices == NULL) {
489 PyErr_NoMemory();
490 return -1;
491 }
492 for (k=0; k<view->ndim;k++) {
493 indices[k] = 0;
494 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000495
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000496 if (fort == 'F') {
497 addone = _add_one_to_index_F;
498 }
499 else {
500 addone = _add_one_to_index_C;
501 }
502 dest = buf;
503 /* XXX : This is not going to be the fastest code in the world
Guido van Rossum98297ee2007-11-06 21:34:58 +0000504 several optimizations are possible.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000505 */
506 elements = len / view->itemsize;
507 while (elements--) {
508 addone(view->ndim, indices, view->shape);
509 ptr = PyBuffer_GetPointer(view, indices);
510 memcpy(dest, ptr, view->itemsize);
511 dest += view->itemsize;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000512 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000513 PyMem_Free(indices);
514 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000515}
516
517int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000518PyBuffer_FromContiguous(Py_buffer *view, void *buf, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000519{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000520 int k;
521 void (*addone)(int, Py_ssize_t *, Py_ssize_t *);
522 Py_ssize_t *indices, elements;
523 char *src, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000524
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000525 if (len > view->len) {
526 len = view->len;
527 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000528
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000529 if (PyBuffer_IsContiguous(view, fort)) {
530 /* simplest copy is all that is needed */
531 memcpy(view->buf, buf, len);
532 return 0;
533 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000534
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000535 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000536
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000537 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000538 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
539 if (indices == NULL) {
540 PyErr_NoMemory();
541 return -1;
542 }
543 for (k=0; k<view->ndim;k++) {
544 indices[k] = 0;
545 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000546
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000547 if (fort == 'F') {
548 addone = _add_one_to_index_F;
549 }
550 else {
551 addone = _add_one_to_index_C;
552 }
553 src = buf;
554 /* XXX : This is not going to be the fastest code in the world
Guido van Rossum98297ee2007-11-06 21:34:58 +0000555 several optimizations are possible.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000556 */
557 elements = len / view->itemsize;
558 while (elements--) {
559 addone(view->ndim, indices, view->shape);
560 ptr = PyBuffer_GetPointer(view, indices);
561 memcpy(ptr, src, view->itemsize);
562 src += view->itemsize;
563 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000564
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000565 PyMem_Free(indices);
566 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000567}
568
Guido van Rossum98297ee2007-11-06 21:34:58 +0000569int PyObject_CopyData(PyObject *dest, PyObject *src)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000570{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000571 Py_buffer view_dest, view_src;
572 int k;
573 Py_ssize_t *indices, elements;
574 char *dptr, *sptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000575
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000576 if (!PyObject_CheckBuffer(dest) ||
577 !PyObject_CheckBuffer(src)) {
578 PyErr_SetString(PyExc_TypeError,
579 "both destination and source must have the "\
580 "buffer interface");
581 return -1;
582 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000583
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000584 if (PyObject_GetBuffer(dest, &view_dest, PyBUF_FULL) != 0) return -1;
585 if (PyObject_GetBuffer(src, &view_src, PyBUF_FULL_RO) != 0) {
Martin v. Löwis423be952008-08-13 15:53:07 +0000586 PyBuffer_Release(&view_dest);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000587 return -1;
588 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000589
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000590 if (view_dest.len < view_src.len) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000591 PyErr_SetString(PyExc_BufferError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000592 "destination is too small to receive data from source");
Martin v. Löwis423be952008-08-13 15:53:07 +0000593 PyBuffer_Release(&view_dest);
594 PyBuffer_Release(&view_src);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000595 return -1;
596 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000597
Guido van Rossum98297ee2007-11-06 21:34:58 +0000598 if ((PyBuffer_IsContiguous(&view_dest, 'C') &&
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000599 PyBuffer_IsContiguous(&view_src, 'C')) ||
Guido van Rossum98297ee2007-11-06 21:34:58 +0000600 (PyBuffer_IsContiguous(&view_dest, 'F') &&
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000601 PyBuffer_IsContiguous(&view_src, 'F'))) {
602 /* simplest copy is all that is needed */
603 memcpy(view_dest.buf, view_src.buf, view_src.len);
Martin v. Löwis423be952008-08-13 15:53:07 +0000604 PyBuffer_Release(&view_dest);
605 PyBuffer_Release(&view_src);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000606 return 0;
607 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000608
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000609 /* Otherwise a more elaborate copy scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000610
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000611 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000612 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*view_src.ndim);
613 if (indices == NULL) {
614 PyErr_NoMemory();
Martin v. Löwis423be952008-08-13 15:53:07 +0000615 PyBuffer_Release(&view_dest);
616 PyBuffer_Release(&view_src);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000617 return -1;
618 }
619 for (k=0; k<view_src.ndim;k++) {
620 indices[k] = 0;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000621 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000622 elements = 1;
623 for (k=0; k<view_src.ndim; k++) {
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000624 /* XXX(nnorwitz): can this overflow? */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000625 elements *= view_src.shape[k];
626 }
627 while (elements--) {
628 _add_one_to_index_C(view_src.ndim, indices, view_src.shape);
629 dptr = PyBuffer_GetPointer(&view_dest, indices);
630 sptr = PyBuffer_GetPointer(&view_src, indices);
631 memcpy(dptr, sptr, view_src.itemsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000632 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000633 PyMem_Free(indices);
Martin v. Löwis423be952008-08-13 15:53:07 +0000634 PyBuffer_Release(&view_dest);
635 PyBuffer_Release(&view_src);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000636 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000637}
638
639void
640PyBuffer_FillContiguousStrides(int nd, Py_ssize_t *shape,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000641 Py_ssize_t *strides, int itemsize,
642 char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000643{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000644 int k;
645 Py_ssize_t sd;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000646
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000647 sd = itemsize;
648 if (fort == 'F') {
649 for (k=0; k<nd; k++) {
650 strides[k] = sd;
651 sd *= shape[k];
Guido van Rossum98297ee2007-11-06 21:34:58 +0000652 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000653 }
654 else {
655 for (k=nd-1; k>=0; k--) {
656 strides[k] = sd;
657 sd *= shape[k];
658 }
659 }
660 return;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000661}
662
663int
Martin v. Löwis423be952008-08-13 15:53:07 +0000664PyBuffer_FillInfo(Py_buffer *view, PyObject *obj, void *buf, Py_ssize_t len,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000665 int readonly, int flags)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000666{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000667 if (view == NULL) return 0;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000668 if (((flags & PyBUF_WRITABLE) == PyBUF_WRITABLE) &&
669 (readonly == 1)) {
670 PyErr_SetString(PyExc_BufferError,
671 "Object is not writable.");
672 return -1;
673 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000674
Martin v. Löwis423be952008-08-13 15:53:07 +0000675 view->obj = obj;
Martin v. Löwis74bbea72008-08-14 20:32:30 +0000676 if (obj)
677 Py_INCREF(obj);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000678 view->buf = buf;
679 view->len = len;
680 view->readonly = readonly;
681 view->itemsize = 1;
682 view->format = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000683 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT)
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000684 view->format = "B";
685 view->ndim = 1;
686 view->shape = NULL;
687 if ((flags & PyBUF_ND) == PyBUF_ND)
688 view->shape = &(view->len);
689 view->strides = NULL;
690 if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES)
691 view->strides = &(view->itemsize);
692 view->suboffsets = NULL;
693 view->internal = NULL;
694 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000695}
696
Martin v. Löwis423be952008-08-13 15:53:07 +0000697void
698PyBuffer_Release(Py_buffer *view)
699{
700 PyObject *obj = view->obj;
Martin v. Löwis74bbea72008-08-14 20:32:30 +0000701 if (obj && Py_TYPE(obj)->tp_as_buffer && Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer)
702 Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer(obj, view);
703 Py_XDECREF(obj);
704 view->obj = NULL;
Martin v. Löwis423be952008-08-13 15:53:07 +0000705}
706
Eric Smith8fd3eba2008-02-17 19:48:00 +0000707PyObject *
708PyObject_Format(PyObject *obj, PyObject *format_spec)
709{
710 static PyObject * str__format__ = NULL;
711 PyObject *meth;
712 PyObject *empty = NULL;
713 PyObject *result = NULL;
714
715 /* Initialize cached value */
716 if (str__format__ == NULL) {
717 /* Initialize static variable needed by _PyType_Lookup */
718 str__format__ = PyUnicode_FromString("__format__");
719 if (str__format__ == NULL)
720 goto done;
721 }
722
723 /* If no format_spec is provided, use an empty string */
724 if (format_spec == NULL) {
725 empty = PyUnicode_FromUnicode(NULL, 0);
726 format_spec = empty;
727 }
728
729 /* Make sure the type is initialized. float gets initialized late */
730 if (Py_TYPE(obj)->tp_dict == NULL)
731 if (PyType_Ready(Py_TYPE(obj)) < 0)
732 goto done;
733
734 /* Find the (unbound!) __format__ method (a borrowed reference) */
735 meth = _PyType_Lookup(Py_TYPE(obj), str__format__);
736 if (meth == NULL) {
737 PyErr_Format(PyExc_TypeError,
738 "Type %.100s doesn't define __format__",
739 Py_TYPE(obj)->tp_name);
740 goto done;
741 }
742
743 /* And call it, binding it to the value */
744 result = PyObject_CallFunctionObjArgs(meth, obj, format_spec, NULL);
745
746 if (result && !PyUnicode_Check(result)) {
747 PyErr_SetString(PyExc_TypeError,
748 "__format__ method did not return string");
749 Py_DECREF(result);
750 result = NULL;
751 goto done;
752 }
753
754done:
755 Py_XDECREF(empty);
756 return result;
757}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000758/* Operations on numbers */
759
760int
Fred Drake79912472000-07-09 04:06:11 +0000761PyNumber_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +0000762{
Guido van Rossum6921eca2003-02-18 16:36:28 +0000763 return o && o->ob_type->tp_as_number &&
764 (o->ob_type->tp_as_number->nb_int ||
765 o->ob_type->tp_as_number->nb_float);
Guido van Rossume15dee51995-07-18 14:12:02 +0000766}
767
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000768/* Binary operators */
Guido van Rossume15dee51995-07-18 14:12:02 +0000769
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000770#define NB_SLOT(x) offsetof(PyNumberMethods, x)
771#define NB_BINOP(nb_methods, slot) \
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000772 (*(binaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000773#define NB_TERNOP(nb_methods, slot) \
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000774 (*(ternaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000775
776/*
777 Calling scheme used for binary operations:
778
Neal Norwitz4886cc32006-08-21 17:06:07 +0000779 Order operations are tried until either a valid result or error:
780 w.op(v,w)[*], v.op(v,w), w.op(v,w)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000781
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000782 [*] only when v->ob_type != w->ob_type && w->ob_type is a subclass of
783 v->ob_type
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000784 */
785
786static PyObject *
787binary_op1(PyObject *v, PyObject *w, const int op_slot)
Guido van Rossume15dee51995-07-18 14:12:02 +0000788{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000789 PyObject *x;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000790 binaryfunc slotv = NULL;
791 binaryfunc slotw = NULL;
792
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000793 if (v->ob_type->tp_as_number != NULL)
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000794 slotv = NB_BINOP(v->ob_type->tp_as_number, op_slot);
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000795 if (w->ob_type != v->ob_type &&
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000796 w->ob_type->tp_as_number != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000797 slotw = NB_BINOP(w->ob_type->tp_as_number, op_slot);
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000798 if (slotw == slotv)
799 slotw = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000800 }
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000801 if (slotv) {
Guido van Rossum89c42642001-10-01 17:10:18 +0000802 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
803 x = slotw(v, w);
804 if (x != Py_NotImplemented)
805 return x;
806 Py_DECREF(x); /* can't do it */
807 slotw = NULL;
808 }
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000809 x = slotv(v, w);
810 if (x != Py_NotImplemented)
811 return x;
812 Py_DECREF(x); /* can't do it */
813 }
814 if (slotw) {
815 x = slotw(v, w);
816 if (x != Py_NotImplemented)
817 return x;
818 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000819 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000820 Py_INCREF(Py_NotImplemented);
821 return Py_NotImplemented;
822}
Guido van Rossum77660912002-04-16 16:32:50 +0000823
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000824static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000825binop_type_error(PyObject *v, PyObject *w, const char *op_name)
826{
827 PyErr_Format(PyExc_TypeError,
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000828 "unsupported operand type(s) for %.100s: "
829 "'%.100s' and '%.100s'",
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000830 op_name,
831 v->ob_type->tp_name,
832 w->ob_type->tp_name);
833 return NULL;
834}
835
836static PyObject *
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000837binary_op(PyObject *v, PyObject *w, const int op_slot, const char *op_name)
838{
839 PyObject *result = binary_op1(v, w, op_slot);
840 if (result == Py_NotImplemented) {
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000841 Py_DECREF(result);
842 return binop_type_error(v, w, op_name);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000843 }
844 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000845}
846
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000847
848/*
849 Calling scheme used for ternary operations:
850
Neal Norwitz4886cc32006-08-21 17:06:07 +0000851 Order operations are tried until either a valid result or error:
852 v.op(v,w,z), w.op(v,w,z), z.op(v,w,z)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000853 */
854
855static PyObject *
856ternary_op(PyObject *v,
857 PyObject *w,
858 PyObject *z,
859 const int op_slot,
860 const char *op_name)
Guido van Rossume15dee51995-07-18 14:12:02 +0000861{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000862 PyNumberMethods *mv, *mw, *mz;
Guido van Rossum84675ac2001-09-29 01:05:03 +0000863 PyObject *x = NULL;
864 ternaryfunc slotv = NULL;
865 ternaryfunc slotw = NULL;
866 ternaryfunc slotz = NULL;
Guido van Rossum77660912002-04-16 16:32:50 +0000867
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000868 mv = v->ob_type->tp_as_number;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000869 mw = w->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000870 if (mv != NULL)
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000871 slotv = NB_TERNOP(mv, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000872 if (w->ob_type != v->ob_type &&
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000873 mw != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000874 slotw = NB_TERNOP(mw, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000875 if (slotw == slotv)
876 slotw = NULL;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000877 }
Guido van Rossum84675ac2001-09-29 01:05:03 +0000878 if (slotv) {
Guido van Rossum89c42642001-10-01 17:10:18 +0000879 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
880 x = slotw(v, w, z);
881 if (x != Py_NotImplemented)
882 return x;
883 Py_DECREF(x); /* can't do it */
884 slotw = NULL;
885 }
Guido van Rossum84675ac2001-09-29 01:05:03 +0000886 x = slotv(v, w, z);
887 if (x != Py_NotImplemented)
888 return x;
889 Py_DECREF(x); /* can't do it */
890 }
891 if (slotw) {
892 x = slotw(v, w, z);
893 if (x != Py_NotImplemented)
894 return x;
895 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000896 }
897 mz = z->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000898 if (mz != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000899 slotz = NB_TERNOP(mz, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000900 if (slotz == slotv || slotz == slotw)
901 slotz = NULL;
902 if (slotz) {
903 x = slotz(v, w, z);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000904 if (x != Py_NotImplemented)
905 return x;
Guido van Rossum84675ac2001-09-29 01:05:03 +0000906 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000907 }
908 }
909
Guido van Rossum5c66a262001-10-22 04:12:44 +0000910 if (z == Py_None)
911 PyErr_Format(
912 PyExc_TypeError,
913 "unsupported operand type(s) for ** or pow(): "
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000914 "'%.100s' and '%.100s'",
Guido van Rossum5c66a262001-10-22 04:12:44 +0000915 v->ob_type->tp_name,
916 w->ob_type->tp_name);
917 else
918 PyErr_Format(
919 PyExc_TypeError,
920 "unsupported operand type(s) for pow(): "
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000921 "'%.100s', '%.100s', '%.100s'",
Guido van Rossum5c66a262001-10-22 04:12:44 +0000922 v->ob_type->tp_name,
923 w->ob_type->tp_name,
924 z->ob_type->tp_name);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000925 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000926}
927
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000928#define BINARY_FUNC(func, op, op_name) \
929 PyObject * \
930 func(PyObject *v, PyObject *w) { \
931 return binary_op(v, w, NB_SLOT(op), op_name); \
932 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000933
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000934BINARY_FUNC(PyNumber_Or, nb_or, "|")
935BINARY_FUNC(PyNumber_Xor, nb_xor, "^")
936BINARY_FUNC(PyNumber_And, nb_and, "&")
937BINARY_FUNC(PyNumber_Lshift, nb_lshift, "<<")
938BINARY_FUNC(PyNumber_Rshift, nb_rshift, ">>")
939BINARY_FUNC(PyNumber_Subtract, nb_subtract, "-")
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000940BINARY_FUNC(PyNumber_Divmod, nb_divmod, "divmod()")
Guido van Rossume15dee51995-07-18 14:12:02 +0000941
942PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000943PyNumber_Add(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000944{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000945 PyObject *result = binary_op1(v, w, NB_SLOT(nb_add));
946 if (result == Py_NotImplemented) {
947 PySequenceMethods *m = v->ob_type->tp_as_sequence;
Armin Rigofd163f92005-12-29 15:59:19 +0000948 Py_DECREF(result);
Jeremy Hylton0522d982002-03-08 21:28:54 +0000949 if (m && m->sq_concat) {
Armin Rigofd163f92005-12-29 15:59:19 +0000950 return (*m->sq_concat)(v, w);
Jeremy Hylton0522d982002-03-08 21:28:54 +0000951 }
Armin Rigofd163f92005-12-29 15:59:19 +0000952 result = binop_type_error(v, w, "+");
Guido van Rossume15dee51995-07-18 14:12:02 +0000953 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000954 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000955}
956
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000957static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000958sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000959{
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000960 Py_ssize_t count;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000961 if (PyIndex_Check(n)) {
962 count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000963 if (count == -1 && PyErr_Occurred())
964 return NULL;
965 }
966 else {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000967 return type_error("can't multiply sequence by "
968 "non-int of type '%.200s'", n);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000969 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000970 return (*repeatfunc)(seq, count);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000971}
972
973PyObject *
974PyNumber_Multiply(PyObject *v, PyObject *w)
975{
976 PyObject *result = binary_op1(v, w, NB_SLOT(nb_multiply));
977 if (result == Py_NotImplemented) {
978 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
979 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
Guido van Rossuma3a243e2002-12-31 19:50:03 +0000980 Py_DECREF(result);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000981 if (mv && mv->sq_repeat) {
982 return sequence_repeat(mv->sq_repeat, v, w);
983 }
984 else if (mw && mw->sq_repeat) {
985 return sequence_repeat(mw->sq_repeat, w, v);
986 }
987 result = binop_type_error(v, w, "*");
988 }
989 return result;
990}
991
Guido van Rossume15dee51995-07-18 14:12:02 +0000992PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +0000993PyNumber_FloorDivide(PyObject *v, PyObject *w)
994{
Guido van Rossum4668b002001-08-08 05:00:18 +0000995 return binary_op(v, w, NB_SLOT(nb_floor_divide), "//");
996}
997
998PyObject *
999PyNumber_TrueDivide(PyObject *v, PyObject *w)
1000{
Guido van Rossum4668b002001-08-08 05:00:18 +00001001 return binary_op(v, w, NB_SLOT(nb_true_divide), "/");
1002}
1003
1004PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001005PyNumber_Remainder(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +00001006{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001007 return binary_op(v, w, NB_SLOT(nb_remainder), "%");
Guido van Rossume15dee51995-07-18 14:12:02 +00001008}
1009
1010PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001011PyNumber_Power(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossume15dee51995-07-18 14:12:02 +00001012{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001013 return ternary_op(v, w, z, NB_SLOT(nb_power), "** or pow()");
Guido van Rossume15dee51995-07-18 14:12:02 +00001014}
1015
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001016/* Binary in-place operators */
1017
1018/* The in-place operators are defined to fall back to the 'normal',
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001019 non in-place operations, if the in-place methods are not in place.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001020
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001021 - If the left hand object has the appropriate struct members, and
1022 they are filled, call the appropriate function and return the
1023 result. No coercion is done on the arguments; the left-hand object
1024 is the one the operation is performed on, and it's up to the
1025 function to deal with the right-hand object.
Guido van Rossum77660912002-04-16 16:32:50 +00001026
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001027 - Otherwise, in-place modification is not supported. Handle it exactly as
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001028 a non in-place operation of the same kind.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001029
1030 */
1031
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001032static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001033binary_iop1(PyObject *v, PyObject *w, const int iop_slot, const int op_slot)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001034{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001035 PyNumberMethods *mv = v->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001036 if (mv != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +00001037 binaryfunc slot = NB_BINOP(mv, iop_slot);
1038 if (slot) {
1039 PyObject *x = (slot)(v, w);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001040 if (x != Py_NotImplemented) {
1041 return x;
1042 }
1043 Py_DECREF(x);
1044 }
Thomas Woutersf2b332d2000-09-02 08:34:40 +00001045 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001046 return binary_op1(v, w, op_slot);
1047}
1048
1049static PyObject *
1050binary_iop(PyObject *v, PyObject *w, const int iop_slot, const int op_slot,
1051 const char *op_name)
1052{
1053 PyObject *result = binary_iop1(v, w, iop_slot, op_slot);
1054 if (result == Py_NotImplemented) {
1055 Py_DECREF(result);
1056 return binop_type_error(v, w, op_name);
1057 }
1058 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001059}
1060
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001061#define INPLACE_BINOP(func, iop, op, op_name) \
1062 PyObject * \
1063 func(PyObject *v, PyObject *w) { \
1064 return binary_iop(v, w, NB_SLOT(iop), NB_SLOT(op), op_name); \
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001065 }
1066
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001067INPLACE_BINOP(PyNumber_InPlaceOr, nb_inplace_or, nb_or, "|=")
1068INPLACE_BINOP(PyNumber_InPlaceXor, nb_inplace_xor, nb_xor, "^=")
1069INPLACE_BINOP(PyNumber_InPlaceAnd, nb_inplace_and, nb_and, "&=")
1070INPLACE_BINOP(PyNumber_InPlaceLshift, nb_inplace_lshift, nb_lshift, "<<=")
1071INPLACE_BINOP(PyNumber_InPlaceRshift, nb_inplace_rshift, nb_rshift, ">>=")
1072INPLACE_BINOP(PyNumber_InPlaceSubtract, nb_inplace_subtract, nb_subtract, "-=")
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001073
1074PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001075PyNumber_InPlaceFloorDivide(PyObject *v, PyObject *w)
1076{
Guido van Rossum4668b002001-08-08 05:00:18 +00001077 return binary_iop(v, w, NB_SLOT(nb_inplace_floor_divide),
1078 NB_SLOT(nb_floor_divide), "//=");
1079}
1080
1081PyObject *
1082PyNumber_InPlaceTrueDivide(PyObject *v, PyObject *w)
1083{
Guido van Rossum4668b002001-08-08 05:00:18 +00001084 return binary_iop(v, w, NB_SLOT(nb_inplace_true_divide),
1085 NB_SLOT(nb_true_divide), "/=");
1086}
1087
1088PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001089PyNumber_InPlaceAdd(PyObject *v, PyObject *w)
1090{
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001091 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_add),
1092 NB_SLOT(nb_add));
1093 if (result == Py_NotImplemented) {
1094 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1095 Py_DECREF(result);
1096 if (m != NULL) {
1097 binaryfunc f = NULL;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001098 f = m->sq_inplace_concat;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001099 if (f == NULL)
1100 f = m->sq_concat;
1101 if (f != NULL)
1102 return (*f)(v, w);
1103 }
1104 result = binop_type_error(v, w, "+=");
Guido van Rossumbb8be932000-09-01 23:27:32 +00001105 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001106 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001107}
1108
1109PyObject *
1110PyNumber_InPlaceMultiply(PyObject *v, PyObject *w)
1111{
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001112 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_multiply),
1113 NB_SLOT(nb_multiply));
1114 if (result == Py_NotImplemented) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001115 ssizeargfunc f = NULL;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001116 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1117 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1118 Py_DECREF(result);
1119 if (mv != NULL) {
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001120 f = mv->sq_inplace_repeat;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001121 if (f == NULL)
1122 f = mv->sq_repeat;
1123 if (f != NULL)
1124 return sequence_repeat(f, v, w);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001125 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001126 else if (mw != NULL) {
1127 /* Note that the right hand operand should not be
1128 * mutated in this case so sq_inplace_repeat is not
1129 * used. */
1130 if (mw->sq_repeat)
1131 return sequence_repeat(mw->sq_repeat, w, v);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001132 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001133 result = binop_type_error(v, w, "*=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001134 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001135 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001136}
1137
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001138PyObject *
1139PyNumber_InPlaceRemainder(PyObject *v, PyObject *w)
1140{
Neil Schemenauerd46fbc32002-11-24 01:07:42 +00001141 return binary_iop(v, w, NB_SLOT(nb_inplace_remainder),
1142 NB_SLOT(nb_remainder), "%=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001143}
1144
1145PyObject *
1146PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
1147{
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001148 if (v->ob_type->tp_as_number &&
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001149 v->ob_type->tp_as_number->nb_inplace_power != NULL) {
1150 return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001151 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001152 else {
1153 return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
1154 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001155}
1156
1157
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001158/* Unary operators and functions */
Guido van Rossume15dee51995-07-18 14:12:02 +00001159
1160PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001161PyNumber_Negative(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001162{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001163 PyNumberMethods *m;
1164
1165 if (o == NULL)
1166 return null_error();
1167 m = o->ob_type->tp_as_number;
1168 if (m && m->nb_negative)
1169 return (*m->nb_negative)(o);
1170
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001171 return type_error("bad operand type for unary -: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001172}
1173
1174PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001175PyNumber_Positive(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001176{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001177 PyNumberMethods *m;
1178
1179 if (o == NULL)
1180 return null_error();
1181 m = o->ob_type->tp_as_number;
1182 if (m && m->nb_positive)
1183 return (*m->nb_positive)(o);
1184
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001185 return type_error("bad operand type for unary +: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001186}
1187
1188PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001189PyNumber_Invert(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001190{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001191 PyNumberMethods *m;
1192
1193 if (o == NULL)
1194 return null_error();
1195 m = o->ob_type->tp_as_number;
1196 if (m && m->nb_invert)
1197 return (*m->nb_invert)(o);
1198
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001199 return type_error("bad operand type for unary ~: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001200}
1201
1202PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001203PyNumber_Absolute(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001204{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001205 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001206
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001207 if (o == NULL)
1208 return null_error();
1209 m = o->ob_type->tp_as_number;
1210 if (m && m->nb_absolute)
1211 return m->nb_absolute(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001212
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001213 return type_error("bad operand type for abs(): '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001214}
1215
Guido van Rossum98297ee2007-11-06 21:34:58 +00001216/* Return a Python Int or Long from the object item
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001217 Raise TypeError if the result is not an int-or-long
Guido van Rossum98297ee2007-11-06 21:34:58 +00001218 or if the object cannot be interpreted as an index.
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001219*/
1220PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001221PyNumber_Index(PyObject *item)
1222{
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001223 PyObject *result = NULL;
1224 if (item == NULL)
1225 return null_error();
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001226 if (PyLong_Check(item)) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001227 Py_INCREF(item);
1228 return item;
1229 }
1230 if (PyIndex_Check(item)) {
Trent Nelson71792202008-04-11 23:02:37 +00001231 result = item->ob_type->tp_as_number->nb_index(item);
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001232 if (result && !PyLong_Check(result)) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001233 PyErr_Format(PyExc_TypeError,
Guido van Rossum032a2842007-02-26 05:44:27 +00001234 "__index__ returned non-int "
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001235 "(type %.200s)",
1236 result->ob_type->tp_name);
1237 Py_DECREF(result);
1238 return NULL;
1239 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001240 }
Trent Nelson71792202008-04-11 23:02:37 +00001241 else {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001242 PyErr_Format(PyExc_TypeError,
1243 "'%.200s' object cannot be interpreted "
Guido van Rossum032a2842007-02-26 05:44:27 +00001244 "as an integer", item->ob_type->tp_name);
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001245 }
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001246 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001247}
1248
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001249/* Return an error on Overflow only if err is not NULL*/
1250
1251Py_ssize_t
1252PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1253{
1254 Py_ssize_t result;
1255 PyObject *runerr;
1256 PyObject *value = PyNumber_Index(item);
1257 if (value == NULL)
1258 return -1;
1259
Christian Heimes217cfd12007-12-02 14:31:20 +00001260 /* We're done if PyLong_AsSsize_t() returns without error. */
1261 result = PyLong_AsSsize_t(value);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001262 if (result != -1 || !(runerr = PyErr_Occurred()))
1263 goto finish;
1264
1265 /* Error handling code -- only manage OverflowError differently */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001266 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001267 goto finish;
1268
1269 PyErr_Clear();
Guido van Rossum98297ee2007-11-06 21:34:58 +00001270 /* If no error-handling desired then the default clipping
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001271 is sufficient.
1272 */
1273 if (!err) {
1274 assert(PyLong_Check(value));
Guido van Rossum98297ee2007-11-06 21:34:58 +00001275 /* Whether or not it is less than or equal to
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001276 zero is determined by the sign of ob_size
1277 */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001278 if (_PyLong_Sign(value) < 0)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001279 result = PY_SSIZE_T_MIN;
1280 else
1281 result = PY_SSIZE_T_MAX;
1282 }
1283 else {
1284 /* Otherwise replace the error with caller's error object. */
1285 PyErr_Format(err,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001286 "cannot fit '%.200s' into an index-sized integer",
1287 item->ob_type->tp_name);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001288 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001289
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001290 finish:
1291 Py_DECREF(value);
1292 return result;
1293}
1294
1295
Christian Heimes15ebc882008-02-04 18:48:49 +00001296PyObject *
1297_PyNumber_ConvertIntegralToInt(PyObject *integral, const char* error_format)
1298{
1299 static PyObject *int_name = NULL;
1300 if (int_name == NULL) {
1301 int_name = PyUnicode_InternFromString("__int__");
1302 if (int_name == NULL)
1303 return NULL;
1304 }
1305
1306 if (integral && !PyLong_Check(integral)) {
1307 /* Don't go through tp_as_number->nb_int to avoid
1308 hitting the classic class fallback to __trunc__. */
1309 PyObject *int_func = PyObject_GetAttr(integral, int_name);
1310 if (int_func == NULL) {
1311 PyErr_Clear(); /* Raise a different error. */
1312 goto non_integral_error;
1313 }
1314 Py_DECREF(integral);
1315 integral = PyEval_CallObject(int_func, NULL);
1316 Py_DECREF(int_func);
1317 if (integral && !PyLong_Check(integral)) {
1318 goto non_integral_error;
1319 }
1320 }
1321 return integral;
1322
1323non_integral_error:
1324 PyErr_Format(PyExc_TypeError, error_format, Py_TYPE(integral)->tp_name);
1325 Py_DECREF(integral);
1326 return NULL;
1327}
1328
1329
Guido van Rossum9e896b32000-04-05 20:11:21 +00001330/* Add a check for embedded NULL-bytes in the argument. */
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001331static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001332long_from_string(const char *s, Py_ssize_t len)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001333{
Guido van Rossum4c08d552000-03-10 22:55:18 +00001334 char *end;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001335 PyObject *x;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001336
Guido van Rossum4c08d552000-03-10 22:55:18 +00001337 x = PyLong_FromString((char*)s, &end, 10);
Guido van Rossum9e896b32000-04-05 20:11:21 +00001338 if (x == NULL)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001339 return NULL;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001340 if (end != s + len) {
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001341 PyErr_SetString(PyExc_ValueError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001342 "null byte in argument for int()");
Guido van Rossum9e896b32000-04-05 20:11:21 +00001343 Py_DECREF(x);
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001344 return NULL;
1345 }
1346 return x;
1347}
1348
Guido van Rossume15dee51995-07-18 14:12:02 +00001349PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001350PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001351{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001352 PyNumberMethods *m;
Christian Heimes15ebc882008-02-04 18:48:49 +00001353 static PyObject *trunc_name = NULL;
1354 PyObject *trunc_func;
Guido van Rossum4c08d552000-03-10 22:55:18 +00001355 const char *buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001356 Py_ssize_t buffer_len;
Guido van Rossume15dee51995-07-18 14:12:02 +00001357
Christian Heimes15ebc882008-02-04 18:48:49 +00001358 if (trunc_name == NULL) {
1359 trunc_name = PyUnicode_InternFromString("__trunc__");
1360 if (trunc_name == NULL)
1361 return NULL;
1362 }
1363
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001364 if (o == NULL)
1365 return null_error();
Guido van Rossumddefaf32007-01-14 03:31:43 +00001366 if (PyLong_CheckExact(o)) {
1367 Py_INCREF(o);
1368 return o;
1369 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001370 m = o->ob_type->tp_as_number;
Guido van Rossumddefaf32007-01-14 03:31:43 +00001371 if (m && m->nb_int) { /* This should include subclasses of int */
1372 PyObject *res = m->nb_int(o);
1373 if (res && !PyLong_Check(res)) {
1374 PyErr_Format(PyExc_TypeError,
1375 "__int__ returned non-int (type %.200s)",
1376 res->ob_type->tp_name);
1377 Py_DECREF(res);
1378 return NULL;
1379 }
1380 return res;
1381 }
Mark Dickinsone5e298f2009-01-12 20:49:19 +00001382 if (PyLong_Check(o)) /* An int subclass without nb_int */
Tim Petersdb30ac42002-03-02 04:14:21 +00001383 return _PyLong_Copy((PyLongObject *)o);
Christian Heimes15ebc882008-02-04 18:48:49 +00001384 trunc_func = PyObject_GetAttr(o, trunc_name);
1385 if (trunc_func) {
1386 PyObject *truncated = PyEval_CallObject(trunc_func, NULL);
1387 PyObject *int_instance;
1388 Py_DECREF(trunc_func);
1389 /* __trunc__ is specified to return an Integral type,
1390 but long() needs to return a long. */
1391 int_instance = _PyNumber_ConvertIntegralToInt(
1392 truncated,
1393 "__trunc__ returned non-Integral (type %.200s)");
1394 return int_instance;
1395 }
1396 PyErr_Clear(); /* It's not an error if o.__trunc__ doesn't exist. */
1397
Christian Heimes72b710a2008-05-26 13:28:38 +00001398 if (PyBytes_Check(o))
Christian Heimes15ebc882008-02-04 18:48:49 +00001399 /* need to do extra error checking that PyLong_FromString()
1400 * doesn't do. In particular long('9.5') must raise an
1401 * exception, not truncate the float.
1402 */
Christian Heimes72b710a2008-05-26 13:28:38 +00001403 return long_from_string(PyBytes_AS_STRING(o),
1404 PyBytes_GET_SIZE(o));
Guido van Rossum9e896b32000-04-05 20:11:21 +00001405 if (PyUnicode_Check(o))
1406 /* The above check is done in PyLong_FromUnicode(). */
1407 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(o),
1408 PyUnicode_GET_SIZE(o),
1409 10);
Guido van Rossum4c08d552000-03-10 22:55:18 +00001410 if (!PyObject_AsCharBuffer(o, &buffer, &buffer_len))
1411 return long_from_string(buffer, buffer_len);
Guido van Rossume15dee51995-07-18 14:12:02 +00001412
Guido van Rossumddefaf32007-01-14 03:31:43 +00001413 return type_error("int() argument must be a string or a "
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001414 "number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001415}
1416
1417PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001418PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001419{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001420 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001421
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001422 if (o == NULL)
1423 return null_error();
Brett Cannonc3647ac2005-04-26 03:45:26 +00001424 m = o->ob_type->tp_as_number;
1425 if (m && m->nb_float) { /* This should include subclasses of float */
1426 PyObject *res = m->nb_float(o);
1427 if (res && !PyFloat_Check(res)) {
1428 PyErr_Format(PyExc_TypeError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001429 "__float__ returned non-float (type %.200s)",
1430 res->ob_type->tp_name);
Brett Cannonc3647ac2005-04-26 03:45:26 +00001431 Py_DECREF(res);
1432 return NULL;
1433 }
1434 return res;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001435 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001436 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
Tim Peters7a50f252001-09-10 21:28:20 +00001437 PyFloatObject *po = (PyFloatObject *)o;
1438 return PyFloat_FromDouble(po->ob_fval);
1439 }
Georg Brandl428f0642007-03-18 18:35:15 +00001440 return PyFloat_FromString(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001441}
1442
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001443
1444PyObject *
1445PyNumber_ToBase(PyObject *n, int base)
1446{
Christian Heimesa156e092008-02-16 07:38:31 +00001447 PyObject *res = NULL;
Raymond Hettinger5c960b82008-06-24 22:28:56 +00001448 PyObject *index = PyNumber_Index(n);
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001449
1450 if (!index)
1451 return NULL;
Christian Heimesa156e092008-02-16 07:38:31 +00001452 if (PyLong_Check(index))
1453 res = _PyLong_Format(index, base);
1454 else
1455 /* It should not be possible to get here, as
1456 PyNumber_Index already has a check for the same
1457 condition */
1458 PyErr_SetString(PyExc_ValueError, "PyNumber_ToBase: index not "
1459 "int or long");
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001460 Py_DECREF(index);
1461 return res;
1462}
1463
1464
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001465/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001466
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001467int
Fred Drake79912472000-07-09 04:06:11 +00001468PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001469{
Thomas Wouterscf297e42007-02-23 15:07:44 +00001470 if (PyObject_IsInstance(s, (PyObject *)&PyDict_Type))
1471 return 0;
Guido van Rossum8700b422001-09-07 20:20:11 +00001472 return s != NULL && s->ob_type->tp_as_sequence &&
1473 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001474}
1475
Martin v. Löwis18e16552006-02-15 17:27:45 +00001476Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001477PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001478{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001479 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001480
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001481 if (s == NULL) {
1482 null_error();
1483 return -1;
1484 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001485
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001486 m = s->ob_type->tp_as_sequence;
1487 if (m && m->sq_length)
1488 return m->sq_length(s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001489
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001490 type_error("object of type '%.200s' has no len()", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001491 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001492}
1493
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001494#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001495Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001496PySequence_Length(PyObject *s)
1497{
1498 return PySequence_Size(s);
1499}
1500#define PySequence_Length PySequence_Size
1501
Guido van Rossume15dee51995-07-18 14:12:02 +00001502PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001503PySequence_Concat(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001504{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001505 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001506
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001507 if (s == NULL || o == NULL)
1508 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001509
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001510 m = s->ob_type->tp_as_sequence;
1511 if (m && m->sq_concat)
1512 return m->sq_concat(s, o);
1513
Armin Rigofd163f92005-12-29 15:59:19 +00001514 /* Instances of user classes defining an __add__() method only
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001515 have an nb_add slot, not an sq_concat slot. So we fall back
Armin Rigofd163f92005-12-29 15:59:19 +00001516 to nb_add if both arguments appear to be sequences. */
1517 if (PySequence_Check(s) && PySequence_Check(o)) {
1518 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1519 if (result != Py_NotImplemented)
1520 return result;
1521 Py_DECREF(result);
1522 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001523 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001524}
1525
1526PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001527PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001528{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001529 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001530
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001531 if (o == NULL)
1532 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001533
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001534 m = o->ob_type->tp_as_sequence;
1535 if (m && m->sq_repeat)
1536 return m->sq_repeat(o, count);
1537
Armin Rigofd163f92005-12-29 15:59:19 +00001538 /* Instances of user classes defining a __mul__() method only
1539 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1540 to nb_multiply if o appears to be a sequence. */
1541 if (PySequence_Check(o)) {
1542 PyObject *n, *result;
Christian Heimes217cfd12007-12-02 14:31:20 +00001543 n = PyLong_FromSsize_t(count);
Armin Rigofd163f92005-12-29 15:59:19 +00001544 if (n == NULL)
1545 return NULL;
1546 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1547 Py_DECREF(n);
1548 if (result != Py_NotImplemented)
1549 return result;
1550 Py_DECREF(result);
1551 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001552 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001553}
1554
1555PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001556PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1557{
1558 PySequenceMethods *m;
1559
1560 if (s == NULL || o == NULL)
1561 return null_error();
1562
1563 m = s->ob_type->tp_as_sequence;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001564 if (m && m->sq_inplace_concat)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001565 return m->sq_inplace_concat(s, o);
1566 if (m && m->sq_concat)
1567 return m->sq_concat(s, o);
1568
Armin Rigofd163f92005-12-29 15:59:19 +00001569 if (PySequence_Check(s) && PySequence_Check(o)) {
1570 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1571 NB_SLOT(nb_add));
1572 if (result != Py_NotImplemented)
1573 return result;
1574 Py_DECREF(result);
1575 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001576 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001577}
1578
1579PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001580PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001581{
1582 PySequenceMethods *m;
1583
1584 if (o == NULL)
1585 return null_error();
1586
1587 m = o->ob_type->tp_as_sequence;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001588 if (m && m->sq_inplace_repeat)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001589 return m->sq_inplace_repeat(o, count);
1590 if (m && m->sq_repeat)
1591 return m->sq_repeat(o, count);
1592
Armin Rigofd163f92005-12-29 15:59:19 +00001593 if (PySequence_Check(o)) {
1594 PyObject *n, *result;
Christian Heimes217cfd12007-12-02 14:31:20 +00001595 n = PyLong_FromSsize_t(count);
Armin Rigofd163f92005-12-29 15:59:19 +00001596 if (n == NULL)
1597 return NULL;
1598 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1599 NB_SLOT(nb_multiply));
1600 Py_DECREF(n);
1601 if (result != Py_NotImplemented)
1602 return result;
1603 Py_DECREF(result);
1604 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001605 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001606}
1607
1608PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001609PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001610{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001611 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001612
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001613 if (s == NULL)
1614 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001615
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001616 m = s->ob_type->tp_as_sequence;
1617 if (m && m->sq_item) {
1618 if (i < 0) {
1619 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001620 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001621 if (l < 0)
1622 return NULL;
1623 i += l;
1624 }
1625 }
1626 return m->sq_item(s, i);
1627 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001628
Georg Brandl86b2fb92008-07-16 03:43:04 +00001629 return type_error("'%.200s' object does not support indexing", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001630}
1631
1632PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001633PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00001634{
Thomas Wouters1d75a792000-08-17 22:37:32 +00001635 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001636
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001637 if (!s) return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001638
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001639 mp = s->ob_type->tp_as_mapping;
1640 if (mp->mp_subscript) {
Thomas Wouters1d75a792000-08-17 22:37:32 +00001641 PyObject *res;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001642 PyObject *slice = _PySlice_FromIndices(i1, i2);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001643 if (!slice)
1644 return NULL;
1645 res = mp->mp_subscript(s, slice);
1646 Py_DECREF(slice);
1647 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001648 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001649
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001650 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001651}
1652
1653int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001654PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001655{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001656 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001657
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001658 if (s == NULL) {
1659 null_error();
1660 return -1;
1661 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001662
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001663 m = s->ob_type->tp_as_sequence;
1664 if (m && m->sq_ass_item) {
1665 if (i < 0) {
1666 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001667 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001668 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001669 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001670 i += l;
1671 }
1672 }
1673 return m->sq_ass_item(s, i, o);
1674 }
1675
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001676 type_error("'%.200s' object does not support item assignment", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001677 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001678}
1679
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001680int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001681PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001682{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001683 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001684
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001685 if (s == NULL) {
1686 null_error();
1687 return -1;
1688 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001689
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001690 m = s->ob_type->tp_as_sequence;
1691 if (m && m->sq_ass_item) {
1692 if (i < 0) {
1693 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001694 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001695 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001696 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001697 i += l;
1698 }
1699 }
1700 return m->sq_ass_item(s, i, (PyObject *)NULL);
1701 }
1702
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001703 type_error("'%.200s' object doesn't support item deletion", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001704 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001705}
1706
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001707int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001708PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001709{
Thomas Wouters1d75a792000-08-17 22:37:32 +00001710 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001711
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001712 if (s == NULL) {
1713 null_error();
1714 return -1;
1715 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001716
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001717 mp = s->ob_type->tp_as_mapping;
1718 if (mp->mp_ass_subscript) {
Thomas Wouters1d75a792000-08-17 22:37:32 +00001719 int res;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001720 PyObject *slice = _PySlice_FromIndices(i1, i2);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001721 if (!slice)
1722 return -1;
1723 res = mp->mp_ass_subscript(s, slice, o);
1724 Py_DECREF(slice);
1725 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001726 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00001727
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001728 type_error("'%.200s' object doesn't support slice assignment", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001729 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001730}
1731
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001732int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001733PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001734{
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001735 PyMappingMethods *mp;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001736
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001737 if (s == NULL) {
1738 null_error();
1739 return -1;
1740 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001741
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001742 mp = s->ob_type->tp_as_mapping;
1743 if (mp->mp_ass_subscript) {
1744 int res;
1745 PyObject *slice = _PySlice_FromIndices(i1, i2);
1746 if (!slice)
1747 return -1;
1748 res = mp->mp_ass_subscript(s, slice, NULL);
1749 Py_DECREF(slice);
1750 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001751 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001752 type_error("'%.200s' object doesn't support slice deletion", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001753 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001754}
1755
Guido van Rossume15dee51995-07-18 14:12:02 +00001756PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001757PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00001758{
Tim Peters6912d4d2001-05-05 03:56:37 +00001759 PyObject *it; /* iter(v) */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001760 Py_ssize_t n; /* guess for result tuple size */
Tim Peters6912d4d2001-05-05 03:56:37 +00001761 PyObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001762 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00001763
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001764 if (v == NULL)
1765 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001766
Tim Peters6912d4d2001-05-05 03:56:37 +00001767 /* Special-case the common tuple and list cases, for efficiency. */
Tim Peters4c3a0a32001-09-10 23:37:46 +00001768 if (PyTuple_CheckExact(v)) {
1769 /* Note that we can't know whether it's safe to return
1770 a tuple *subclass* instance as-is, hence the restriction
Tim Peters8ff70a92001-09-10 23:53:53 +00001771 to exact tuples here. In contrast, lists always make
1772 a copy, so there's no need for exactness below. */
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001773 Py_INCREF(v);
1774 return v;
Guido van Rossume15dee51995-07-18 14:12:02 +00001775 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001776 if (PyList_Check(v))
1777 return PyList_AsTuple(v);
1778
Tim Peters6912d4d2001-05-05 03:56:37 +00001779 /* Get iterator. */
1780 it = PyObject_GetIter(v);
1781 if (it == NULL)
Tim Peters1fc240e2001-10-26 05:06:50 +00001782 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001783
Tim Peters6912d4d2001-05-05 03:56:37 +00001784 /* Guess result size and allocate space. */
Christian Heimes255f53b2007-12-08 15:33:56 +00001785 n = _PyObject_LengthHint(v, 10);
Tim Peters6912d4d2001-05-05 03:56:37 +00001786 result = PyTuple_New(n);
1787 if (result == NULL)
1788 goto Fail;
1789
1790 /* Fill the tuple. */
1791 for (j = 0; ; ++j) {
1792 PyObject *item = PyIter_Next(it);
1793 if (item == NULL) {
1794 if (PyErr_Occurred())
1795 goto Fail;
1796 break;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001797 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001798 if (j >= n) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001799 Py_ssize_t oldn = n;
Raymond Hettinger4d012592004-12-16 10:38:38 +00001800 /* The over-allocation strategy can grow a bit faster
Guido van Rossum98297ee2007-11-06 21:34:58 +00001801 than for lists because unlike lists the
Raymond Hettinger4d012592004-12-16 10:38:38 +00001802 over-allocation isn't permanent -- we reclaim
1803 the excess before the end of this routine.
1804 So, grow by ten and then add 25%.
1805 */
1806 n += 10;
1807 n += n >> 2;
1808 if (n < oldn) {
1809 /* Check for overflow */
1810 PyErr_NoMemory();
Raymond Hettingere6bdb372004-12-16 15:10:21 +00001811 Py_DECREF(item);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001812 goto Fail;
Raymond Hettinger4d012592004-12-16 10:38:38 +00001813 }
Tim Peters4324aa32001-05-28 22:30:08 +00001814 if (_PyTuple_Resize(&result, n) != 0) {
Tim Peters12d0a6c2001-05-05 04:10:25 +00001815 Py_DECREF(item);
Tim Peters6912d4d2001-05-05 03:56:37 +00001816 goto Fail;
Tim Peters12d0a6c2001-05-05 04:10:25 +00001817 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001818 }
1819 PyTuple_SET_ITEM(result, j, item);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001820 }
1821
Tim Peters6912d4d2001-05-05 03:56:37 +00001822 /* Cut tuple back if guess was too large. */
1823 if (j < n &&
Tim Peters4324aa32001-05-28 22:30:08 +00001824 _PyTuple_Resize(&result, j) != 0)
Tim Peters6912d4d2001-05-05 03:56:37 +00001825 goto Fail;
1826
1827 Py_DECREF(it);
1828 return result;
1829
1830Fail:
1831 Py_XDECREF(result);
1832 Py_DECREF(it);
1833 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001834}
1835
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001836PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001837PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001838{
Tim Petersf553f892001-05-01 20:45:31 +00001839 PyObject *result; /* result list */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001840 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00001841
Guido van Rossum5dba9e81998-07-10 18:03:50 +00001842 if (v == NULL)
1843 return null_error();
1844
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +00001845 result = PyList_New(0);
1846 if (result == NULL)
Tim Petersf553f892001-05-01 20:45:31 +00001847 return NULL;
1848
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +00001849 rv = _PyList_Extend((PyListObject *)result, v);
1850 if (rv == NULL) {
1851 Py_DECREF(result);
Tim Petersf553f892001-05-01 20:45:31 +00001852 return NULL;
1853 }
Raymond Hettinger969d8c02004-03-17 05:24:23 +00001854 Py_DECREF(rv);
Tim Petersf553f892001-05-01 20:45:31 +00001855 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001856}
1857
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001858PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001859PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001860{
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001861 PyObject *it;
1862
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001863 if (v == NULL)
1864 return null_error();
1865
Michael W. Hudson2801fe12002-11-05 18:05:49 +00001866 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001867 Py_INCREF(v);
1868 return v;
1869 }
1870
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001871 it = PyObject_GetIter(v);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001872 if (it == NULL) {
1873 if (PyErr_ExceptionMatches(PyExc_TypeError))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001874 PyErr_SetString(PyExc_TypeError, m);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001875 return NULL;
1876 }
1877
Raymond Hettinger193814c2004-12-18 19:00:59 +00001878 v = PySequence_List(it);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001879 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001880
1881 return v;
1882}
1883
Tim Peters16a77ad2001-09-08 04:00:12 +00001884/* Iterate over seq. Result depends on the operation:
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001885 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
1886 PY_ITERSEARCH_INDEX: 0-based index of first occurence of obj in seq;
1887 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00001888 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
1889*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001890Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001891_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00001892{
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001893 Py_ssize_t n;
Tim Peters16a77ad2001-09-08 04:00:12 +00001894 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
1895 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00001896
Tim Peters16a77ad2001-09-08 04:00:12 +00001897 if (seq == NULL || obj == NULL) {
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001898 null_error();
1899 return -1;
1900 }
Tim Peters75f8e352001-05-05 11:33:43 +00001901
Tim Peters16a77ad2001-09-08 04:00:12 +00001902 it = PyObject_GetIter(seq);
Tim Peters75f8e352001-05-05 11:33:43 +00001903 if (it == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001904 type_error("argument of type '%.200s' is not iterable", seq);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001905 return -1;
Tim Peters75f8e352001-05-05 11:33:43 +00001906 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001907
Tim Peters16a77ad2001-09-08 04:00:12 +00001908 n = wrapped = 0;
Tim Peters75f8e352001-05-05 11:33:43 +00001909 for (;;) {
1910 int cmp;
1911 PyObject *item = PyIter_Next(it);
1912 if (item == NULL) {
1913 if (PyErr_Occurred())
1914 goto Fail;
1915 break;
1916 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001917
1918 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001919 Py_DECREF(item);
Tim Peters75f8e352001-05-05 11:33:43 +00001920 if (cmp < 0)
1921 goto Fail;
1922 if (cmp > 0) {
Tim Peters16a77ad2001-09-08 04:00:12 +00001923 switch (operation) {
1924 case PY_ITERSEARCH_COUNT:
Thomas Wouters89f507f2006-12-13 04:49:30 +00001925 if (n == PY_SSIZE_T_MAX) {
Tim Peters16a77ad2001-09-08 04:00:12 +00001926 PyErr_SetString(PyExc_OverflowError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00001927 "count exceeds C integer size");
Tim Peters16a77ad2001-09-08 04:00:12 +00001928 goto Fail;
1929 }
Thomas Wouters89f507f2006-12-13 04:49:30 +00001930 ++n;
Tim Peters16a77ad2001-09-08 04:00:12 +00001931 break;
1932
1933 case PY_ITERSEARCH_INDEX:
1934 if (wrapped) {
1935 PyErr_SetString(PyExc_OverflowError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00001936 "index exceeds C integer size");
Tim Peters16a77ad2001-09-08 04:00:12 +00001937 goto Fail;
1938 }
1939 goto Done;
1940
1941 case PY_ITERSEARCH_CONTAINS:
1942 n = 1;
1943 goto Done;
1944
1945 default:
1946 assert(!"unknown operation");
Tim Peters75f8e352001-05-05 11:33:43 +00001947 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001948 }
1949
1950 if (operation == PY_ITERSEARCH_INDEX) {
Thomas Wouters89f507f2006-12-13 04:49:30 +00001951 if (n == PY_SSIZE_T_MAX)
Tim Peters16a77ad2001-09-08 04:00:12 +00001952 wrapped = 1;
Thomas Wouters89f507f2006-12-13 04:49:30 +00001953 ++n;
Tim Peters75f8e352001-05-05 11:33:43 +00001954 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001955 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001956
1957 if (operation != PY_ITERSEARCH_INDEX)
1958 goto Done;
1959
1960 PyErr_SetString(PyExc_ValueError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001961 "sequence.index(x): x not in sequence");
Tim Peters16a77ad2001-09-08 04:00:12 +00001962 /* fall into failure code */
1963Fail:
1964 n = -1;
1965 /* fall through */
1966Done:
Tim Peters75f8e352001-05-05 11:33:43 +00001967 Py_DECREF(it);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001968 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00001969
Guido van Rossume15dee51995-07-18 14:12:02 +00001970}
1971
Tim Peters16a77ad2001-09-08 04:00:12 +00001972/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001973Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001974PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001975{
Tim Peters16a77ad2001-09-08 04:00:12 +00001976 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00001977}
1978
Tim Peterscb8d3682001-05-05 21:05:01 +00001979/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00001980 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00001981 */
1982int
1983PySequence_Contains(PyObject *seq, PyObject *ob)
1984{
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001985 Py_ssize_t result;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001986 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001987 if (sqm != NULL && sqm->sq_contains != NULL)
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001988 return (*sqm->sq_contains)(seq, ob);
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001989 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
1990 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00001991}
1992
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001993/* Backwards compatibility */
1994#undef PySequence_In
1995int
Fred Drake79912472000-07-09 04:06:11 +00001996PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001997{
1998 return PySequence_Contains(w, v);
1999}
2000
Neal Norwitz1fc4b772006-03-04 18:49:58 +00002001Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00002002PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002003{
Tim Peters16a77ad2001-09-08 04:00:12 +00002004 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00002005}
2006
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002007/* Operations on mappings */
2008
2009int
Fred Drake79912472000-07-09 04:06:11 +00002010PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002011{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002012 return o && o->ob_type->tp_as_mapping &&
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00002013 o->ob_type->tp_as_mapping->mp_subscript;
Guido van Rossume15dee51995-07-18 14:12:02 +00002014}
2015
Martin v. Löwis18e16552006-02-15 17:27:45 +00002016Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00002017PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002018{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002019 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00002020
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002021 if (o == NULL) {
2022 null_error();
2023 return -1;
2024 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002025
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002026 m = o->ob_type->tp_as_mapping;
2027 if (m && m->mp_length)
2028 return m->mp_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00002029
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002030 type_error("object of type '%.200s' has no len()", o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002031 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00002032}
2033
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002034#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00002035Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002036PyMapping_Length(PyObject *o)
2037{
2038 return PyMapping_Size(o);
2039}
2040#define PyMapping_Length PyMapping_Size
2041
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002042PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002043PyMapping_GetItemString(PyObject *o, char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002044{
2045 PyObject *okey, *r;
2046
2047 if (key == NULL)
2048 return null_error();
2049
Martin v. Löwis5b222132007-06-10 09:51:05 +00002050 okey = PyUnicode_FromString(key);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002051 if (okey == NULL)
2052 return NULL;
2053 r = PyObject_GetItem(o, okey);
2054 Py_DECREF(okey);
2055 return r;
2056}
2057
2058int
Fred Drake79912472000-07-09 04:06:11 +00002059PyMapping_SetItemString(PyObject *o, char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002060{
2061 PyObject *okey;
2062 int r;
2063
2064 if (key == NULL) {
2065 null_error();
2066 return -1;
2067 }
2068
Martin v. Löwis5b222132007-06-10 09:51:05 +00002069 okey = PyUnicode_FromString(key);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002070 if (okey == NULL)
Guido van Rossumed6219b1998-05-29 02:59:33 +00002071 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002072 r = PyObject_SetItem(o, okey, value);
2073 Py_DECREF(okey);
2074 return r;
2075}
2076
2077int
Fred Drake79912472000-07-09 04:06:11 +00002078PyMapping_HasKeyString(PyObject *o, char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002079{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002080 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002081
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002082 v = PyMapping_GetItemString(o, key);
2083 if (v) {
2084 Py_DECREF(v);
2085 return 1;
2086 }
2087 PyErr_Clear();
2088 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002089}
2090
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002091int
Fred Drake79912472000-07-09 04:06:11 +00002092PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002093{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002094 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002095
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002096 v = PyObject_GetItem(o, key);
2097 if (v) {
2098 Py_DECREF(v);
2099 return 1;
2100 }
2101 PyErr_Clear();
2102 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002103}
2104
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002105PyObject *
2106PyMapping_Keys(PyObject *o)
2107{
2108 PyObject *keys;
2109 PyObject *fast;
2110
2111 if (PyDict_CheckExact(o))
2112 return PyDict_Keys(o);
2113 keys = PyObject_CallMethod(o, "keys", NULL);
2114 if (keys == NULL)
2115 return NULL;
2116 fast = PySequence_Fast(keys, "o.keys() are not iterable");
2117 Py_DECREF(keys);
2118 return fast;
2119}
2120
2121PyObject *
2122PyMapping_Items(PyObject *o)
2123{
2124 PyObject *items;
2125 PyObject *fast;
2126
2127 if (PyDict_CheckExact(o))
2128 return PyDict_Items(o);
2129 items = PyObject_CallMethod(o, "items", NULL);
2130 if (items == NULL)
2131 return NULL;
2132 fast = PySequence_Fast(items, "o.items() are not iterable");
2133 Py_DECREF(items);
2134 return fast;
2135}
2136
2137PyObject *
2138PyMapping_Values(PyObject *o)
2139{
2140 PyObject *values;
2141 PyObject *fast;
2142
2143 if (PyDict_CheckExact(o))
2144 return PyDict_Values(o);
2145 values = PyObject_CallMethod(o, "values", NULL);
2146 if (values == NULL)
2147 return NULL;
2148 fast = PySequence_Fast(values, "o.values() are not iterable");
2149 Py_DECREF(values);
2150 return fast;
2151}
2152
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002153/* Operations on callable objects */
2154
2155/* XXX PyCallable_Check() is in object.c */
2156
Guido van Rossume15dee51995-07-18 14:12:02 +00002157PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002158PyObject_CallObject(PyObject *o, PyObject *a)
Guido van Rossume15dee51995-07-18 14:12:02 +00002159{
Guido van Rossum5560b742001-09-14 16:47:50 +00002160 return PyEval_CallObjectWithKeywords(o, a, NULL);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002161}
Guido van Rossume15dee51995-07-18 14:12:02 +00002162
2163PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002164PyObject_Call(PyObject *func, PyObject *arg, PyObject *kw)
2165{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002166 ternaryfunc call;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002167
2168 if ((call = func->ob_type->tp_call) != NULL) {
Thomas Wouters89d996e2007-09-08 17:39:28 +00002169 PyObject *result;
2170 if (Py_EnterRecursiveCall(" while calling a Python object"))
2171 return NULL;
2172 result = (*call)(func, arg, kw);
2173 Py_LeaveRecursiveCall();
Tim Peters6d6c1a32001-08-02 04:15:00 +00002174 if (result == NULL && !PyErr_Occurred())
2175 PyErr_SetString(
2176 PyExc_SystemError,
2177 "NULL result without error in PyObject_Call");
2178 return result;
2179 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002180 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
Fred Drake573395a2001-11-01 20:26:12 +00002181 func->ob_type->tp_name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002182 return NULL;
2183}
2184
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002185static PyObject*
2186call_function_tail(PyObject *callable, PyObject *args)
2187{
2188 PyObject *retval;
2189
2190 if (args == NULL)
2191 return NULL;
2192
2193 if (!PyTuple_Check(args)) {
2194 PyObject *a;
2195
2196 a = PyTuple_New(1);
2197 if (a == NULL) {
2198 Py_DECREF(args);
2199 return NULL;
2200 }
2201 PyTuple_SET_ITEM(a, 0, args);
2202 args = a;
2203 }
2204 retval = PyObject_Call(callable, args, NULL);
2205
2206 Py_DECREF(args);
2207
2208 return retval;
2209}
2210
Tim Peters6d6c1a32001-08-02 04:15:00 +00002211PyObject *
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002212PyObject_CallFunction(PyObject *callable, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002213{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002214 va_list va;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002215 PyObject *args;
Guido van Rossume15dee51995-07-18 14:12:02 +00002216
Fred Drakeb92cf062001-10-27 06:16:31 +00002217 if (callable == NULL)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002218 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002219
Fred Drakeb92cf062001-10-27 06:16:31 +00002220 if (format && *format) {
2221 va_start(va, format);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002222 args = Py_VaBuildValue(format, va);
Fred Drakeb92cf062001-10-27 06:16:31 +00002223 va_end(va);
2224 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002225 else
2226 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002227
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002228 return call_function_tail(callable, args);
2229}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002230
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002231PyObject *
2232_PyObject_CallFunction_SizeT(PyObject *callable, char *format, ...)
2233{
2234 va_list va;
2235 PyObject *args;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002236
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002237 if (callable == NULL)
2238 return null_error();
2239
2240 if (format && *format) {
2241 va_start(va, format);
2242 args = _Py_VaBuildValue_SizeT(format, va);
2243 va_end(va);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002244 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002245 else
2246 args = PyTuple_New(0);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002247
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002248 return call_function_tail(callable, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002249}
2250
2251PyObject *
Guido van Rossume15dee51995-07-18 14:12:02 +00002252PyObject_CallMethod(PyObject *o, char *name, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002253{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002254 va_list va;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002255 PyObject *args;
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002256 PyObject *func = NULL;
2257 PyObject *retval = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002258
Fred Drakeb92cf062001-10-27 06:16:31 +00002259 if (o == NULL || name == NULL)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002260 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002261
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002262 func = PyObject_GetAttrString(o, name);
2263 if (func == NULL) {
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002264 PyErr_SetString(PyExc_AttributeError, name);
2265 return 0;
2266 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002267
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002268 if (!PyCallable_Check(func)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002269 type_error("attribute of type '%.200s' is not callable", func);
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002270 goto exit;
2271 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002272
Fred Drakeb92cf062001-10-27 06:16:31 +00002273 if (format && *format) {
2274 va_start(va, format);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002275 args = Py_VaBuildValue(format, va);
Fred Drakeb92cf062001-10-27 06:16:31 +00002276 va_end(va);
2277 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002278 else
2279 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002280
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002281 retval = call_function_tail(func, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002282
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002283 exit:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002284 /* args gets consumed in call_function_tail */
2285 Py_XDECREF(func);
2286
2287 return retval;
2288}
2289
2290PyObject *
2291_PyObject_CallMethod_SizeT(PyObject *o, char *name, char *format, ...)
2292{
2293 va_list va;
2294 PyObject *args;
2295 PyObject *func = NULL;
2296 PyObject *retval = NULL;
2297
2298 if (o == NULL || name == NULL)
2299 return null_error();
2300
2301 func = PyObject_GetAttrString(o, name);
2302 if (func == NULL) {
2303 PyErr_SetString(PyExc_AttributeError, name);
2304 return 0;
2305 }
2306
2307 if (!PyCallable_Check(func)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002308 type_error("attribute of type '%.200s' is not callable", func);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002309 goto exit;
2310 }
2311
2312 if (format && *format) {
2313 va_start(va, format);
2314 args = _Py_VaBuildValue_SizeT(format, va);
2315 va_end(va);
2316 }
2317 else
2318 args = PyTuple_New(0);
2319
2320 retval = call_function_tail(func, args);
2321
2322 exit:
2323 /* args gets consumed in call_function_tail */
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002324 Py_XDECREF(func);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002325
2326 return retval;
Guido van Rossume15dee51995-07-18 14:12:02 +00002327}
Guido van Rossum823649d2001-03-21 18:40:58 +00002328
2329
Fred Drakeb421b8c2001-10-26 16:21:32 +00002330static PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002331objargs_mktuple(va_list va)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002332{
2333 int i, n = 0;
2334 va_list countva;
2335 PyObject *result, *tmp;
2336
2337#ifdef VA_LIST_IS_ARRAY
2338 memcpy(countva, va, sizeof(va_list));
2339#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002340#ifdef __va_copy
2341 __va_copy(countva, va);
2342#else
Fred Drakeb421b8c2001-10-26 16:21:32 +00002343 countva = va;
2344#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002345#endif
Fred Drakeb421b8c2001-10-26 16:21:32 +00002346
2347 while (((PyObject *)va_arg(countva, PyObject *)) != NULL)
2348 ++n;
2349 result = PyTuple_New(n);
2350 if (result != NULL && n > 0) {
2351 for (i = 0; i < n; ++i) {
2352 tmp = (PyObject *)va_arg(va, PyObject *);
2353 PyTuple_SET_ITEM(result, i, tmp);
2354 Py_INCREF(tmp);
2355 }
2356 }
2357 return result;
2358}
2359
2360PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002361PyObject_CallMethodObjArgs(PyObject *callable, PyObject *name, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002362{
2363 PyObject *args, *tmp;
2364 va_list vargs;
2365
2366 if (callable == NULL || name == NULL)
2367 return null_error();
2368
2369 callable = PyObject_GetAttr(callable, name);
2370 if (callable == NULL)
2371 return NULL;
2372
2373 /* count the args */
2374 va_start(vargs, name);
Fred Drakeb0c079e2001-10-28 02:39:03 +00002375 args = objargs_mktuple(vargs);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002376 va_end(vargs);
2377 if (args == NULL) {
2378 Py_DECREF(callable);
2379 return NULL;
2380 }
2381 tmp = PyObject_Call(callable, args, NULL);
2382 Py_DECREF(args);
2383 Py_DECREF(callable);
2384
2385 return tmp;
2386}
2387
2388PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002389PyObject_CallFunctionObjArgs(PyObject *callable, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002390{
2391 PyObject *args, *tmp;
2392 va_list vargs;
2393
2394 if (callable == NULL)
2395 return null_error();
2396
2397 /* count the args */
2398 va_start(vargs, callable);
Fred Drakeb0c079e2001-10-28 02:39:03 +00002399 args = objargs_mktuple(vargs);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002400 va_end(vargs);
2401 if (args == NULL)
2402 return NULL;
2403 tmp = PyObject_Call(callable, args, NULL);
2404 Py_DECREF(args);
2405
2406 return tmp;
2407}
2408
2409
Guido van Rossum823649d2001-03-21 18:40:58 +00002410/* isinstance(), issubclass() */
2411
Barry Warsawf16951c2002-04-23 22:45:44 +00002412/* abstract_get_bases() has logically 4 return states, with a sort of 0th
2413 * state that will almost never happen.
2414 *
2415 * 0. creating the __bases__ static string could get a MemoryError
2416 * 1. getattr(cls, '__bases__') could raise an AttributeError
2417 * 2. getattr(cls, '__bases__') could raise some other exception
2418 * 3. getattr(cls, '__bases__') could return a tuple
2419 * 4. getattr(cls, '__bases__') could return something other than a tuple
2420 *
2421 * Only state #3 is a non-error state and only it returns a non-NULL object
2422 * (it returns the retrieved tuple).
2423 *
2424 * Any raised AttributeErrors are masked by clearing the exception and
2425 * returning NULL. If an object other than a tuple comes out of __bases__,
2426 * then again, the return value is NULL. So yes, these two situations
2427 * produce exactly the same results: NULL is returned and no error is set.
2428 *
2429 * If some exception other than AttributeError is raised, then NULL is also
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002430 * returned, but the exception is not cleared. That's because we want the
Barry Warsawf16951c2002-04-23 22:45:44 +00002431 * exception to be propagated along.
2432 *
2433 * Callers are expected to test for PyErr_Occurred() when the return value
2434 * is NULL to decide whether a valid exception should be propagated or not.
2435 * When there's no exception to propagate, it's customary for the caller to
2436 * set a TypeError.
2437 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002438static PyObject *
2439abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002440{
2441 static PyObject *__bases__ = NULL;
2442 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002443
2444 if (__bases__ == NULL) {
Christian Heimesfe82e772008-01-28 02:38:20 +00002445 __bases__ = PyUnicode_InternFromString("__bases__");
Guido van Rossum823649d2001-03-21 18:40:58 +00002446 if (__bases__ == NULL)
Neil Schemenauer6b471292001-10-18 03:18:43 +00002447 return NULL;
Guido van Rossum823649d2001-03-21 18:40:58 +00002448 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002449 Py_ALLOW_RECURSION
Neil Schemenauer6b471292001-10-18 03:18:43 +00002450 bases = PyObject_GetAttr(cls, __bases__);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002451 Py_END_ALLOW_RECURSION
Barry Warsawf16951c2002-04-23 22:45:44 +00002452 if (bases == NULL) {
2453 if (PyErr_ExceptionMatches(PyExc_AttributeError))
2454 PyErr_Clear();
Neil Schemenauer6b471292001-10-18 03:18:43 +00002455 return NULL;
Guido van Rossum823649d2001-03-21 18:40:58 +00002456 }
Barry Warsawf16951c2002-04-23 22:45:44 +00002457 if (!PyTuple_Check(bases)) {
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002458 Py_DECREF(bases);
Barry Warsawf16951c2002-04-23 22:45:44 +00002459 return NULL;
2460 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002461 return bases;
2462}
2463
2464
2465static int
2466abstract_issubclass(PyObject *derived, PyObject *cls)
2467{
Antoine Pitrouec569b72008-08-26 22:40:48 +00002468 PyObject *bases = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002469 Py_ssize_t i, n;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002470 int r = 0;
2471
Antoine Pitrouec569b72008-08-26 22:40:48 +00002472 while (1) {
2473 if (derived == cls)
2474 return 1;
2475 bases = abstract_get_bases(derived);
2476 if (bases == NULL) {
2477 if (PyErr_Occurred())
2478 return -1;
2479 return 0;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002480 }
Antoine Pitrouec569b72008-08-26 22:40:48 +00002481 n = PyTuple_GET_SIZE(bases);
2482 if (n == 0) {
2483 Py_DECREF(bases);
2484 return 0;
2485 }
2486 /* Avoid recursivity in the single inheritance case */
2487 if (n == 1) {
2488 derived = PyTuple_GET_ITEM(bases, 0);
2489 Py_DECREF(bases);
2490 continue;
2491 }
2492 for (i = 0; i < n; i++) {
2493 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
2494 if (r != 0)
2495 break;
2496 }
2497 Py_DECREF(bases);
2498 return r;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002499 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002500}
2501
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002502static int
2503check_class(PyObject *cls, const char *error)
2504{
2505 PyObject *bases = abstract_get_bases(cls);
2506 if (bases == NULL) {
2507 /* Do not mask errors. */
2508 if (!PyErr_Occurred())
2509 PyErr_SetString(PyExc_TypeError, error);
2510 return 0;
2511 }
2512 Py_DECREF(bases);
2513 return -1;
2514}
2515
Brett Cannon4f653312004-03-20 22:52:14 +00002516static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002517recursive_isinstance(PyObject *inst, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002518{
2519 PyObject *icls;
2520 static PyObject *__class__ = NULL;
2521 int retval = 0;
2522
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002523 if (__class__ == NULL) {
Christian Heimesfe82e772008-01-28 02:38:20 +00002524 __class__ = PyUnicode_InternFromString("__class__");
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002525 if (__class__ == NULL)
2526 return -1;
2527 }
2528
Guido van Rossum45aecf42006-03-15 04:58:47 +00002529 if (PyType_Check(cls)) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00002530 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002531 if (retval == 0) {
2532 PyObject *c = PyObject_GetAttr(inst, __class__);
2533 if (c == NULL) {
2534 PyErr_Clear();
2535 }
2536 else {
Guido van Rossume5b130b2003-02-12 03:36:05 +00002537 if (c != (PyObject *)(inst->ob_type) &&
2538 PyType_Check(c))
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002539 retval = PyType_IsSubtype(
2540 (PyTypeObject *)c,
2541 (PyTypeObject *)cls);
2542 Py_DECREF(c);
2543 }
2544 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002545 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002546 else {
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002547 if (!check_class(cls,
2548 "isinstance() arg 2 must be a class, type,"
2549 " or tuple of classes and types"))
Neil Schemenauer6b471292001-10-18 03:18:43 +00002550 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002551 icls = PyObject_GetAttr(inst, __class__);
Neil Schemenauer6b471292001-10-18 03:18:43 +00002552 if (icls == NULL) {
2553 PyErr_Clear();
2554 retval = 0;
Guido van Rossum823649d2001-03-21 18:40:58 +00002555 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002556 else {
2557 retval = abstract_issubclass(icls, cls);
2558 Py_DECREF(icls);
2559 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002560 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002561
Guido van Rossum823649d2001-03-21 18:40:58 +00002562 return retval;
2563}
2564
2565int
Brett Cannon4f653312004-03-20 22:52:14 +00002566PyObject_IsInstance(PyObject *inst, PyObject *cls)
2567{
Christian Heimesa156e092008-02-16 07:38:31 +00002568 static PyObject *name = NULL;
Guido van Rossume7ba4952007-06-06 23:52:48 +00002569 PyObject *checker;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002570
2571 /* Quick test for an exact match */
2572 if (Py_TYPE(inst) == (PyTypeObject *)cls)
2573 return 1;
2574
Antoine Pitrouec569b72008-08-26 22:40:48 +00002575 if (PyTuple_Check(cls)) {
2576 Py_ssize_t i;
2577 Py_ssize_t n;
2578 int r = 0;
2579
2580 if (Py_EnterRecursiveCall(" in __instancecheck__"))
2581 return -1;
2582 n = PyTuple_GET_SIZE(cls);
2583 for (i = 0; i < n; ++i) {
2584 PyObject *item = PyTuple_GET_ITEM(cls, i);
2585 r = PyObject_IsInstance(inst, item);
2586 if (r != 0)
2587 /* either found it, or got an error */
2588 break;
2589 }
2590 Py_LeaveRecursiveCall();
2591 return r;
2592 }
Christian Heimesa156e092008-02-16 07:38:31 +00002593 if (name == NULL) {
2594 name = PyUnicode_InternFromString("__instancecheck__");
2595 if (name == NULL)
2596 return -1;
2597 }
2598 checker = PyObject_GetAttr(cls, name);
Christian Heimese25f35e2008-03-20 10:49:03 +00002599 if (checker == NULL && PyErr_Occurred())
2600 PyErr_Clear();
Guido van Rossumadee45e2007-05-25 17:55:52 +00002601 if (checker != NULL) {
2602 PyObject *res;
2603 int ok = -1;
Guido van Rossum29478ef2007-05-29 00:39:44 +00002604 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2605 Py_DECREF(checker);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002606 return ok;
Guido van Rossum29478ef2007-05-29 00:39:44 +00002607 }
Guido van Rossumadee45e2007-05-25 17:55:52 +00002608 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
2609 Py_LeaveRecursiveCall();
2610 Py_DECREF(checker);
2611 if (res != NULL) {
2612 ok = PyObject_IsTrue(res);
2613 Py_DECREF(res);
2614 }
2615 return ok;
2616 }
Antoine Pitrouec569b72008-08-26 22:40:48 +00002617 return recursive_isinstance(inst, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002618}
2619
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002620static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002621recursive_issubclass(PyObject *derived, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002622{
Antoine Pitrouec569b72008-08-26 22:40:48 +00002623 if (PyType_Check(cls) && PyType_Check(derived)) {
2624 /* Fast path (non-recursive) */
2625 return PyType_IsSubtype((PyTypeObject *)derived, (PyTypeObject *)cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002626 }
Antoine Pitrouec569b72008-08-26 22:40:48 +00002627 if (!check_class(derived,
2628 "issubclass() arg 1 must be a class"))
2629 return -1;
2630 if (!check_class(cls,
2631 "issubclass() arg 2 must be a class"
2632 " or tuple of classes"))
2633 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002634
Antoine Pitrouec569b72008-08-26 22:40:48 +00002635 return abstract_issubclass(derived, cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002636}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002637
Brett Cannon4f653312004-03-20 22:52:14 +00002638int
2639PyObject_IsSubclass(PyObject *derived, PyObject *cls)
2640{
Christian Heimesa156e092008-02-16 07:38:31 +00002641 static PyObject *name = NULL;
Guido van Rossumadee45e2007-05-25 17:55:52 +00002642 PyObject *t, *v, *tb;
Guido van Rossume7ba4952007-06-06 23:52:48 +00002643 PyObject *checker;
Christian Heimesa156e092008-02-16 07:38:31 +00002644
Antoine Pitrouec569b72008-08-26 22:40:48 +00002645 if (PyTuple_Check(cls)) {
2646 Py_ssize_t i;
2647 Py_ssize_t n;
2648 int r = 0;
2649
2650 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
2651 return -1;
2652 n = PyTuple_GET_SIZE(cls);
2653 for (i = 0; i < n; ++i) {
2654 PyObject *item = PyTuple_GET_ITEM(cls, i);
2655 r = PyObject_IsSubclass(derived, item);
2656 if (r != 0)
2657 /* either found it, or got an error */
2658 break;
2659 }
2660 Py_LeaveRecursiveCall();
2661 return r;
2662 }
Christian Heimesa156e092008-02-16 07:38:31 +00002663 if (name == NULL) {
2664 name = PyUnicode_InternFromString("__subclasscheck__");
2665 if (name == NULL)
2666 return -1;
2667 }
Antoine Pitrouec569b72008-08-26 22:40:48 +00002668 PyErr_Fetch(&t, &v, &tb);
Christian Heimesa156e092008-02-16 07:38:31 +00002669 checker = PyObject_GetAttr(cls, name);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002670 PyErr_Restore(t, v, tb);
2671 if (checker != NULL) {
2672 PyObject *res;
2673 int ok = -1;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002674 if (Py_EnterRecursiveCall(" in __subclasscheck__")) {
2675 Py_DECREF(checker);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002676 return ok;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002677 }
Guido van Rossumadee45e2007-05-25 17:55:52 +00002678 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
2679 Py_LeaveRecursiveCall();
2680 Py_DECREF(checker);
2681 if (res != NULL) {
2682 ok = PyObject_IsTrue(res);
2683 Py_DECREF(res);
2684 }
2685 return ok;
2686 }
Antoine Pitrouec569b72008-08-26 22:40:48 +00002687 return recursive_issubclass(derived, cls);
2688}
2689
2690int
2691_PyObject_RealIsInstance(PyObject *inst, PyObject *cls)
2692{
2693 return recursive_isinstance(inst, cls);
2694}
2695
2696int
2697_PyObject_RealIsSubclass(PyObject *derived, PyObject *cls)
2698{
2699 return recursive_issubclass(derived, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002700}
2701
2702
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002703PyObject *
2704PyObject_GetIter(PyObject *o)
2705{
2706 PyTypeObject *t = o->ob_type;
2707 getiterfunc f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002708 f = t->tp_iter;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002709 if (f == NULL) {
2710 if (PySequence_Check(o))
Guido van Rossum213c7a62001-04-23 14:08:49 +00002711 return PySeqIter_New(o);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002712 return type_error("'%.200s' object is not iterable", o);
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002713 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00002714 else {
2715 PyObject *res = (*f)(o);
2716 if (res != NULL && !PyIter_Check(res)) {
2717 PyErr_Format(PyExc_TypeError,
2718 "iter() returned non-iterator "
2719 "of type '%.100s'",
2720 res->ob_type->tp_name);
2721 Py_DECREF(res);
2722 res = NULL;
2723 }
2724 return res;
2725 }
2726}
2727
Tim Petersf4848da2001-05-05 00:14:56 +00002728/* Return next item.
2729 * If an error occurs, return NULL. PyErr_Occurred() will be true.
2730 * If the iteration terminates normally, return NULL and clear the
2731 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
2732 * will be false.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002733 * Else return the next object. PyErr_Occurred() will be false.
Tim Petersf4848da2001-05-05 00:14:56 +00002734 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002735PyObject *
2736PyIter_Next(PyObject *iter)
2737{
Tim Petersf4848da2001-05-05 00:14:56 +00002738 PyObject *result;
Tim Petersf4848da2001-05-05 00:14:56 +00002739 result = (*iter->ob_type->tp_iternext)(iter);
2740 if (result == NULL &&
2741 PyErr_Occurred() &&
2742 PyErr_ExceptionMatches(PyExc_StopIteration))
2743 PyErr_Clear();
2744 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002745}