blob: 0d40d17d65936c45d8db55f65c6261b224d08b7f [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);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000263 return 0;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000264}
Guido van Rossum4c08d552000-03-10 22:55:18 +0000265
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000266int
267PyObject_CheckReadBuffer(PyObject *obj)
268{
Guido van Rossum98297ee2007-11-06 21:34:58 +0000269 PyBufferProcs *pb = obj->ob_type->tp_as_buffer;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000270
271 if (pb == NULL ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000272 pb->bf_getbuffer == NULL)
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000273 return 0;
274 if ((*pb->bf_getbuffer)(obj, NULL, PyBUF_SIMPLE) == -1) {
275 PyErr_Clear();
276 return 0;
277 }
278 if (*pb->bf_releasebuffer != NULL)
279 (*pb->bf_releasebuffer)(obj, NULL);
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000280 return 1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000281}
282
283int PyObject_AsReadBuffer(PyObject *obj,
284 const void **buffer,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000285 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000286{
287 PyBufferProcs *pb;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000288 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000289
290 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
291 null_error();
292 return -1;
293 }
294 pb = obj->ob_type->tp_as_buffer;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000295 if (pb == NULL ||
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000296 pb->bf_getbuffer == NULL) {
Guido van Rossum4c08d552000-03-10 22:55:18 +0000297 PyErr_SetString(PyExc_TypeError,
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000298 "expected an object with a buffer interface");
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000299 return -1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000300 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000301
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000302 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE)) return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000303
304 *buffer = view.buf;
305 *buffer_len = view.len;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000306 if (pb->bf_releasebuffer != NULL)
307 (*pb->bf_releasebuffer)(obj, &view);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000308 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000309}
310
311int PyObject_AsWriteBuffer(PyObject *obj,
312 void **buffer,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000313 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000314{
315 PyBufferProcs *pb;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000316 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000317
318 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
319 null_error();
320 return -1;
321 }
322 pb = obj->ob_type->tp_as_buffer;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000323 if (pb == NULL ||
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000324 pb->bf_getbuffer == NULL ||
325 ((*pb->bf_getbuffer)(obj, &view, PyBUF_WRITABLE) != 0)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000326 PyErr_SetString(PyExc_TypeError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000327 "expected an object with a writable buffer interface");
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000328 return -1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000329 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000330
331 *buffer = view.buf;
332 *buffer_len = view.len;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000333 if (pb->bf_releasebuffer != NULL)
334 (*pb->bf_releasebuffer)(obj, &view);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000335 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000336}
337
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000338/* Buffer C-API for Python 3.0 */
339
340int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000341PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000342{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000343 if (!PyObject_CheckBuffer(obj)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000344 PyErr_Format(PyExc_TypeError,
345 "'%100s' does not have the buffer interface",
Christian Heimes90aa7642007-12-19 02:45:37 +0000346 Py_TYPE(obj)->tp_name);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000347 return -1;
348 }
349 return (*(obj->ob_type->tp_as_buffer->bf_getbuffer))(obj, view, flags);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000350}
351
352void
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000353PyObject_ReleaseBuffer(PyObject *obj, Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000354{
Guido van Rossum98297ee2007-11-06 21:34:58 +0000355 if (obj->ob_type->tp_as_buffer != NULL &&
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000356 obj->ob_type->tp_as_buffer->bf_releasebuffer != NULL) {
357 (*(obj->ob_type->tp_as_buffer->bf_releasebuffer))(obj, view);
358 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000359}
360
361
362static int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000363_IsFortranContiguous(Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000364{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000365 Py_ssize_t sd, dim;
366 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000367
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000368 if (view->ndim == 0) return 1;
369 if (view->strides == NULL) return (view->ndim == 1);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000370
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000371 sd = view->itemsize;
372 if (view->ndim == 1) return (view->shape[0] == 1 ||
373 sd == view->strides[0]);
374 for (i=0; i<view->ndim; i++) {
375 dim = view->shape[i];
376 if (dim == 0) return 1;
377 if (view->strides[i] != sd) return 0;
378 sd *= dim;
379 }
380 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000381}
382
383static int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000384_IsCContiguous(Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000385{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000386 Py_ssize_t sd, dim;
387 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000388
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000389 if (view->ndim == 0) return 1;
390 if (view->strides == NULL) return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000391
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000392 sd = view->itemsize;
393 if (view->ndim == 1) return (view->shape[0] == 1 ||
394 sd == view->strides[0]);
395 for (i=view->ndim-1; i>=0; i--) {
396 dim = view->shape[i];
397 if (dim == 0) return 1;
398 if (view->strides[i] != sd) return 0;
399 sd *= dim;
400 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000401 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000402}
403
404int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000405PyBuffer_IsContiguous(Py_buffer *view, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000406{
407
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000408 if (view->suboffsets != NULL) return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000409
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000410 if (fort == 'C')
411 return _IsCContiguous(view);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000412 else if (fort == 'F')
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000413 return _IsFortranContiguous(view);
414 else if (fort == 'A')
415 return (_IsCContiguous(view) || _IsFortranContiguous(view));
416 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000417}
418
419
Guido van Rossum98297ee2007-11-06 21:34:58 +0000420void*
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000421PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000422{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000423 char* pointer;
424 int i;
425 pointer = (char *)view->buf;
426 for (i = 0; i < view->ndim; i++) {
427 pointer += view->strides[i]*indices[i];
428 if ((view->suboffsets != NULL) && (view->suboffsets[i] >= 0)) {
429 pointer = *((char**)pointer) + view->suboffsets[i];
430 }
431 }
432 return (void*)pointer;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000433}
434
435
Guido van Rossum98297ee2007-11-06 21:34:58 +0000436void
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000437_add_one_to_index_F(int nd, Py_ssize_t *index, Py_ssize_t *shape)
438{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000439 int k;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000440
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000441 for (k=0; k<nd; k++) {
442 if (index[k] < shape[k]-1) {
443 index[k]++;
444 break;
445 }
446 else {
447 index[k] = 0;
448 }
449 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000450}
451
Guido van Rossum98297ee2007-11-06 21:34:58 +0000452void
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000453_add_one_to_index_C(int nd, Py_ssize_t *index, Py_ssize_t *shape)
454{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000455 int k;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000456
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000457 for (k=nd-1; k>=0; k--) {
458 if (index[k] < shape[k]-1) {
459 index[k]++;
460 break;
461 }
462 else {
463 index[k] = 0;
464 }
465 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000466}
467
468 /* view is not checked for consistency in either of these. It is
Guido van Rossum98297ee2007-11-06 21:34:58 +0000469 assumed that the size of the buffer is view->len in
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000470 view->len / view->itemsize elements.
471 */
472
Guido van Rossum98297ee2007-11-06 21:34:58 +0000473int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000474PyBuffer_ToContiguous(void *buf, Py_buffer *view, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000475{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000476 int k;
477 void (*addone)(int, Py_ssize_t *, Py_ssize_t *);
478 Py_ssize_t *indices, elements;
479 char *dest, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000480
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000481 if (len > view->len) {
482 len = view->len;
483 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000484
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000485 if (PyBuffer_IsContiguous(view, fort)) {
486 /* simplest copy is all that is needed */
487 memcpy(buf, view->buf, len);
488 return 0;
489 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000490
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000491 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000492
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000493 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000494 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
495 if (indices == NULL) {
496 PyErr_NoMemory();
497 return -1;
498 }
499 for (k=0; k<view->ndim;k++) {
500 indices[k] = 0;
501 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000502
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000503 if (fort == 'F') {
504 addone = _add_one_to_index_F;
505 }
506 else {
507 addone = _add_one_to_index_C;
508 }
509 dest = buf;
510 /* XXX : This is not going to be the fastest code in the world
Guido van Rossum98297ee2007-11-06 21:34:58 +0000511 several optimizations are possible.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000512 */
513 elements = len / view->itemsize;
514 while (elements--) {
515 addone(view->ndim, indices, view->shape);
516 ptr = PyBuffer_GetPointer(view, indices);
517 memcpy(dest, ptr, view->itemsize);
518 dest += view->itemsize;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000519 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000520 PyMem_Free(indices);
521 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000522}
523
524int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000525PyBuffer_FromContiguous(Py_buffer *view, void *buf, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000526{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000527 int k;
528 void (*addone)(int, Py_ssize_t *, Py_ssize_t *);
529 Py_ssize_t *indices, elements;
530 char *src, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000531
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000532 if (len > view->len) {
533 len = view->len;
534 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000535
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000536 if (PyBuffer_IsContiguous(view, fort)) {
537 /* simplest copy is all that is needed */
538 memcpy(view->buf, buf, len);
539 return 0;
540 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000541
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000542 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000543
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000544 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000545 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
546 if (indices == NULL) {
547 PyErr_NoMemory();
548 return -1;
549 }
550 for (k=0; k<view->ndim;k++) {
551 indices[k] = 0;
552 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000553
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000554 if (fort == 'F') {
555 addone = _add_one_to_index_F;
556 }
557 else {
558 addone = _add_one_to_index_C;
559 }
560 src = buf;
561 /* XXX : This is not going to be the fastest code in the world
Guido van Rossum98297ee2007-11-06 21:34:58 +0000562 several optimizations are possible.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000563 */
564 elements = len / view->itemsize;
565 while (elements--) {
566 addone(view->ndim, indices, view->shape);
567 ptr = PyBuffer_GetPointer(view, indices);
568 memcpy(ptr, src, view->itemsize);
569 src += view->itemsize;
570 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000571
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000572 PyMem_Free(indices);
573 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000574}
575
Guido van Rossum98297ee2007-11-06 21:34:58 +0000576int PyObject_CopyData(PyObject *dest, PyObject *src)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000577{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000578 Py_buffer view_dest, view_src;
579 int k;
580 Py_ssize_t *indices, elements;
581 char *dptr, *sptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000582
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000583 if (!PyObject_CheckBuffer(dest) ||
584 !PyObject_CheckBuffer(src)) {
585 PyErr_SetString(PyExc_TypeError,
586 "both destination and source must have the "\
587 "buffer interface");
588 return -1;
589 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000590
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000591 if (PyObject_GetBuffer(dest, &view_dest, PyBUF_FULL) != 0) return -1;
592 if (PyObject_GetBuffer(src, &view_src, PyBUF_FULL_RO) != 0) {
593 PyObject_ReleaseBuffer(dest, &view_dest);
594 return -1;
595 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000596
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000597 if (view_dest.len < view_src.len) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000598 PyErr_SetString(PyExc_BufferError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000599 "destination is too small to receive data from source");
600 PyObject_ReleaseBuffer(dest, &view_dest);
601 PyObject_ReleaseBuffer(src, &view_src);
602 return -1;
603 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000604
Guido van Rossum98297ee2007-11-06 21:34:58 +0000605 if ((PyBuffer_IsContiguous(&view_dest, 'C') &&
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000606 PyBuffer_IsContiguous(&view_src, 'C')) ||
Guido van Rossum98297ee2007-11-06 21:34:58 +0000607 (PyBuffer_IsContiguous(&view_dest, 'F') &&
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000608 PyBuffer_IsContiguous(&view_src, 'F'))) {
609 /* simplest copy is all that is needed */
610 memcpy(view_dest.buf, view_src.buf, view_src.len);
611 PyObject_ReleaseBuffer(dest, &view_dest);
612 PyObject_ReleaseBuffer(src, &view_src);
613 return 0;
614 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000615
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000616 /* Otherwise a more elaborate copy scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000617
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000618 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000619 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*view_src.ndim);
620 if (indices == NULL) {
621 PyErr_NoMemory();
622 PyObject_ReleaseBuffer(dest, &view_dest);
623 PyObject_ReleaseBuffer(src, &view_src);
624 return -1;
625 }
626 for (k=0; k<view_src.ndim;k++) {
627 indices[k] = 0;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000628 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000629 elements = 1;
630 for (k=0; k<view_src.ndim; k++) {
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000631 /* XXX(nnorwitz): can this overflow? */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000632 elements *= view_src.shape[k];
633 }
634 while (elements--) {
635 _add_one_to_index_C(view_src.ndim, indices, view_src.shape);
636 dptr = PyBuffer_GetPointer(&view_dest, indices);
637 sptr = PyBuffer_GetPointer(&view_src, indices);
638 memcpy(dptr, sptr, view_src.itemsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000639 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000640 PyMem_Free(indices);
641 PyObject_ReleaseBuffer(dest, &view_dest);
642 PyObject_ReleaseBuffer(src, &view_src);
643 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000644}
645
646void
647PyBuffer_FillContiguousStrides(int nd, Py_ssize_t *shape,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000648 Py_ssize_t *strides, int itemsize,
649 char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000650{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000651 int k;
652 Py_ssize_t sd;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000653
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000654 sd = itemsize;
655 if (fort == 'F') {
656 for (k=0; k<nd; k++) {
657 strides[k] = sd;
658 sd *= shape[k];
Guido van Rossum98297ee2007-11-06 21:34:58 +0000659 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000660 }
661 else {
662 for (k=nd-1; k>=0; k--) {
663 strides[k] = sd;
664 sd *= shape[k];
665 }
666 }
667 return;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000668}
669
670int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000671PyBuffer_FillInfo(Py_buffer *view, void *buf, Py_ssize_t len,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000672 int readonly, int flags)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000673{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000674 if (view == NULL) return 0;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000675 if (((flags & PyBUF_WRITABLE) == PyBUF_WRITABLE) &&
676 (readonly == 1)) {
677 PyErr_SetString(PyExc_BufferError,
678 "Object is not writable.");
679 return -1;
680 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000681
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000682 view->buf = buf;
683 view->len = len;
684 view->readonly = readonly;
685 view->itemsize = 1;
686 view->format = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000687 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT)
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000688 view->format = "B";
689 view->ndim = 1;
690 view->shape = NULL;
691 if ((flags & PyBUF_ND) == PyBUF_ND)
692 view->shape = &(view->len);
693 view->strides = NULL;
694 if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES)
695 view->strides = &(view->itemsize);
696 view->suboffsets = NULL;
697 view->internal = NULL;
698 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000699}
700
Eric Smith8fd3eba2008-02-17 19:48:00 +0000701PyObject *
702PyObject_Format(PyObject *obj, PyObject *format_spec)
703{
704 static PyObject * str__format__ = NULL;
705 PyObject *meth;
706 PyObject *empty = NULL;
707 PyObject *result = NULL;
708
709 /* Initialize cached value */
710 if (str__format__ == NULL) {
711 /* Initialize static variable needed by _PyType_Lookup */
712 str__format__ = PyUnicode_FromString("__format__");
713 if (str__format__ == NULL)
714 goto done;
715 }
716
717 /* If no format_spec is provided, use an empty string */
718 if (format_spec == NULL) {
719 empty = PyUnicode_FromUnicode(NULL, 0);
720 format_spec = empty;
721 }
722
723 /* Make sure the type is initialized. float gets initialized late */
724 if (Py_TYPE(obj)->tp_dict == NULL)
725 if (PyType_Ready(Py_TYPE(obj)) < 0)
726 goto done;
727
728 /* Find the (unbound!) __format__ method (a borrowed reference) */
729 meth = _PyType_Lookup(Py_TYPE(obj), str__format__);
730 if (meth == NULL) {
731 PyErr_Format(PyExc_TypeError,
732 "Type %.100s doesn't define __format__",
733 Py_TYPE(obj)->tp_name);
734 goto done;
735 }
736
737 /* And call it, binding it to the value */
738 result = PyObject_CallFunctionObjArgs(meth, obj, format_spec, NULL);
739
740 if (result && !PyUnicode_Check(result)) {
741 PyErr_SetString(PyExc_TypeError,
742 "__format__ method did not return string");
743 Py_DECREF(result);
744 result = NULL;
745 goto done;
746 }
747
748done:
749 Py_XDECREF(empty);
750 return result;
751}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000752/* Operations on numbers */
753
754int
Fred Drake79912472000-07-09 04:06:11 +0000755PyNumber_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +0000756{
Guido van Rossum6921eca2003-02-18 16:36:28 +0000757 return o && o->ob_type->tp_as_number &&
758 (o->ob_type->tp_as_number->nb_int ||
759 o->ob_type->tp_as_number->nb_float);
Guido van Rossume15dee51995-07-18 14:12:02 +0000760}
761
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000762/* Binary operators */
Guido van Rossume15dee51995-07-18 14:12:02 +0000763
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000764#define NB_SLOT(x) offsetof(PyNumberMethods, x)
765#define NB_BINOP(nb_methods, slot) \
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000766 (*(binaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000767#define NB_TERNOP(nb_methods, slot) \
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000768 (*(ternaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000769
770/*
771 Calling scheme used for binary operations:
772
Neal Norwitz4886cc32006-08-21 17:06:07 +0000773 Order operations are tried until either a valid result or error:
774 w.op(v,w)[*], v.op(v,w), w.op(v,w)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000775
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000776 [*] only when v->ob_type != w->ob_type && w->ob_type is a subclass of
777 v->ob_type
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000778 */
779
780static PyObject *
781binary_op1(PyObject *v, PyObject *w, const int op_slot)
Guido van Rossume15dee51995-07-18 14:12:02 +0000782{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000783 PyObject *x;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000784 binaryfunc slotv = NULL;
785 binaryfunc slotw = NULL;
786
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000787 if (v->ob_type->tp_as_number != NULL)
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000788 slotv = NB_BINOP(v->ob_type->tp_as_number, op_slot);
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000789 if (w->ob_type != v->ob_type &&
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000790 w->ob_type->tp_as_number != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000791 slotw = NB_BINOP(w->ob_type->tp_as_number, op_slot);
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000792 if (slotw == slotv)
793 slotw = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000794 }
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000795 if (slotv) {
Guido van Rossum89c42642001-10-01 17:10:18 +0000796 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
797 x = slotw(v, w);
798 if (x != Py_NotImplemented)
799 return x;
800 Py_DECREF(x); /* can't do it */
801 slotw = NULL;
802 }
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000803 x = slotv(v, w);
804 if (x != Py_NotImplemented)
805 return x;
806 Py_DECREF(x); /* can't do it */
807 }
808 if (slotw) {
809 x = slotw(v, w);
810 if (x != Py_NotImplemented)
811 return x;
812 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000813 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000814 Py_INCREF(Py_NotImplemented);
815 return Py_NotImplemented;
816}
Guido van Rossum77660912002-04-16 16:32:50 +0000817
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000818static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000819binop_type_error(PyObject *v, PyObject *w, const char *op_name)
820{
821 PyErr_Format(PyExc_TypeError,
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000822 "unsupported operand type(s) for %.100s: "
823 "'%.100s' and '%.100s'",
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000824 op_name,
825 v->ob_type->tp_name,
826 w->ob_type->tp_name);
827 return NULL;
828}
829
830static PyObject *
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000831binary_op(PyObject *v, PyObject *w, const int op_slot, const char *op_name)
832{
833 PyObject *result = binary_op1(v, w, op_slot);
834 if (result == Py_NotImplemented) {
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000835 Py_DECREF(result);
836 return binop_type_error(v, w, op_name);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000837 }
838 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000839}
840
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000841
842/*
843 Calling scheme used for ternary operations:
844
Neal Norwitz4886cc32006-08-21 17:06:07 +0000845 Order operations are tried until either a valid result or error:
846 v.op(v,w,z), w.op(v,w,z), z.op(v,w,z)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000847 */
848
849static PyObject *
850ternary_op(PyObject *v,
851 PyObject *w,
852 PyObject *z,
853 const int op_slot,
854 const char *op_name)
Guido van Rossume15dee51995-07-18 14:12:02 +0000855{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000856 PyNumberMethods *mv, *mw, *mz;
Guido van Rossum84675ac2001-09-29 01:05:03 +0000857 PyObject *x = NULL;
858 ternaryfunc slotv = NULL;
859 ternaryfunc slotw = NULL;
860 ternaryfunc slotz = NULL;
Guido van Rossum77660912002-04-16 16:32:50 +0000861
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000862 mv = v->ob_type->tp_as_number;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000863 mw = w->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000864 if (mv != NULL)
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000865 slotv = NB_TERNOP(mv, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000866 if (w->ob_type != v->ob_type &&
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000867 mw != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000868 slotw = NB_TERNOP(mw, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000869 if (slotw == slotv)
870 slotw = NULL;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000871 }
Guido van Rossum84675ac2001-09-29 01:05:03 +0000872 if (slotv) {
Guido van Rossum89c42642001-10-01 17:10:18 +0000873 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
874 x = slotw(v, w, z);
875 if (x != Py_NotImplemented)
876 return x;
877 Py_DECREF(x); /* can't do it */
878 slotw = NULL;
879 }
Guido van Rossum84675ac2001-09-29 01:05:03 +0000880 x = slotv(v, w, z);
881 if (x != Py_NotImplemented)
882 return x;
883 Py_DECREF(x); /* can't do it */
884 }
885 if (slotw) {
886 x = slotw(v, w, z);
887 if (x != Py_NotImplemented)
888 return x;
889 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000890 }
891 mz = z->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000892 if (mz != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000893 slotz = NB_TERNOP(mz, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000894 if (slotz == slotv || slotz == slotw)
895 slotz = NULL;
896 if (slotz) {
897 x = slotz(v, w, z);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000898 if (x != Py_NotImplemented)
899 return x;
Guido van Rossum84675ac2001-09-29 01:05:03 +0000900 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000901 }
902 }
903
Guido van Rossum5c66a262001-10-22 04:12:44 +0000904 if (z == Py_None)
905 PyErr_Format(
906 PyExc_TypeError,
907 "unsupported operand type(s) for ** or pow(): "
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000908 "'%.100s' and '%.100s'",
Guido van Rossum5c66a262001-10-22 04:12:44 +0000909 v->ob_type->tp_name,
910 w->ob_type->tp_name);
911 else
912 PyErr_Format(
913 PyExc_TypeError,
914 "unsupported operand type(s) for pow(): "
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000915 "'%.100s', '%.100s', '%.100s'",
Guido van Rossum5c66a262001-10-22 04:12:44 +0000916 v->ob_type->tp_name,
917 w->ob_type->tp_name,
918 z->ob_type->tp_name);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000919 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000920}
921
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000922#define BINARY_FUNC(func, op, op_name) \
923 PyObject * \
924 func(PyObject *v, PyObject *w) { \
925 return binary_op(v, w, NB_SLOT(op), op_name); \
926 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000927
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000928BINARY_FUNC(PyNumber_Or, nb_or, "|")
929BINARY_FUNC(PyNumber_Xor, nb_xor, "^")
930BINARY_FUNC(PyNumber_And, nb_and, "&")
931BINARY_FUNC(PyNumber_Lshift, nb_lshift, "<<")
932BINARY_FUNC(PyNumber_Rshift, nb_rshift, ">>")
933BINARY_FUNC(PyNumber_Subtract, nb_subtract, "-")
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000934BINARY_FUNC(PyNumber_Divmod, nb_divmod, "divmod()")
Guido van Rossume15dee51995-07-18 14:12:02 +0000935
936PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000937PyNumber_Add(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000938{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000939 PyObject *result = binary_op1(v, w, NB_SLOT(nb_add));
940 if (result == Py_NotImplemented) {
941 PySequenceMethods *m = v->ob_type->tp_as_sequence;
Armin Rigofd163f92005-12-29 15:59:19 +0000942 Py_DECREF(result);
Jeremy Hylton0522d982002-03-08 21:28:54 +0000943 if (m && m->sq_concat) {
Armin Rigofd163f92005-12-29 15:59:19 +0000944 return (*m->sq_concat)(v, w);
Jeremy Hylton0522d982002-03-08 21:28:54 +0000945 }
Armin Rigofd163f92005-12-29 15:59:19 +0000946 result = binop_type_error(v, w, "+");
Guido van Rossume15dee51995-07-18 14:12:02 +0000947 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000948 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000949}
950
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000951static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000952sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000953{
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000954 Py_ssize_t count;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000955 if (PyIndex_Check(n)) {
956 count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000957 if (count == -1 && PyErr_Occurred())
958 return NULL;
959 }
960 else {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000961 return type_error("can't multiply sequence by "
962 "non-int of type '%.200s'", n);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000963 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000964 return (*repeatfunc)(seq, count);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000965}
966
967PyObject *
968PyNumber_Multiply(PyObject *v, PyObject *w)
969{
970 PyObject *result = binary_op1(v, w, NB_SLOT(nb_multiply));
971 if (result == Py_NotImplemented) {
972 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
973 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
Guido van Rossuma3a243e2002-12-31 19:50:03 +0000974 Py_DECREF(result);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000975 if (mv && mv->sq_repeat) {
976 return sequence_repeat(mv->sq_repeat, v, w);
977 }
978 else if (mw && mw->sq_repeat) {
979 return sequence_repeat(mw->sq_repeat, w, v);
980 }
981 result = binop_type_error(v, w, "*");
982 }
983 return result;
984}
985
Guido van Rossume15dee51995-07-18 14:12:02 +0000986PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +0000987PyNumber_FloorDivide(PyObject *v, PyObject *w)
988{
Guido van Rossum4668b002001-08-08 05:00:18 +0000989 return binary_op(v, w, NB_SLOT(nb_floor_divide), "//");
990}
991
992PyObject *
993PyNumber_TrueDivide(PyObject *v, PyObject *w)
994{
Guido van Rossum4668b002001-08-08 05:00:18 +0000995 return binary_op(v, w, NB_SLOT(nb_true_divide), "/");
996}
997
998PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000999PyNumber_Remainder(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +00001000{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001001 return binary_op(v, w, NB_SLOT(nb_remainder), "%");
Guido van Rossume15dee51995-07-18 14:12:02 +00001002}
1003
1004PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001005PyNumber_Power(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossume15dee51995-07-18 14:12:02 +00001006{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001007 return ternary_op(v, w, z, NB_SLOT(nb_power), "** or pow()");
Guido van Rossume15dee51995-07-18 14:12:02 +00001008}
1009
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001010/* Binary in-place operators */
1011
1012/* The in-place operators are defined to fall back to the 'normal',
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001013 non in-place operations, if the in-place methods are not in place.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001014
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001015 - If the left hand object has the appropriate struct members, and
1016 they are filled, call the appropriate function and return the
1017 result. No coercion is done on the arguments; the left-hand object
1018 is the one the operation is performed on, and it's up to the
1019 function to deal with the right-hand object.
Guido van Rossum77660912002-04-16 16:32:50 +00001020
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001021 - Otherwise, in-place modification is not supported. Handle it exactly as
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001022 a non in-place operation of the same kind.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001023
1024 */
1025
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001026static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001027binary_iop1(PyObject *v, PyObject *w, const int iop_slot, const int op_slot)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001028{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001029 PyNumberMethods *mv = v->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001030 if (mv != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +00001031 binaryfunc slot = NB_BINOP(mv, iop_slot);
1032 if (slot) {
1033 PyObject *x = (slot)(v, w);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001034 if (x != Py_NotImplemented) {
1035 return x;
1036 }
1037 Py_DECREF(x);
1038 }
Thomas Woutersf2b332d2000-09-02 08:34:40 +00001039 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001040 return binary_op1(v, w, op_slot);
1041}
1042
1043static PyObject *
1044binary_iop(PyObject *v, PyObject *w, const int iop_slot, const int op_slot,
1045 const char *op_name)
1046{
1047 PyObject *result = binary_iop1(v, w, iop_slot, op_slot);
1048 if (result == Py_NotImplemented) {
1049 Py_DECREF(result);
1050 return binop_type_error(v, w, op_name);
1051 }
1052 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001053}
1054
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001055#define INPLACE_BINOP(func, iop, op, op_name) \
1056 PyObject * \
1057 func(PyObject *v, PyObject *w) { \
1058 return binary_iop(v, w, NB_SLOT(iop), NB_SLOT(op), op_name); \
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001059 }
1060
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001061INPLACE_BINOP(PyNumber_InPlaceOr, nb_inplace_or, nb_or, "|=")
1062INPLACE_BINOP(PyNumber_InPlaceXor, nb_inplace_xor, nb_xor, "^=")
1063INPLACE_BINOP(PyNumber_InPlaceAnd, nb_inplace_and, nb_and, "&=")
1064INPLACE_BINOP(PyNumber_InPlaceLshift, nb_inplace_lshift, nb_lshift, "<<=")
1065INPLACE_BINOP(PyNumber_InPlaceRshift, nb_inplace_rshift, nb_rshift, ">>=")
1066INPLACE_BINOP(PyNumber_InPlaceSubtract, nb_inplace_subtract, nb_subtract, "-=")
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001067
1068PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001069PyNumber_InPlaceFloorDivide(PyObject *v, PyObject *w)
1070{
Guido van Rossum4668b002001-08-08 05:00:18 +00001071 return binary_iop(v, w, NB_SLOT(nb_inplace_floor_divide),
1072 NB_SLOT(nb_floor_divide), "//=");
1073}
1074
1075PyObject *
1076PyNumber_InPlaceTrueDivide(PyObject *v, PyObject *w)
1077{
Guido van Rossum4668b002001-08-08 05:00:18 +00001078 return binary_iop(v, w, NB_SLOT(nb_inplace_true_divide),
1079 NB_SLOT(nb_true_divide), "/=");
1080}
1081
1082PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001083PyNumber_InPlaceAdd(PyObject *v, PyObject *w)
1084{
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001085 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_add),
1086 NB_SLOT(nb_add));
1087 if (result == Py_NotImplemented) {
1088 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1089 Py_DECREF(result);
1090 if (m != NULL) {
1091 binaryfunc f = NULL;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001092 f = m->sq_inplace_concat;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001093 if (f == NULL)
1094 f = m->sq_concat;
1095 if (f != NULL)
1096 return (*f)(v, w);
1097 }
1098 result = binop_type_error(v, w, "+=");
Guido van Rossumbb8be932000-09-01 23:27:32 +00001099 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001100 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001101}
1102
1103PyObject *
1104PyNumber_InPlaceMultiply(PyObject *v, PyObject *w)
1105{
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001106 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_multiply),
1107 NB_SLOT(nb_multiply));
1108 if (result == Py_NotImplemented) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001109 ssizeargfunc f = NULL;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001110 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1111 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1112 Py_DECREF(result);
1113 if (mv != NULL) {
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001114 f = mv->sq_inplace_repeat;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001115 if (f == NULL)
1116 f = mv->sq_repeat;
1117 if (f != NULL)
1118 return sequence_repeat(f, v, w);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001119 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001120 else if (mw != NULL) {
1121 /* Note that the right hand operand should not be
1122 * mutated in this case so sq_inplace_repeat is not
1123 * used. */
1124 if (mw->sq_repeat)
1125 return sequence_repeat(mw->sq_repeat, w, v);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001126 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001127 result = binop_type_error(v, w, "*=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001128 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001129 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001130}
1131
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001132PyObject *
1133PyNumber_InPlaceRemainder(PyObject *v, PyObject *w)
1134{
Neil Schemenauerd46fbc32002-11-24 01:07:42 +00001135 return binary_iop(v, w, NB_SLOT(nb_inplace_remainder),
1136 NB_SLOT(nb_remainder), "%=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001137}
1138
1139PyObject *
1140PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
1141{
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001142 if (v->ob_type->tp_as_number &&
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001143 v->ob_type->tp_as_number->nb_inplace_power != NULL) {
1144 return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001145 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001146 else {
1147 return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
1148 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001149}
1150
1151
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001152/* Unary operators and functions */
Guido van Rossume15dee51995-07-18 14:12:02 +00001153
1154PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001155PyNumber_Negative(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001156{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001157 PyNumberMethods *m;
1158
1159 if (o == NULL)
1160 return null_error();
1161 m = o->ob_type->tp_as_number;
1162 if (m && m->nb_negative)
1163 return (*m->nb_negative)(o);
1164
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001165 return type_error("bad operand type for unary -: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001166}
1167
1168PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001169PyNumber_Positive(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001170{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001171 PyNumberMethods *m;
1172
1173 if (o == NULL)
1174 return null_error();
1175 m = o->ob_type->tp_as_number;
1176 if (m && m->nb_positive)
1177 return (*m->nb_positive)(o);
1178
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001179 return type_error("bad operand type for unary +: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001180}
1181
1182PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001183PyNumber_Invert(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001184{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001185 PyNumberMethods *m;
1186
1187 if (o == NULL)
1188 return null_error();
1189 m = o->ob_type->tp_as_number;
1190 if (m && m->nb_invert)
1191 return (*m->nb_invert)(o);
1192
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001193 return type_error("bad operand type for unary ~: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001194}
1195
1196PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001197PyNumber_Absolute(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001198{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001199 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001200
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001201 if (o == NULL)
1202 return null_error();
1203 m = o->ob_type->tp_as_number;
1204 if (m && m->nb_absolute)
1205 return m->nb_absolute(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001206
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001207 return type_error("bad operand type for abs(): '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001208}
1209
Guido van Rossum98297ee2007-11-06 21:34:58 +00001210/* Return a Python Int or Long from the object item
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001211 Raise TypeError if the result is not an int-or-long
Guido van Rossum98297ee2007-11-06 21:34:58 +00001212 or if the object cannot be interpreted as an index.
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001213*/
1214PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001215PyNumber_Index(PyObject *item)
1216{
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001217 PyObject *result = NULL;
1218 if (item == NULL)
1219 return null_error();
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001220 if (PyLong_Check(item)) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001221 Py_INCREF(item);
1222 return item;
1223 }
1224 if (PyIndex_Check(item)) {
Trent Nelson71792202008-04-11 23:02:37 +00001225 result = item->ob_type->tp_as_number->nb_index(item);
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001226 if (result && !PyLong_Check(result)) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001227 PyErr_Format(PyExc_TypeError,
Guido van Rossum032a2842007-02-26 05:44:27 +00001228 "__index__ returned non-int "
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001229 "(type %.200s)",
1230 result->ob_type->tp_name);
1231 Py_DECREF(result);
1232 return NULL;
1233 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001234 }
Trent Nelson71792202008-04-11 23:02:37 +00001235 else {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001236 PyErr_Format(PyExc_TypeError,
1237 "'%.200s' object cannot be interpreted "
Guido van Rossum032a2842007-02-26 05:44:27 +00001238 "as an integer", item->ob_type->tp_name);
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001239 }
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001240 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001241}
1242
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001243/* Return an error on Overflow only if err is not NULL*/
1244
1245Py_ssize_t
1246PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1247{
1248 Py_ssize_t result;
1249 PyObject *runerr;
1250 PyObject *value = PyNumber_Index(item);
1251 if (value == NULL)
1252 return -1;
1253
Christian Heimes217cfd12007-12-02 14:31:20 +00001254 /* We're done if PyLong_AsSsize_t() returns without error. */
1255 result = PyLong_AsSsize_t(value);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001256 if (result != -1 || !(runerr = PyErr_Occurred()))
1257 goto finish;
1258
1259 /* Error handling code -- only manage OverflowError differently */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001260 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001261 goto finish;
1262
1263 PyErr_Clear();
Guido van Rossum98297ee2007-11-06 21:34:58 +00001264 /* If no error-handling desired then the default clipping
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001265 is sufficient.
1266 */
1267 if (!err) {
1268 assert(PyLong_Check(value));
Guido van Rossum98297ee2007-11-06 21:34:58 +00001269 /* Whether or not it is less than or equal to
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001270 zero is determined by the sign of ob_size
1271 */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001272 if (_PyLong_Sign(value) < 0)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001273 result = PY_SSIZE_T_MIN;
1274 else
1275 result = PY_SSIZE_T_MAX;
1276 }
1277 else {
1278 /* Otherwise replace the error with caller's error object. */
1279 PyErr_Format(err,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001280 "cannot fit '%.200s' into an index-sized integer",
1281 item->ob_type->tp_name);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001282 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001283
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001284 finish:
1285 Py_DECREF(value);
1286 return result;
1287}
1288
1289
Christian Heimes15ebc882008-02-04 18:48:49 +00001290PyObject *
1291_PyNumber_ConvertIntegralToInt(PyObject *integral, const char* error_format)
1292{
1293 static PyObject *int_name = NULL;
1294 if (int_name == NULL) {
1295 int_name = PyUnicode_InternFromString("__int__");
1296 if (int_name == NULL)
1297 return NULL;
1298 }
1299
1300 if (integral && !PyLong_Check(integral)) {
1301 /* Don't go through tp_as_number->nb_int to avoid
1302 hitting the classic class fallback to __trunc__. */
1303 PyObject *int_func = PyObject_GetAttr(integral, int_name);
1304 if (int_func == NULL) {
1305 PyErr_Clear(); /* Raise a different error. */
1306 goto non_integral_error;
1307 }
1308 Py_DECREF(integral);
1309 integral = PyEval_CallObject(int_func, NULL);
1310 Py_DECREF(int_func);
1311 if (integral && !PyLong_Check(integral)) {
1312 goto non_integral_error;
1313 }
1314 }
1315 return integral;
1316
1317non_integral_error:
1318 PyErr_Format(PyExc_TypeError, error_format, Py_TYPE(integral)->tp_name);
1319 Py_DECREF(integral);
1320 return NULL;
1321}
1322
1323
Guido van Rossum9e896b32000-04-05 20:11:21 +00001324/* Add a check for embedded NULL-bytes in the argument. */
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001325static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001326long_from_string(const char *s, Py_ssize_t len)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001327{
Guido van Rossum4c08d552000-03-10 22:55:18 +00001328 char *end;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001329 PyObject *x;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001330
Guido van Rossum4c08d552000-03-10 22:55:18 +00001331 x = PyLong_FromString((char*)s, &end, 10);
Guido van Rossum9e896b32000-04-05 20:11:21 +00001332 if (x == NULL)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001333 return NULL;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001334 if (end != s + len) {
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001335 PyErr_SetString(PyExc_ValueError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001336 "null byte in argument for int()");
Guido van Rossum9e896b32000-04-05 20:11:21 +00001337 Py_DECREF(x);
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001338 return NULL;
1339 }
1340 return x;
1341}
1342
Guido van Rossume15dee51995-07-18 14:12:02 +00001343PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001344PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001345{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001346 PyNumberMethods *m;
Christian Heimes15ebc882008-02-04 18:48:49 +00001347 static PyObject *trunc_name = NULL;
1348 PyObject *trunc_func;
Guido van Rossum4c08d552000-03-10 22:55:18 +00001349 const char *buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001350 Py_ssize_t buffer_len;
Guido van Rossume15dee51995-07-18 14:12:02 +00001351
Christian Heimes15ebc882008-02-04 18:48:49 +00001352 if (trunc_name == NULL) {
1353 trunc_name = PyUnicode_InternFromString("__trunc__");
1354 if (trunc_name == NULL)
1355 return NULL;
1356 }
1357
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001358 if (o == NULL)
1359 return null_error();
Guido van Rossumddefaf32007-01-14 03:31:43 +00001360 if (PyLong_CheckExact(o)) {
1361 Py_INCREF(o);
1362 return o;
1363 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001364 m = o->ob_type->tp_as_number;
Guido van Rossumddefaf32007-01-14 03:31:43 +00001365 if (m && m->nb_int) { /* This should include subclasses of int */
1366 PyObject *res = m->nb_int(o);
1367 if (res && !PyLong_Check(res)) {
1368 PyErr_Format(PyExc_TypeError,
1369 "__int__ returned non-int (type %.200s)",
1370 res->ob_type->tp_name);
1371 Py_DECREF(res);
1372 return NULL;
1373 }
1374 return res;
1375 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001376 if (m && m->nb_long) { /* This should include subclasses of long */
Christian Heimes15ebc882008-02-04 18:48:49 +00001377 /* Classic classes always take this branch. */
Brett Cannonc3647ac2005-04-26 03:45:26 +00001378 PyObject *res = m->nb_long(o);
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001379 if (res && !PyLong_Check(res)) {
Brett Cannonc3647ac2005-04-26 03:45:26 +00001380 PyErr_Format(PyExc_TypeError,
1381 "__long__ returned non-long (type %.200s)",
1382 res->ob_type->tp_name);
1383 Py_DECREF(res);
1384 return NULL;
1385 }
1386 return res;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001387 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001388 if (PyLong_Check(o)) /* A long subclass without nb_long */
Tim Petersdb30ac42002-03-02 04:14:21 +00001389 return _PyLong_Copy((PyLongObject *)o);
Christian Heimes15ebc882008-02-04 18:48:49 +00001390 trunc_func = PyObject_GetAttr(o, trunc_name);
1391 if (trunc_func) {
1392 PyObject *truncated = PyEval_CallObject(trunc_func, NULL);
1393 PyObject *int_instance;
1394 Py_DECREF(trunc_func);
1395 /* __trunc__ is specified to return an Integral type,
1396 but long() needs to return a long. */
1397 int_instance = _PyNumber_ConvertIntegralToInt(
1398 truncated,
1399 "__trunc__ returned non-Integral (type %.200s)");
1400 return int_instance;
1401 }
1402 PyErr_Clear(); /* It's not an error if o.__trunc__ doesn't exist. */
1403
Christian Heimes72b710a2008-05-26 13:28:38 +00001404 if (PyBytes_Check(o))
Christian Heimes15ebc882008-02-04 18:48:49 +00001405 /* need to do extra error checking that PyLong_FromString()
1406 * doesn't do. In particular long('9.5') must raise an
1407 * exception, not truncate the float.
1408 */
Christian Heimes72b710a2008-05-26 13:28:38 +00001409 return long_from_string(PyBytes_AS_STRING(o),
1410 PyBytes_GET_SIZE(o));
Guido van Rossum9e896b32000-04-05 20:11:21 +00001411 if (PyUnicode_Check(o))
1412 /* The above check is done in PyLong_FromUnicode(). */
1413 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(o),
1414 PyUnicode_GET_SIZE(o),
1415 10);
Guido van Rossum4c08d552000-03-10 22:55:18 +00001416 if (!PyObject_AsCharBuffer(o, &buffer, &buffer_len))
1417 return long_from_string(buffer, buffer_len);
Guido van Rossume15dee51995-07-18 14:12:02 +00001418
Guido van Rossumddefaf32007-01-14 03:31:43 +00001419 return type_error("int() argument must be a string or a "
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001420 "number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001421}
1422
1423PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001424PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001425{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001426 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001427
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001428 if (o == NULL)
1429 return null_error();
Brett Cannonc3647ac2005-04-26 03:45:26 +00001430 m = o->ob_type->tp_as_number;
1431 if (m && m->nb_float) { /* This should include subclasses of float */
1432 PyObject *res = m->nb_float(o);
1433 if (res && !PyFloat_Check(res)) {
1434 PyErr_Format(PyExc_TypeError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001435 "__float__ returned non-float (type %.200s)",
1436 res->ob_type->tp_name);
Brett Cannonc3647ac2005-04-26 03:45:26 +00001437 Py_DECREF(res);
1438 return NULL;
1439 }
1440 return res;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001441 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001442 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
Tim Peters7a50f252001-09-10 21:28:20 +00001443 PyFloatObject *po = (PyFloatObject *)o;
1444 return PyFloat_FromDouble(po->ob_fval);
1445 }
Georg Brandl428f0642007-03-18 18:35:15 +00001446 return PyFloat_FromString(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001447}
1448
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001449
1450PyObject *
1451PyNumber_ToBase(PyObject *n, int base)
1452{
Christian Heimesa156e092008-02-16 07:38:31 +00001453 PyObject *res = NULL;
Raymond Hettingerd11a4432008-06-22 11:39:13 +00001454 PyObject *index;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001455
Raymond Hettingerd11a4432008-06-22 11:39:13 +00001456 if (PyFloat_Check(n))
1457 return _float_to_base(n, base);
1458 index = PyNumber_Index(n);
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001459 if (!index)
1460 return NULL;
Christian Heimesa156e092008-02-16 07:38:31 +00001461 if (PyLong_Check(index))
1462 res = _PyLong_Format(index, base);
1463 else
1464 /* It should not be possible to get here, as
1465 PyNumber_Index already has a check for the same
1466 condition */
1467 PyErr_SetString(PyExc_ValueError, "PyNumber_ToBase: index not "
1468 "int or long");
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001469 Py_DECREF(index);
1470 return res;
1471}
1472
1473
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001474/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001475
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001476int
Fred Drake79912472000-07-09 04:06:11 +00001477PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001478{
Thomas Wouterscf297e42007-02-23 15:07:44 +00001479 if (PyObject_IsInstance(s, (PyObject *)&PyDict_Type))
1480 return 0;
Guido van Rossum8700b422001-09-07 20:20:11 +00001481 return s != NULL && s->ob_type->tp_as_sequence &&
1482 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001483}
1484
Martin v. Löwis18e16552006-02-15 17:27:45 +00001485Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001486PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001487{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001488 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001489
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001490 if (s == NULL) {
1491 null_error();
1492 return -1;
1493 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001494
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001495 m = s->ob_type->tp_as_sequence;
1496 if (m && m->sq_length)
1497 return m->sq_length(s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001498
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001499 type_error("object of type '%.200s' has no len()", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001500 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001501}
1502
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001503#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001504Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001505PySequence_Length(PyObject *s)
1506{
1507 return PySequence_Size(s);
1508}
1509#define PySequence_Length PySequence_Size
1510
Guido van Rossume15dee51995-07-18 14:12:02 +00001511PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001512PySequence_Concat(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001513{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001514 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001515
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001516 if (s == NULL || o == NULL)
1517 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001518
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001519 m = s->ob_type->tp_as_sequence;
1520 if (m && m->sq_concat)
1521 return m->sq_concat(s, o);
1522
Armin Rigofd163f92005-12-29 15:59:19 +00001523 /* Instances of user classes defining an __add__() method only
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001524 have an nb_add slot, not an sq_concat slot. So we fall back
Armin Rigofd163f92005-12-29 15:59:19 +00001525 to nb_add if both arguments appear to be sequences. */
1526 if (PySequence_Check(s) && PySequence_Check(o)) {
1527 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1528 if (result != Py_NotImplemented)
1529 return result;
1530 Py_DECREF(result);
1531 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001532 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001533}
1534
1535PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001536PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001537{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001538 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001539
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001540 if (o == NULL)
1541 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001542
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001543 m = o->ob_type->tp_as_sequence;
1544 if (m && m->sq_repeat)
1545 return m->sq_repeat(o, count);
1546
Armin Rigofd163f92005-12-29 15:59:19 +00001547 /* Instances of user classes defining a __mul__() method only
1548 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1549 to nb_multiply if o appears to be a sequence. */
1550 if (PySequence_Check(o)) {
1551 PyObject *n, *result;
Christian Heimes217cfd12007-12-02 14:31:20 +00001552 n = PyLong_FromSsize_t(count);
Armin Rigofd163f92005-12-29 15:59:19 +00001553 if (n == NULL)
1554 return NULL;
1555 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1556 Py_DECREF(n);
1557 if (result != Py_NotImplemented)
1558 return result;
1559 Py_DECREF(result);
1560 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001561 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001562}
1563
1564PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001565PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1566{
1567 PySequenceMethods *m;
1568
1569 if (s == NULL || o == NULL)
1570 return null_error();
1571
1572 m = s->ob_type->tp_as_sequence;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001573 if (m && m->sq_inplace_concat)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001574 return m->sq_inplace_concat(s, o);
1575 if (m && m->sq_concat)
1576 return m->sq_concat(s, o);
1577
Armin Rigofd163f92005-12-29 15:59:19 +00001578 if (PySequence_Check(s) && PySequence_Check(o)) {
1579 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1580 NB_SLOT(nb_add));
1581 if (result != Py_NotImplemented)
1582 return result;
1583 Py_DECREF(result);
1584 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001585 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001586}
1587
1588PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001589PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001590{
1591 PySequenceMethods *m;
1592
1593 if (o == NULL)
1594 return null_error();
1595
1596 m = o->ob_type->tp_as_sequence;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001597 if (m && m->sq_inplace_repeat)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001598 return m->sq_inplace_repeat(o, count);
1599 if (m && m->sq_repeat)
1600 return m->sq_repeat(o, count);
1601
Armin Rigofd163f92005-12-29 15:59:19 +00001602 if (PySequence_Check(o)) {
1603 PyObject *n, *result;
Christian Heimes217cfd12007-12-02 14:31:20 +00001604 n = PyLong_FromSsize_t(count);
Armin Rigofd163f92005-12-29 15:59:19 +00001605 if (n == NULL)
1606 return NULL;
1607 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1608 NB_SLOT(nb_multiply));
1609 Py_DECREF(n);
1610 if (result != Py_NotImplemented)
1611 return result;
1612 Py_DECREF(result);
1613 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001614 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001615}
1616
1617PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001618PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001619{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001620 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001621
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001622 if (s == NULL)
1623 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001624
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001625 m = s->ob_type->tp_as_sequence;
1626 if (m && m->sq_item) {
1627 if (i < 0) {
1628 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001629 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001630 if (l < 0)
1631 return NULL;
1632 i += l;
1633 }
1634 }
1635 return m->sq_item(s, i);
1636 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001637
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001638 return type_error("'%.200s' object is unindexable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001639}
1640
1641PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001642PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00001643{
Thomas Wouters1d75a792000-08-17 22:37:32 +00001644 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001645
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001646 if (!s) return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001647
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001648 mp = s->ob_type->tp_as_mapping;
1649 if (mp->mp_subscript) {
Thomas Wouters1d75a792000-08-17 22:37:32 +00001650 PyObject *res;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001651 PyObject *slice = _PySlice_FromIndices(i1, i2);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001652 if (!slice)
1653 return NULL;
1654 res = mp->mp_subscript(s, slice);
1655 Py_DECREF(slice);
1656 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001657 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001658
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001659 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001660}
1661
1662int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001663PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001664{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001665 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001666
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001667 if (s == NULL) {
1668 null_error();
1669 return -1;
1670 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001671
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001672 m = s->ob_type->tp_as_sequence;
1673 if (m && m->sq_ass_item) {
1674 if (i < 0) {
1675 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001676 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001677 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001678 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001679 i += l;
1680 }
1681 }
1682 return m->sq_ass_item(s, i, o);
1683 }
1684
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001685 type_error("'%.200s' object does not support item assignment", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001686 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001687}
1688
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001689int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001690PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001691{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001692 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001693
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001694 if (s == NULL) {
1695 null_error();
1696 return -1;
1697 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001698
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001699 m = s->ob_type->tp_as_sequence;
1700 if (m && m->sq_ass_item) {
1701 if (i < 0) {
1702 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001703 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001704 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001705 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001706 i += l;
1707 }
1708 }
1709 return m->sq_ass_item(s, i, (PyObject *)NULL);
1710 }
1711
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001712 type_error("'%.200s' object doesn't support item deletion", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001713 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001714}
1715
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001716int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001717PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001718{
Thomas Wouters1d75a792000-08-17 22:37:32 +00001719 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001720
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001721 if (s == NULL) {
1722 null_error();
1723 return -1;
1724 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001725
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001726 mp = s->ob_type->tp_as_mapping;
1727 if (mp->mp_ass_subscript) {
Thomas Wouters1d75a792000-08-17 22:37:32 +00001728 int res;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001729 PyObject *slice = _PySlice_FromIndices(i1, i2);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001730 if (!slice)
1731 return -1;
1732 res = mp->mp_ass_subscript(s, slice, o);
1733 Py_DECREF(slice);
1734 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001735 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00001736
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001737 type_error("'%.200s' object doesn't support slice assignment", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001738 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001739}
1740
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001741int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001742PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001743{
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001744 PyMappingMethods *mp;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001745
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001746 if (s == NULL) {
1747 null_error();
1748 return -1;
1749 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001750
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001751 mp = s->ob_type->tp_as_mapping;
1752 if (mp->mp_ass_subscript) {
1753 int res;
1754 PyObject *slice = _PySlice_FromIndices(i1, i2);
1755 if (!slice)
1756 return -1;
1757 res = mp->mp_ass_subscript(s, slice, NULL);
1758 Py_DECREF(slice);
1759 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001760 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001761 type_error("'%.200s' object doesn't support slice deletion", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001762 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001763}
1764
Guido van Rossume15dee51995-07-18 14:12:02 +00001765PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001766PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00001767{
Tim Peters6912d4d2001-05-05 03:56:37 +00001768 PyObject *it; /* iter(v) */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001769 Py_ssize_t n; /* guess for result tuple size */
Tim Peters6912d4d2001-05-05 03:56:37 +00001770 PyObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001771 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00001772
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001773 if (v == NULL)
1774 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001775
Tim Peters6912d4d2001-05-05 03:56:37 +00001776 /* Special-case the common tuple and list cases, for efficiency. */
Tim Peters4c3a0a32001-09-10 23:37:46 +00001777 if (PyTuple_CheckExact(v)) {
1778 /* Note that we can't know whether it's safe to return
1779 a tuple *subclass* instance as-is, hence the restriction
Tim Peters8ff70a92001-09-10 23:53:53 +00001780 to exact tuples here. In contrast, lists always make
1781 a copy, so there's no need for exactness below. */
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001782 Py_INCREF(v);
1783 return v;
Guido van Rossume15dee51995-07-18 14:12:02 +00001784 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001785 if (PyList_Check(v))
1786 return PyList_AsTuple(v);
1787
Tim Peters6912d4d2001-05-05 03:56:37 +00001788 /* Get iterator. */
1789 it = PyObject_GetIter(v);
1790 if (it == NULL)
Tim Peters1fc240e2001-10-26 05:06:50 +00001791 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001792
Tim Peters6912d4d2001-05-05 03:56:37 +00001793 /* Guess result size and allocate space. */
Christian Heimes255f53b2007-12-08 15:33:56 +00001794 n = _PyObject_LengthHint(v, 10);
Tim Peters6912d4d2001-05-05 03:56:37 +00001795 result = PyTuple_New(n);
1796 if (result == NULL)
1797 goto Fail;
1798
1799 /* Fill the tuple. */
1800 for (j = 0; ; ++j) {
1801 PyObject *item = PyIter_Next(it);
1802 if (item == NULL) {
1803 if (PyErr_Occurred())
1804 goto Fail;
1805 break;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001806 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001807 if (j >= n) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001808 Py_ssize_t oldn = n;
Raymond Hettinger4d012592004-12-16 10:38:38 +00001809 /* The over-allocation strategy can grow a bit faster
Guido van Rossum98297ee2007-11-06 21:34:58 +00001810 than for lists because unlike lists the
Raymond Hettinger4d012592004-12-16 10:38:38 +00001811 over-allocation isn't permanent -- we reclaim
1812 the excess before the end of this routine.
1813 So, grow by ten and then add 25%.
1814 */
1815 n += 10;
1816 n += n >> 2;
1817 if (n < oldn) {
1818 /* Check for overflow */
1819 PyErr_NoMemory();
Raymond Hettingere6bdb372004-12-16 15:10:21 +00001820 Py_DECREF(item);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001821 goto Fail;
Raymond Hettinger4d012592004-12-16 10:38:38 +00001822 }
Tim Peters4324aa32001-05-28 22:30:08 +00001823 if (_PyTuple_Resize(&result, n) != 0) {
Tim Peters12d0a6c2001-05-05 04:10:25 +00001824 Py_DECREF(item);
Tim Peters6912d4d2001-05-05 03:56:37 +00001825 goto Fail;
Tim Peters12d0a6c2001-05-05 04:10:25 +00001826 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001827 }
1828 PyTuple_SET_ITEM(result, j, item);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001829 }
1830
Tim Peters6912d4d2001-05-05 03:56:37 +00001831 /* Cut tuple back if guess was too large. */
1832 if (j < n &&
Tim Peters4324aa32001-05-28 22:30:08 +00001833 _PyTuple_Resize(&result, j) != 0)
Tim Peters6912d4d2001-05-05 03:56:37 +00001834 goto Fail;
1835
1836 Py_DECREF(it);
1837 return result;
1838
1839Fail:
1840 Py_XDECREF(result);
1841 Py_DECREF(it);
1842 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001843}
1844
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001845PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001846PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001847{
Tim Petersf553f892001-05-01 20:45:31 +00001848 PyObject *result; /* result list */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001849 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00001850
Guido van Rossum5dba9e81998-07-10 18:03:50 +00001851 if (v == NULL)
1852 return null_error();
1853
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +00001854 result = PyList_New(0);
1855 if (result == NULL)
Tim Petersf553f892001-05-01 20:45:31 +00001856 return NULL;
1857
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +00001858 rv = _PyList_Extend((PyListObject *)result, v);
1859 if (rv == NULL) {
1860 Py_DECREF(result);
Tim Petersf553f892001-05-01 20:45:31 +00001861 return NULL;
1862 }
Raymond Hettinger969d8c02004-03-17 05:24:23 +00001863 Py_DECREF(rv);
Tim Petersf553f892001-05-01 20:45:31 +00001864 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001865}
1866
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001867PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001868PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001869{
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001870 PyObject *it;
1871
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001872 if (v == NULL)
1873 return null_error();
1874
Michael W. Hudson2801fe12002-11-05 18:05:49 +00001875 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001876 Py_INCREF(v);
1877 return v;
1878 }
1879
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001880 it = PyObject_GetIter(v);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001881 if (it == NULL) {
1882 if (PyErr_ExceptionMatches(PyExc_TypeError))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001883 PyErr_SetString(PyExc_TypeError, m);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001884 return NULL;
1885 }
1886
Raymond Hettinger193814c2004-12-18 19:00:59 +00001887 v = PySequence_List(it);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001888 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001889
1890 return v;
1891}
1892
Tim Peters16a77ad2001-09-08 04:00:12 +00001893/* Iterate over seq. Result depends on the operation:
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001894 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
1895 PY_ITERSEARCH_INDEX: 0-based index of first occurence of obj in seq;
1896 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00001897 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
1898*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001899Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001900_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00001901{
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001902 Py_ssize_t n;
Tim Peters16a77ad2001-09-08 04:00:12 +00001903 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
1904 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00001905
Tim Peters16a77ad2001-09-08 04:00:12 +00001906 if (seq == NULL || obj == NULL) {
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001907 null_error();
1908 return -1;
1909 }
Tim Peters75f8e352001-05-05 11:33:43 +00001910
Tim Peters16a77ad2001-09-08 04:00:12 +00001911 it = PyObject_GetIter(seq);
Tim Peters75f8e352001-05-05 11:33:43 +00001912 if (it == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001913 type_error("argument of type '%.200s' is not iterable", seq);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001914 return -1;
Tim Peters75f8e352001-05-05 11:33:43 +00001915 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001916
Tim Peters16a77ad2001-09-08 04:00:12 +00001917 n = wrapped = 0;
Tim Peters75f8e352001-05-05 11:33:43 +00001918 for (;;) {
1919 int cmp;
1920 PyObject *item = PyIter_Next(it);
1921 if (item == NULL) {
1922 if (PyErr_Occurred())
1923 goto Fail;
1924 break;
1925 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001926
1927 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001928 Py_DECREF(item);
Tim Peters75f8e352001-05-05 11:33:43 +00001929 if (cmp < 0)
1930 goto Fail;
1931 if (cmp > 0) {
Tim Peters16a77ad2001-09-08 04:00:12 +00001932 switch (operation) {
1933 case PY_ITERSEARCH_COUNT:
Thomas Wouters89f507f2006-12-13 04:49:30 +00001934 if (n == PY_SSIZE_T_MAX) {
Tim Peters16a77ad2001-09-08 04:00:12 +00001935 PyErr_SetString(PyExc_OverflowError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00001936 "count exceeds C integer size");
Tim Peters16a77ad2001-09-08 04:00:12 +00001937 goto Fail;
1938 }
Thomas Wouters89f507f2006-12-13 04:49:30 +00001939 ++n;
Tim Peters16a77ad2001-09-08 04:00:12 +00001940 break;
1941
1942 case PY_ITERSEARCH_INDEX:
1943 if (wrapped) {
1944 PyErr_SetString(PyExc_OverflowError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00001945 "index exceeds C integer size");
Tim Peters16a77ad2001-09-08 04:00:12 +00001946 goto Fail;
1947 }
1948 goto Done;
1949
1950 case PY_ITERSEARCH_CONTAINS:
1951 n = 1;
1952 goto Done;
1953
1954 default:
1955 assert(!"unknown operation");
Tim Peters75f8e352001-05-05 11:33:43 +00001956 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001957 }
1958
1959 if (operation == PY_ITERSEARCH_INDEX) {
Thomas Wouters89f507f2006-12-13 04:49:30 +00001960 if (n == PY_SSIZE_T_MAX)
Tim Peters16a77ad2001-09-08 04:00:12 +00001961 wrapped = 1;
Thomas Wouters89f507f2006-12-13 04:49:30 +00001962 ++n;
Tim Peters75f8e352001-05-05 11:33:43 +00001963 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001964 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001965
1966 if (operation != PY_ITERSEARCH_INDEX)
1967 goto Done;
1968
1969 PyErr_SetString(PyExc_ValueError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001970 "sequence.index(x): x not in sequence");
Tim Peters16a77ad2001-09-08 04:00:12 +00001971 /* fall into failure code */
1972Fail:
1973 n = -1;
1974 /* fall through */
1975Done:
Tim Peters75f8e352001-05-05 11:33:43 +00001976 Py_DECREF(it);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001977 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00001978
Guido van Rossume15dee51995-07-18 14:12:02 +00001979}
1980
Tim Peters16a77ad2001-09-08 04:00:12 +00001981/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001982Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001983PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001984{
Tim Peters16a77ad2001-09-08 04:00:12 +00001985 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00001986}
1987
Tim Peterscb8d3682001-05-05 21:05:01 +00001988/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00001989 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00001990 */
1991int
1992PySequence_Contains(PyObject *seq, PyObject *ob)
1993{
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001994 Py_ssize_t result;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001995 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001996 if (sqm != NULL && sqm->sq_contains != NULL)
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001997 return (*sqm->sq_contains)(seq, ob);
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001998 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
1999 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00002000}
2001
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002002/* Backwards compatibility */
2003#undef PySequence_In
2004int
Fred Drake79912472000-07-09 04:06:11 +00002005PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002006{
2007 return PySequence_Contains(w, v);
2008}
2009
Neal Norwitz1fc4b772006-03-04 18:49:58 +00002010Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00002011PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002012{
Tim Peters16a77ad2001-09-08 04:00:12 +00002013 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00002014}
2015
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002016/* Operations on mappings */
2017
2018int
Fred Drake79912472000-07-09 04:06:11 +00002019PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002020{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002021 return o && o->ob_type->tp_as_mapping &&
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00002022 o->ob_type->tp_as_mapping->mp_subscript;
Guido van Rossume15dee51995-07-18 14:12:02 +00002023}
2024
Martin v. Löwis18e16552006-02-15 17:27:45 +00002025Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00002026PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002027{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002028 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00002029
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002030 if (o == NULL) {
2031 null_error();
2032 return -1;
2033 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002034
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002035 m = o->ob_type->tp_as_mapping;
2036 if (m && m->mp_length)
2037 return m->mp_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00002038
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002039 type_error("object of type '%.200s' has no len()", o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002040 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00002041}
2042
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002043#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00002044Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002045PyMapping_Length(PyObject *o)
2046{
2047 return PyMapping_Size(o);
2048}
2049#define PyMapping_Length PyMapping_Size
2050
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002051PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002052PyMapping_GetItemString(PyObject *o, char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002053{
2054 PyObject *okey, *r;
2055
2056 if (key == NULL)
2057 return null_error();
2058
Martin v. Löwis5b222132007-06-10 09:51:05 +00002059 okey = PyUnicode_FromString(key);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002060 if (okey == NULL)
2061 return NULL;
2062 r = PyObject_GetItem(o, okey);
2063 Py_DECREF(okey);
2064 return r;
2065}
2066
2067int
Fred Drake79912472000-07-09 04:06:11 +00002068PyMapping_SetItemString(PyObject *o, char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002069{
2070 PyObject *okey;
2071 int r;
2072
2073 if (key == NULL) {
2074 null_error();
2075 return -1;
2076 }
2077
Martin v. Löwis5b222132007-06-10 09:51:05 +00002078 okey = PyUnicode_FromString(key);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002079 if (okey == NULL)
Guido van Rossumed6219b1998-05-29 02:59:33 +00002080 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002081 r = PyObject_SetItem(o, okey, value);
2082 Py_DECREF(okey);
2083 return r;
2084}
2085
2086int
Fred Drake79912472000-07-09 04:06:11 +00002087PyMapping_HasKeyString(PyObject *o, char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002088{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002089 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002090
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002091 v = PyMapping_GetItemString(o, key);
2092 if (v) {
2093 Py_DECREF(v);
2094 return 1;
2095 }
2096 PyErr_Clear();
2097 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002098}
2099
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002100int
Fred Drake79912472000-07-09 04:06:11 +00002101PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002102{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002103 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002104
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002105 v = PyObject_GetItem(o, key);
2106 if (v) {
2107 Py_DECREF(v);
2108 return 1;
2109 }
2110 PyErr_Clear();
2111 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002112}
2113
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002114PyObject *
2115PyMapping_Keys(PyObject *o)
2116{
2117 PyObject *keys;
2118 PyObject *fast;
2119
2120 if (PyDict_CheckExact(o))
2121 return PyDict_Keys(o);
2122 keys = PyObject_CallMethod(o, "keys", NULL);
2123 if (keys == NULL)
2124 return NULL;
2125 fast = PySequence_Fast(keys, "o.keys() are not iterable");
2126 Py_DECREF(keys);
2127 return fast;
2128}
2129
2130PyObject *
2131PyMapping_Items(PyObject *o)
2132{
2133 PyObject *items;
2134 PyObject *fast;
2135
2136 if (PyDict_CheckExact(o))
2137 return PyDict_Items(o);
2138 items = PyObject_CallMethod(o, "items", NULL);
2139 if (items == NULL)
2140 return NULL;
2141 fast = PySequence_Fast(items, "o.items() are not iterable");
2142 Py_DECREF(items);
2143 return fast;
2144}
2145
2146PyObject *
2147PyMapping_Values(PyObject *o)
2148{
2149 PyObject *values;
2150 PyObject *fast;
2151
2152 if (PyDict_CheckExact(o))
2153 return PyDict_Values(o);
2154 values = PyObject_CallMethod(o, "values", NULL);
2155 if (values == NULL)
2156 return NULL;
2157 fast = PySequence_Fast(values, "o.values() are not iterable");
2158 Py_DECREF(values);
2159 return fast;
2160}
2161
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002162/* Operations on callable objects */
2163
2164/* XXX PyCallable_Check() is in object.c */
2165
Guido van Rossume15dee51995-07-18 14:12:02 +00002166PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002167PyObject_CallObject(PyObject *o, PyObject *a)
Guido van Rossume15dee51995-07-18 14:12:02 +00002168{
Guido van Rossum5560b742001-09-14 16:47:50 +00002169 return PyEval_CallObjectWithKeywords(o, a, NULL);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002170}
Guido van Rossume15dee51995-07-18 14:12:02 +00002171
2172PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002173PyObject_Call(PyObject *func, PyObject *arg, PyObject *kw)
2174{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002175 ternaryfunc call;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002176
2177 if ((call = func->ob_type->tp_call) != NULL) {
Thomas Wouters89d996e2007-09-08 17:39:28 +00002178 PyObject *result;
2179 if (Py_EnterRecursiveCall(" while calling a Python object"))
2180 return NULL;
2181 result = (*call)(func, arg, kw);
2182 Py_LeaveRecursiveCall();
Tim Peters6d6c1a32001-08-02 04:15:00 +00002183 if (result == NULL && !PyErr_Occurred())
2184 PyErr_SetString(
2185 PyExc_SystemError,
2186 "NULL result without error in PyObject_Call");
2187 return result;
2188 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002189 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
Fred Drake573395a2001-11-01 20:26:12 +00002190 func->ob_type->tp_name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002191 return NULL;
2192}
2193
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002194static PyObject*
2195call_function_tail(PyObject *callable, PyObject *args)
2196{
2197 PyObject *retval;
2198
2199 if (args == NULL)
2200 return NULL;
2201
2202 if (!PyTuple_Check(args)) {
2203 PyObject *a;
2204
2205 a = PyTuple_New(1);
2206 if (a == NULL) {
2207 Py_DECREF(args);
2208 return NULL;
2209 }
2210 PyTuple_SET_ITEM(a, 0, args);
2211 args = a;
2212 }
2213 retval = PyObject_Call(callable, args, NULL);
2214
2215 Py_DECREF(args);
2216
2217 return retval;
2218}
2219
Tim Peters6d6c1a32001-08-02 04:15:00 +00002220PyObject *
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002221PyObject_CallFunction(PyObject *callable, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002222{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002223 va_list va;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002224 PyObject *args;
Guido van Rossume15dee51995-07-18 14:12:02 +00002225
Fred Drakeb92cf062001-10-27 06:16:31 +00002226 if (callable == NULL)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002227 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002228
Fred Drakeb92cf062001-10-27 06:16:31 +00002229 if (format && *format) {
2230 va_start(va, format);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002231 args = Py_VaBuildValue(format, va);
Fred Drakeb92cf062001-10-27 06:16:31 +00002232 va_end(va);
2233 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002234 else
2235 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002236
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002237 return call_function_tail(callable, args);
2238}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002239
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002240PyObject *
2241_PyObject_CallFunction_SizeT(PyObject *callable, char *format, ...)
2242{
2243 va_list va;
2244 PyObject *args;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002245
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002246 if (callable == NULL)
2247 return null_error();
2248
2249 if (format && *format) {
2250 va_start(va, format);
2251 args = _Py_VaBuildValue_SizeT(format, va);
2252 va_end(va);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002253 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002254 else
2255 args = PyTuple_New(0);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002256
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002257 return call_function_tail(callable, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002258}
2259
2260PyObject *
Guido van Rossume15dee51995-07-18 14:12:02 +00002261PyObject_CallMethod(PyObject *o, char *name, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002262{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002263 va_list va;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002264 PyObject *args;
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002265 PyObject *func = NULL;
2266 PyObject *retval = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002267
Fred Drakeb92cf062001-10-27 06:16:31 +00002268 if (o == NULL || name == NULL)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002269 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002270
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002271 func = PyObject_GetAttrString(o, name);
2272 if (func == NULL) {
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002273 PyErr_SetString(PyExc_AttributeError, name);
2274 return 0;
2275 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002276
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002277 if (!PyCallable_Check(func)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002278 type_error("attribute of type '%.200s' is not callable", func);
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002279 goto exit;
2280 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002281
Fred Drakeb92cf062001-10-27 06:16:31 +00002282 if (format && *format) {
2283 va_start(va, format);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002284 args = Py_VaBuildValue(format, va);
Fred Drakeb92cf062001-10-27 06:16:31 +00002285 va_end(va);
2286 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002287 else
2288 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002289
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002290 retval = call_function_tail(func, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002291
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002292 exit:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002293 /* args gets consumed in call_function_tail */
2294 Py_XDECREF(func);
2295
2296 return retval;
2297}
2298
2299PyObject *
2300_PyObject_CallMethod_SizeT(PyObject *o, char *name, char *format, ...)
2301{
2302 va_list va;
2303 PyObject *args;
2304 PyObject *func = NULL;
2305 PyObject *retval = NULL;
2306
2307 if (o == NULL || name == NULL)
2308 return null_error();
2309
2310 func = PyObject_GetAttrString(o, name);
2311 if (func == NULL) {
2312 PyErr_SetString(PyExc_AttributeError, name);
2313 return 0;
2314 }
2315
2316 if (!PyCallable_Check(func)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002317 type_error("attribute of type '%.200s' is not callable", func);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002318 goto exit;
2319 }
2320
2321 if (format && *format) {
2322 va_start(va, format);
2323 args = _Py_VaBuildValue_SizeT(format, va);
2324 va_end(va);
2325 }
2326 else
2327 args = PyTuple_New(0);
2328
2329 retval = call_function_tail(func, args);
2330
2331 exit:
2332 /* args gets consumed in call_function_tail */
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002333 Py_XDECREF(func);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002334
2335 return retval;
Guido van Rossume15dee51995-07-18 14:12:02 +00002336}
Guido van Rossum823649d2001-03-21 18:40:58 +00002337
2338
Fred Drakeb421b8c2001-10-26 16:21:32 +00002339static PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002340objargs_mktuple(va_list va)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002341{
2342 int i, n = 0;
2343 va_list countva;
2344 PyObject *result, *tmp;
2345
2346#ifdef VA_LIST_IS_ARRAY
2347 memcpy(countva, va, sizeof(va_list));
2348#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002349#ifdef __va_copy
2350 __va_copy(countva, va);
2351#else
Fred Drakeb421b8c2001-10-26 16:21:32 +00002352 countva = va;
2353#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002354#endif
Fred Drakeb421b8c2001-10-26 16:21:32 +00002355
2356 while (((PyObject *)va_arg(countva, PyObject *)) != NULL)
2357 ++n;
2358 result = PyTuple_New(n);
2359 if (result != NULL && n > 0) {
2360 for (i = 0; i < n; ++i) {
2361 tmp = (PyObject *)va_arg(va, PyObject *);
2362 PyTuple_SET_ITEM(result, i, tmp);
2363 Py_INCREF(tmp);
2364 }
2365 }
2366 return result;
2367}
2368
2369PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002370PyObject_CallMethodObjArgs(PyObject *callable, PyObject *name, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002371{
2372 PyObject *args, *tmp;
2373 va_list vargs;
2374
2375 if (callable == NULL || name == NULL)
2376 return null_error();
2377
2378 callable = PyObject_GetAttr(callable, name);
2379 if (callable == NULL)
2380 return NULL;
2381
2382 /* count the args */
2383 va_start(vargs, name);
Fred Drakeb0c079e2001-10-28 02:39:03 +00002384 args = objargs_mktuple(vargs);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002385 va_end(vargs);
2386 if (args == NULL) {
2387 Py_DECREF(callable);
2388 return NULL;
2389 }
2390 tmp = PyObject_Call(callable, args, NULL);
2391 Py_DECREF(args);
2392 Py_DECREF(callable);
2393
2394 return tmp;
2395}
2396
2397PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002398PyObject_CallFunctionObjArgs(PyObject *callable, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002399{
2400 PyObject *args, *tmp;
2401 va_list vargs;
2402
2403 if (callable == NULL)
2404 return null_error();
2405
2406 /* count the args */
2407 va_start(vargs, callable);
Fred Drakeb0c079e2001-10-28 02:39:03 +00002408 args = objargs_mktuple(vargs);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002409 va_end(vargs);
2410 if (args == NULL)
2411 return NULL;
2412 tmp = PyObject_Call(callable, args, NULL);
2413 Py_DECREF(args);
2414
2415 return tmp;
2416}
2417
2418
Guido van Rossum823649d2001-03-21 18:40:58 +00002419/* isinstance(), issubclass() */
2420
Barry Warsawf16951c2002-04-23 22:45:44 +00002421/* abstract_get_bases() has logically 4 return states, with a sort of 0th
2422 * state that will almost never happen.
2423 *
2424 * 0. creating the __bases__ static string could get a MemoryError
2425 * 1. getattr(cls, '__bases__') could raise an AttributeError
2426 * 2. getattr(cls, '__bases__') could raise some other exception
2427 * 3. getattr(cls, '__bases__') could return a tuple
2428 * 4. getattr(cls, '__bases__') could return something other than a tuple
2429 *
2430 * Only state #3 is a non-error state and only it returns a non-NULL object
2431 * (it returns the retrieved tuple).
2432 *
2433 * Any raised AttributeErrors are masked by clearing the exception and
2434 * returning NULL. If an object other than a tuple comes out of __bases__,
2435 * then again, the return value is NULL. So yes, these two situations
2436 * produce exactly the same results: NULL is returned and no error is set.
2437 *
2438 * If some exception other than AttributeError is raised, then NULL is also
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002439 * returned, but the exception is not cleared. That's because we want the
Barry Warsawf16951c2002-04-23 22:45:44 +00002440 * exception to be propagated along.
2441 *
2442 * Callers are expected to test for PyErr_Occurred() when the return value
2443 * is NULL to decide whether a valid exception should be propagated or not.
2444 * When there's no exception to propagate, it's customary for the caller to
2445 * set a TypeError.
2446 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002447static PyObject *
2448abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002449{
2450 static PyObject *__bases__ = NULL;
2451 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002452
2453 if (__bases__ == NULL) {
Christian Heimesfe82e772008-01-28 02:38:20 +00002454 __bases__ = PyUnicode_InternFromString("__bases__");
Guido van Rossum823649d2001-03-21 18:40:58 +00002455 if (__bases__ == NULL)
Neil Schemenauer6b471292001-10-18 03:18:43 +00002456 return NULL;
Guido van Rossum823649d2001-03-21 18:40:58 +00002457 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002458 Py_ALLOW_RECURSION
Neil Schemenauer6b471292001-10-18 03:18:43 +00002459 bases = PyObject_GetAttr(cls, __bases__);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002460 Py_END_ALLOW_RECURSION
Barry Warsawf16951c2002-04-23 22:45:44 +00002461 if (bases == NULL) {
2462 if (PyErr_ExceptionMatches(PyExc_AttributeError))
2463 PyErr_Clear();
Neil Schemenauer6b471292001-10-18 03:18:43 +00002464 return NULL;
Guido van Rossum823649d2001-03-21 18:40:58 +00002465 }
Barry Warsawf16951c2002-04-23 22:45:44 +00002466 if (!PyTuple_Check(bases)) {
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002467 Py_DECREF(bases);
Barry Warsawf16951c2002-04-23 22:45:44 +00002468 return NULL;
2469 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002470 return bases;
2471}
2472
2473
2474static int
2475abstract_issubclass(PyObject *derived, PyObject *cls)
2476{
2477 PyObject *bases;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002478 Py_ssize_t i, n;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002479 int r = 0;
2480
2481
Guido van Rossum823649d2001-03-21 18:40:58 +00002482 if (derived == cls)
2483 return 1;
2484
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002485 if (PyTuple_Check(cls)) {
2486 /* Not a general sequence -- that opens up the road to
2487 recursion and stack overflow. */
2488 n = PyTuple_GET_SIZE(cls);
2489 for (i = 0; i < n; i++) {
2490 if (derived == PyTuple_GET_ITEM(cls, i))
2491 return 1;
2492 }
2493 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002494 bases = abstract_get_bases(derived);
Barry Warsawf16951c2002-04-23 22:45:44 +00002495 if (bases == NULL) {
2496 if (PyErr_Occurred())
2497 return -1;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002498 return 0;
Barry Warsawf16951c2002-04-23 22:45:44 +00002499 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002500 n = PyTuple_GET_SIZE(bases);
2501 for (i = 0; i < n; i++) {
Neil Schemenauer6b471292001-10-18 03:18:43 +00002502 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002503 if (r != 0)
2504 break;
2505 }
2506
2507 Py_DECREF(bases);
2508
2509 return r;
2510}
2511
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002512static int
2513check_class(PyObject *cls, const char *error)
2514{
2515 PyObject *bases = abstract_get_bases(cls);
2516 if (bases == NULL) {
2517 /* Do not mask errors. */
2518 if (!PyErr_Occurred())
2519 PyErr_SetString(PyExc_TypeError, error);
2520 return 0;
2521 }
2522 Py_DECREF(bases);
2523 return -1;
2524}
2525
Brett Cannon4f653312004-03-20 22:52:14 +00002526static int
2527recursive_isinstance(PyObject *inst, PyObject *cls, int recursion_depth)
Guido van Rossum823649d2001-03-21 18:40:58 +00002528{
2529 PyObject *icls;
2530 static PyObject *__class__ = NULL;
2531 int retval = 0;
2532
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002533 if (__class__ == NULL) {
Christian Heimesfe82e772008-01-28 02:38:20 +00002534 __class__ = PyUnicode_InternFromString("__class__");
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002535 if (__class__ == NULL)
2536 return -1;
2537 }
2538
Guido van Rossum45aecf42006-03-15 04:58:47 +00002539 if (PyType_Check(cls)) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00002540 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002541 if (retval == 0) {
2542 PyObject *c = PyObject_GetAttr(inst, __class__);
2543 if (c == NULL) {
2544 PyErr_Clear();
2545 }
2546 else {
Guido van Rossume5b130b2003-02-12 03:36:05 +00002547 if (c != (PyObject *)(inst->ob_type) &&
2548 PyType_Check(c))
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002549 retval = PyType_IsSubtype(
2550 (PyTypeObject *)c,
2551 (PyTypeObject *)cls);
2552 Py_DECREF(c);
2553 }
2554 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002555 }
Guido van Rossum03290ec2001-10-07 20:54:12 +00002556 else if (PyTuple_Check(cls)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00002557 Py_ssize_t i, n;
Guido van Rossum03290ec2001-10-07 20:54:12 +00002558
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002559 if (!recursion_depth) {
2560 PyErr_SetString(PyExc_RuntimeError,
2561 "nest level of tuple too deep");
2562 return -1;
2563 }
Brett Cannon4f653312004-03-20 22:52:14 +00002564
Guido van Rossum03290ec2001-10-07 20:54:12 +00002565 n = PyTuple_GET_SIZE(cls);
2566 for (i = 0; i < n; i++) {
Brett Cannon4f653312004-03-20 22:52:14 +00002567 retval = recursive_isinstance(
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002568 inst,
2569 PyTuple_GET_ITEM(cls, i),
2570 recursion_depth-1);
Guido van Rossum03290ec2001-10-07 20:54:12 +00002571 if (retval != 0)
2572 break;
2573 }
Guido van Rossum03290ec2001-10-07 20:54:12 +00002574 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002575 else {
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002576 if (!check_class(cls,
2577 "isinstance() arg 2 must be a class, type,"
2578 " or tuple of classes and types"))
Neil Schemenauer6b471292001-10-18 03:18:43 +00002579 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002580 icls = PyObject_GetAttr(inst, __class__);
Neil Schemenauer6b471292001-10-18 03:18:43 +00002581 if (icls == NULL) {
2582 PyErr_Clear();
2583 retval = 0;
Guido van Rossum823649d2001-03-21 18:40:58 +00002584 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002585 else {
2586 retval = abstract_issubclass(icls, cls);
2587 Py_DECREF(icls);
2588 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002589 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002590
Guido van Rossum823649d2001-03-21 18:40:58 +00002591 return retval;
2592}
2593
2594int
Brett Cannon4f653312004-03-20 22:52:14 +00002595PyObject_IsInstance(PyObject *inst, PyObject *cls)
2596{
Christian Heimesa156e092008-02-16 07:38:31 +00002597 static PyObject *name = NULL;
Guido van Rossume7ba4952007-06-06 23:52:48 +00002598 PyObject *checker;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002599
2600 /* Quick test for an exact match */
2601 if (Py_TYPE(inst) == (PyTypeObject *)cls)
2602 return 1;
2603
Christian Heimesa156e092008-02-16 07:38:31 +00002604 if (name == NULL) {
2605 name = PyUnicode_InternFromString("__instancecheck__");
2606 if (name == NULL)
2607 return -1;
2608 }
2609 checker = PyObject_GetAttr(cls, name);
Christian Heimese25f35e2008-03-20 10:49:03 +00002610 if (checker == NULL && PyErr_Occurred())
2611 PyErr_Clear();
Guido van Rossumadee45e2007-05-25 17:55:52 +00002612 if (checker != NULL) {
2613 PyObject *res;
2614 int ok = -1;
Guido van Rossum29478ef2007-05-29 00:39:44 +00002615 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2616 Py_DECREF(checker);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002617 return ok;
Guido van Rossum29478ef2007-05-29 00:39:44 +00002618 }
Guido van Rossumadee45e2007-05-25 17:55:52 +00002619 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
2620 Py_LeaveRecursiveCall();
2621 Py_DECREF(checker);
2622 if (res != NULL) {
2623 ok = PyObject_IsTrue(res);
2624 Py_DECREF(res);
2625 }
2626 return ok;
2627 }
2628 return recursive_isinstance(inst, cls, Py_GetRecursionLimit());
Brett Cannon4f653312004-03-20 22:52:14 +00002629}
2630
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002631static int
Brett Cannon4f653312004-03-20 22:52:14 +00002632recursive_issubclass(PyObject *derived, PyObject *cls, int recursion_depth)
Guido van Rossum823649d2001-03-21 18:40:58 +00002633{
2634 int retval;
2635
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002636 {
Guido van Rossumf6c9ba82003-02-10 16:05:43 +00002637 if (!check_class(derived,
2638 "issubclass() arg 1 must be a class"))
Neil Schemenauer6b471292001-10-18 03:18:43 +00002639 return -1;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002640
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002641 if (PyTuple_Check(cls)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00002642 Py_ssize_t i;
2643 Py_ssize_t n = PyTuple_GET_SIZE(cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002644
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002645 if (!recursion_depth) {
2646 PyErr_SetString(PyExc_RuntimeError,
2647 "nest level of tuple too deep");
2648 return -1;
2649 }
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002650 for (i = 0; i < n; ++i) {
Brett Cannon4f653312004-03-20 22:52:14 +00002651 retval = recursive_issubclass(
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002652 derived,
2653 PyTuple_GET_ITEM(cls, i),
2654 recursion_depth-1);
Guido van Rossumf6c9ba82003-02-10 16:05:43 +00002655 if (retval != 0) {
2656 /* either found it, or got an error */
Walter Dörwald7e5c6a02002-12-12 19:14:08 +00002657 return retval;
Guido van Rossumf6c9ba82003-02-10 16:05:43 +00002658 }
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002659 }
Walter Dörwald7e5c6a02002-12-12 19:14:08 +00002660 return 0;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002661 }
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002662 else {
2663 if (!check_class(cls,
2664 "issubclass() arg 2 must be a class"
2665 " or tuple of classes"))
2666 return -1;
2667 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002668
2669 retval = abstract_issubclass(derived, cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002670 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002671
2672 return retval;
2673}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002674
Brett Cannon4f653312004-03-20 22:52:14 +00002675int
2676PyObject_IsSubclass(PyObject *derived, PyObject *cls)
2677{
Christian Heimesa156e092008-02-16 07:38:31 +00002678 static PyObject *name = NULL;
Guido van Rossumadee45e2007-05-25 17:55:52 +00002679 PyObject *t, *v, *tb;
Guido van Rossume7ba4952007-06-06 23:52:48 +00002680 PyObject *checker;
Guido van Rossumadee45e2007-05-25 17:55:52 +00002681 PyErr_Fetch(&t, &v, &tb);
Christian Heimesa156e092008-02-16 07:38:31 +00002682
2683 if (name == NULL) {
2684 name = PyUnicode_InternFromString("__subclasscheck__");
2685 if (name == NULL)
2686 return -1;
2687 }
2688 checker = PyObject_GetAttr(cls, name);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002689 PyErr_Restore(t, v, tb);
2690 if (checker != NULL) {
2691 PyObject *res;
2692 int ok = -1;
2693 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
2694 return ok;
2695 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
2696 Py_LeaveRecursiveCall();
2697 Py_DECREF(checker);
2698 if (res != NULL) {
2699 ok = PyObject_IsTrue(res);
2700 Py_DECREF(res);
2701 }
2702 return ok;
2703 }
2704 return recursive_issubclass(derived, cls, Py_GetRecursionLimit());
Brett Cannon4f653312004-03-20 22:52:14 +00002705}
2706
2707
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002708PyObject *
2709PyObject_GetIter(PyObject *o)
2710{
2711 PyTypeObject *t = o->ob_type;
2712 getiterfunc f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002713 f = t->tp_iter;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002714 if (f == NULL) {
2715 if (PySequence_Check(o))
Guido van Rossum213c7a62001-04-23 14:08:49 +00002716 return PySeqIter_New(o);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002717 return type_error("'%.200s' object is not iterable", o);
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002718 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00002719 else {
2720 PyObject *res = (*f)(o);
2721 if (res != NULL && !PyIter_Check(res)) {
2722 PyErr_Format(PyExc_TypeError,
2723 "iter() returned non-iterator "
2724 "of type '%.100s'",
2725 res->ob_type->tp_name);
2726 Py_DECREF(res);
2727 res = NULL;
2728 }
2729 return res;
2730 }
2731}
2732
Tim Petersf4848da2001-05-05 00:14:56 +00002733/* Return next item.
2734 * If an error occurs, return NULL. PyErr_Occurred() will be true.
2735 * If the iteration terminates normally, return NULL and clear the
2736 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
2737 * will be false.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002738 * Else return the next object. PyErr_Occurred() will be false.
Tim Petersf4848da2001-05-05 00:14:56 +00002739 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002740PyObject *
2741PyIter_Next(PyObject *iter)
2742{
Tim Petersf4848da2001-05-05 00:14:56 +00002743 PyObject *result;
Raymond Hettinger8049dde2003-03-01 01:44:32 +00002744 assert(PyIter_Check(iter));
Tim Petersf4848da2001-05-05 00:14:56 +00002745 result = (*iter->ob_type->tp_iternext)(iter);
2746 if (result == NULL &&
2747 PyErr_Occurred() &&
2748 PyErr_ExceptionMatches(PyExc_StopIteration))
2749 PyErr_Clear();
2750 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002751}