blob: 6b73acad10ce104779f2dacf1e46924a4f7ae1ec [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
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000352static int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000353_IsFortranContiguous(Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000354{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000355 Py_ssize_t sd, dim;
356 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000357
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000358 if (view->ndim == 0) return 1;
359 if (view->strides == NULL) return (view->ndim == 1);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000360
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000361 sd = view->itemsize;
362 if (view->ndim == 1) return (view->shape[0] == 1 ||
363 sd == view->strides[0]);
364 for (i=0; i<view->ndim; i++) {
365 dim = view->shape[i];
366 if (dim == 0) return 1;
367 if (view->strides[i] != sd) return 0;
368 sd *= dim;
369 }
370 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000371}
372
373static int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000374_IsCContiguous(Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000375{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000376 Py_ssize_t sd, dim;
377 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000378
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000379 if (view->ndim == 0) return 1;
380 if (view->strides == NULL) return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000381
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000382 sd = view->itemsize;
383 if (view->ndim == 1) return (view->shape[0] == 1 ||
384 sd == view->strides[0]);
385 for (i=view->ndim-1; i>=0; i--) {
386 dim = view->shape[i];
387 if (dim == 0) return 1;
388 if (view->strides[i] != sd) return 0;
389 sd *= dim;
390 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000391 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000392}
393
394int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000395PyBuffer_IsContiguous(Py_buffer *view, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000396{
397
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000398 if (view->suboffsets != NULL) return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000399
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000400 if (fort == 'C')
401 return _IsCContiguous(view);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000402 else if (fort == 'F')
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000403 return _IsFortranContiguous(view);
404 else if (fort == 'A')
405 return (_IsCContiguous(view) || _IsFortranContiguous(view));
406 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000407}
408
409
Guido van Rossum98297ee2007-11-06 21:34:58 +0000410void*
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000411PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000412{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000413 char* pointer;
414 int i;
415 pointer = (char *)view->buf;
416 for (i = 0; i < view->ndim; i++) {
417 pointer += view->strides[i]*indices[i];
418 if ((view->suboffsets != NULL) && (view->suboffsets[i] >= 0)) {
419 pointer = *((char**)pointer) + view->suboffsets[i];
420 }
421 }
422 return (void*)pointer;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000423}
424
425
Guido van Rossum98297ee2007-11-06 21:34:58 +0000426void
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000427_add_one_to_index_F(int nd, Py_ssize_t *index, Py_ssize_t *shape)
428{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000429 int k;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000430
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000431 for (k=0; k<nd; k++) {
432 if (index[k] < shape[k]-1) {
433 index[k]++;
434 break;
435 }
436 else {
437 index[k] = 0;
438 }
439 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000440}
441
Guido van Rossum98297ee2007-11-06 21:34:58 +0000442void
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000443_add_one_to_index_C(int nd, Py_ssize_t *index, Py_ssize_t *shape)
444{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000445 int k;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000446
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000447 for (k=nd-1; k>=0; k--) {
448 if (index[k] < shape[k]-1) {
449 index[k]++;
450 break;
451 }
452 else {
453 index[k] = 0;
454 }
455 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000456}
457
458 /* view is not checked for consistency in either of these. It is
Guido van Rossum98297ee2007-11-06 21:34:58 +0000459 assumed that the size of the buffer is view->len in
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000460 view->len / view->itemsize elements.
461 */
462
Guido van Rossum98297ee2007-11-06 21:34:58 +0000463int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000464PyBuffer_ToContiguous(void *buf, Py_buffer *view, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000465{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000466 int k;
467 void (*addone)(int, Py_ssize_t *, Py_ssize_t *);
468 Py_ssize_t *indices, elements;
469 char *dest, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000470
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000471 if (len > view->len) {
472 len = view->len;
473 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000474
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000475 if (PyBuffer_IsContiguous(view, fort)) {
476 /* simplest copy is all that is needed */
477 memcpy(buf, view->buf, len);
478 return 0;
479 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000480
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000481 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000482
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000483 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000484 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
485 if (indices == NULL) {
486 PyErr_NoMemory();
487 return -1;
488 }
489 for (k=0; k<view->ndim;k++) {
490 indices[k] = 0;
491 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000492
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000493 if (fort == 'F') {
494 addone = _add_one_to_index_F;
495 }
496 else {
497 addone = _add_one_to_index_C;
498 }
499 dest = buf;
500 /* XXX : This is not going to be the fastest code in the world
Guido van Rossum98297ee2007-11-06 21:34:58 +0000501 several optimizations are possible.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000502 */
503 elements = len / view->itemsize;
504 while (elements--) {
505 addone(view->ndim, indices, view->shape);
506 ptr = PyBuffer_GetPointer(view, indices);
507 memcpy(dest, ptr, view->itemsize);
508 dest += view->itemsize;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000509 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000510 PyMem_Free(indices);
511 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000512}
513
514int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000515PyBuffer_FromContiguous(Py_buffer *view, void *buf, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000516{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000517 int k;
518 void (*addone)(int, Py_ssize_t *, Py_ssize_t *);
519 Py_ssize_t *indices, elements;
520 char *src, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000521
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000522 if (len > view->len) {
523 len = view->len;
524 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000525
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000526 if (PyBuffer_IsContiguous(view, fort)) {
527 /* simplest copy is all that is needed */
528 memcpy(view->buf, buf, len);
529 return 0;
530 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000531
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000532 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000533
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000534 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000535 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
536 if (indices == NULL) {
537 PyErr_NoMemory();
538 return -1;
539 }
540 for (k=0; k<view->ndim;k++) {
541 indices[k] = 0;
542 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000543
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000544 if (fort == 'F') {
545 addone = _add_one_to_index_F;
546 }
547 else {
548 addone = _add_one_to_index_C;
549 }
550 src = buf;
551 /* XXX : This is not going to be the fastest code in the world
Guido van Rossum98297ee2007-11-06 21:34:58 +0000552 several optimizations are possible.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000553 */
554 elements = len / view->itemsize;
555 while (elements--) {
556 addone(view->ndim, indices, view->shape);
557 ptr = PyBuffer_GetPointer(view, indices);
558 memcpy(ptr, src, view->itemsize);
559 src += view->itemsize;
560 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000561
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000562 PyMem_Free(indices);
563 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000564}
565
Guido van Rossum98297ee2007-11-06 21:34:58 +0000566int PyObject_CopyData(PyObject *dest, PyObject *src)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000567{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000568 Py_buffer view_dest, view_src;
569 int k;
570 Py_ssize_t *indices, elements;
571 char *dptr, *sptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000572
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000573 if (!PyObject_CheckBuffer(dest) ||
574 !PyObject_CheckBuffer(src)) {
575 PyErr_SetString(PyExc_TypeError,
576 "both destination and source must have the "\
577 "buffer interface");
578 return -1;
579 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000580
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000581 if (PyObject_GetBuffer(dest, &view_dest, PyBUF_FULL) != 0) return -1;
582 if (PyObject_GetBuffer(src, &view_src, PyBUF_FULL_RO) != 0) {
Martin v. Löwis423be952008-08-13 15:53:07 +0000583 PyBuffer_Release(&view_dest);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000584 return -1;
585 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000586
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000587 if (view_dest.len < view_src.len) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000588 PyErr_SetString(PyExc_BufferError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000589 "destination is too small to receive data from source");
Martin v. Löwis423be952008-08-13 15:53:07 +0000590 PyBuffer_Release(&view_dest);
591 PyBuffer_Release(&view_src);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000592 return -1;
593 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000594
Guido van Rossum98297ee2007-11-06 21:34:58 +0000595 if ((PyBuffer_IsContiguous(&view_dest, 'C') &&
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000596 PyBuffer_IsContiguous(&view_src, 'C')) ||
Guido van Rossum98297ee2007-11-06 21:34:58 +0000597 (PyBuffer_IsContiguous(&view_dest, 'F') &&
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000598 PyBuffer_IsContiguous(&view_src, 'F'))) {
599 /* simplest copy is all that is needed */
600 memcpy(view_dest.buf, view_src.buf, view_src.len);
Martin v. Löwis423be952008-08-13 15:53:07 +0000601 PyBuffer_Release(&view_dest);
602 PyBuffer_Release(&view_src);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000603 return 0;
604 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000605
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000606 /* Otherwise a more elaborate copy scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000607
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000608 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000609 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*view_src.ndim);
610 if (indices == NULL) {
611 PyErr_NoMemory();
Martin v. Löwis423be952008-08-13 15:53:07 +0000612 PyBuffer_Release(&view_dest);
613 PyBuffer_Release(&view_src);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000614 return -1;
615 }
616 for (k=0; k<view_src.ndim;k++) {
617 indices[k] = 0;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000618 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000619 elements = 1;
620 for (k=0; k<view_src.ndim; k++) {
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000621 /* XXX(nnorwitz): can this overflow? */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000622 elements *= view_src.shape[k];
623 }
624 while (elements--) {
625 _add_one_to_index_C(view_src.ndim, indices, view_src.shape);
626 dptr = PyBuffer_GetPointer(&view_dest, indices);
627 sptr = PyBuffer_GetPointer(&view_src, indices);
628 memcpy(dptr, sptr, view_src.itemsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000629 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000630 PyMem_Free(indices);
Martin v. Löwis423be952008-08-13 15:53:07 +0000631 PyBuffer_Release(&view_dest);
632 PyBuffer_Release(&view_src);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000633 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000634}
635
636void
637PyBuffer_FillContiguousStrides(int nd, Py_ssize_t *shape,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000638 Py_ssize_t *strides, int itemsize,
639 char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000640{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000641 int k;
642 Py_ssize_t sd;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000643
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000644 sd = itemsize;
645 if (fort == 'F') {
646 for (k=0; k<nd; k++) {
647 strides[k] = sd;
648 sd *= shape[k];
Guido van Rossum98297ee2007-11-06 21:34:58 +0000649 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000650 }
651 else {
652 for (k=nd-1; k>=0; k--) {
653 strides[k] = sd;
654 sd *= shape[k];
655 }
656 }
657 return;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000658}
659
660int
Martin v. Löwis423be952008-08-13 15:53:07 +0000661PyBuffer_FillInfo(Py_buffer *view, PyObject *obj, void *buf, Py_ssize_t len,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000662 int readonly, int flags)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000663{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000664 if (view == NULL) return 0;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000665 if (((flags & PyBUF_WRITABLE) == PyBUF_WRITABLE) &&
666 (readonly == 1)) {
667 PyErr_SetString(PyExc_BufferError,
668 "Object is not writable.");
669 return -1;
670 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000671
Martin v. Löwis423be952008-08-13 15:53:07 +0000672 view->obj = obj;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000673 view->buf = buf;
674 view->len = len;
675 view->readonly = readonly;
676 view->itemsize = 1;
677 view->format = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000678 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT)
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000679 view->format = "B";
680 view->ndim = 1;
681 view->shape = NULL;
682 if ((flags & PyBUF_ND) == PyBUF_ND)
683 view->shape = &(view->len);
684 view->strides = NULL;
685 if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES)
686 view->strides = &(view->itemsize);
687 view->suboffsets = NULL;
688 view->internal = NULL;
689 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000690}
691
Martin v. Löwis423be952008-08-13 15:53:07 +0000692void
693PyBuffer_Release(Py_buffer *view)
694{
695 PyObject *obj = view->obj;
696 if (!obj || !Py_TYPE(obj)->tp_as_buffer || !Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer)
697 /* Unmanaged buffer */
698 return;
699 Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer(obj, view);
700
701}
702
Eric Smith8fd3eba2008-02-17 19:48:00 +0000703PyObject *
704PyObject_Format(PyObject *obj, PyObject *format_spec)
705{
706 static PyObject * str__format__ = NULL;
707 PyObject *meth;
708 PyObject *empty = NULL;
709 PyObject *result = NULL;
710
711 /* Initialize cached value */
712 if (str__format__ == NULL) {
713 /* Initialize static variable needed by _PyType_Lookup */
714 str__format__ = PyUnicode_FromString("__format__");
715 if (str__format__ == NULL)
716 goto done;
717 }
718
719 /* If no format_spec is provided, use an empty string */
720 if (format_spec == NULL) {
721 empty = PyUnicode_FromUnicode(NULL, 0);
722 format_spec = empty;
723 }
724
725 /* Make sure the type is initialized. float gets initialized late */
726 if (Py_TYPE(obj)->tp_dict == NULL)
727 if (PyType_Ready(Py_TYPE(obj)) < 0)
728 goto done;
729
730 /* Find the (unbound!) __format__ method (a borrowed reference) */
731 meth = _PyType_Lookup(Py_TYPE(obj), str__format__);
732 if (meth == NULL) {
733 PyErr_Format(PyExc_TypeError,
734 "Type %.100s doesn't define __format__",
735 Py_TYPE(obj)->tp_name);
736 goto done;
737 }
738
739 /* And call it, binding it to the value */
740 result = PyObject_CallFunctionObjArgs(meth, obj, format_spec, NULL);
741
742 if (result && !PyUnicode_Check(result)) {
743 PyErr_SetString(PyExc_TypeError,
744 "__format__ method did not return string");
745 Py_DECREF(result);
746 result = NULL;
747 goto done;
748 }
749
750done:
751 Py_XDECREF(empty);
752 return result;
753}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000754/* Operations on numbers */
755
756int
Fred Drake79912472000-07-09 04:06:11 +0000757PyNumber_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +0000758{
Guido van Rossum6921eca2003-02-18 16:36:28 +0000759 return o && o->ob_type->tp_as_number &&
760 (o->ob_type->tp_as_number->nb_int ||
761 o->ob_type->tp_as_number->nb_float);
Guido van Rossume15dee51995-07-18 14:12:02 +0000762}
763
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000764/* Binary operators */
Guido van Rossume15dee51995-07-18 14:12:02 +0000765
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000766#define NB_SLOT(x) offsetof(PyNumberMethods, x)
767#define NB_BINOP(nb_methods, slot) \
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000768 (*(binaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000769#define NB_TERNOP(nb_methods, slot) \
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000770 (*(ternaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000771
772/*
773 Calling scheme used for binary operations:
774
Neal Norwitz4886cc32006-08-21 17:06:07 +0000775 Order operations are tried until either a valid result or error:
776 w.op(v,w)[*], v.op(v,w), w.op(v,w)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000777
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000778 [*] only when v->ob_type != w->ob_type && w->ob_type is a subclass of
779 v->ob_type
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000780 */
781
782static PyObject *
783binary_op1(PyObject *v, PyObject *w, const int op_slot)
Guido van Rossume15dee51995-07-18 14:12:02 +0000784{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000785 PyObject *x;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000786 binaryfunc slotv = NULL;
787 binaryfunc slotw = NULL;
788
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000789 if (v->ob_type->tp_as_number != NULL)
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000790 slotv = NB_BINOP(v->ob_type->tp_as_number, op_slot);
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000791 if (w->ob_type != v->ob_type &&
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000792 w->ob_type->tp_as_number != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000793 slotw = NB_BINOP(w->ob_type->tp_as_number, op_slot);
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000794 if (slotw == slotv)
795 slotw = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000796 }
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000797 if (slotv) {
Guido van Rossum89c42642001-10-01 17:10:18 +0000798 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
799 x = slotw(v, w);
800 if (x != Py_NotImplemented)
801 return x;
802 Py_DECREF(x); /* can't do it */
803 slotw = NULL;
804 }
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000805 x = slotv(v, w);
806 if (x != Py_NotImplemented)
807 return x;
808 Py_DECREF(x); /* can't do it */
809 }
810 if (slotw) {
811 x = slotw(v, w);
812 if (x != Py_NotImplemented)
813 return x;
814 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000815 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000816 Py_INCREF(Py_NotImplemented);
817 return Py_NotImplemented;
818}
Guido van Rossum77660912002-04-16 16:32:50 +0000819
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000820static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000821binop_type_error(PyObject *v, PyObject *w, const char *op_name)
822{
823 PyErr_Format(PyExc_TypeError,
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000824 "unsupported operand type(s) for %.100s: "
825 "'%.100s' and '%.100s'",
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000826 op_name,
827 v->ob_type->tp_name,
828 w->ob_type->tp_name);
829 return NULL;
830}
831
832static PyObject *
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000833binary_op(PyObject *v, PyObject *w, const int op_slot, const char *op_name)
834{
835 PyObject *result = binary_op1(v, w, op_slot);
836 if (result == Py_NotImplemented) {
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000837 Py_DECREF(result);
838 return binop_type_error(v, w, op_name);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000839 }
840 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000841}
842
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000843
844/*
845 Calling scheme used for ternary operations:
846
Neal Norwitz4886cc32006-08-21 17:06:07 +0000847 Order operations are tried until either a valid result or error:
848 v.op(v,w,z), w.op(v,w,z), z.op(v,w,z)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000849 */
850
851static PyObject *
852ternary_op(PyObject *v,
853 PyObject *w,
854 PyObject *z,
855 const int op_slot,
856 const char *op_name)
Guido van Rossume15dee51995-07-18 14:12:02 +0000857{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000858 PyNumberMethods *mv, *mw, *mz;
Guido van Rossum84675ac2001-09-29 01:05:03 +0000859 PyObject *x = NULL;
860 ternaryfunc slotv = NULL;
861 ternaryfunc slotw = NULL;
862 ternaryfunc slotz = NULL;
Guido van Rossum77660912002-04-16 16:32:50 +0000863
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000864 mv = v->ob_type->tp_as_number;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000865 mw = w->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000866 if (mv != NULL)
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000867 slotv = NB_TERNOP(mv, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000868 if (w->ob_type != v->ob_type &&
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000869 mw != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000870 slotw = NB_TERNOP(mw, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000871 if (slotw == slotv)
872 slotw = NULL;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000873 }
Guido van Rossum84675ac2001-09-29 01:05:03 +0000874 if (slotv) {
Guido van Rossum89c42642001-10-01 17:10:18 +0000875 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
876 x = slotw(v, w, z);
877 if (x != Py_NotImplemented)
878 return x;
879 Py_DECREF(x); /* can't do it */
880 slotw = NULL;
881 }
Guido van Rossum84675ac2001-09-29 01:05:03 +0000882 x = slotv(v, w, z);
883 if (x != Py_NotImplemented)
884 return x;
885 Py_DECREF(x); /* can't do it */
886 }
887 if (slotw) {
888 x = slotw(v, w, z);
889 if (x != Py_NotImplemented)
890 return x;
891 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000892 }
893 mz = z->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000894 if (mz != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000895 slotz = NB_TERNOP(mz, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000896 if (slotz == slotv || slotz == slotw)
897 slotz = NULL;
898 if (slotz) {
899 x = slotz(v, w, z);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000900 if (x != Py_NotImplemented)
901 return x;
Guido van Rossum84675ac2001-09-29 01:05:03 +0000902 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000903 }
904 }
905
Guido van Rossum5c66a262001-10-22 04:12:44 +0000906 if (z == Py_None)
907 PyErr_Format(
908 PyExc_TypeError,
909 "unsupported operand type(s) for ** or pow(): "
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000910 "'%.100s' and '%.100s'",
Guido van Rossum5c66a262001-10-22 04:12:44 +0000911 v->ob_type->tp_name,
912 w->ob_type->tp_name);
913 else
914 PyErr_Format(
915 PyExc_TypeError,
916 "unsupported operand type(s) for pow(): "
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000917 "'%.100s', '%.100s', '%.100s'",
Guido van Rossum5c66a262001-10-22 04:12:44 +0000918 v->ob_type->tp_name,
919 w->ob_type->tp_name,
920 z->ob_type->tp_name);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000921 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000922}
923
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000924#define BINARY_FUNC(func, op, op_name) \
925 PyObject * \
926 func(PyObject *v, PyObject *w) { \
927 return binary_op(v, w, NB_SLOT(op), op_name); \
928 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000929
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000930BINARY_FUNC(PyNumber_Or, nb_or, "|")
931BINARY_FUNC(PyNumber_Xor, nb_xor, "^")
932BINARY_FUNC(PyNumber_And, nb_and, "&")
933BINARY_FUNC(PyNumber_Lshift, nb_lshift, "<<")
934BINARY_FUNC(PyNumber_Rshift, nb_rshift, ">>")
935BINARY_FUNC(PyNumber_Subtract, nb_subtract, "-")
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000936BINARY_FUNC(PyNumber_Divmod, nb_divmod, "divmod()")
Guido van Rossume15dee51995-07-18 14:12:02 +0000937
938PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000939PyNumber_Add(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000940{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000941 PyObject *result = binary_op1(v, w, NB_SLOT(nb_add));
942 if (result == Py_NotImplemented) {
943 PySequenceMethods *m = v->ob_type->tp_as_sequence;
Armin Rigofd163f92005-12-29 15:59:19 +0000944 Py_DECREF(result);
Jeremy Hylton0522d982002-03-08 21:28:54 +0000945 if (m && m->sq_concat) {
Armin Rigofd163f92005-12-29 15:59:19 +0000946 return (*m->sq_concat)(v, w);
Jeremy Hylton0522d982002-03-08 21:28:54 +0000947 }
Armin Rigofd163f92005-12-29 15:59:19 +0000948 result = binop_type_error(v, w, "+");
Guido van Rossume15dee51995-07-18 14:12:02 +0000949 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000950 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000951}
952
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000953static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000954sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000955{
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000956 Py_ssize_t count;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000957 if (PyIndex_Check(n)) {
958 count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000959 if (count == -1 && PyErr_Occurred())
960 return NULL;
961 }
962 else {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000963 return type_error("can't multiply sequence by "
964 "non-int of type '%.200s'", n);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000965 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000966 return (*repeatfunc)(seq, count);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000967}
968
969PyObject *
970PyNumber_Multiply(PyObject *v, PyObject *w)
971{
972 PyObject *result = binary_op1(v, w, NB_SLOT(nb_multiply));
973 if (result == Py_NotImplemented) {
974 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
975 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
Guido van Rossuma3a243e2002-12-31 19:50:03 +0000976 Py_DECREF(result);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000977 if (mv && mv->sq_repeat) {
978 return sequence_repeat(mv->sq_repeat, v, w);
979 }
980 else if (mw && mw->sq_repeat) {
981 return sequence_repeat(mw->sq_repeat, w, v);
982 }
983 result = binop_type_error(v, w, "*");
984 }
985 return result;
986}
987
Guido van Rossume15dee51995-07-18 14:12:02 +0000988PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +0000989PyNumber_FloorDivide(PyObject *v, PyObject *w)
990{
Guido van Rossum4668b002001-08-08 05:00:18 +0000991 return binary_op(v, w, NB_SLOT(nb_floor_divide), "//");
992}
993
994PyObject *
995PyNumber_TrueDivide(PyObject *v, PyObject *w)
996{
Guido van Rossum4668b002001-08-08 05:00:18 +0000997 return binary_op(v, w, NB_SLOT(nb_true_divide), "/");
998}
999
1000PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001001PyNumber_Remainder(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +00001002{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001003 return binary_op(v, w, NB_SLOT(nb_remainder), "%");
Guido van Rossume15dee51995-07-18 14:12:02 +00001004}
1005
1006PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001007PyNumber_Power(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossume15dee51995-07-18 14:12:02 +00001008{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001009 return ternary_op(v, w, z, NB_SLOT(nb_power), "** or pow()");
Guido van Rossume15dee51995-07-18 14:12:02 +00001010}
1011
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001012/* Binary in-place operators */
1013
1014/* The in-place operators are defined to fall back to the 'normal',
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001015 non in-place operations, if the in-place methods are not in place.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001016
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001017 - If the left hand object has the appropriate struct members, and
1018 they are filled, call the appropriate function and return the
1019 result. No coercion is done on the arguments; the left-hand object
1020 is the one the operation is performed on, and it's up to the
1021 function to deal with the right-hand object.
Guido van Rossum77660912002-04-16 16:32:50 +00001022
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001023 - Otherwise, in-place modification is not supported. Handle it exactly as
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001024 a non in-place operation of the same kind.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001025
1026 */
1027
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001028static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001029binary_iop1(PyObject *v, PyObject *w, const int iop_slot, const int op_slot)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001030{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001031 PyNumberMethods *mv = v->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001032 if (mv != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +00001033 binaryfunc slot = NB_BINOP(mv, iop_slot);
1034 if (slot) {
1035 PyObject *x = (slot)(v, w);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001036 if (x != Py_NotImplemented) {
1037 return x;
1038 }
1039 Py_DECREF(x);
1040 }
Thomas Woutersf2b332d2000-09-02 08:34:40 +00001041 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001042 return binary_op1(v, w, op_slot);
1043}
1044
1045static PyObject *
1046binary_iop(PyObject *v, PyObject *w, const int iop_slot, const int op_slot,
1047 const char *op_name)
1048{
1049 PyObject *result = binary_iop1(v, w, iop_slot, op_slot);
1050 if (result == Py_NotImplemented) {
1051 Py_DECREF(result);
1052 return binop_type_error(v, w, op_name);
1053 }
1054 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001055}
1056
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001057#define INPLACE_BINOP(func, iop, op, op_name) \
1058 PyObject * \
1059 func(PyObject *v, PyObject *w) { \
1060 return binary_iop(v, w, NB_SLOT(iop), NB_SLOT(op), op_name); \
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001061 }
1062
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001063INPLACE_BINOP(PyNumber_InPlaceOr, nb_inplace_or, nb_or, "|=")
1064INPLACE_BINOP(PyNumber_InPlaceXor, nb_inplace_xor, nb_xor, "^=")
1065INPLACE_BINOP(PyNumber_InPlaceAnd, nb_inplace_and, nb_and, "&=")
1066INPLACE_BINOP(PyNumber_InPlaceLshift, nb_inplace_lshift, nb_lshift, "<<=")
1067INPLACE_BINOP(PyNumber_InPlaceRshift, nb_inplace_rshift, nb_rshift, ">>=")
1068INPLACE_BINOP(PyNumber_InPlaceSubtract, nb_inplace_subtract, nb_subtract, "-=")
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001069
1070PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001071PyNumber_InPlaceFloorDivide(PyObject *v, PyObject *w)
1072{
Guido van Rossum4668b002001-08-08 05:00:18 +00001073 return binary_iop(v, w, NB_SLOT(nb_inplace_floor_divide),
1074 NB_SLOT(nb_floor_divide), "//=");
1075}
1076
1077PyObject *
1078PyNumber_InPlaceTrueDivide(PyObject *v, PyObject *w)
1079{
Guido van Rossum4668b002001-08-08 05:00:18 +00001080 return binary_iop(v, w, NB_SLOT(nb_inplace_true_divide),
1081 NB_SLOT(nb_true_divide), "/=");
1082}
1083
1084PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001085PyNumber_InPlaceAdd(PyObject *v, PyObject *w)
1086{
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001087 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_add),
1088 NB_SLOT(nb_add));
1089 if (result == Py_NotImplemented) {
1090 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1091 Py_DECREF(result);
1092 if (m != NULL) {
1093 binaryfunc f = NULL;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001094 f = m->sq_inplace_concat;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001095 if (f == NULL)
1096 f = m->sq_concat;
1097 if (f != NULL)
1098 return (*f)(v, w);
1099 }
1100 result = binop_type_error(v, w, "+=");
Guido van Rossumbb8be932000-09-01 23:27:32 +00001101 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001102 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001103}
1104
1105PyObject *
1106PyNumber_InPlaceMultiply(PyObject *v, PyObject *w)
1107{
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001108 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_multiply),
1109 NB_SLOT(nb_multiply));
1110 if (result == Py_NotImplemented) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001111 ssizeargfunc f = NULL;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001112 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1113 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1114 Py_DECREF(result);
1115 if (mv != NULL) {
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001116 f = mv->sq_inplace_repeat;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001117 if (f == NULL)
1118 f = mv->sq_repeat;
1119 if (f != NULL)
1120 return sequence_repeat(f, v, w);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001121 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001122 else if (mw != NULL) {
1123 /* Note that the right hand operand should not be
1124 * mutated in this case so sq_inplace_repeat is not
1125 * used. */
1126 if (mw->sq_repeat)
1127 return sequence_repeat(mw->sq_repeat, w, v);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001128 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001129 result = binop_type_error(v, w, "*=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001130 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001131 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001132}
1133
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001134PyObject *
1135PyNumber_InPlaceRemainder(PyObject *v, PyObject *w)
1136{
Neil Schemenauerd46fbc32002-11-24 01:07:42 +00001137 return binary_iop(v, w, NB_SLOT(nb_inplace_remainder),
1138 NB_SLOT(nb_remainder), "%=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001139}
1140
1141PyObject *
1142PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
1143{
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001144 if (v->ob_type->tp_as_number &&
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001145 v->ob_type->tp_as_number->nb_inplace_power != NULL) {
1146 return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001147 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001148 else {
1149 return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
1150 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001151}
1152
1153
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001154/* Unary operators and functions */
Guido van Rossume15dee51995-07-18 14:12:02 +00001155
1156PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001157PyNumber_Negative(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001158{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001159 PyNumberMethods *m;
1160
1161 if (o == NULL)
1162 return null_error();
1163 m = o->ob_type->tp_as_number;
1164 if (m && m->nb_negative)
1165 return (*m->nb_negative)(o);
1166
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001167 return type_error("bad operand type for unary -: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001168}
1169
1170PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001171PyNumber_Positive(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001172{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001173 PyNumberMethods *m;
1174
1175 if (o == NULL)
1176 return null_error();
1177 m = o->ob_type->tp_as_number;
1178 if (m && m->nb_positive)
1179 return (*m->nb_positive)(o);
1180
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001181 return type_error("bad operand type for unary +: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001182}
1183
1184PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001185PyNumber_Invert(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001186{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001187 PyNumberMethods *m;
1188
1189 if (o == NULL)
1190 return null_error();
1191 m = o->ob_type->tp_as_number;
1192 if (m && m->nb_invert)
1193 return (*m->nb_invert)(o);
1194
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001195 return type_error("bad operand type for unary ~: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001196}
1197
1198PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001199PyNumber_Absolute(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001200{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001201 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001202
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001203 if (o == NULL)
1204 return null_error();
1205 m = o->ob_type->tp_as_number;
1206 if (m && m->nb_absolute)
1207 return m->nb_absolute(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001208
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001209 return type_error("bad operand type for abs(): '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001210}
1211
Guido van Rossum98297ee2007-11-06 21:34:58 +00001212/* Return a Python Int or Long from the object item
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001213 Raise TypeError if the result is not an int-or-long
Guido van Rossum98297ee2007-11-06 21:34:58 +00001214 or if the object cannot be interpreted as an index.
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001215*/
1216PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001217PyNumber_Index(PyObject *item)
1218{
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001219 PyObject *result = NULL;
1220 if (item == NULL)
1221 return null_error();
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001222 if (PyLong_Check(item)) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001223 Py_INCREF(item);
1224 return item;
1225 }
1226 if (PyIndex_Check(item)) {
Trent Nelson71792202008-04-11 23:02:37 +00001227 result = item->ob_type->tp_as_number->nb_index(item);
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001228 if (result && !PyLong_Check(result)) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001229 PyErr_Format(PyExc_TypeError,
Guido van Rossum032a2842007-02-26 05:44:27 +00001230 "__index__ returned non-int "
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001231 "(type %.200s)",
1232 result->ob_type->tp_name);
1233 Py_DECREF(result);
1234 return NULL;
1235 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001236 }
Trent Nelson71792202008-04-11 23:02:37 +00001237 else {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001238 PyErr_Format(PyExc_TypeError,
1239 "'%.200s' object cannot be interpreted "
Guido van Rossum032a2842007-02-26 05:44:27 +00001240 "as an integer", item->ob_type->tp_name);
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001241 }
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001242 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001243}
1244
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001245/* Return an error on Overflow only if err is not NULL*/
1246
1247Py_ssize_t
1248PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1249{
1250 Py_ssize_t result;
1251 PyObject *runerr;
1252 PyObject *value = PyNumber_Index(item);
1253 if (value == NULL)
1254 return -1;
1255
Christian Heimes217cfd12007-12-02 14:31:20 +00001256 /* We're done if PyLong_AsSsize_t() returns without error. */
1257 result = PyLong_AsSsize_t(value);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001258 if (result != -1 || !(runerr = PyErr_Occurred()))
1259 goto finish;
1260
1261 /* Error handling code -- only manage OverflowError differently */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001262 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001263 goto finish;
1264
1265 PyErr_Clear();
Guido van Rossum98297ee2007-11-06 21:34:58 +00001266 /* If no error-handling desired then the default clipping
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001267 is sufficient.
1268 */
1269 if (!err) {
1270 assert(PyLong_Check(value));
Guido van Rossum98297ee2007-11-06 21:34:58 +00001271 /* Whether or not it is less than or equal to
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001272 zero is determined by the sign of ob_size
1273 */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001274 if (_PyLong_Sign(value) < 0)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001275 result = PY_SSIZE_T_MIN;
1276 else
1277 result = PY_SSIZE_T_MAX;
1278 }
1279 else {
1280 /* Otherwise replace the error with caller's error object. */
1281 PyErr_Format(err,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001282 "cannot fit '%.200s' into an index-sized integer",
1283 item->ob_type->tp_name);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001284 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001285
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001286 finish:
1287 Py_DECREF(value);
1288 return result;
1289}
1290
1291
Christian Heimes15ebc882008-02-04 18:48:49 +00001292PyObject *
1293_PyNumber_ConvertIntegralToInt(PyObject *integral, const char* error_format)
1294{
1295 static PyObject *int_name = NULL;
1296 if (int_name == NULL) {
1297 int_name = PyUnicode_InternFromString("__int__");
1298 if (int_name == NULL)
1299 return NULL;
1300 }
1301
1302 if (integral && !PyLong_Check(integral)) {
1303 /* Don't go through tp_as_number->nb_int to avoid
1304 hitting the classic class fallback to __trunc__. */
1305 PyObject *int_func = PyObject_GetAttr(integral, int_name);
1306 if (int_func == NULL) {
1307 PyErr_Clear(); /* Raise a different error. */
1308 goto non_integral_error;
1309 }
1310 Py_DECREF(integral);
1311 integral = PyEval_CallObject(int_func, NULL);
1312 Py_DECREF(int_func);
1313 if (integral && !PyLong_Check(integral)) {
1314 goto non_integral_error;
1315 }
1316 }
1317 return integral;
1318
1319non_integral_error:
1320 PyErr_Format(PyExc_TypeError, error_format, Py_TYPE(integral)->tp_name);
1321 Py_DECREF(integral);
1322 return NULL;
1323}
1324
1325
Guido van Rossum9e896b32000-04-05 20:11:21 +00001326/* Add a check for embedded NULL-bytes in the argument. */
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001327static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001328long_from_string(const char *s, Py_ssize_t len)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001329{
Guido van Rossum4c08d552000-03-10 22:55:18 +00001330 char *end;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001331 PyObject *x;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001332
Guido van Rossum4c08d552000-03-10 22:55:18 +00001333 x = PyLong_FromString((char*)s, &end, 10);
Guido van Rossum9e896b32000-04-05 20:11:21 +00001334 if (x == NULL)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001335 return NULL;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001336 if (end != s + len) {
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001337 PyErr_SetString(PyExc_ValueError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001338 "null byte in argument for int()");
Guido van Rossum9e896b32000-04-05 20:11:21 +00001339 Py_DECREF(x);
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001340 return NULL;
1341 }
1342 return x;
1343}
1344
Guido van Rossume15dee51995-07-18 14:12:02 +00001345PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001346PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001347{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001348 PyNumberMethods *m;
Christian Heimes15ebc882008-02-04 18:48:49 +00001349 static PyObject *trunc_name = NULL;
1350 PyObject *trunc_func;
Guido van Rossum4c08d552000-03-10 22:55:18 +00001351 const char *buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001352 Py_ssize_t buffer_len;
Guido van Rossume15dee51995-07-18 14:12:02 +00001353
Christian Heimes15ebc882008-02-04 18:48:49 +00001354 if (trunc_name == NULL) {
1355 trunc_name = PyUnicode_InternFromString("__trunc__");
1356 if (trunc_name == NULL)
1357 return NULL;
1358 }
1359
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001360 if (o == NULL)
1361 return null_error();
Guido van Rossumddefaf32007-01-14 03:31:43 +00001362 if (PyLong_CheckExact(o)) {
1363 Py_INCREF(o);
1364 return o;
1365 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001366 m = o->ob_type->tp_as_number;
Guido van Rossumddefaf32007-01-14 03:31:43 +00001367 if (m && m->nb_int) { /* This should include subclasses of int */
1368 PyObject *res = m->nb_int(o);
1369 if (res && !PyLong_Check(res)) {
1370 PyErr_Format(PyExc_TypeError,
1371 "__int__ returned non-int (type %.200s)",
1372 res->ob_type->tp_name);
1373 Py_DECREF(res);
1374 return NULL;
1375 }
1376 return res;
1377 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001378 if (m && m->nb_long) { /* This should include subclasses of long */
Christian Heimes15ebc882008-02-04 18:48:49 +00001379 /* Classic classes always take this branch. */
Brett Cannonc3647ac2005-04-26 03:45:26 +00001380 PyObject *res = m->nb_long(o);
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001381 if (res && !PyLong_Check(res)) {
Brett Cannonc3647ac2005-04-26 03:45:26 +00001382 PyErr_Format(PyExc_TypeError,
1383 "__long__ returned non-long (type %.200s)",
1384 res->ob_type->tp_name);
1385 Py_DECREF(res);
1386 return NULL;
1387 }
1388 return res;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001389 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001390 if (PyLong_Check(o)) /* A long subclass without nb_long */
Tim Petersdb30ac42002-03-02 04:14:21 +00001391 return _PyLong_Copy((PyLongObject *)o);
Christian Heimes15ebc882008-02-04 18:48:49 +00001392 trunc_func = PyObject_GetAttr(o, trunc_name);
1393 if (trunc_func) {
1394 PyObject *truncated = PyEval_CallObject(trunc_func, NULL);
1395 PyObject *int_instance;
1396 Py_DECREF(trunc_func);
1397 /* __trunc__ is specified to return an Integral type,
1398 but long() needs to return a long. */
1399 int_instance = _PyNumber_ConvertIntegralToInt(
1400 truncated,
1401 "__trunc__ returned non-Integral (type %.200s)");
1402 return int_instance;
1403 }
1404 PyErr_Clear(); /* It's not an error if o.__trunc__ doesn't exist. */
1405
Christian Heimes72b710a2008-05-26 13:28:38 +00001406 if (PyBytes_Check(o))
Christian Heimes15ebc882008-02-04 18:48:49 +00001407 /* need to do extra error checking that PyLong_FromString()
1408 * doesn't do. In particular long('9.5') must raise an
1409 * exception, not truncate the float.
1410 */
Christian Heimes72b710a2008-05-26 13:28:38 +00001411 return long_from_string(PyBytes_AS_STRING(o),
1412 PyBytes_GET_SIZE(o));
Guido van Rossum9e896b32000-04-05 20:11:21 +00001413 if (PyUnicode_Check(o))
1414 /* The above check is done in PyLong_FromUnicode(). */
1415 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(o),
1416 PyUnicode_GET_SIZE(o),
1417 10);
Guido van Rossum4c08d552000-03-10 22:55:18 +00001418 if (!PyObject_AsCharBuffer(o, &buffer, &buffer_len))
1419 return long_from_string(buffer, buffer_len);
Guido van Rossume15dee51995-07-18 14:12:02 +00001420
Guido van Rossumddefaf32007-01-14 03:31:43 +00001421 return type_error("int() argument must be a string or a "
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001422 "number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001423}
1424
1425PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001426PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001427{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001428 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001429
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001430 if (o == NULL)
1431 return null_error();
Brett Cannonc3647ac2005-04-26 03:45:26 +00001432 m = o->ob_type->tp_as_number;
1433 if (m && m->nb_float) { /* This should include subclasses of float */
1434 PyObject *res = m->nb_float(o);
1435 if (res && !PyFloat_Check(res)) {
1436 PyErr_Format(PyExc_TypeError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001437 "__float__ returned non-float (type %.200s)",
1438 res->ob_type->tp_name);
Brett Cannonc3647ac2005-04-26 03:45:26 +00001439 Py_DECREF(res);
1440 return NULL;
1441 }
1442 return res;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001443 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001444 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
Tim Peters7a50f252001-09-10 21:28:20 +00001445 PyFloatObject *po = (PyFloatObject *)o;
1446 return PyFloat_FromDouble(po->ob_fval);
1447 }
Georg Brandl428f0642007-03-18 18:35:15 +00001448 return PyFloat_FromString(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001449}
1450
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001451
1452PyObject *
1453PyNumber_ToBase(PyObject *n, int base)
1454{
Christian Heimesa156e092008-02-16 07:38:31 +00001455 PyObject *res = NULL;
Raymond Hettinger5c960b82008-06-24 22:28:56 +00001456 PyObject *index = PyNumber_Index(n);
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001457
1458 if (!index)
1459 return NULL;
Christian Heimesa156e092008-02-16 07:38:31 +00001460 if (PyLong_Check(index))
1461 res = _PyLong_Format(index, base);
1462 else
1463 /* It should not be possible to get here, as
1464 PyNumber_Index already has a check for the same
1465 condition */
1466 PyErr_SetString(PyExc_ValueError, "PyNumber_ToBase: index not "
1467 "int or long");
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001468 Py_DECREF(index);
1469 return res;
1470}
1471
1472
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001473/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001474
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001475int
Fred Drake79912472000-07-09 04:06:11 +00001476PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001477{
Thomas Wouterscf297e42007-02-23 15:07:44 +00001478 if (PyObject_IsInstance(s, (PyObject *)&PyDict_Type))
1479 return 0;
Guido van Rossum8700b422001-09-07 20:20:11 +00001480 return s != NULL && s->ob_type->tp_as_sequence &&
1481 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001482}
1483
Martin v. Löwis18e16552006-02-15 17:27:45 +00001484Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001485PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001486{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001487 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001488
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001489 if (s == NULL) {
1490 null_error();
1491 return -1;
1492 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001493
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001494 m = s->ob_type->tp_as_sequence;
1495 if (m && m->sq_length)
1496 return m->sq_length(s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001497
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001498 type_error("object of type '%.200s' has no len()", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001499 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001500}
1501
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001502#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001503Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001504PySequence_Length(PyObject *s)
1505{
1506 return PySequence_Size(s);
1507}
1508#define PySequence_Length PySequence_Size
1509
Guido van Rossume15dee51995-07-18 14:12:02 +00001510PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001511PySequence_Concat(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001512{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001513 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001514
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001515 if (s == NULL || o == NULL)
1516 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001517
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001518 m = s->ob_type->tp_as_sequence;
1519 if (m && m->sq_concat)
1520 return m->sq_concat(s, o);
1521
Armin Rigofd163f92005-12-29 15:59:19 +00001522 /* Instances of user classes defining an __add__() method only
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001523 have an nb_add slot, not an sq_concat slot. So we fall back
Armin Rigofd163f92005-12-29 15:59:19 +00001524 to nb_add if both arguments appear to be sequences. */
1525 if (PySequence_Check(s) && PySequence_Check(o)) {
1526 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1527 if (result != Py_NotImplemented)
1528 return result;
1529 Py_DECREF(result);
1530 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001531 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001532}
1533
1534PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001535PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001536{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001537 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001538
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001539 if (o == NULL)
1540 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001541
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001542 m = o->ob_type->tp_as_sequence;
1543 if (m && m->sq_repeat)
1544 return m->sq_repeat(o, count);
1545
Armin Rigofd163f92005-12-29 15:59:19 +00001546 /* Instances of user classes defining a __mul__() method only
1547 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1548 to nb_multiply if o appears to be a sequence. */
1549 if (PySequence_Check(o)) {
1550 PyObject *n, *result;
Christian Heimes217cfd12007-12-02 14:31:20 +00001551 n = PyLong_FromSsize_t(count);
Armin Rigofd163f92005-12-29 15:59:19 +00001552 if (n == NULL)
1553 return NULL;
1554 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1555 Py_DECREF(n);
1556 if (result != Py_NotImplemented)
1557 return result;
1558 Py_DECREF(result);
1559 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001560 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001561}
1562
1563PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001564PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1565{
1566 PySequenceMethods *m;
1567
1568 if (s == NULL || o == NULL)
1569 return null_error();
1570
1571 m = s->ob_type->tp_as_sequence;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001572 if (m && m->sq_inplace_concat)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001573 return m->sq_inplace_concat(s, o);
1574 if (m && m->sq_concat)
1575 return m->sq_concat(s, o);
1576
Armin Rigofd163f92005-12-29 15:59:19 +00001577 if (PySequence_Check(s) && PySequence_Check(o)) {
1578 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1579 NB_SLOT(nb_add));
1580 if (result != Py_NotImplemented)
1581 return result;
1582 Py_DECREF(result);
1583 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001584 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001585}
1586
1587PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001588PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001589{
1590 PySequenceMethods *m;
1591
1592 if (o == NULL)
1593 return null_error();
1594
1595 m = o->ob_type->tp_as_sequence;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001596 if (m && m->sq_inplace_repeat)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001597 return m->sq_inplace_repeat(o, count);
1598 if (m && m->sq_repeat)
1599 return m->sq_repeat(o, count);
1600
Armin Rigofd163f92005-12-29 15:59:19 +00001601 if (PySequence_Check(o)) {
1602 PyObject *n, *result;
Christian Heimes217cfd12007-12-02 14:31:20 +00001603 n = PyLong_FromSsize_t(count);
Armin Rigofd163f92005-12-29 15:59:19 +00001604 if (n == NULL)
1605 return NULL;
1606 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1607 NB_SLOT(nb_multiply));
1608 Py_DECREF(n);
1609 if (result != Py_NotImplemented)
1610 return result;
1611 Py_DECREF(result);
1612 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001613 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001614}
1615
1616PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001617PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001618{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001619 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001620
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001621 if (s == NULL)
1622 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001623
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001624 m = s->ob_type->tp_as_sequence;
1625 if (m && m->sq_item) {
1626 if (i < 0) {
1627 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001628 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001629 if (l < 0)
1630 return NULL;
1631 i += l;
1632 }
1633 }
1634 return m->sq_item(s, i);
1635 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001636
Georg Brandl86b2fb92008-07-16 03:43:04 +00001637 return type_error("'%.200s' object does not support indexing", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001638}
1639
1640PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001641PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00001642{
Thomas Wouters1d75a792000-08-17 22:37:32 +00001643 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001644
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001645 if (!s) return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001646
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001647 mp = s->ob_type->tp_as_mapping;
1648 if (mp->mp_subscript) {
Thomas Wouters1d75a792000-08-17 22:37:32 +00001649 PyObject *res;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001650 PyObject *slice = _PySlice_FromIndices(i1, i2);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001651 if (!slice)
1652 return NULL;
1653 res = mp->mp_subscript(s, slice);
1654 Py_DECREF(slice);
1655 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001656 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001657
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001658 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001659}
1660
1661int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001662PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001663{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001664 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001665
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001666 if (s == NULL) {
1667 null_error();
1668 return -1;
1669 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001670
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001671 m = s->ob_type->tp_as_sequence;
1672 if (m && m->sq_ass_item) {
1673 if (i < 0) {
1674 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001675 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001676 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001677 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001678 i += l;
1679 }
1680 }
1681 return m->sq_ass_item(s, i, o);
1682 }
1683
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001684 type_error("'%.200s' object does not support item assignment", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001685 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001686}
1687
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001688int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001689PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001690{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001691 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001692
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001693 if (s == NULL) {
1694 null_error();
1695 return -1;
1696 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001697
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001698 m = s->ob_type->tp_as_sequence;
1699 if (m && m->sq_ass_item) {
1700 if (i < 0) {
1701 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001702 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001703 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001704 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001705 i += l;
1706 }
1707 }
1708 return m->sq_ass_item(s, i, (PyObject *)NULL);
1709 }
1710
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001711 type_error("'%.200s' object doesn't support item deletion", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001712 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001713}
1714
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001715int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001716PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001717{
Thomas Wouters1d75a792000-08-17 22:37:32 +00001718 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001719
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001720 if (s == NULL) {
1721 null_error();
1722 return -1;
1723 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001724
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001725 mp = s->ob_type->tp_as_mapping;
1726 if (mp->mp_ass_subscript) {
Thomas Wouters1d75a792000-08-17 22:37:32 +00001727 int res;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001728 PyObject *slice = _PySlice_FromIndices(i1, i2);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001729 if (!slice)
1730 return -1;
1731 res = mp->mp_ass_subscript(s, slice, o);
1732 Py_DECREF(slice);
1733 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001734 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00001735
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001736 type_error("'%.200s' object doesn't support slice assignment", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001737 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001738}
1739
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001740int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001741PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001742{
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001743 PyMappingMethods *mp;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001744
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001745 if (s == NULL) {
1746 null_error();
1747 return -1;
1748 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001749
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001750 mp = s->ob_type->tp_as_mapping;
1751 if (mp->mp_ass_subscript) {
1752 int res;
1753 PyObject *slice = _PySlice_FromIndices(i1, i2);
1754 if (!slice)
1755 return -1;
1756 res = mp->mp_ass_subscript(s, slice, NULL);
1757 Py_DECREF(slice);
1758 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001759 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001760 type_error("'%.200s' object doesn't support slice deletion", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001761 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001762}
1763
Guido van Rossume15dee51995-07-18 14:12:02 +00001764PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001765PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00001766{
Tim Peters6912d4d2001-05-05 03:56:37 +00001767 PyObject *it; /* iter(v) */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001768 Py_ssize_t n; /* guess for result tuple size */
Tim Peters6912d4d2001-05-05 03:56:37 +00001769 PyObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001770 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00001771
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001772 if (v == NULL)
1773 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001774
Tim Peters6912d4d2001-05-05 03:56:37 +00001775 /* Special-case the common tuple and list cases, for efficiency. */
Tim Peters4c3a0a32001-09-10 23:37:46 +00001776 if (PyTuple_CheckExact(v)) {
1777 /* Note that we can't know whether it's safe to return
1778 a tuple *subclass* instance as-is, hence the restriction
Tim Peters8ff70a92001-09-10 23:53:53 +00001779 to exact tuples here. In contrast, lists always make
1780 a copy, so there's no need for exactness below. */
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001781 Py_INCREF(v);
1782 return v;
Guido van Rossume15dee51995-07-18 14:12:02 +00001783 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001784 if (PyList_Check(v))
1785 return PyList_AsTuple(v);
1786
Tim Peters6912d4d2001-05-05 03:56:37 +00001787 /* Get iterator. */
1788 it = PyObject_GetIter(v);
1789 if (it == NULL)
Tim Peters1fc240e2001-10-26 05:06:50 +00001790 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001791
Tim Peters6912d4d2001-05-05 03:56:37 +00001792 /* Guess result size and allocate space. */
Christian Heimes255f53b2007-12-08 15:33:56 +00001793 n = _PyObject_LengthHint(v, 10);
Tim Peters6912d4d2001-05-05 03:56:37 +00001794 result = PyTuple_New(n);
1795 if (result == NULL)
1796 goto Fail;
1797
1798 /* Fill the tuple. */
1799 for (j = 0; ; ++j) {
1800 PyObject *item = PyIter_Next(it);
1801 if (item == NULL) {
1802 if (PyErr_Occurred())
1803 goto Fail;
1804 break;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001805 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001806 if (j >= n) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001807 Py_ssize_t oldn = n;
Raymond Hettinger4d012592004-12-16 10:38:38 +00001808 /* The over-allocation strategy can grow a bit faster
Guido van Rossum98297ee2007-11-06 21:34:58 +00001809 than for lists because unlike lists the
Raymond Hettinger4d012592004-12-16 10:38:38 +00001810 over-allocation isn't permanent -- we reclaim
1811 the excess before the end of this routine.
1812 So, grow by ten and then add 25%.
1813 */
1814 n += 10;
1815 n += n >> 2;
1816 if (n < oldn) {
1817 /* Check for overflow */
1818 PyErr_NoMemory();
Raymond Hettingere6bdb372004-12-16 15:10:21 +00001819 Py_DECREF(item);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001820 goto Fail;
Raymond Hettinger4d012592004-12-16 10:38:38 +00001821 }
Tim Peters4324aa32001-05-28 22:30:08 +00001822 if (_PyTuple_Resize(&result, n) != 0) {
Tim Peters12d0a6c2001-05-05 04:10:25 +00001823 Py_DECREF(item);
Tim Peters6912d4d2001-05-05 03:56:37 +00001824 goto Fail;
Tim Peters12d0a6c2001-05-05 04:10:25 +00001825 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001826 }
1827 PyTuple_SET_ITEM(result, j, item);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001828 }
1829
Tim Peters6912d4d2001-05-05 03:56:37 +00001830 /* Cut tuple back if guess was too large. */
1831 if (j < n &&
Tim Peters4324aa32001-05-28 22:30:08 +00001832 _PyTuple_Resize(&result, j) != 0)
Tim Peters6912d4d2001-05-05 03:56:37 +00001833 goto Fail;
1834
1835 Py_DECREF(it);
1836 return result;
1837
1838Fail:
1839 Py_XDECREF(result);
1840 Py_DECREF(it);
1841 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001842}
1843
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001844PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001845PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001846{
Tim Petersf553f892001-05-01 20:45:31 +00001847 PyObject *result; /* result list */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001848 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00001849
Guido van Rossum5dba9e81998-07-10 18:03:50 +00001850 if (v == NULL)
1851 return null_error();
1852
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +00001853 result = PyList_New(0);
1854 if (result == NULL)
Tim Petersf553f892001-05-01 20:45:31 +00001855 return NULL;
1856
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +00001857 rv = _PyList_Extend((PyListObject *)result, v);
1858 if (rv == NULL) {
1859 Py_DECREF(result);
Tim Petersf553f892001-05-01 20:45:31 +00001860 return NULL;
1861 }
Raymond Hettinger969d8c02004-03-17 05:24:23 +00001862 Py_DECREF(rv);
Tim Petersf553f892001-05-01 20:45:31 +00001863 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001864}
1865
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001866PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001867PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001868{
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001869 PyObject *it;
1870
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001871 if (v == NULL)
1872 return null_error();
1873
Michael W. Hudson2801fe12002-11-05 18:05:49 +00001874 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001875 Py_INCREF(v);
1876 return v;
1877 }
1878
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001879 it = PyObject_GetIter(v);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001880 if (it == NULL) {
1881 if (PyErr_ExceptionMatches(PyExc_TypeError))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001882 PyErr_SetString(PyExc_TypeError, m);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001883 return NULL;
1884 }
1885
Raymond Hettinger193814c2004-12-18 19:00:59 +00001886 v = PySequence_List(it);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001887 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001888
1889 return v;
1890}
1891
Tim Peters16a77ad2001-09-08 04:00:12 +00001892/* Iterate over seq. Result depends on the operation:
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001893 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
1894 PY_ITERSEARCH_INDEX: 0-based index of first occurence of obj in seq;
1895 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00001896 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
1897*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001898Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001899_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00001900{
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001901 Py_ssize_t n;
Tim Peters16a77ad2001-09-08 04:00:12 +00001902 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
1903 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00001904
Tim Peters16a77ad2001-09-08 04:00:12 +00001905 if (seq == NULL || obj == NULL) {
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001906 null_error();
1907 return -1;
1908 }
Tim Peters75f8e352001-05-05 11:33:43 +00001909
Tim Peters16a77ad2001-09-08 04:00:12 +00001910 it = PyObject_GetIter(seq);
Tim Peters75f8e352001-05-05 11:33:43 +00001911 if (it == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001912 type_error("argument of type '%.200s' is not iterable", seq);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001913 return -1;
Tim Peters75f8e352001-05-05 11:33:43 +00001914 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001915
Tim Peters16a77ad2001-09-08 04:00:12 +00001916 n = wrapped = 0;
Tim Peters75f8e352001-05-05 11:33:43 +00001917 for (;;) {
1918 int cmp;
1919 PyObject *item = PyIter_Next(it);
1920 if (item == NULL) {
1921 if (PyErr_Occurred())
1922 goto Fail;
1923 break;
1924 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001925
1926 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001927 Py_DECREF(item);
Tim Peters75f8e352001-05-05 11:33:43 +00001928 if (cmp < 0)
1929 goto Fail;
1930 if (cmp > 0) {
Tim Peters16a77ad2001-09-08 04:00:12 +00001931 switch (operation) {
1932 case PY_ITERSEARCH_COUNT:
Thomas Wouters89f507f2006-12-13 04:49:30 +00001933 if (n == PY_SSIZE_T_MAX) {
Tim Peters16a77ad2001-09-08 04:00:12 +00001934 PyErr_SetString(PyExc_OverflowError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00001935 "count exceeds C integer size");
Tim Peters16a77ad2001-09-08 04:00:12 +00001936 goto Fail;
1937 }
Thomas Wouters89f507f2006-12-13 04:49:30 +00001938 ++n;
Tim Peters16a77ad2001-09-08 04:00:12 +00001939 break;
1940
1941 case PY_ITERSEARCH_INDEX:
1942 if (wrapped) {
1943 PyErr_SetString(PyExc_OverflowError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00001944 "index exceeds C integer size");
Tim Peters16a77ad2001-09-08 04:00:12 +00001945 goto Fail;
1946 }
1947 goto Done;
1948
1949 case PY_ITERSEARCH_CONTAINS:
1950 n = 1;
1951 goto Done;
1952
1953 default:
1954 assert(!"unknown operation");
Tim Peters75f8e352001-05-05 11:33:43 +00001955 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001956 }
1957
1958 if (operation == PY_ITERSEARCH_INDEX) {
Thomas Wouters89f507f2006-12-13 04:49:30 +00001959 if (n == PY_SSIZE_T_MAX)
Tim Peters16a77ad2001-09-08 04:00:12 +00001960 wrapped = 1;
Thomas Wouters89f507f2006-12-13 04:49:30 +00001961 ++n;
Tim Peters75f8e352001-05-05 11:33:43 +00001962 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001963 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001964
1965 if (operation != PY_ITERSEARCH_INDEX)
1966 goto Done;
1967
1968 PyErr_SetString(PyExc_ValueError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001969 "sequence.index(x): x not in sequence");
Tim Peters16a77ad2001-09-08 04:00:12 +00001970 /* fall into failure code */
1971Fail:
1972 n = -1;
1973 /* fall through */
1974Done:
Tim Peters75f8e352001-05-05 11:33:43 +00001975 Py_DECREF(it);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001976 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00001977
Guido van Rossume15dee51995-07-18 14:12:02 +00001978}
1979
Tim Peters16a77ad2001-09-08 04:00:12 +00001980/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001981Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001982PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001983{
Tim Peters16a77ad2001-09-08 04:00:12 +00001984 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00001985}
1986
Tim Peterscb8d3682001-05-05 21:05:01 +00001987/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00001988 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00001989 */
1990int
1991PySequence_Contains(PyObject *seq, PyObject *ob)
1992{
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001993 Py_ssize_t result;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001994 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001995 if (sqm != NULL && sqm->sq_contains != NULL)
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001996 return (*sqm->sq_contains)(seq, ob);
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001997 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
1998 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00001999}
2000
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002001/* Backwards compatibility */
2002#undef PySequence_In
2003int
Fred Drake79912472000-07-09 04:06:11 +00002004PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002005{
2006 return PySequence_Contains(w, v);
2007}
2008
Neal Norwitz1fc4b772006-03-04 18:49:58 +00002009Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00002010PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002011{
Tim Peters16a77ad2001-09-08 04:00:12 +00002012 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00002013}
2014
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002015/* Operations on mappings */
2016
2017int
Fred Drake79912472000-07-09 04:06:11 +00002018PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002019{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002020 return o && o->ob_type->tp_as_mapping &&
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00002021 o->ob_type->tp_as_mapping->mp_subscript;
Guido van Rossume15dee51995-07-18 14:12:02 +00002022}
2023
Martin v. Löwis18e16552006-02-15 17:27:45 +00002024Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00002025PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002026{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002027 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00002028
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002029 if (o == NULL) {
2030 null_error();
2031 return -1;
2032 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002033
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002034 m = o->ob_type->tp_as_mapping;
2035 if (m && m->mp_length)
2036 return m->mp_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00002037
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002038 type_error("object of type '%.200s' has no len()", o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002039 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00002040}
2041
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002042#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00002043Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002044PyMapping_Length(PyObject *o)
2045{
2046 return PyMapping_Size(o);
2047}
2048#define PyMapping_Length PyMapping_Size
2049
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002050PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002051PyMapping_GetItemString(PyObject *o, char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002052{
2053 PyObject *okey, *r;
2054
2055 if (key == NULL)
2056 return null_error();
2057
Martin v. Löwis5b222132007-06-10 09:51:05 +00002058 okey = PyUnicode_FromString(key);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002059 if (okey == NULL)
2060 return NULL;
2061 r = PyObject_GetItem(o, okey);
2062 Py_DECREF(okey);
2063 return r;
2064}
2065
2066int
Fred Drake79912472000-07-09 04:06:11 +00002067PyMapping_SetItemString(PyObject *o, char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002068{
2069 PyObject *okey;
2070 int r;
2071
2072 if (key == NULL) {
2073 null_error();
2074 return -1;
2075 }
2076
Martin v. Löwis5b222132007-06-10 09:51:05 +00002077 okey = PyUnicode_FromString(key);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002078 if (okey == NULL)
Guido van Rossumed6219b1998-05-29 02:59:33 +00002079 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002080 r = PyObject_SetItem(o, okey, value);
2081 Py_DECREF(okey);
2082 return r;
2083}
2084
2085int
Fred Drake79912472000-07-09 04:06:11 +00002086PyMapping_HasKeyString(PyObject *o, char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002087{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002088 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002089
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002090 v = PyMapping_GetItemString(o, key);
2091 if (v) {
2092 Py_DECREF(v);
2093 return 1;
2094 }
2095 PyErr_Clear();
2096 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002097}
2098
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002099int
Fred Drake79912472000-07-09 04:06:11 +00002100PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002101{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002102 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002103
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002104 v = PyObject_GetItem(o, key);
2105 if (v) {
2106 Py_DECREF(v);
2107 return 1;
2108 }
2109 PyErr_Clear();
2110 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002111}
2112
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002113PyObject *
2114PyMapping_Keys(PyObject *o)
2115{
2116 PyObject *keys;
2117 PyObject *fast;
2118
2119 if (PyDict_CheckExact(o))
2120 return PyDict_Keys(o);
2121 keys = PyObject_CallMethod(o, "keys", NULL);
2122 if (keys == NULL)
2123 return NULL;
2124 fast = PySequence_Fast(keys, "o.keys() are not iterable");
2125 Py_DECREF(keys);
2126 return fast;
2127}
2128
2129PyObject *
2130PyMapping_Items(PyObject *o)
2131{
2132 PyObject *items;
2133 PyObject *fast;
2134
2135 if (PyDict_CheckExact(o))
2136 return PyDict_Items(o);
2137 items = PyObject_CallMethod(o, "items", NULL);
2138 if (items == NULL)
2139 return NULL;
2140 fast = PySequence_Fast(items, "o.items() are not iterable");
2141 Py_DECREF(items);
2142 return fast;
2143}
2144
2145PyObject *
2146PyMapping_Values(PyObject *o)
2147{
2148 PyObject *values;
2149 PyObject *fast;
2150
2151 if (PyDict_CheckExact(o))
2152 return PyDict_Values(o);
2153 values = PyObject_CallMethod(o, "values", NULL);
2154 if (values == NULL)
2155 return NULL;
2156 fast = PySequence_Fast(values, "o.values() are not iterable");
2157 Py_DECREF(values);
2158 return fast;
2159}
2160
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002161/* Operations on callable objects */
2162
2163/* XXX PyCallable_Check() is in object.c */
2164
Guido van Rossume15dee51995-07-18 14:12:02 +00002165PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002166PyObject_CallObject(PyObject *o, PyObject *a)
Guido van Rossume15dee51995-07-18 14:12:02 +00002167{
Guido van Rossum5560b742001-09-14 16:47:50 +00002168 return PyEval_CallObjectWithKeywords(o, a, NULL);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002169}
Guido van Rossume15dee51995-07-18 14:12:02 +00002170
2171PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002172PyObject_Call(PyObject *func, PyObject *arg, PyObject *kw)
2173{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002174 ternaryfunc call;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002175
2176 if ((call = func->ob_type->tp_call) != NULL) {
Thomas Wouters89d996e2007-09-08 17:39:28 +00002177 PyObject *result;
2178 if (Py_EnterRecursiveCall(" while calling a Python object"))
2179 return NULL;
2180 result = (*call)(func, arg, kw);
2181 Py_LeaveRecursiveCall();
Tim Peters6d6c1a32001-08-02 04:15:00 +00002182 if (result == NULL && !PyErr_Occurred())
2183 PyErr_SetString(
2184 PyExc_SystemError,
2185 "NULL result without error in PyObject_Call");
2186 return result;
2187 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002188 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
Fred Drake573395a2001-11-01 20:26:12 +00002189 func->ob_type->tp_name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002190 return NULL;
2191}
2192
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002193static PyObject*
2194call_function_tail(PyObject *callable, PyObject *args)
2195{
2196 PyObject *retval;
2197
2198 if (args == NULL)
2199 return NULL;
2200
2201 if (!PyTuple_Check(args)) {
2202 PyObject *a;
2203
2204 a = PyTuple_New(1);
2205 if (a == NULL) {
2206 Py_DECREF(args);
2207 return NULL;
2208 }
2209 PyTuple_SET_ITEM(a, 0, args);
2210 args = a;
2211 }
2212 retval = PyObject_Call(callable, args, NULL);
2213
2214 Py_DECREF(args);
2215
2216 return retval;
2217}
2218
Tim Peters6d6c1a32001-08-02 04:15:00 +00002219PyObject *
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002220PyObject_CallFunction(PyObject *callable, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002221{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002222 va_list va;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002223 PyObject *args;
Guido van Rossume15dee51995-07-18 14:12:02 +00002224
Fred Drakeb92cf062001-10-27 06:16:31 +00002225 if (callable == NULL)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002226 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002227
Fred Drakeb92cf062001-10-27 06:16:31 +00002228 if (format && *format) {
2229 va_start(va, format);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002230 args = Py_VaBuildValue(format, va);
Fred Drakeb92cf062001-10-27 06:16:31 +00002231 va_end(va);
2232 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002233 else
2234 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002235
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002236 return call_function_tail(callable, args);
2237}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002238
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002239PyObject *
2240_PyObject_CallFunction_SizeT(PyObject *callable, char *format, ...)
2241{
2242 va_list va;
2243 PyObject *args;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002244
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002245 if (callable == NULL)
2246 return null_error();
2247
2248 if (format && *format) {
2249 va_start(va, format);
2250 args = _Py_VaBuildValue_SizeT(format, va);
2251 va_end(va);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002252 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002253 else
2254 args = PyTuple_New(0);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002255
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002256 return call_function_tail(callable, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002257}
2258
2259PyObject *
Guido van Rossume15dee51995-07-18 14:12:02 +00002260PyObject_CallMethod(PyObject *o, char *name, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002261{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002262 va_list va;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002263 PyObject *args;
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002264 PyObject *func = NULL;
2265 PyObject *retval = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002266
Fred Drakeb92cf062001-10-27 06:16:31 +00002267 if (o == NULL || name == NULL)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002268 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002269
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002270 func = PyObject_GetAttrString(o, name);
2271 if (func == NULL) {
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002272 PyErr_SetString(PyExc_AttributeError, name);
2273 return 0;
2274 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002275
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002276 if (!PyCallable_Check(func)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002277 type_error("attribute of type '%.200s' is not callable", func);
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002278 goto exit;
2279 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002280
Fred Drakeb92cf062001-10-27 06:16:31 +00002281 if (format && *format) {
2282 va_start(va, format);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002283 args = Py_VaBuildValue(format, va);
Fred Drakeb92cf062001-10-27 06:16:31 +00002284 va_end(va);
2285 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002286 else
2287 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002288
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002289 retval = call_function_tail(func, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002290
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002291 exit:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002292 /* args gets consumed in call_function_tail */
2293 Py_XDECREF(func);
2294
2295 return retval;
2296}
2297
2298PyObject *
2299_PyObject_CallMethod_SizeT(PyObject *o, char *name, char *format, ...)
2300{
2301 va_list va;
2302 PyObject *args;
2303 PyObject *func = NULL;
2304 PyObject *retval = NULL;
2305
2306 if (o == NULL || name == NULL)
2307 return null_error();
2308
2309 func = PyObject_GetAttrString(o, name);
2310 if (func == NULL) {
2311 PyErr_SetString(PyExc_AttributeError, name);
2312 return 0;
2313 }
2314
2315 if (!PyCallable_Check(func)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002316 type_error("attribute of type '%.200s' is not callable", func);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002317 goto exit;
2318 }
2319
2320 if (format && *format) {
2321 va_start(va, format);
2322 args = _Py_VaBuildValue_SizeT(format, va);
2323 va_end(va);
2324 }
2325 else
2326 args = PyTuple_New(0);
2327
2328 retval = call_function_tail(func, args);
2329
2330 exit:
2331 /* args gets consumed in call_function_tail */
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002332 Py_XDECREF(func);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002333
2334 return retval;
Guido van Rossume15dee51995-07-18 14:12:02 +00002335}
Guido van Rossum823649d2001-03-21 18:40:58 +00002336
2337
Fred Drakeb421b8c2001-10-26 16:21:32 +00002338static PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002339objargs_mktuple(va_list va)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002340{
2341 int i, n = 0;
2342 va_list countva;
2343 PyObject *result, *tmp;
2344
2345#ifdef VA_LIST_IS_ARRAY
2346 memcpy(countva, va, sizeof(va_list));
2347#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002348#ifdef __va_copy
2349 __va_copy(countva, va);
2350#else
Fred Drakeb421b8c2001-10-26 16:21:32 +00002351 countva = va;
2352#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002353#endif
Fred Drakeb421b8c2001-10-26 16:21:32 +00002354
2355 while (((PyObject *)va_arg(countva, PyObject *)) != NULL)
2356 ++n;
2357 result = PyTuple_New(n);
2358 if (result != NULL && n > 0) {
2359 for (i = 0; i < n; ++i) {
2360 tmp = (PyObject *)va_arg(va, PyObject *);
2361 PyTuple_SET_ITEM(result, i, tmp);
2362 Py_INCREF(tmp);
2363 }
2364 }
2365 return result;
2366}
2367
2368PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002369PyObject_CallMethodObjArgs(PyObject *callable, PyObject *name, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002370{
2371 PyObject *args, *tmp;
2372 va_list vargs;
2373
2374 if (callable == NULL || name == NULL)
2375 return null_error();
2376
2377 callable = PyObject_GetAttr(callable, name);
2378 if (callable == NULL)
2379 return NULL;
2380
2381 /* count the args */
2382 va_start(vargs, name);
Fred Drakeb0c079e2001-10-28 02:39:03 +00002383 args = objargs_mktuple(vargs);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002384 va_end(vargs);
2385 if (args == NULL) {
2386 Py_DECREF(callable);
2387 return NULL;
2388 }
2389 tmp = PyObject_Call(callable, args, NULL);
2390 Py_DECREF(args);
2391 Py_DECREF(callable);
2392
2393 return tmp;
2394}
2395
2396PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002397PyObject_CallFunctionObjArgs(PyObject *callable, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002398{
2399 PyObject *args, *tmp;
2400 va_list vargs;
2401
2402 if (callable == NULL)
2403 return null_error();
2404
2405 /* count the args */
2406 va_start(vargs, callable);
Fred Drakeb0c079e2001-10-28 02:39:03 +00002407 args = objargs_mktuple(vargs);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002408 va_end(vargs);
2409 if (args == NULL)
2410 return NULL;
2411 tmp = PyObject_Call(callable, args, NULL);
2412 Py_DECREF(args);
2413
2414 return tmp;
2415}
2416
2417
Guido van Rossum823649d2001-03-21 18:40:58 +00002418/* isinstance(), issubclass() */
2419
Barry Warsawf16951c2002-04-23 22:45:44 +00002420/* abstract_get_bases() has logically 4 return states, with a sort of 0th
2421 * state that will almost never happen.
2422 *
2423 * 0. creating the __bases__ static string could get a MemoryError
2424 * 1. getattr(cls, '__bases__') could raise an AttributeError
2425 * 2. getattr(cls, '__bases__') could raise some other exception
2426 * 3. getattr(cls, '__bases__') could return a tuple
2427 * 4. getattr(cls, '__bases__') could return something other than a tuple
2428 *
2429 * Only state #3 is a non-error state and only it returns a non-NULL object
2430 * (it returns the retrieved tuple).
2431 *
2432 * Any raised AttributeErrors are masked by clearing the exception and
2433 * returning NULL. If an object other than a tuple comes out of __bases__,
2434 * then again, the return value is NULL. So yes, these two situations
2435 * produce exactly the same results: NULL is returned and no error is set.
2436 *
2437 * If some exception other than AttributeError is raised, then NULL is also
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002438 * returned, but the exception is not cleared. That's because we want the
Barry Warsawf16951c2002-04-23 22:45:44 +00002439 * exception to be propagated along.
2440 *
2441 * Callers are expected to test for PyErr_Occurred() when the return value
2442 * is NULL to decide whether a valid exception should be propagated or not.
2443 * When there's no exception to propagate, it's customary for the caller to
2444 * set a TypeError.
2445 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002446static PyObject *
2447abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002448{
2449 static PyObject *__bases__ = NULL;
2450 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002451
2452 if (__bases__ == NULL) {
Christian Heimesfe82e772008-01-28 02:38:20 +00002453 __bases__ = PyUnicode_InternFromString("__bases__");
Guido van Rossum823649d2001-03-21 18:40:58 +00002454 if (__bases__ == NULL)
Neil Schemenauer6b471292001-10-18 03:18:43 +00002455 return NULL;
Guido van Rossum823649d2001-03-21 18:40:58 +00002456 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002457 Py_ALLOW_RECURSION
Neil Schemenauer6b471292001-10-18 03:18:43 +00002458 bases = PyObject_GetAttr(cls, __bases__);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002459 Py_END_ALLOW_RECURSION
Barry Warsawf16951c2002-04-23 22:45:44 +00002460 if (bases == NULL) {
2461 if (PyErr_ExceptionMatches(PyExc_AttributeError))
2462 PyErr_Clear();
Neil Schemenauer6b471292001-10-18 03:18:43 +00002463 return NULL;
Guido van Rossum823649d2001-03-21 18:40:58 +00002464 }
Barry Warsawf16951c2002-04-23 22:45:44 +00002465 if (!PyTuple_Check(bases)) {
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002466 Py_DECREF(bases);
Barry Warsawf16951c2002-04-23 22:45:44 +00002467 return NULL;
2468 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002469 return bases;
2470}
2471
2472
2473static int
2474abstract_issubclass(PyObject *derived, PyObject *cls)
2475{
2476 PyObject *bases;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002477 Py_ssize_t i, n;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002478 int r = 0;
2479
2480
Guido van Rossum823649d2001-03-21 18:40:58 +00002481 if (derived == cls)
2482 return 1;
2483
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002484 if (PyTuple_Check(cls)) {
2485 /* Not a general sequence -- that opens up the road to
2486 recursion and stack overflow. */
2487 n = PyTuple_GET_SIZE(cls);
2488 for (i = 0; i < n; i++) {
2489 if (derived == PyTuple_GET_ITEM(cls, i))
2490 return 1;
2491 }
2492 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002493 bases = abstract_get_bases(derived);
Barry Warsawf16951c2002-04-23 22:45:44 +00002494 if (bases == NULL) {
2495 if (PyErr_Occurred())
2496 return -1;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002497 return 0;
Barry Warsawf16951c2002-04-23 22:45:44 +00002498 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002499 n = PyTuple_GET_SIZE(bases);
2500 for (i = 0; i < n; i++) {
Neil Schemenauer6b471292001-10-18 03:18:43 +00002501 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002502 if (r != 0)
2503 break;
2504 }
2505
2506 Py_DECREF(bases);
2507
2508 return r;
2509}
2510
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002511static int
2512check_class(PyObject *cls, const char *error)
2513{
2514 PyObject *bases = abstract_get_bases(cls);
2515 if (bases == NULL) {
2516 /* Do not mask errors. */
2517 if (!PyErr_Occurred())
2518 PyErr_SetString(PyExc_TypeError, error);
2519 return 0;
2520 }
2521 Py_DECREF(bases);
2522 return -1;
2523}
2524
Brett Cannon4f653312004-03-20 22:52:14 +00002525static int
2526recursive_isinstance(PyObject *inst, PyObject *cls, int recursion_depth)
Guido van Rossum823649d2001-03-21 18:40:58 +00002527{
2528 PyObject *icls;
2529 static PyObject *__class__ = NULL;
2530 int retval = 0;
2531
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002532 if (__class__ == NULL) {
Christian Heimesfe82e772008-01-28 02:38:20 +00002533 __class__ = PyUnicode_InternFromString("__class__");
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002534 if (__class__ == NULL)
2535 return -1;
2536 }
2537
Guido van Rossum45aecf42006-03-15 04:58:47 +00002538 if (PyType_Check(cls)) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00002539 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002540 if (retval == 0) {
2541 PyObject *c = PyObject_GetAttr(inst, __class__);
2542 if (c == NULL) {
2543 PyErr_Clear();
2544 }
2545 else {
Guido van Rossume5b130b2003-02-12 03:36:05 +00002546 if (c != (PyObject *)(inst->ob_type) &&
2547 PyType_Check(c))
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002548 retval = PyType_IsSubtype(
2549 (PyTypeObject *)c,
2550 (PyTypeObject *)cls);
2551 Py_DECREF(c);
2552 }
2553 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002554 }
Guido van Rossum03290ec2001-10-07 20:54:12 +00002555 else if (PyTuple_Check(cls)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00002556 Py_ssize_t i, n;
Guido van Rossum03290ec2001-10-07 20:54:12 +00002557
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002558 if (!recursion_depth) {
2559 PyErr_SetString(PyExc_RuntimeError,
2560 "nest level of tuple too deep");
2561 return -1;
2562 }
Brett Cannon4f653312004-03-20 22:52:14 +00002563
Guido van Rossum03290ec2001-10-07 20:54:12 +00002564 n = PyTuple_GET_SIZE(cls);
2565 for (i = 0; i < n; i++) {
Brett Cannon4f653312004-03-20 22:52:14 +00002566 retval = recursive_isinstance(
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002567 inst,
2568 PyTuple_GET_ITEM(cls, i),
2569 recursion_depth-1);
Guido van Rossum03290ec2001-10-07 20:54:12 +00002570 if (retval != 0)
2571 break;
2572 }
Guido van Rossum03290ec2001-10-07 20:54:12 +00002573 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002574 else {
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002575 if (!check_class(cls,
2576 "isinstance() arg 2 must be a class, type,"
2577 " or tuple of classes and types"))
Neil Schemenauer6b471292001-10-18 03:18:43 +00002578 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002579 icls = PyObject_GetAttr(inst, __class__);
Neil Schemenauer6b471292001-10-18 03:18:43 +00002580 if (icls == NULL) {
2581 PyErr_Clear();
2582 retval = 0;
Guido van Rossum823649d2001-03-21 18:40:58 +00002583 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002584 else {
2585 retval = abstract_issubclass(icls, cls);
2586 Py_DECREF(icls);
2587 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002588 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002589
Guido van Rossum823649d2001-03-21 18:40:58 +00002590 return retval;
2591}
2592
2593int
Brett Cannon4f653312004-03-20 22:52:14 +00002594PyObject_IsInstance(PyObject *inst, PyObject *cls)
2595{
Christian Heimesa156e092008-02-16 07:38:31 +00002596 static PyObject *name = NULL;
Guido van Rossume7ba4952007-06-06 23:52:48 +00002597 PyObject *checker;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002598
2599 /* Quick test for an exact match */
2600 if (Py_TYPE(inst) == (PyTypeObject *)cls)
2601 return 1;
2602
Christian Heimesa156e092008-02-16 07:38:31 +00002603 if (name == NULL) {
2604 name = PyUnicode_InternFromString("__instancecheck__");
2605 if (name == NULL)
2606 return -1;
2607 }
2608 checker = PyObject_GetAttr(cls, name);
Christian Heimese25f35e2008-03-20 10:49:03 +00002609 if (checker == NULL && PyErr_Occurred())
2610 PyErr_Clear();
Guido van Rossumadee45e2007-05-25 17:55:52 +00002611 if (checker != NULL) {
2612 PyObject *res;
2613 int ok = -1;
Guido van Rossum29478ef2007-05-29 00:39:44 +00002614 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2615 Py_DECREF(checker);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002616 return ok;
Guido van Rossum29478ef2007-05-29 00:39:44 +00002617 }
Guido van Rossumadee45e2007-05-25 17:55:52 +00002618 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
2619 Py_LeaveRecursiveCall();
2620 Py_DECREF(checker);
2621 if (res != NULL) {
2622 ok = PyObject_IsTrue(res);
2623 Py_DECREF(res);
2624 }
2625 return ok;
2626 }
2627 return recursive_isinstance(inst, cls, Py_GetRecursionLimit());
Brett Cannon4f653312004-03-20 22:52:14 +00002628}
2629
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002630static int
Brett Cannon4f653312004-03-20 22:52:14 +00002631recursive_issubclass(PyObject *derived, PyObject *cls, int recursion_depth)
Guido van Rossum823649d2001-03-21 18:40:58 +00002632{
2633 int retval;
2634
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002635 {
Guido van Rossumf6c9ba82003-02-10 16:05:43 +00002636 if (!check_class(derived,
2637 "issubclass() arg 1 must be a class"))
Neil Schemenauer6b471292001-10-18 03:18:43 +00002638 return -1;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002639
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002640 if (PyTuple_Check(cls)) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00002641 Py_ssize_t i;
2642 Py_ssize_t n = PyTuple_GET_SIZE(cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002643
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002644 if (!recursion_depth) {
2645 PyErr_SetString(PyExc_RuntimeError,
2646 "nest level of tuple too deep");
2647 return -1;
2648 }
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002649 for (i = 0; i < n; ++i) {
Brett Cannon4f653312004-03-20 22:52:14 +00002650 retval = recursive_issubclass(
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002651 derived,
2652 PyTuple_GET_ITEM(cls, i),
2653 recursion_depth-1);
Guido van Rossumf6c9ba82003-02-10 16:05:43 +00002654 if (retval != 0) {
2655 /* either found it, or got an error */
Walter Dörwald7e5c6a02002-12-12 19:14:08 +00002656 return retval;
Guido van Rossumf6c9ba82003-02-10 16:05:43 +00002657 }
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002658 }
Walter Dörwald7e5c6a02002-12-12 19:14:08 +00002659 return 0;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002660 }
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002661 else {
2662 if (!check_class(cls,
2663 "issubclass() arg 2 must be a class"
2664 " or tuple of classes"))
2665 return -1;
2666 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002667
2668 retval = abstract_issubclass(derived, cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002669 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002670
2671 return retval;
2672}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002673
Brett Cannon4f653312004-03-20 22:52:14 +00002674int
2675PyObject_IsSubclass(PyObject *derived, PyObject *cls)
2676{
Christian Heimesa156e092008-02-16 07:38:31 +00002677 static PyObject *name = NULL;
Guido van Rossumadee45e2007-05-25 17:55:52 +00002678 PyObject *t, *v, *tb;
Guido van Rossume7ba4952007-06-06 23:52:48 +00002679 PyObject *checker;
Guido van Rossumadee45e2007-05-25 17:55:52 +00002680 PyErr_Fetch(&t, &v, &tb);
Christian Heimesa156e092008-02-16 07:38:31 +00002681
2682 if (name == NULL) {
2683 name = PyUnicode_InternFromString("__subclasscheck__");
2684 if (name == NULL)
2685 return -1;
2686 }
2687 checker = PyObject_GetAttr(cls, name);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002688 PyErr_Restore(t, v, tb);
2689 if (checker != NULL) {
2690 PyObject *res;
2691 int ok = -1;
2692 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
2693 return ok;
2694 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
2695 Py_LeaveRecursiveCall();
2696 Py_DECREF(checker);
2697 if (res != NULL) {
2698 ok = PyObject_IsTrue(res);
2699 Py_DECREF(res);
2700 }
2701 return ok;
2702 }
2703 return recursive_issubclass(derived, cls, Py_GetRecursionLimit());
Brett Cannon4f653312004-03-20 22:52:14 +00002704}
2705
2706
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002707PyObject *
2708PyObject_GetIter(PyObject *o)
2709{
2710 PyTypeObject *t = o->ob_type;
2711 getiterfunc f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002712 f = t->tp_iter;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002713 if (f == NULL) {
2714 if (PySequence_Check(o))
Guido van Rossum213c7a62001-04-23 14:08:49 +00002715 return PySeqIter_New(o);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002716 return type_error("'%.200s' object is not iterable", o);
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002717 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00002718 else {
2719 PyObject *res = (*f)(o);
2720 if (res != NULL && !PyIter_Check(res)) {
2721 PyErr_Format(PyExc_TypeError,
2722 "iter() returned non-iterator "
2723 "of type '%.100s'",
2724 res->ob_type->tp_name);
2725 Py_DECREF(res);
2726 res = NULL;
2727 }
2728 return res;
2729 }
2730}
2731
Tim Petersf4848da2001-05-05 00:14:56 +00002732/* Return next item.
2733 * If an error occurs, return NULL. PyErr_Occurred() will be true.
2734 * If the iteration terminates normally, return NULL and clear the
2735 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
2736 * will be false.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002737 * Else return the next object. PyErr_Occurred() will be false.
Tim Petersf4848da2001-05-05 00:14:56 +00002738 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002739PyObject *
2740PyIter_Next(PyObject *iter)
2741{
Tim Petersf4848da2001-05-05 00:14:56 +00002742 PyObject *result;
Raymond Hettinger8049dde2003-03-01 01:44:32 +00002743 assert(PyIter_Check(iter));
Tim Petersf4848da2001-05-05 00:14:56 +00002744 result = (*iter->ob_type->tp_iternext)(iter);
2745 if (result == NULL &&
2746 PyErr_Occurred() &&
2747 PyErr_ExceptionMatches(PyExc_StopIteration))
2748 PyErr_Clear();
2749 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002750}