blob: 684b0b4abd273af610c56212c632955f34dacbe8 [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;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000675 if (((flags & PyBUF_LOCK) == PyBUF_LOCK) &&
Gregory P. Smith46218752008-03-15 06:05:36 +0000676 readonly != 0) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000677 PyErr_SetString(PyExc_BufferError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000678 "Cannot lock this object.");
679 return -1;
680 }
681 if (((flags & PyBUF_WRITABLE) == PyBUF_WRITABLE) &&
682 (readonly == 1)) {
683 PyErr_SetString(PyExc_BufferError,
684 "Object is not writable.");
685 return -1;
686 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000687
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000688 view->buf = buf;
689 view->len = len;
690 view->readonly = readonly;
691 view->itemsize = 1;
692 view->format = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000693 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT)
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000694 view->format = "B";
695 view->ndim = 1;
696 view->shape = NULL;
697 if ((flags & PyBUF_ND) == PyBUF_ND)
698 view->shape = &(view->len);
699 view->strides = NULL;
700 if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES)
701 view->strides = &(view->itemsize);
702 view->suboffsets = NULL;
703 view->internal = NULL;
704 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000705}
706
Eric Smith8fd3eba2008-02-17 19:48:00 +0000707PyObject *
708PyObject_Format(PyObject *obj, PyObject *format_spec)
709{
710 static PyObject * str__format__ = NULL;
711 PyObject *meth;
712 PyObject *empty = NULL;
713 PyObject *result = NULL;
714
715 /* Initialize cached value */
716 if (str__format__ == NULL) {
717 /* Initialize static variable needed by _PyType_Lookup */
718 str__format__ = PyUnicode_FromString("__format__");
719 if (str__format__ == NULL)
720 goto done;
721 }
722
723 /* If no format_spec is provided, use an empty string */
724 if (format_spec == NULL) {
725 empty = PyUnicode_FromUnicode(NULL, 0);
726 format_spec = empty;
727 }
728
729 /* Make sure the type is initialized. float gets initialized late */
730 if (Py_TYPE(obj)->tp_dict == NULL)
731 if (PyType_Ready(Py_TYPE(obj)) < 0)
732 goto done;
733
734 /* Find the (unbound!) __format__ method (a borrowed reference) */
735 meth = _PyType_Lookup(Py_TYPE(obj), str__format__);
736 if (meth == NULL) {
737 PyErr_Format(PyExc_TypeError,
738 "Type %.100s doesn't define __format__",
739 Py_TYPE(obj)->tp_name);
740 goto done;
741 }
742
743 /* And call it, binding it to the value */
744 result = PyObject_CallFunctionObjArgs(meth, obj, format_spec, NULL);
745
746 if (result && !PyUnicode_Check(result)) {
747 PyErr_SetString(PyExc_TypeError,
748 "__format__ method did not return string");
749 Py_DECREF(result);
750 result = NULL;
751 goto done;
752 }
753
754done:
755 Py_XDECREF(empty);
756 return result;
757}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000758/* Operations on numbers */
759
760int
Fred Drake79912472000-07-09 04:06:11 +0000761PyNumber_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +0000762{
Guido van Rossum6921eca2003-02-18 16:36:28 +0000763 return o && o->ob_type->tp_as_number &&
764 (o->ob_type->tp_as_number->nb_int ||
765 o->ob_type->tp_as_number->nb_float);
Guido van Rossume15dee51995-07-18 14:12:02 +0000766}
767
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000768/* Binary operators */
Guido van Rossume15dee51995-07-18 14:12:02 +0000769
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000770#define NB_SLOT(x) offsetof(PyNumberMethods, x)
771#define NB_BINOP(nb_methods, slot) \
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000772 (*(binaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000773#define NB_TERNOP(nb_methods, slot) \
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000774 (*(ternaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000775
776/*
777 Calling scheme used for binary operations:
778
Neal Norwitz4886cc32006-08-21 17:06:07 +0000779 Order operations are tried until either a valid result or error:
780 w.op(v,w)[*], v.op(v,w), w.op(v,w)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000781
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000782 [*] only when v->ob_type != w->ob_type && w->ob_type is a subclass of
783 v->ob_type
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000784 */
785
786static PyObject *
787binary_op1(PyObject *v, PyObject *w, const int op_slot)
Guido van Rossume15dee51995-07-18 14:12:02 +0000788{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000789 PyObject *x;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000790 binaryfunc slotv = NULL;
791 binaryfunc slotw = NULL;
792
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000793 if (v->ob_type->tp_as_number != NULL)
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000794 slotv = NB_BINOP(v->ob_type->tp_as_number, op_slot);
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000795 if (w->ob_type != v->ob_type &&
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000796 w->ob_type->tp_as_number != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000797 slotw = NB_BINOP(w->ob_type->tp_as_number, op_slot);
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000798 if (slotw == slotv)
799 slotw = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000800 }
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000801 if (slotv) {
Guido van Rossum89c42642001-10-01 17:10:18 +0000802 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
803 x = slotw(v, w);
804 if (x != Py_NotImplemented)
805 return x;
806 Py_DECREF(x); /* can't do it */
807 slotw = NULL;
808 }
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000809 x = slotv(v, w);
810 if (x != Py_NotImplemented)
811 return x;
812 Py_DECREF(x); /* can't do it */
813 }
814 if (slotw) {
815 x = slotw(v, w);
816 if (x != Py_NotImplemented)
817 return x;
818 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000819 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000820 Py_INCREF(Py_NotImplemented);
821 return Py_NotImplemented;
822}
Guido van Rossum77660912002-04-16 16:32:50 +0000823
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000824static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000825binop_type_error(PyObject *v, PyObject *w, const char *op_name)
826{
827 PyErr_Format(PyExc_TypeError,
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000828 "unsupported operand type(s) for %.100s: "
829 "'%.100s' and '%.100s'",
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000830 op_name,
831 v->ob_type->tp_name,
832 w->ob_type->tp_name);
833 return NULL;
834}
835
836static PyObject *
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000837binary_op(PyObject *v, PyObject *w, const int op_slot, const char *op_name)
838{
839 PyObject *result = binary_op1(v, w, op_slot);
840 if (result == Py_NotImplemented) {
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000841 Py_DECREF(result);
842 return binop_type_error(v, w, op_name);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000843 }
844 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000845}
846
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000847
848/*
849 Calling scheme used for ternary operations:
850
Neal Norwitz4886cc32006-08-21 17:06:07 +0000851 Order operations are tried until either a valid result or error:
852 v.op(v,w,z), w.op(v,w,z), z.op(v,w,z)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000853 */
854
855static PyObject *
856ternary_op(PyObject *v,
857 PyObject *w,
858 PyObject *z,
859 const int op_slot,
860 const char *op_name)
Guido van Rossume15dee51995-07-18 14:12:02 +0000861{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000862 PyNumberMethods *mv, *mw, *mz;
Guido van Rossum84675ac2001-09-29 01:05:03 +0000863 PyObject *x = NULL;
864 ternaryfunc slotv = NULL;
865 ternaryfunc slotw = NULL;
866 ternaryfunc slotz = NULL;
Guido van Rossum77660912002-04-16 16:32:50 +0000867
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000868 mv = v->ob_type->tp_as_number;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000869 mw = w->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000870 if (mv != NULL)
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000871 slotv = NB_TERNOP(mv, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000872 if (w->ob_type != v->ob_type &&
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000873 mw != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000874 slotw = NB_TERNOP(mw, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000875 if (slotw == slotv)
876 slotw = NULL;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000877 }
Guido van Rossum84675ac2001-09-29 01:05:03 +0000878 if (slotv) {
Guido van Rossum89c42642001-10-01 17:10:18 +0000879 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
880 x = slotw(v, w, z);
881 if (x != Py_NotImplemented)
882 return x;
883 Py_DECREF(x); /* can't do it */
884 slotw = NULL;
885 }
Guido van Rossum84675ac2001-09-29 01:05:03 +0000886 x = slotv(v, w, z);
887 if (x != Py_NotImplemented)
888 return x;
889 Py_DECREF(x); /* can't do it */
890 }
891 if (slotw) {
892 x = slotw(v, w, z);
893 if (x != Py_NotImplemented)
894 return x;
895 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000896 }
897 mz = z->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000898 if (mz != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000899 slotz = NB_TERNOP(mz, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000900 if (slotz == slotv || slotz == slotw)
901 slotz = NULL;
902 if (slotz) {
903 x = slotz(v, w, z);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000904 if (x != Py_NotImplemented)
905 return x;
Guido van Rossum84675ac2001-09-29 01:05:03 +0000906 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000907 }
908 }
909
Guido van Rossum5c66a262001-10-22 04:12:44 +0000910 if (z == Py_None)
911 PyErr_Format(
912 PyExc_TypeError,
913 "unsupported operand type(s) for ** or pow(): "
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000914 "'%.100s' and '%.100s'",
Guido van Rossum5c66a262001-10-22 04:12:44 +0000915 v->ob_type->tp_name,
916 w->ob_type->tp_name);
917 else
918 PyErr_Format(
919 PyExc_TypeError,
920 "unsupported operand type(s) for pow(): "
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000921 "'%.100s', '%.100s', '%.100s'",
Guido van Rossum5c66a262001-10-22 04:12:44 +0000922 v->ob_type->tp_name,
923 w->ob_type->tp_name,
924 z->ob_type->tp_name);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000925 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000926}
927
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000928#define BINARY_FUNC(func, op, op_name) \
929 PyObject * \
930 func(PyObject *v, PyObject *w) { \
931 return binary_op(v, w, NB_SLOT(op), op_name); \
932 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000933
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000934BINARY_FUNC(PyNumber_Or, nb_or, "|")
935BINARY_FUNC(PyNumber_Xor, nb_xor, "^")
936BINARY_FUNC(PyNumber_And, nb_and, "&")
937BINARY_FUNC(PyNumber_Lshift, nb_lshift, "<<")
938BINARY_FUNC(PyNumber_Rshift, nb_rshift, ">>")
939BINARY_FUNC(PyNumber_Subtract, nb_subtract, "-")
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000940BINARY_FUNC(PyNumber_Divmod, nb_divmod, "divmod()")
Guido van Rossume15dee51995-07-18 14:12:02 +0000941
942PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000943PyNumber_Add(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000944{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000945 PyObject *result = binary_op1(v, w, NB_SLOT(nb_add));
946 if (result == Py_NotImplemented) {
947 PySequenceMethods *m = v->ob_type->tp_as_sequence;
Armin Rigofd163f92005-12-29 15:59:19 +0000948 Py_DECREF(result);
Jeremy Hylton0522d982002-03-08 21:28:54 +0000949 if (m && m->sq_concat) {
Armin Rigofd163f92005-12-29 15:59:19 +0000950 return (*m->sq_concat)(v, w);
Jeremy Hylton0522d982002-03-08 21:28:54 +0000951 }
Armin Rigofd163f92005-12-29 15:59:19 +0000952 result = binop_type_error(v, w, "+");
Guido van Rossume15dee51995-07-18 14:12:02 +0000953 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000954 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000955}
956
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000957static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000958sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000959{
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000960 Py_ssize_t count;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000961 if (PyIndex_Check(n)) {
962 count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000963 if (count == -1 && PyErr_Occurred())
964 return NULL;
965 }
966 else {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000967 return type_error("can't multiply sequence by "
968 "non-int of type '%.200s'", n);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000969 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000970 return (*repeatfunc)(seq, count);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000971}
972
973PyObject *
974PyNumber_Multiply(PyObject *v, PyObject *w)
975{
976 PyObject *result = binary_op1(v, w, NB_SLOT(nb_multiply));
977 if (result == Py_NotImplemented) {
978 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
979 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
Guido van Rossuma3a243e2002-12-31 19:50:03 +0000980 Py_DECREF(result);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000981 if (mv && mv->sq_repeat) {
982 return sequence_repeat(mv->sq_repeat, v, w);
983 }
984 else if (mw && mw->sq_repeat) {
985 return sequence_repeat(mw->sq_repeat, w, v);
986 }
987 result = binop_type_error(v, w, "*");
988 }
989 return result;
990}
991
Guido van Rossume15dee51995-07-18 14:12:02 +0000992PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +0000993PyNumber_FloorDivide(PyObject *v, PyObject *w)
994{
Guido van Rossum4668b002001-08-08 05:00:18 +0000995 return binary_op(v, w, NB_SLOT(nb_floor_divide), "//");
996}
997
998PyObject *
999PyNumber_TrueDivide(PyObject *v, PyObject *w)
1000{
Guido van Rossum4668b002001-08-08 05:00:18 +00001001 return binary_op(v, w, NB_SLOT(nb_true_divide), "/");
1002}
1003
1004PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001005PyNumber_Remainder(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +00001006{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001007 return binary_op(v, w, NB_SLOT(nb_remainder), "%");
Guido van Rossume15dee51995-07-18 14:12:02 +00001008}
1009
1010PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001011PyNumber_Power(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossume15dee51995-07-18 14:12:02 +00001012{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001013 return ternary_op(v, w, z, NB_SLOT(nb_power), "** or pow()");
Guido van Rossume15dee51995-07-18 14:12:02 +00001014}
1015
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001016/* Binary in-place operators */
1017
1018/* The in-place operators are defined to fall back to the 'normal',
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001019 non in-place operations, if the in-place methods are not in place.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001020
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001021 - If the left hand object has the appropriate struct members, and
1022 they are filled, call the appropriate function and return the
1023 result. No coercion is done on the arguments; the left-hand object
1024 is the one the operation is performed on, and it's up to the
1025 function to deal with the right-hand object.
Guido van Rossum77660912002-04-16 16:32:50 +00001026
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001027 - Otherwise, in-place modification is not supported. Handle it exactly as
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001028 a non in-place operation of the same kind.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001029
1030 */
1031
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001032static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001033binary_iop1(PyObject *v, PyObject *w, const int iop_slot, const int op_slot)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001034{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001035 PyNumberMethods *mv = v->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001036 if (mv != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +00001037 binaryfunc slot = NB_BINOP(mv, iop_slot);
1038 if (slot) {
1039 PyObject *x = (slot)(v, w);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001040 if (x != Py_NotImplemented) {
1041 return x;
1042 }
1043 Py_DECREF(x);
1044 }
Thomas Woutersf2b332d2000-09-02 08:34:40 +00001045 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001046 return binary_op1(v, w, op_slot);
1047}
1048
1049static PyObject *
1050binary_iop(PyObject *v, PyObject *w, const int iop_slot, const int op_slot,
1051 const char *op_name)
1052{
1053 PyObject *result = binary_iop1(v, w, iop_slot, op_slot);
1054 if (result == Py_NotImplemented) {
1055 Py_DECREF(result);
1056 return binop_type_error(v, w, op_name);
1057 }
1058 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001059}
1060
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001061#define INPLACE_BINOP(func, iop, op, op_name) \
1062 PyObject * \
1063 func(PyObject *v, PyObject *w) { \
1064 return binary_iop(v, w, NB_SLOT(iop), NB_SLOT(op), op_name); \
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001065 }
1066
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001067INPLACE_BINOP(PyNumber_InPlaceOr, nb_inplace_or, nb_or, "|=")
1068INPLACE_BINOP(PyNumber_InPlaceXor, nb_inplace_xor, nb_xor, "^=")
1069INPLACE_BINOP(PyNumber_InPlaceAnd, nb_inplace_and, nb_and, "&=")
1070INPLACE_BINOP(PyNumber_InPlaceLshift, nb_inplace_lshift, nb_lshift, "<<=")
1071INPLACE_BINOP(PyNumber_InPlaceRshift, nb_inplace_rshift, nb_rshift, ">>=")
1072INPLACE_BINOP(PyNumber_InPlaceSubtract, nb_inplace_subtract, nb_subtract, "-=")
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001073
1074PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001075PyNumber_InPlaceFloorDivide(PyObject *v, PyObject *w)
1076{
Guido van Rossum4668b002001-08-08 05:00:18 +00001077 return binary_iop(v, w, NB_SLOT(nb_inplace_floor_divide),
1078 NB_SLOT(nb_floor_divide), "//=");
1079}
1080
1081PyObject *
1082PyNumber_InPlaceTrueDivide(PyObject *v, PyObject *w)
1083{
Guido van Rossum4668b002001-08-08 05:00:18 +00001084 return binary_iop(v, w, NB_SLOT(nb_inplace_true_divide),
1085 NB_SLOT(nb_true_divide), "/=");
1086}
1087
1088PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001089PyNumber_InPlaceAdd(PyObject *v, PyObject *w)
1090{
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001091 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_add),
1092 NB_SLOT(nb_add));
1093 if (result == Py_NotImplemented) {
1094 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1095 Py_DECREF(result);
1096 if (m != NULL) {
1097 binaryfunc f = NULL;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001098 f = m->sq_inplace_concat;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001099 if (f == NULL)
1100 f = m->sq_concat;
1101 if (f != NULL)
1102 return (*f)(v, w);
1103 }
1104 result = binop_type_error(v, w, "+=");
Guido van Rossumbb8be932000-09-01 23:27:32 +00001105 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001106 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001107}
1108
1109PyObject *
1110PyNumber_InPlaceMultiply(PyObject *v, PyObject *w)
1111{
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001112 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_multiply),
1113 NB_SLOT(nb_multiply));
1114 if (result == Py_NotImplemented) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001115 ssizeargfunc f = NULL;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001116 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1117 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1118 Py_DECREF(result);
1119 if (mv != NULL) {
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001120 f = mv->sq_inplace_repeat;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001121 if (f == NULL)
1122 f = mv->sq_repeat;
1123 if (f != NULL)
1124 return sequence_repeat(f, v, w);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001125 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001126 else if (mw != NULL) {
1127 /* Note that the right hand operand should not be
1128 * mutated in this case so sq_inplace_repeat is not
1129 * used. */
1130 if (mw->sq_repeat)
1131 return sequence_repeat(mw->sq_repeat, w, v);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001132 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001133 result = binop_type_error(v, w, "*=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001134 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001135 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001136}
1137
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001138PyObject *
1139PyNumber_InPlaceRemainder(PyObject *v, PyObject *w)
1140{
Neil Schemenauerd46fbc32002-11-24 01:07:42 +00001141 return binary_iop(v, w, NB_SLOT(nb_inplace_remainder),
1142 NB_SLOT(nb_remainder), "%=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001143}
1144
1145PyObject *
1146PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
1147{
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001148 if (v->ob_type->tp_as_number &&
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001149 v->ob_type->tp_as_number->nb_inplace_power != NULL) {
1150 return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001151 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001152 else {
1153 return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
1154 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001155}
1156
1157
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001158/* Unary operators and functions */
Guido van Rossume15dee51995-07-18 14:12:02 +00001159
1160PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001161PyNumber_Negative(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001162{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001163 PyNumberMethods *m;
1164
1165 if (o == NULL)
1166 return null_error();
1167 m = o->ob_type->tp_as_number;
1168 if (m && m->nb_negative)
1169 return (*m->nb_negative)(o);
1170
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001171 return type_error("bad operand type for unary -: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001172}
1173
1174PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001175PyNumber_Positive(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001176{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001177 PyNumberMethods *m;
1178
1179 if (o == NULL)
1180 return null_error();
1181 m = o->ob_type->tp_as_number;
1182 if (m && m->nb_positive)
1183 return (*m->nb_positive)(o);
1184
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001185 return type_error("bad operand type for unary +: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001186}
1187
1188PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001189PyNumber_Invert(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001190{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001191 PyNumberMethods *m;
1192
1193 if (o == NULL)
1194 return null_error();
1195 m = o->ob_type->tp_as_number;
1196 if (m && m->nb_invert)
1197 return (*m->nb_invert)(o);
1198
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001199 return type_error("bad operand type for unary ~: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001200}
1201
1202PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001203PyNumber_Absolute(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001204{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001205 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001206
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001207 if (o == NULL)
1208 return null_error();
1209 m = o->ob_type->tp_as_number;
1210 if (m && m->nb_absolute)
1211 return m->nb_absolute(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001212
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001213 return type_error("bad operand type for abs(): '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001214}
1215
Guido van Rossum98297ee2007-11-06 21:34:58 +00001216/* Return a Python Int or Long from the object item
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001217 Raise TypeError if the result is not an int-or-long
Guido van Rossum98297ee2007-11-06 21:34:58 +00001218 or if the object cannot be interpreted as an index.
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001219*/
1220PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001221PyNumber_Index(PyObject *item)
1222{
Trent Nelsone2ae4682008-04-10 16:25:37 +00001223 PyNumberMethods *m;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001224 PyObject *result = NULL;
1225 if (item == NULL)
1226 return null_error();
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001227 if (PyLong_Check(item)) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001228 Py_INCREF(item);
1229 return item;
1230 }
Trent Nelsone2ae4682008-04-10 16:25:37 +00001231 m = item->ob_type->tp_as_number;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001232 if (PyIndex_Check(item)) {
Trent Nelsone2ae4682008-04-10 16:25:37 +00001233 result = m->nb_index(item);
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001234 if (result && !PyLong_Check(result)) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001235 PyErr_Format(PyExc_TypeError,
Guido van Rossum032a2842007-02-26 05:44:27 +00001236 "__index__ returned non-int "
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001237 "(type %.200s)",
1238 result->ob_type->tp_name);
1239 Py_DECREF(result);
1240 return NULL;
1241 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001242 }
Trent Nelsond12fbe92008-04-10 22:21:23 +00001243 else if (m && m->nb_int != NULL && m->nb_float == NULL) {
Trent Nelsone2ae4682008-04-10 16:25:37 +00001244 result = m->nb_int(item);
1245 if (result && !PyLong_Check(result)) {
1246 PyErr_Format(PyExc_TypeError,
1247 "__int__ returned non-int "
1248 "(type %.200s)",
1249 result->ob_type->tp_name);
1250 Py_DECREF(result);
1251 return NULL;
1252 }
1253 } else {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001254 PyErr_Format(PyExc_TypeError,
1255 "'%.200s' object cannot be interpreted "
Guido van Rossum032a2842007-02-26 05:44:27 +00001256 "as an integer", item->ob_type->tp_name);
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001257 }
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001258 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001259}
1260
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001261/* Return an error on Overflow only if err is not NULL*/
1262
1263Py_ssize_t
1264PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1265{
1266 Py_ssize_t result;
1267 PyObject *runerr;
1268 PyObject *value = PyNumber_Index(item);
1269 if (value == NULL)
1270 return -1;
1271
Christian Heimes217cfd12007-12-02 14:31:20 +00001272 /* We're done if PyLong_AsSsize_t() returns without error. */
1273 result = PyLong_AsSsize_t(value);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001274 if (result != -1 || !(runerr = PyErr_Occurred()))
1275 goto finish;
1276
1277 /* Error handling code -- only manage OverflowError differently */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001278 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001279 goto finish;
1280
1281 PyErr_Clear();
Guido van Rossum98297ee2007-11-06 21:34:58 +00001282 /* If no error-handling desired then the default clipping
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001283 is sufficient.
1284 */
1285 if (!err) {
1286 assert(PyLong_Check(value));
Guido van Rossum98297ee2007-11-06 21:34:58 +00001287 /* Whether or not it is less than or equal to
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001288 zero is determined by the sign of ob_size
1289 */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001290 if (_PyLong_Sign(value) < 0)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001291 result = PY_SSIZE_T_MIN;
1292 else
1293 result = PY_SSIZE_T_MAX;
1294 }
1295 else {
1296 /* Otherwise replace the error with caller's error object. */
1297 PyErr_Format(err,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001298 "cannot fit '%.200s' into an index-sized integer",
1299 item->ob_type->tp_name);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001300 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001301
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001302 finish:
1303 Py_DECREF(value);
1304 return result;
1305}
1306
1307
Christian Heimes15ebc882008-02-04 18:48:49 +00001308PyObject *
1309_PyNumber_ConvertIntegralToInt(PyObject *integral, const char* error_format)
1310{
1311 static PyObject *int_name = NULL;
1312 if (int_name == NULL) {
1313 int_name = PyUnicode_InternFromString("__int__");
1314 if (int_name == NULL)
1315 return NULL;
1316 }
1317
1318 if (integral && !PyLong_Check(integral)) {
1319 /* Don't go through tp_as_number->nb_int to avoid
1320 hitting the classic class fallback to __trunc__. */
1321 PyObject *int_func = PyObject_GetAttr(integral, int_name);
1322 if (int_func == NULL) {
1323 PyErr_Clear(); /* Raise a different error. */
1324 goto non_integral_error;
1325 }
1326 Py_DECREF(integral);
1327 integral = PyEval_CallObject(int_func, NULL);
1328 Py_DECREF(int_func);
1329 if (integral && !PyLong_Check(integral)) {
1330 goto non_integral_error;
1331 }
1332 }
1333 return integral;
1334
1335non_integral_error:
1336 PyErr_Format(PyExc_TypeError, error_format, Py_TYPE(integral)->tp_name);
1337 Py_DECREF(integral);
1338 return NULL;
1339}
1340
1341
Guido van Rossum9e896b32000-04-05 20:11:21 +00001342/* Add a check for embedded NULL-bytes in the argument. */
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001343static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001344long_from_string(const char *s, Py_ssize_t len)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001345{
Guido van Rossum4c08d552000-03-10 22:55:18 +00001346 char *end;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001347 PyObject *x;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001348
Guido van Rossum4c08d552000-03-10 22:55:18 +00001349 x = PyLong_FromString((char*)s, &end, 10);
Guido van Rossum9e896b32000-04-05 20:11:21 +00001350 if (x == NULL)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001351 return NULL;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001352 if (end != s + len) {
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001353 PyErr_SetString(PyExc_ValueError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001354 "null byte in argument for int()");
Guido van Rossum9e896b32000-04-05 20:11:21 +00001355 Py_DECREF(x);
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001356 return NULL;
1357 }
1358 return x;
1359}
1360
Guido van Rossume15dee51995-07-18 14:12:02 +00001361PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001362PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001363{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001364 PyNumberMethods *m;
Christian Heimes15ebc882008-02-04 18:48:49 +00001365 static PyObject *trunc_name = NULL;
1366 PyObject *trunc_func;
Guido van Rossum4c08d552000-03-10 22:55:18 +00001367 const char *buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001368 Py_ssize_t buffer_len;
Guido van Rossume15dee51995-07-18 14:12:02 +00001369
Christian Heimes15ebc882008-02-04 18:48:49 +00001370 if (trunc_name == NULL) {
1371 trunc_name = PyUnicode_InternFromString("__trunc__");
1372 if (trunc_name == NULL)
1373 return NULL;
1374 }
1375
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001376 if (o == NULL)
1377 return null_error();
Guido van Rossumddefaf32007-01-14 03:31:43 +00001378 if (PyLong_CheckExact(o)) {
1379 Py_INCREF(o);
1380 return o;
1381 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001382 m = o->ob_type->tp_as_number;
Guido van Rossumddefaf32007-01-14 03:31:43 +00001383 if (m && m->nb_int) { /* This should include subclasses of int */
1384 PyObject *res = m->nb_int(o);
1385 if (res && !PyLong_Check(res)) {
1386 PyErr_Format(PyExc_TypeError,
1387 "__int__ returned non-int (type %.200s)",
1388 res->ob_type->tp_name);
1389 Py_DECREF(res);
1390 return NULL;
1391 }
1392 return res;
1393 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001394 if (m && m->nb_long) { /* This should include subclasses of long */
Christian Heimes15ebc882008-02-04 18:48:49 +00001395 /* Classic classes always take this branch. */
Brett Cannonc3647ac2005-04-26 03:45:26 +00001396 PyObject *res = m->nb_long(o);
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001397 if (res && !PyLong_Check(res)) {
Brett Cannonc3647ac2005-04-26 03:45:26 +00001398 PyErr_Format(PyExc_TypeError,
1399 "__long__ returned non-long (type %.200s)",
1400 res->ob_type->tp_name);
1401 Py_DECREF(res);
1402 return NULL;
1403 }
1404 return res;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001405 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001406 if (PyLong_Check(o)) /* A long subclass without nb_long */
Tim Petersdb30ac42002-03-02 04:14:21 +00001407 return _PyLong_Copy((PyLongObject *)o);
Christian Heimes15ebc882008-02-04 18:48:49 +00001408 trunc_func = PyObject_GetAttr(o, trunc_name);
1409 if (trunc_func) {
1410 PyObject *truncated = PyEval_CallObject(trunc_func, NULL);
1411 PyObject *int_instance;
1412 Py_DECREF(trunc_func);
1413 /* __trunc__ is specified to return an Integral type,
1414 but long() needs to return a long. */
1415 int_instance = _PyNumber_ConvertIntegralToInt(
1416 truncated,
1417 "__trunc__ returned non-Integral (type %.200s)");
1418 return int_instance;
1419 }
1420 PyErr_Clear(); /* It's not an error if o.__trunc__ doesn't exist. */
1421
1422 if (PyString_Check(o))
1423 /* need to do extra error checking that PyLong_FromString()
1424 * doesn't do. In particular long('9.5') must raise an
1425 * exception, not truncate the float.
1426 */
1427 return long_from_string(PyString_AS_STRING(o),
1428 PyString_GET_SIZE(o));
Guido van Rossum9e896b32000-04-05 20:11:21 +00001429 if (PyUnicode_Check(o))
1430 /* The above check is done in PyLong_FromUnicode(). */
1431 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(o),
1432 PyUnicode_GET_SIZE(o),
1433 10);
Guido van Rossum4c08d552000-03-10 22:55:18 +00001434 if (!PyObject_AsCharBuffer(o, &buffer, &buffer_len))
1435 return long_from_string(buffer, buffer_len);
Guido van Rossume15dee51995-07-18 14:12:02 +00001436
Guido van Rossumddefaf32007-01-14 03:31:43 +00001437 return type_error("int() argument must be a string or a "
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001438 "number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001439}
1440
1441PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001442PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001443{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001444 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001445
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001446 if (o == NULL)
1447 return null_error();
Brett Cannonc3647ac2005-04-26 03:45:26 +00001448 m = o->ob_type->tp_as_number;
1449 if (m && m->nb_float) { /* This should include subclasses of float */
1450 PyObject *res = m->nb_float(o);
1451 if (res && !PyFloat_Check(res)) {
1452 PyErr_Format(PyExc_TypeError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001453 "__float__ returned non-float (type %.200s)",
1454 res->ob_type->tp_name);
Brett Cannonc3647ac2005-04-26 03:45:26 +00001455 Py_DECREF(res);
1456 return NULL;
1457 }
1458 return res;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001459 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001460 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
Tim Peters7a50f252001-09-10 21:28:20 +00001461 PyFloatObject *po = (PyFloatObject *)o;
1462 return PyFloat_FromDouble(po->ob_fval);
1463 }
Georg Brandl428f0642007-03-18 18:35:15 +00001464 return PyFloat_FromString(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001465}
1466
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001467
1468PyObject *
1469PyNumber_ToBase(PyObject *n, int base)
1470{
Christian Heimesa156e092008-02-16 07:38:31 +00001471 PyObject *res = NULL;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001472 PyObject *index = PyNumber_Index(n);
1473
1474 if (!index)
1475 return NULL;
Christian Heimesa156e092008-02-16 07:38:31 +00001476 if (PyLong_Check(index))
1477 res = _PyLong_Format(index, base);
1478 else
1479 /* It should not be possible to get here, as
1480 PyNumber_Index already has a check for the same
1481 condition */
1482 PyErr_SetString(PyExc_ValueError, "PyNumber_ToBase: index not "
1483 "int or long");
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001484 Py_DECREF(index);
1485 return res;
1486}
1487
1488
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001489/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001490
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001491int
Fred Drake79912472000-07-09 04:06:11 +00001492PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001493{
Thomas Wouterscf297e42007-02-23 15:07:44 +00001494 if (PyObject_IsInstance(s, (PyObject *)&PyDict_Type))
1495 return 0;
Guido van Rossum8700b422001-09-07 20:20:11 +00001496 return s != NULL && s->ob_type->tp_as_sequence &&
1497 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001498}
1499
Martin v. Löwis18e16552006-02-15 17:27:45 +00001500Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001501PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001502{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001503 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001504
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001505 if (s == NULL) {
1506 null_error();
1507 return -1;
1508 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001509
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001510 m = s->ob_type->tp_as_sequence;
1511 if (m && m->sq_length)
1512 return m->sq_length(s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001513
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001514 type_error("object of type '%.200s' has no len()", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001515 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001516}
1517
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001518#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001519Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001520PySequence_Length(PyObject *s)
1521{
1522 return PySequence_Size(s);
1523}
1524#define PySequence_Length PySequence_Size
1525
Guido van Rossume15dee51995-07-18 14:12:02 +00001526PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001527PySequence_Concat(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001528{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001529 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001530
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001531 if (s == NULL || o == NULL)
1532 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001533
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001534 m = s->ob_type->tp_as_sequence;
1535 if (m && m->sq_concat)
1536 return m->sq_concat(s, o);
1537
Armin Rigofd163f92005-12-29 15:59:19 +00001538 /* Instances of user classes defining an __add__() method only
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001539 have an nb_add slot, not an sq_concat slot. So we fall back
Armin Rigofd163f92005-12-29 15:59:19 +00001540 to nb_add if both arguments appear to be sequences. */
1541 if (PySequence_Check(s) && PySequence_Check(o)) {
1542 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1543 if (result != Py_NotImplemented)
1544 return result;
1545 Py_DECREF(result);
1546 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001547 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001548}
1549
1550PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001551PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001552{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001553 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001554
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001555 if (o == NULL)
1556 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001557
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001558 m = o->ob_type->tp_as_sequence;
1559 if (m && m->sq_repeat)
1560 return m->sq_repeat(o, count);
1561
Armin Rigofd163f92005-12-29 15:59:19 +00001562 /* Instances of user classes defining a __mul__() method only
1563 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1564 to nb_multiply if o appears to be a sequence. */
1565 if (PySequence_Check(o)) {
1566 PyObject *n, *result;
Christian Heimes217cfd12007-12-02 14:31:20 +00001567 n = PyLong_FromSsize_t(count);
Armin Rigofd163f92005-12-29 15:59:19 +00001568 if (n == NULL)
1569 return NULL;
1570 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1571 Py_DECREF(n);
1572 if (result != Py_NotImplemented)
1573 return result;
1574 Py_DECREF(result);
1575 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001576 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001577}
1578
1579PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001580PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1581{
1582 PySequenceMethods *m;
1583
1584 if (s == NULL || o == NULL)
1585 return null_error();
1586
1587 m = s->ob_type->tp_as_sequence;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001588 if (m && m->sq_inplace_concat)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001589 return m->sq_inplace_concat(s, o);
1590 if (m && m->sq_concat)
1591 return m->sq_concat(s, o);
1592
Armin Rigofd163f92005-12-29 15:59:19 +00001593 if (PySequence_Check(s) && PySequence_Check(o)) {
1594 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1595 NB_SLOT(nb_add));
1596 if (result != Py_NotImplemented)
1597 return result;
1598 Py_DECREF(result);
1599 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001600 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001601}
1602
1603PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001604PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001605{
1606 PySequenceMethods *m;
1607
1608 if (o == NULL)
1609 return null_error();
1610
1611 m = o->ob_type->tp_as_sequence;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001612 if (m && m->sq_inplace_repeat)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001613 return m->sq_inplace_repeat(o, count);
1614 if (m && m->sq_repeat)
1615 return m->sq_repeat(o, count);
1616
Armin Rigofd163f92005-12-29 15:59:19 +00001617 if (PySequence_Check(o)) {
1618 PyObject *n, *result;
Christian Heimes217cfd12007-12-02 14:31:20 +00001619 n = PyLong_FromSsize_t(count);
Armin Rigofd163f92005-12-29 15:59:19 +00001620 if (n == NULL)
1621 return NULL;
1622 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1623 NB_SLOT(nb_multiply));
1624 Py_DECREF(n);
1625 if (result != Py_NotImplemented)
1626 return result;
1627 Py_DECREF(result);
1628 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001629 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001630}
1631
1632PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001633PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001634{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001635 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001636
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001637 if (s == NULL)
1638 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001639
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001640 m = s->ob_type->tp_as_sequence;
1641 if (m && m->sq_item) {
1642 if (i < 0) {
1643 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001644 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001645 if (l < 0)
1646 return NULL;
1647 i += l;
1648 }
1649 }
1650 return m->sq_item(s, i);
1651 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001652
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001653 return type_error("'%.200s' object is unindexable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001654}
1655
1656PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001657PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00001658{
Thomas Wouters1d75a792000-08-17 22:37:32 +00001659 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001660
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001661 if (!s) return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001662
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001663 mp = s->ob_type->tp_as_mapping;
1664 if (mp->mp_subscript) {
Thomas Wouters1d75a792000-08-17 22:37:32 +00001665 PyObject *res;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001666 PyObject *slice = _PySlice_FromIndices(i1, i2);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001667 if (!slice)
1668 return NULL;
1669 res = mp->mp_subscript(s, slice);
1670 Py_DECREF(slice);
1671 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001672 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001673
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001674 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001675}
1676
1677int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001678PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001679{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001680 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001681
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001682 if (s == NULL) {
1683 null_error();
1684 return -1;
1685 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001686
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001687 m = s->ob_type->tp_as_sequence;
1688 if (m && m->sq_ass_item) {
1689 if (i < 0) {
1690 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001691 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001692 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001693 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001694 i += l;
1695 }
1696 }
1697 return m->sq_ass_item(s, i, o);
1698 }
1699
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001700 type_error("'%.200s' object does not support item assignment", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001701 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001702}
1703
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001704int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001705PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001706{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001707 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001708
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001709 if (s == NULL) {
1710 null_error();
1711 return -1;
1712 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001713
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001714 m = s->ob_type->tp_as_sequence;
1715 if (m && m->sq_ass_item) {
1716 if (i < 0) {
1717 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001718 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001719 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001720 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001721 i += l;
1722 }
1723 }
1724 return m->sq_ass_item(s, i, (PyObject *)NULL);
1725 }
1726
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001727 type_error("'%.200s' object doesn't support item deletion", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001728 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001729}
1730
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001731int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001732PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001733{
Thomas Wouters1d75a792000-08-17 22:37:32 +00001734 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001735
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001736 if (s == NULL) {
1737 null_error();
1738 return -1;
1739 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001740
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001741 mp = s->ob_type->tp_as_mapping;
1742 if (mp->mp_ass_subscript) {
Thomas Wouters1d75a792000-08-17 22:37:32 +00001743 int res;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001744 PyObject *slice = _PySlice_FromIndices(i1, i2);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001745 if (!slice)
1746 return -1;
1747 res = mp->mp_ass_subscript(s, slice, o);
1748 Py_DECREF(slice);
1749 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001750 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00001751
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001752 type_error("'%.200s' object doesn't support slice assignment", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001753 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001754}
1755
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001756int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001757PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001758{
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001759 PyMappingMethods *mp;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001760
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001761 if (s == NULL) {
1762 null_error();
1763 return -1;
1764 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001765
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001766 mp = s->ob_type->tp_as_mapping;
1767 if (mp->mp_ass_subscript) {
1768 int res;
1769 PyObject *slice = _PySlice_FromIndices(i1, i2);
1770 if (!slice)
1771 return -1;
1772 res = mp->mp_ass_subscript(s, slice, NULL);
1773 Py_DECREF(slice);
1774 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001775 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001776 type_error("'%.200s' object doesn't support slice deletion", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001777 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001778}
1779
Guido van Rossume15dee51995-07-18 14:12:02 +00001780PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001781PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00001782{
Tim Peters6912d4d2001-05-05 03:56:37 +00001783 PyObject *it; /* iter(v) */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001784 Py_ssize_t n; /* guess for result tuple size */
Tim Peters6912d4d2001-05-05 03:56:37 +00001785 PyObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001786 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00001787
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001788 if (v == NULL)
1789 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001790
Tim Peters6912d4d2001-05-05 03:56:37 +00001791 /* Special-case the common tuple and list cases, for efficiency. */
Tim Peters4c3a0a32001-09-10 23:37:46 +00001792 if (PyTuple_CheckExact(v)) {
1793 /* Note that we can't know whether it's safe to return
1794 a tuple *subclass* instance as-is, hence the restriction
Tim Peters8ff70a92001-09-10 23:53:53 +00001795 to exact tuples here. In contrast, lists always make
1796 a copy, so there's no need for exactness below. */
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001797 Py_INCREF(v);
1798 return v;
Guido van Rossume15dee51995-07-18 14:12:02 +00001799 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001800 if (PyList_Check(v))
1801 return PyList_AsTuple(v);
1802
Tim Peters6912d4d2001-05-05 03:56:37 +00001803 /* Get iterator. */
1804 it = PyObject_GetIter(v);
1805 if (it == NULL)
Tim Peters1fc240e2001-10-26 05:06:50 +00001806 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001807
Tim Peters6912d4d2001-05-05 03:56:37 +00001808 /* Guess result size and allocate space. */
Christian Heimes255f53b2007-12-08 15:33:56 +00001809 n = _PyObject_LengthHint(v, 10);
Tim Peters6912d4d2001-05-05 03:56:37 +00001810 result = PyTuple_New(n);
1811 if (result == NULL)
1812 goto Fail;
1813
1814 /* Fill the tuple. */
1815 for (j = 0; ; ++j) {
1816 PyObject *item = PyIter_Next(it);
1817 if (item == NULL) {
1818 if (PyErr_Occurred())
1819 goto Fail;
1820 break;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001821 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001822 if (j >= n) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001823 Py_ssize_t oldn = n;
Raymond Hettinger4d012592004-12-16 10:38:38 +00001824 /* The over-allocation strategy can grow a bit faster
Guido van Rossum98297ee2007-11-06 21:34:58 +00001825 than for lists because unlike lists the
Raymond Hettinger4d012592004-12-16 10:38:38 +00001826 over-allocation isn't permanent -- we reclaim
1827 the excess before the end of this routine.
1828 So, grow by ten and then add 25%.
1829 */
1830 n += 10;
1831 n += n >> 2;
1832 if (n < oldn) {
1833 /* Check for overflow */
1834 PyErr_NoMemory();
Raymond Hettingere6bdb372004-12-16 15:10:21 +00001835 Py_DECREF(item);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001836 goto Fail;
Raymond Hettinger4d012592004-12-16 10:38:38 +00001837 }
Tim Peters4324aa32001-05-28 22:30:08 +00001838 if (_PyTuple_Resize(&result, n) != 0) {
Tim Peters12d0a6c2001-05-05 04:10:25 +00001839 Py_DECREF(item);
Tim Peters6912d4d2001-05-05 03:56:37 +00001840 goto Fail;
Tim Peters12d0a6c2001-05-05 04:10:25 +00001841 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001842 }
1843 PyTuple_SET_ITEM(result, j, item);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001844 }
1845
Tim Peters6912d4d2001-05-05 03:56:37 +00001846 /* Cut tuple back if guess was too large. */
1847 if (j < n &&
Tim Peters4324aa32001-05-28 22:30:08 +00001848 _PyTuple_Resize(&result, j) != 0)
Tim Peters6912d4d2001-05-05 03:56:37 +00001849 goto Fail;
1850
1851 Py_DECREF(it);
1852 return result;
1853
1854Fail:
1855 Py_XDECREF(result);
1856 Py_DECREF(it);
1857 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001858}
1859
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001860PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001861PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001862{
Tim Petersf553f892001-05-01 20:45:31 +00001863 PyObject *result; /* result list */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001864 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00001865
Guido van Rossum5dba9e81998-07-10 18:03:50 +00001866 if (v == NULL)
1867 return null_error();
1868
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +00001869 result = PyList_New(0);
1870 if (result == NULL)
Tim Petersf553f892001-05-01 20:45:31 +00001871 return NULL;
1872
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +00001873 rv = _PyList_Extend((PyListObject *)result, v);
1874 if (rv == NULL) {
1875 Py_DECREF(result);
Tim Petersf553f892001-05-01 20:45:31 +00001876 return NULL;
1877 }
Raymond Hettinger969d8c02004-03-17 05:24:23 +00001878 Py_DECREF(rv);
Tim Petersf553f892001-05-01 20:45:31 +00001879 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001880}
1881
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001882PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001883PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001884{
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001885 PyObject *it;
1886
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001887 if (v == NULL)
1888 return null_error();
1889
Michael W. Hudson2801fe12002-11-05 18:05:49 +00001890 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001891 Py_INCREF(v);
1892 return v;
1893 }
1894
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001895 it = PyObject_GetIter(v);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001896 if (it == NULL) {
1897 if (PyErr_ExceptionMatches(PyExc_TypeError))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001898 PyErr_SetString(PyExc_TypeError, m);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001899 return NULL;
1900 }
1901
Raymond Hettinger193814c2004-12-18 19:00:59 +00001902 v = PySequence_List(it);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001903 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001904
1905 return v;
1906}
1907
Tim Peters16a77ad2001-09-08 04:00:12 +00001908/* Iterate over seq. Result depends on the operation:
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001909 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
1910 PY_ITERSEARCH_INDEX: 0-based index of first occurence of obj in seq;
1911 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00001912 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
1913*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001914Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001915_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00001916{
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001917 Py_ssize_t n;
Tim Peters16a77ad2001-09-08 04:00:12 +00001918 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
1919 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00001920
Tim Peters16a77ad2001-09-08 04:00:12 +00001921 if (seq == NULL || obj == NULL) {
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001922 null_error();
1923 return -1;
1924 }
Tim Peters75f8e352001-05-05 11:33:43 +00001925
Tim Peters16a77ad2001-09-08 04:00:12 +00001926 it = PyObject_GetIter(seq);
Tim Peters75f8e352001-05-05 11:33:43 +00001927 if (it == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001928 type_error("argument of type '%.200s' is not iterable", seq);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001929 return -1;
Tim Peters75f8e352001-05-05 11:33:43 +00001930 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001931
Tim Peters16a77ad2001-09-08 04:00:12 +00001932 n = wrapped = 0;
Tim Peters75f8e352001-05-05 11:33:43 +00001933 for (;;) {
1934 int cmp;
1935 PyObject *item = PyIter_Next(it);
1936 if (item == NULL) {
1937 if (PyErr_Occurred())
1938 goto Fail;
1939 break;
1940 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001941
1942 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001943 Py_DECREF(item);
Tim Peters75f8e352001-05-05 11:33:43 +00001944 if (cmp < 0)
1945 goto Fail;
1946 if (cmp > 0) {
Tim Peters16a77ad2001-09-08 04:00:12 +00001947 switch (operation) {
1948 case PY_ITERSEARCH_COUNT:
Thomas Wouters89f507f2006-12-13 04:49:30 +00001949 if (n == PY_SSIZE_T_MAX) {
Tim Peters16a77ad2001-09-08 04:00:12 +00001950 PyErr_SetString(PyExc_OverflowError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00001951 "count exceeds C integer size");
Tim Peters16a77ad2001-09-08 04:00:12 +00001952 goto Fail;
1953 }
Thomas Wouters89f507f2006-12-13 04:49:30 +00001954 ++n;
Tim Peters16a77ad2001-09-08 04:00:12 +00001955 break;
1956
1957 case PY_ITERSEARCH_INDEX:
1958 if (wrapped) {
1959 PyErr_SetString(PyExc_OverflowError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00001960 "index exceeds C integer size");
Tim Peters16a77ad2001-09-08 04:00:12 +00001961 goto Fail;
1962 }
1963 goto Done;
1964
1965 case PY_ITERSEARCH_CONTAINS:
1966 n = 1;
1967 goto Done;
1968
1969 default:
1970 assert(!"unknown operation");
Tim Peters75f8e352001-05-05 11:33:43 +00001971 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001972 }
1973
1974 if (operation == PY_ITERSEARCH_INDEX) {
Thomas Wouters89f507f2006-12-13 04:49:30 +00001975 if (n == PY_SSIZE_T_MAX)
Tim Peters16a77ad2001-09-08 04:00:12 +00001976 wrapped = 1;
Thomas Wouters89f507f2006-12-13 04:49:30 +00001977 ++n;
Tim Peters75f8e352001-05-05 11:33:43 +00001978 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001979 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001980
1981 if (operation != PY_ITERSEARCH_INDEX)
1982 goto Done;
1983
1984 PyErr_SetString(PyExc_ValueError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001985 "sequence.index(x): x not in sequence");
Tim Peters16a77ad2001-09-08 04:00:12 +00001986 /* fall into failure code */
1987Fail:
1988 n = -1;
1989 /* fall through */
1990Done:
Tim Peters75f8e352001-05-05 11:33:43 +00001991 Py_DECREF(it);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001992 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00001993
Guido van Rossume15dee51995-07-18 14:12:02 +00001994}
1995
Tim Peters16a77ad2001-09-08 04:00:12 +00001996/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001997Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001998PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001999{
Tim Peters16a77ad2001-09-08 04:00:12 +00002000 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00002001}
2002
Tim Peterscb8d3682001-05-05 21:05:01 +00002003/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00002004 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00002005 */
2006int
2007PySequence_Contains(PyObject *seq, PyObject *ob)
2008{
Neal Norwitz1fc4b772006-03-04 18:49:58 +00002009 Py_ssize_t result;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002010 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002011 if (sqm != NULL && sqm->sq_contains != NULL)
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002012 return (*sqm->sq_contains)(seq, ob);
Neal Norwitz1fc4b772006-03-04 18:49:58 +00002013 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
2014 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00002015}
2016
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002017/* Backwards compatibility */
2018#undef PySequence_In
2019int
Fred Drake79912472000-07-09 04:06:11 +00002020PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002021{
2022 return PySequence_Contains(w, v);
2023}
2024
Neal Norwitz1fc4b772006-03-04 18:49:58 +00002025Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00002026PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002027{
Tim Peters16a77ad2001-09-08 04:00:12 +00002028 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00002029}
2030
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002031/* Operations on mappings */
2032
2033int
Fred Drake79912472000-07-09 04:06:11 +00002034PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002035{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002036 return o && o->ob_type->tp_as_mapping &&
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00002037 o->ob_type->tp_as_mapping->mp_subscript;
Guido van Rossume15dee51995-07-18 14:12:02 +00002038}
2039
Martin v. Löwis18e16552006-02-15 17:27:45 +00002040Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00002041PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002042{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002043 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00002044
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002045 if (o == NULL) {
2046 null_error();
2047 return -1;
2048 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002049
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002050 m = o->ob_type->tp_as_mapping;
2051 if (m && m->mp_length)
2052 return m->mp_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00002053
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002054 type_error("object of type '%.200s' has no len()", o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002055 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00002056}
2057
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002058#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00002059Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002060PyMapping_Length(PyObject *o)
2061{
2062 return PyMapping_Size(o);
2063}
2064#define PyMapping_Length PyMapping_Size
2065
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002066PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002067PyMapping_GetItemString(PyObject *o, char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002068{
2069 PyObject *okey, *r;
2070
2071 if (key == NULL)
2072 return null_error();
2073
Martin v. Löwis5b222132007-06-10 09:51:05 +00002074 okey = PyUnicode_FromString(key);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002075 if (okey == NULL)
2076 return NULL;
2077 r = PyObject_GetItem(o, okey);
2078 Py_DECREF(okey);
2079 return r;
2080}
2081
2082int
Fred Drake79912472000-07-09 04:06:11 +00002083PyMapping_SetItemString(PyObject *o, char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002084{
2085 PyObject *okey;
2086 int r;
2087
2088 if (key == NULL) {
2089 null_error();
2090 return -1;
2091 }
2092
Martin v. Löwis5b222132007-06-10 09:51:05 +00002093 okey = PyUnicode_FromString(key);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002094 if (okey == NULL)
Guido van Rossumed6219b1998-05-29 02:59:33 +00002095 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002096 r = PyObject_SetItem(o, okey, value);
2097 Py_DECREF(okey);
2098 return r;
2099}
2100
2101int
Fred Drake79912472000-07-09 04:06:11 +00002102PyMapping_HasKeyString(PyObject *o, char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002103{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002104 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002105
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002106 v = PyMapping_GetItemString(o, key);
2107 if (v) {
2108 Py_DECREF(v);
2109 return 1;
2110 }
2111 PyErr_Clear();
2112 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002113}
2114
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002115int
Fred Drake79912472000-07-09 04:06:11 +00002116PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002117{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002118 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002119
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002120 v = PyObject_GetItem(o, key);
2121 if (v) {
2122 Py_DECREF(v);
2123 return 1;
2124 }
2125 PyErr_Clear();
2126 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002127}
2128
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002129PyObject *
2130PyMapping_Keys(PyObject *o)
2131{
2132 PyObject *keys;
2133 PyObject *fast;
2134
2135 if (PyDict_CheckExact(o))
2136 return PyDict_Keys(o);
2137 keys = PyObject_CallMethod(o, "keys", NULL);
2138 if (keys == NULL)
2139 return NULL;
2140 fast = PySequence_Fast(keys, "o.keys() are not iterable");
2141 Py_DECREF(keys);
2142 return fast;
2143}
2144
2145PyObject *
2146PyMapping_Items(PyObject *o)
2147{
2148 PyObject *items;
2149 PyObject *fast;
2150
2151 if (PyDict_CheckExact(o))
2152 return PyDict_Items(o);
2153 items = PyObject_CallMethod(o, "items", NULL);
2154 if (items == NULL)
2155 return NULL;
2156 fast = PySequence_Fast(items, "o.items() are not iterable");
2157 Py_DECREF(items);
2158 return fast;
2159}
2160
2161PyObject *
2162PyMapping_Values(PyObject *o)
2163{
2164 PyObject *values;
2165 PyObject *fast;
2166
2167 if (PyDict_CheckExact(o))
2168 return PyDict_Values(o);
2169 values = PyObject_CallMethod(o, "values", NULL);
2170 if (values == NULL)
2171 return NULL;
2172 fast = PySequence_Fast(values, "o.values() are not iterable");
2173 Py_DECREF(values);
2174 return fast;
2175}
2176
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002177/* Operations on callable objects */
2178
2179/* XXX PyCallable_Check() is in object.c */
2180
Guido van Rossume15dee51995-07-18 14:12:02 +00002181PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002182PyObject_CallObject(PyObject *o, PyObject *a)
Guido van Rossume15dee51995-07-18 14:12:02 +00002183{
Guido van Rossum5560b742001-09-14 16:47:50 +00002184 return PyEval_CallObjectWithKeywords(o, a, NULL);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002185}
Guido van Rossume15dee51995-07-18 14:12:02 +00002186
2187PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002188PyObject_Call(PyObject *func, PyObject *arg, PyObject *kw)
2189{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002190 ternaryfunc call;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002191
2192 if ((call = func->ob_type->tp_call) != NULL) {
Thomas Wouters89d996e2007-09-08 17:39:28 +00002193 PyObject *result;
2194 if (Py_EnterRecursiveCall(" while calling a Python object"))
2195 return NULL;
2196 result = (*call)(func, arg, kw);
2197 Py_LeaveRecursiveCall();
Tim Peters6d6c1a32001-08-02 04:15:00 +00002198 if (result == NULL && !PyErr_Occurred())
2199 PyErr_SetString(
2200 PyExc_SystemError,
2201 "NULL result without error in PyObject_Call");
2202 return result;
2203 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002204 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
Fred Drake573395a2001-11-01 20:26:12 +00002205 func->ob_type->tp_name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002206 return NULL;
2207}
2208
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002209static PyObject*
2210call_function_tail(PyObject *callable, PyObject *args)
2211{
2212 PyObject *retval;
2213
2214 if (args == NULL)
2215 return NULL;
2216
2217 if (!PyTuple_Check(args)) {
2218 PyObject *a;
2219
2220 a = PyTuple_New(1);
2221 if (a == NULL) {
2222 Py_DECREF(args);
2223 return NULL;
2224 }
2225 PyTuple_SET_ITEM(a, 0, args);
2226 args = a;
2227 }
2228 retval = PyObject_Call(callable, args, NULL);
2229
2230 Py_DECREF(args);
2231
2232 return retval;
2233}
2234
Tim Peters6d6c1a32001-08-02 04:15:00 +00002235PyObject *
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002236PyObject_CallFunction(PyObject *callable, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002237{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002238 va_list va;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002239 PyObject *args;
Guido van Rossume15dee51995-07-18 14:12:02 +00002240
Fred Drakeb92cf062001-10-27 06:16:31 +00002241 if (callable == NULL)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002242 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002243
Fred Drakeb92cf062001-10-27 06:16:31 +00002244 if (format && *format) {
2245 va_start(va, format);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002246 args = Py_VaBuildValue(format, va);
Fred Drakeb92cf062001-10-27 06:16:31 +00002247 va_end(va);
2248 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002249 else
2250 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002251
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002252 return call_function_tail(callable, args);
2253}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002254
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002255PyObject *
2256_PyObject_CallFunction_SizeT(PyObject *callable, char *format, ...)
2257{
2258 va_list va;
2259 PyObject *args;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002260
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002261 if (callable == NULL)
2262 return null_error();
2263
2264 if (format && *format) {
2265 va_start(va, format);
2266 args = _Py_VaBuildValue_SizeT(format, va);
2267 va_end(va);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002268 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002269 else
2270 args = PyTuple_New(0);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002271
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002272 return call_function_tail(callable, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002273}
2274
2275PyObject *
Guido van Rossume15dee51995-07-18 14:12:02 +00002276PyObject_CallMethod(PyObject *o, char *name, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002277{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002278 va_list va;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002279 PyObject *args;
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002280 PyObject *func = NULL;
2281 PyObject *retval = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002282
Fred Drakeb92cf062001-10-27 06:16:31 +00002283 if (o == NULL || name == NULL)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002284 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002285
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002286 func = PyObject_GetAttrString(o, name);
2287 if (func == NULL) {
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002288 PyErr_SetString(PyExc_AttributeError, name);
2289 return 0;
2290 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002291
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002292 if (!PyCallable_Check(func)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002293 type_error("attribute of type '%.200s' is not callable", func);
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002294 goto exit;
2295 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002296
Fred Drakeb92cf062001-10-27 06:16:31 +00002297 if (format && *format) {
2298 va_start(va, format);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002299 args = Py_VaBuildValue(format, va);
Fred Drakeb92cf062001-10-27 06:16:31 +00002300 va_end(va);
2301 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002302 else
2303 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002304
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002305 retval = call_function_tail(func, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002306
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002307 exit:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002308 /* args gets consumed in call_function_tail */
2309 Py_XDECREF(func);
2310
2311 return retval;
2312}
2313
2314PyObject *
2315_PyObject_CallMethod_SizeT(PyObject *o, char *name, char *format, ...)
2316{
2317 va_list va;
2318 PyObject *args;
2319 PyObject *func = NULL;
2320 PyObject *retval = NULL;
2321
2322 if (o == NULL || name == NULL)
2323 return null_error();
2324
2325 func = PyObject_GetAttrString(o, name);
2326 if (func == NULL) {
2327 PyErr_SetString(PyExc_AttributeError, name);
2328 return 0;
2329 }
2330
2331 if (!PyCallable_Check(func)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002332 type_error("attribute of type '%.200s' is not callable", func);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002333 goto exit;
2334 }
2335
2336 if (format && *format) {
2337 va_start(va, format);
2338 args = _Py_VaBuildValue_SizeT(format, va);
2339 va_end(va);
2340 }
2341 else
2342 args = PyTuple_New(0);
2343
2344 retval = call_function_tail(func, args);
2345
2346 exit:
2347 /* args gets consumed in call_function_tail */
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002348 Py_XDECREF(func);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002349
2350 return retval;
Guido van Rossume15dee51995-07-18 14:12:02 +00002351}
Guido van Rossum823649d2001-03-21 18:40:58 +00002352
2353
Fred Drakeb421b8c2001-10-26 16:21:32 +00002354static PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002355objargs_mktuple(va_list va)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002356{
2357 int i, n = 0;
2358 va_list countva;
2359 PyObject *result, *tmp;
2360
2361#ifdef VA_LIST_IS_ARRAY
2362 memcpy(countva, va, sizeof(va_list));
2363#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002364#ifdef __va_copy
2365 __va_copy(countva, va);
2366#else
Fred Drakeb421b8c2001-10-26 16:21:32 +00002367 countva = va;
2368#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002369#endif
Fred Drakeb421b8c2001-10-26 16:21:32 +00002370
2371 while (((PyObject *)va_arg(countva, PyObject *)) != NULL)
2372 ++n;
2373 result = PyTuple_New(n);
2374 if (result != NULL && n > 0) {
2375 for (i = 0; i < n; ++i) {
2376 tmp = (PyObject *)va_arg(va, PyObject *);
2377 PyTuple_SET_ITEM(result, i, tmp);
2378 Py_INCREF(tmp);
2379 }
2380 }
2381 return result;
2382}
2383
2384PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002385PyObject_CallMethodObjArgs(PyObject *callable, PyObject *name, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002386{
2387 PyObject *args, *tmp;
2388 va_list vargs;
2389
2390 if (callable == NULL || name == NULL)
2391 return null_error();
2392
2393 callable = PyObject_GetAttr(callable, name);
2394 if (callable == NULL)
2395 return NULL;
2396
2397 /* count the args */
2398 va_start(vargs, name);
Fred Drakeb0c079e2001-10-28 02:39:03 +00002399 args = objargs_mktuple(vargs);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002400 va_end(vargs);
2401 if (args == NULL) {
2402 Py_DECREF(callable);
2403 return NULL;
2404 }
2405 tmp = PyObject_Call(callable, args, NULL);
2406 Py_DECREF(args);
2407 Py_DECREF(callable);
2408
2409 return tmp;
2410}
2411
2412PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002413PyObject_CallFunctionObjArgs(PyObject *callable, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002414{
2415 PyObject *args, *tmp;
2416 va_list vargs;
2417
2418 if (callable == NULL)
2419 return null_error();
2420
2421 /* count the args */
2422 va_start(vargs, callable);
Fred Drakeb0c079e2001-10-28 02:39:03 +00002423 args = objargs_mktuple(vargs);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002424 va_end(vargs);
2425 if (args == NULL)
2426 return NULL;
2427 tmp = PyObject_Call(callable, args, NULL);
2428 Py_DECREF(args);
2429
2430 return tmp;
2431}
2432
2433
Guido van Rossum823649d2001-03-21 18:40:58 +00002434/* isinstance(), issubclass() */
2435
Barry Warsawf16951c2002-04-23 22:45:44 +00002436/* abstract_get_bases() has logically 4 return states, with a sort of 0th
2437 * state that will almost never happen.
2438 *
2439 * 0. creating the __bases__ static string could get a MemoryError
2440 * 1. getattr(cls, '__bases__') could raise an AttributeError
2441 * 2. getattr(cls, '__bases__') could raise some other exception
2442 * 3. getattr(cls, '__bases__') could return a tuple
2443 * 4. getattr(cls, '__bases__') could return something other than a tuple
2444 *
2445 * Only state #3 is a non-error state and only it returns a non-NULL object
2446 * (it returns the retrieved tuple).
2447 *
2448 * Any raised AttributeErrors are masked by clearing the exception and
2449 * returning NULL. If an object other than a tuple comes out of __bases__,
2450 * then again, the return value is NULL. So yes, these two situations
2451 * produce exactly the same results: NULL is returned and no error is set.
2452 *
2453 * If some exception other than AttributeError is raised, then NULL is also
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002454 * returned, but the exception is not cleared. That's because we want the
Barry Warsawf16951c2002-04-23 22:45:44 +00002455 * exception to be propagated along.
2456 *
2457 * Callers are expected to test for PyErr_Occurred() when the return value
2458 * is NULL to decide whether a valid exception should be propagated or not.
2459 * When there's no exception to propagate, it's customary for the caller to
2460 * set a TypeError.
2461 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002462static PyObject *
2463abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002464{
2465 static PyObject *__bases__ = NULL;
2466 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002467
2468 if (__bases__ == NULL) {
Christian Heimesfe82e772008-01-28 02:38:20 +00002469 __bases__ = PyUnicode_InternFromString("__bases__");
Guido van Rossum823649d2001-03-21 18:40:58 +00002470 if (__bases__ == NULL)
Neil Schemenauer6b471292001-10-18 03:18:43 +00002471 return NULL;
Guido van Rossum823649d2001-03-21 18:40:58 +00002472 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002473 Py_ALLOW_RECURSION
Neil Schemenauer6b471292001-10-18 03:18:43 +00002474 bases = PyObject_GetAttr(cls, __bases__);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002475 Py_END_ALLOW_RECURSION
Barry Warsawf16951c2002-04-23 22:45:44 +00002476 if (bases == NULL) {
2477 if (PyErr_ExceptionMatches(PyExc_AttributeError))
2478 PyErr_Clear();
Neil Schemenauer6b471292001-10-18 03:18:43 +00002479 return NULL;
Guido van Rossum823649d2001-03-21 18:40:58 +00002480 }
Barry Warsawf16951c2002-04-23 22:45:44 +00002481 if (!PyTuple_Check(bases)) {
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002482 Py_DECREF(bases);
Barry Warsawf16951c2002-04-23 22:45:44 +00002483 return NULL;
2484 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002485 return bases;
2486}
2487
2488
2489static int
2490abstract_issubclass(PyObject *derived, PyObject *cls)
2491{
2492 PyObject *bases;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002493 Py_ssize_t i, n;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002494 int r = 0;
2495
2496
Guido van Rossum823649d2001-03-21 18:40:58 +00002497 if (derived == cls)
2498 return 1;
2499
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002500 if (PyTuple_Check(cls)) {
2501 /* Not a general sequence -- that opens up the road to
2502 recursion and stack overflow. */
2503 n = PyTuple_GET_SIZE(cls);
2504 for (i = 0; i < n; i++) {
2505 if (derived == PyTuple_GET_ITEM(cls, i))
2506 return 1;
2507 }
2508 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002509 bases = abstract_get_bases(derived);
Barry Warsawf16951c2002-04-23 22:45:44 +00002510 if (bases == NULL) {
2511 if (PyErr_Occurred())
2512 return -1;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002513 return 0;
Barry Warsawf16951c2002-04-23 22:45:44 +00002514 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002515 n = PyTuple_GET_SIZE(bases);
2516 for (i = 0; i < n; i++) {
Neil Schemenauer6b471292001-10-18 03:18:43 +00002517 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002518 if (r != 0)
2519 break;
2520 }
2521
2522 Py_DECREF(bases);
2523
2524 return r;
2525}
2526
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002527static int
2528check_class(PyObject *cls, const char *error)
2529{
2530 PyObject *bases = abstract_get_bases(cls);
2531 if (bases == NULL) {
2532 /* Do not mask errors. */
2533 if (!PyErr_Occurred())
2534 PyErr_SetString(PyExc_TypeError, error);
2535 return 0;
2536 }
2537 Py_DECREF(bases);
2538 return -1;
2539}
2540
Brett Cannon4f653312004-03-20 22:52:14 +00002541static int
2542recursive_isinstance(PyObject *inst, PyObject *cls, int recursion_depth)
Guido van Rossum823649d2001-03-21 18:40:58 +00002543{
2544 PyObject *icls;
2545 static PyObject *__class__ = NULL;
2546 int retval = 0;
2547
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002548 if (__class__ == NULL) {
Christian Heimesfe82e772008-01-28 02:38:20 +00002549 __class__ = PyUnicode_InternFromString("__class__");
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002550 if (__class__ == NULL)
2551 return -1;
2552 }
2553
Guido van Rossum45aecf42006-03-15 04:58:47 +00002554 if (PyType_Check(cls)) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00002555 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002556 if (retval == 0) {
2557 PyObject *c = PyObject_GetAttr(inst, __class__);
2558 if (c == NULL) {
2559 PyErr_Clear();
2560 }
2561 else {
Guido van Rossume5b130b2003-02-12 03:36:05 +00002562 if (c != (PyObject *)(inst->ob_type) &&
2563 PyType_Check(c))
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002564 retval = PyType_IsSubtype(
2565 (PyTypeObject *)c,
2566 (PyTypeObject *)cls);
2567 Py_DECREF(c);
2568 }
2569 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002570 }
Guido van Rossum03290ec2001-10-07 20:54:12 +00002571 else if (PyTuple_Check(cls)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00002572 Py_ssize_t i, n;
Guido van Rossum03290ec2001-10-07 20:54:12 +00002573
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002574 if (!recursion_depth) {
2575 PyErr_SetString(PyExc_RuntimeError,
2576 "nest level of tuple too deep");
2577 return -1;
2578 }
Brett Cannon4f653312004-03-20 22:52:14 +00002579
Guido van Rossum03290ec2001-10-07 20:54:12 +00002580 n = PyTuple_GET_SIZE(cls);
2581 for (i = 0; i < n; i++) {
Brett Cannon4f653312004-03-20 22:52:14 +00002582 retval = recursive_isinstance(
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002583 inst,
2584 PyTuple_GET_ITEM(cls, i),
2585 recursion_depth-1);
Guido van Rossum03290ec2001-10-07 20:54:12 +00002586 if (retval != 0)
2587 break;
2588 }
Guido van Rossum03290ec2001-10-07 20:54:12 +00002589 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002590 else {
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002591 if (!check_class(cls,
2592 "isinstance() arg 2 must be a class, type,"
2593 " or tuple of classes and types"))
Neil Schemenauer6b471292001-10-18 03:18:43 +00002594 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002595 icls = PyObject_GetAttr(inst, __class__);
Neil Schemenauer6b471292001-10-18 03:18:43 +00002596 if (icls == NULL) {
2597 PyErr_Clear();
2598 retval = 0;
Guido van Rossum823649d2001-03-21 18:40:58 +00002599 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002600 else {
2601 retval = abstract_issubclass(icls, cls);
2602 Py_DECREF(icls);
2603 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002604 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002605
Guido van Rossum823649d2001-03-21 18:40:58 +00002606 return retval;
2607}
2608
2609int
Brett Cannon4f653312004-03-20 22:52:14 +00002610PyObject_IsInstance(PyObject *inst, PyObject *cls)
2611{
Christian Heimesa156e092008-02-16 07:38:31 +00002612 static PyObject *name = NULL;
Guido van Rossume7ba4952007-06-06 23:52:48 +00002613 PyObject *checker;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002614
2615 /* Quick test for an exact match */
2616 if (Py_TYPE(inst) == (PyTypeObject *)cls)
2617 return 1;
2618
Christian Heimesa156e092008-02-16 07:38:31 +00002619 if (name == NULL) {
2620 name = PyUnicode_InternFromString("__instancecheck__");
2621 if (name == NULL)
2622 return -1;
2623 }
2624 checker = PyObject_GetAttr(cls, name);
Christian Heimese25f35e2008-03-20 10:49:03 +00002625 if (checker == NULL && PyErr_Occurred())
2626 PyErr_Clear();
Guido van Rossumadee45e2007-05-25 17:55:52 +00002627 if (checker != NULL) {
2628 PyObject *res;
2629 int ok = -1;
Guido van Rossum29478ef2007-05-29 00:39:44 +00002630 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2631 Py_DECREF(checker);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002632 return ok;
Guido van Rossum29478ef2007-05-29 00:39:44 +00002633 }
Guido van Rossumadee45e2007-05-25 17:55:52 +00002634 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
2635 Py_LeaveRecursiveCall();
2636 Py_DECREF(checker);
2637 if (res != NULL) {
2638 ok = PyObject_IsTrue(res);
2639 Py_DECREF(res);
2640 }
2641 return ok;
2642 }
2643 return recursive_isinstance(inst, cls, Py_GetRecursionLimit());
Brett Cannon4f653312004-03-20 22:52:14 +00002644}
2645
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002646static int
Brett Cannon4f653312004-03-20 22:52:14 +00002647recursive_issubclass(PyObject *derived, PyObject *cls, int recursion_depth)
Guido van Rossum823649d2001-03-21 18:40:58 +00002648{
2649 int retval;
2650
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002651 {
Guido van Rossumf6c9ba82003-02-10 16:05:43 +00002652 if (!check_class(derived,
2653 "issubclass() arg 1 must be a class"))
Neil Schemenauer6b471292001-10-18 03:18:43 +00002654 return -1;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002655
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002656 if (PyTuple_Check(cls)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00002657 Py_ssize_t i;
2658 Py_ssize_t n = PyTuple_GET_SIZE(cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002659
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002660 if (!recursion_depth) {
2661 PyErr_SetString(PyExc_RuntimeError,
2662 "nest level of tuple too deep");
2663 return -1;
2664 }
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002665 for (i = 0; i < n; ++i) {
Brett Cannon4f653312004-03-20 22:52:14 +00002666 retval = recursive_issubclass(
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002667 derived,
2668 PyTuple_GET_ITEM(cls, i),
2669 recursion_depth-1);
Guido van Rossumf6c9ba82003-02-10 16:05:43 +00002670 if (retval != 0) {
2671 /* either found it, or got an error */
Walter Dörwald7e5c6a02002-12-12 19:14:08 +00002672 return retval;
Guido van Rossumf6c9ba82003-02-10 16:05:43 +00002673 }
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002674 }
Walter Dörwald7e5c6a02002-12-12 19:14:08 +00002675 return 0;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002676 }
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002677 else {
2678 if (!check_class(cls,
2679 "issubclass() arg 2 must be a class"
2680 " or tuple of classes"))
2681 return -1;
2682 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002683
2684 retval = abstract_issubclass(derived, cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002685 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002686
2687 return retval;
2688}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002689
Brett Cannon4f653312004-03-20 22:52:14 +00002690int
2691PyObject_IsSubclass(PyObject *derived, PyObject *cls)
2692{
Christian Heimesa156e092008-02-16 07:38:31 +00002693 static PyObject *name = NULL;
Guido van Rossumadee45e2007-05-25 17:55:52 +00002694 PyObject *t, *v, *tb;
Guido van Rossume7ba4952007-06-06 23:52:48 +00002695 PyObject *checker;
Guido van Rossumadee45e2007-05-25 17:55:52 +00002696 PyErr_Fetch(&t, &v, &tb);
Christian Heimesa156e092008-02-16 07:38:31 +00002697
2698 if (name == NULL) {
2699 name = PyUnicode_InternFromString("__subclasscheck__");
2700 if (name == NULL)
2701 return -1;
2702 }
2703 checker = PyObject_GetAttr(cls, name);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002704 PyErr_Restore(t, v, tb);
2705 if (checker != NULL) {
2706 PyObject *res;
2707 int ok = -1;
2708 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
2709 return ok;
2710 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
2711 Py_LeaveRecursiveCall();
2712 Py_DECREF(checker);
2713 if (res != NULL) {
2714 ok = PyObject_IsTrue(res);
2715 Py_DECREF(res);
2716 }
2717 return ok;
2718 }
2719 return recursive_issubclass(derived, cls, Py_GetRecursionLimit());
Brett Cannon4f653312004-03-20 22:52:14 +00002720}
2721
2722
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002723PyObject *
2724PyObject_GetIter(PyObject *o)
2725{
2726 PyTypeObject *t = o->ob_type;
2727 getiterfunc f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002728 f = t->tp_iter;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002729 if (f == NULL) {
2730 if (PySequence_Check(o))
Guido van Rossum213c7a62001-04-23 14:08:49 +00002731 return PySeqIter_New(o);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002732 return type_error("'%.200s' object is not iterable", o);
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002733 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00002734 else {
2735 PyObject *res = (*f)(o);
2736 if (res != NULL && !PyIter_Check(res)) {
2737 PyErr_Format(PyExc_TypeError,
2738 "iter() returned non-iterator "
2739 "of type '%.100s'",
2740 res->ob_type->tp_name);
2741 Py_DECREF(res);
2742 res = NULL;
2743 }
2744 return res;
2745 }
2746}
2747
Tim Petersf4848da2001-05-05 00:14:56 +00002748/* Return next item.
2749 * If an error occurs, return NULL. PyErr_Occurred() will be true.
2750 * If the iteration terminates normally, return NULL and clear the
2751 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
2752 * will be false.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002753 * Else return the next object. PyErr_Occurred() will be false.
Tim Petersf4848da2001-05-05 00:14:56 +00002754 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002755PyObject *
2756PyIter_Next(PyObject *iter)
2757{
Tim Petersf4848da2001-05-05 00:14:56 +00002758 PyObject *result;
Raymond Hettinger8049dde2003-03-01 01:44:32 +00002759 assert(PyIter_Check(iter));
Tim Petersf4848da2001-05-05 00:14:56 +00002760 result = (*iter->ob_type->tp_iternext)(iter);
2761 if (result == NULL &&
2762 PyErr_Occurred() &&
2763 PyErr_ExceptionMatches(PyExc_StopIteration))
2764 PyErr_Clear();
2765 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002766}