blob: ac61011c82025dda665b911e1c285a47c8647ead [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;
Martin v. Löwis74bbea72008-08-14 20:32:30 +0000673 if (obj)
674 Py_INCREF(obj);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000675 view->buf = buf;
676 view->len = len;
677 view->readonly = readonly;
678 view->itemsize = 1;
679 view->format = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000680 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT)
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000681 view->format = "B";
682 view->ndim = 1;
683 view->shape = NULL;
684 if ((flags & PyBUF_ND) == PyBUF_ND)
685 view->shape = &(view->len);
686 view->strides = NULL;
687 if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES)
688 view->strides = &(view->itemsize);
689 view->suboffsets = NULL;
690 view->internal = NULL;
691 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000692}
693
Martin v. Löwis423be952008-08-13 15:53:07 +0000694void
695PyBuffer_Release(Py_buffer *view)
696{
697 PyObject *obj = view->obj;
Martin v. Löwis74bbea72008-08-14 20:32:30 +0000698 if (obj && Py_TYPE(obj)->tp_as_buffer && Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer)
699 Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer(obj, view);
700 Py_XDECREF(obj);
701 view->obj = NULL;
Martin v. Löwis423be952008-08-13 15:53:07 +0000702}
703
Eric Smith8fd3eba2008-02-17 19:48:00 +0000704PyObject *
705PyObject_Format(PyObject *obj, PyObject *format_spec)
706{
707 static PyObject * str__format__ = NULL;
708 PyObject *meth;
709 PyObject *empty = NULL;
710 PyObject *result = NULL;
711
712 /* Initialize cached value */
713 if (str__format__ == NULL) {
714 /* Initialize static variable needed by _PyType_Lookup */
715 str__format__ = PyUnicode_FromString("__format__");
716 if (str__format__ == NULL)
717 goto done;
718 }
719
720 /* If no format_spec is provided, use an empty string */
721 if (format_spec == NULL) {
722 empty = PyUnicode_FromUnicode(NULL, 0);
723 format_spec = empty;
724 }
725
726 /* Make sure the type is initialized. float gets initialized late */
727 if (Py_TYPE(obj)->tp_dict == NULL)
728 if (PyType_Ready(Py_TYPE(obj)) < 0)
729 goto done;
730
731 /* Find the (unbound!) __format__ method (a borrowed reference) */
732 meth = _PyType_Lookup(Py_TYPE(obj), str__format__);
733 if (meth == NULL) {
734 PyErr_Format(PyExc_TypeError,
735 "Type %.100s doesn't define __format__",
736 Py_TYPE(obj)->tp_name);
737 goto done;
738 }
739
740 /* And call it, binding it to the value */
741 result = PyObject_CallFunctionObjArgs(meth, obj, format_spec, NULL);
742
743 if (result && !PyUnicode_Check(result)) {
744 PyErr_SetString(PyExc_TypeError,
745 "__format__ method did not return string");
746 Py_DECREF(result);
747 result = NULL;
748 goto done;
749 }
750
751done:
752 Py_XDECREF(empty);
753 return result;
754}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000755/* Operations on numbers */
756
757int
Fred Drake79912472000-07-09 04:06:11 +0000758PyNumber_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +0000759{
Guido van Rossum6921eca2003-02-18 16:36:28 +0000760 return o && o->ob_type->tp_as_number &&
761 (o->ob_type->tp_as_number->nb_int ||
762 o->ob_type->tp_as_number->nb_float);
Guido van Rossume15dee51995-07-18 14:12:02 +0000763}
764
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000765/* Binary operators */
Guido van Rossume15dee51995-07-18 14:12:02 +0000766
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000767#define NB_SLOT(x) offsetof(PyNumberMethods, x)
768#define NB_BINOP(nb_methods, slot) \
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000769 (*(binaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000770#define NB_TERNOP(nb_methods, slot) \
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000771 (*(ternaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000772
773/*
774 Calling scheme used for binary operations:
775
Neal Norwitz4886cc32006-08-21 17:06:07 +0000776 Order operations are tried until either a valid result or error:
777 w.op(v,w)[*], v.op(v,w), w.op(v,w)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000778
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000779 [*] only when v->ob_type != w->ob_type && w->ob_type is a subclass of
780 v->ob_type
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000781 */
782
783static PyObject *
784binary_op1(PyObject *v, PyObject *w, const int op_slot)
Guido van Rossume15dee51995-07-18 14:12:02 +0000785{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000786 PyObject *x;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000787 binaryfunc slotv = NULL;
788 binaryfunc slotw = NULL;
789
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000790 if (v->ob_type->tp_as_number != NULL)
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000791 slotv = NB_BINOP(v->ob_type->tp_as_number, op_slot);
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000792 if (w->ob_type != v->ob_type &&
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000793 w->ob_type->tp_as_number != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000794 slotw = NB_BINOP(w->ob_type->tp_as_number, op_slot);
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000795 if (slotw == slotv)
796 slotw = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000797 }
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000798 if (slotv) {
Guido van Rossum89c42642001-10-01 17:10:18 +0000799 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
800 x = slotw(v, w);
801 if (x != Py_NotImplemented)
802 return x;
803 Py_DECREF(x); /* can't do it */
804 slotw = NULL;
805 }
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000806 x = slotv(v, w);
807 if (x != Py_NotImplemented)
808 return x;
809 Py_DECREF(x); /* can't do it */
810 }
811 if (slotw) {
812 x = slotw(v, w);
813 if (x != Py_NotImplemented)
814 return x;
815 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000816 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000817 Py_INCREF(Py_NotImplemented);
818 return Py_NotImplemented;
819}
Guido van Rossum77660912002-04-16 16:32:50 +0000820
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000821static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000822binop_type_error(PyObject *v, PyObject *w, const char *op_name)
823{
824 PyErr_Format(PyExc_TypeError,
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000825 "unsupported operand type(s) for %.100s: "
826 "'%.100s' and '%.100s'",
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000827 op_name,
828 v->ob_type->tp_name,
829 w->ob_type->tp_name);
830 return NULL;
831}
832
833static PyObject *
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000834binary_op(PyObject *v, PyObject *w, const int op_slot, const char *op_name)
835{
836 PyObject *result = binary_op1(v, w, op_slot);
837 if (result == Py_NotImplemented) {
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000838 Py_DECREF(result);
839 return binop_type_error(v, w, op_name);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000840 }
841 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000842}
843
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000844
845/*
846 Calling scheme used for ternary operations:
847
Neal Norwitz4886cc32006-08-21 17:06:07 +0000848 Order operations are tried until either a valid result or error:
849 v.op(v,w,z), w.op(v,w,z), z.op(v,w,z)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000850 */
851
852static PyObject *
853ternary_op(PyObject *v,
854 PyObject *w,
855 PyObject *z,
856 const int op_slot,
857 const char *op_name)
Guido van Rossume15dee51995-07-18 14:12:02 +0000858{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000859 PyNumberMethods *mv, *mw, *mz;
Guido van Rossum84675ac2001-09-29 01:05:03 +0000860 PyObject *x = NULL;
861 ternaryfunc slotv = NULL;
862 ternaryfunc slotw = NULL;
863 ternaryfunc slotz = NULL;
Guido van Rossum77660912002-04-16 16:32:50 +0000864
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000865 mv = v->ob_type->tp_as_number;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000866 mw = w->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000867 if (mv != NULL)
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000868 slotv = NB_TERNOP(mv, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000869 if (w->ob_type != v->ob_type &&
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000870 mw != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000871 slotw = NB_TERNOP(mw, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000872 if (slotw == slotv)
873 slotw = NULL;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000874 }
Guido van Rossum84675ac2001-09-29 01:05:03 +0000875 if (slotv) {
Guido van Rossum89c42642001-10-01 17:10:18 +0000876 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
877 x = slotw(v, w, z);
878 if (x != Py_NotImplemented)
879 return x;
880 Py_DECREF(x); /* can't do it */
881 slotw = NULL;
882 }
Guido van Rossum84675ac2001-09-29 01:05:03 +0000883 x = slotv(v, w, z);
884 if (x != Py_NotImplemented)
885 return x;
886 Py_DECREF(x); /* can't do it */
887 }
888 if (slotw) {
889 x = slotw(v, w, z);
890 if (x != Py_NotImplemented)
891 return x;
892 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000893 }
894 mz = z->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000895 if (mz != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000896 slotz = NB_TERNOP(mz, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000897 if (slotz == slotv || slotz == slotw)
898 slotz = NULL;
899 if (slotz) {
900 x = slotz(v, w, z);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000901 if (x != Py_NotImplemented)
902 return x;
Guido van Rossum84675ac2001-09-29 01:05:03 +0000903 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000904 }
905 }
906
Guido van Rossum5c66a262001-10-22 04:12:44 +0000907 if (z == Py_None)
908 PyErr_Format(
909 PyExc_TypeError,
910 "unsupported operand type(s) for ** or pow(): "
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000911 "'%.100s' and '%.100s'",
Guido van Rossum5c66a262001-10-22 04:12:44 +0000912 v->ob_type->tp_name,
913 w->ob_type->tp_name);
914 else
915 PyErr_Format(
916 PyExc_TypeError,
917 "unsupported operand type(s) for pow(): "
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000918 "'%.100s', '%.100s', '%.100s'",
Guido van Rossum5c66a262001-10-22 04:12:44 +0000919 v->ob_type->tp_name,
920 w->ob_type->tp_name,
921 z->ob_type->tp_name);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000922 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000923}
924
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000925#define BINARY_FUNC(func, op, op_name) \
926 PyObject * \
927 func(PyObject *v, PyObject *w) { \
928 return binary_op(v, w, NB_SLOT(op), op_name); \
929 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000930
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000931BINARY_FUNC(PyNumber_Or, nb_or, "|")
932BINARY_FUNC(PyNumber_Xor, nb_xor, "^")
933BINARY_FUNC(PyNumber_And, nb_and, "&")
934BINARY_FUNC(PyNumber_Lshift, nb_lshift, "<<")
935BINARY_FUNC(PyNumber_Rshift, nb_rshift, ">>")
936BINARY_FUNC(PyNumber_Subtract, nb_subtract, "-")
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000937BINARY_FUNC(PyNumber_Divmod, nb_divmod, "divmod()")
Guido van Rossume15dee51995-07-18 14:12:02 +0000938
939PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000940PyNumber_Add(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000941{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000942 PyObject *result = binary_op1(v, w, NB_SLOT(nb_add));
943 if (result == Py_NotImplemented) {
944 PySequenceMethods *m = v->ob_type->tp_as_sequence;
Armin Rigofd163f92005-12-29 15:59:19 +0000945 Py_DECREF(result);
Jeremy Hylton0522d982002-03-08 21:28:54 +0000946 if (m && m->sq_concat) {
Armin Rigofd163f92005-12-29 15:59:19 +0000947 return (*m->sq_concat)(v, w);
Jeremy Hylton0522d982002-03-08 21:28:54 +0000948 }
Armin Rigofd163f92005-12-29 15:59:19 +0000949 result = binop_type_error(v, w, "+");
Guido van Rossume15dee51995-07-18 14:12:02 +0000950 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000951 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000952}
953
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000954static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000955sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000956{
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000957 Py_ssize_t count;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000958 if (PyIndex_Check(n)) {
959 count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000960 if (count == -1 && PyErr_Occurred())
961 return NULL;
962 }
963 else {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000964 return type_error("can't multiply sequence by "
965 "non-int of type '%.200s'", n);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000966 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000967 return (*repeatfunc)(seq, count);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000968}
969
970PyObject *
971PyNumber_Multiply(PyObject *v, PyObject *w)
972{
973 PyObject *result = binary_op1(v, w, NB_SLOT(nb_multiply));
974 if (result == Py_NotImplemented) {
975 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
976 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
Guido van Rossuma3a243e2002-12-31 19:50:03 +0000977 Py_DECREF(result);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000978 if (mv && mv->sq_repeat) {
979 return sequence_repeat(mv->sq_repeat, v, w);
980 }
981 else if (mw && mw->sq_repeat) {
982 return sequence_repeat(mw->sq_repeat, w, v);
983 }
984 result = binop_type_error(v, w, "*");
985 }
986 return result;
987}
988
Guido van Rossume15dee51995-07-18 14:12:02 +0000989PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +0000990PyNumber_FloorDivide(PyObject *v, PyObject *w)
991{
Guido van Rossum4668b002001-08-08 05:00:18 +0000992 return binary_op(v, w, NB_SLOT(nb_floor_divide), "//");
993}
994
995PyObject *
996PyNumber_TrueDivide(PyObject *v, PyObject *w)
997{
Guido van Rossum4668b002001-08-08 05:00:18 +0000998 return binary_op(v, w, NB_SLOT(nb_true_divide), "/");
999}
1000
1001PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001002PyNumber_Remainder(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +00001003{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001004 return binary_op(v, w, NB_SLOT(nb_remainder), "%");
Guido van Rossume15dee51995-07-18 14:12:02 +00001005}
1006
1007PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001008PyNumber_Power(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossume15dee51995-07-18 14:12:02 +00001009{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001010 return ternary_op(v, w, z, NB_SLOT(nb_power), "** or pow()");
Guido van Rossume15dee51995-07-18 14:12:02 +00001011}
1012
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001013/* Binary in-place operators */
1014
1015/* The in-place operators are defined to fall back to the 'normal',
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001016 non in-place operations, if the in-place methods are not in place.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001017
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001018 - If the left hand object has the appropriate struct members, and
1019 they are filled, call the appropriate function and return the
1020 result. No coercion is done on the arguments; the left-hand object
1021 is the one the operation is performed on, and it's up to the
1022 function to deal with the right-hand object.
Guido van Rossum77660912002-04-16 16:32:50 +00001023
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001024 - Otherwise, in-place modification is not supported. Handle it exactly as
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001025 a non in-place operation of the same kind.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001026
1027 */
1028
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001029static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001030binary_iop1(PyObject *v, PyObject *w, const int iop_slot, const int op_slot)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001031{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001032 PyNumberMethods *mv = v->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001033 if (mv != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +00001034 binaryfunc slot = NB_BINOP(mv, iop_slot);
1035 if (slot) {
1036 PyObject *x = (slot)(v, w);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001037 if (x != Py_NotImplemented) {
1038 return x;
1039 }
1040 Py_DECREF(x);
1041 }
Thomas Woutersf2b332d2000-09-02 08:34:40 +00001042 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001043 return binary_op1(v, w, op_slot);
1044}
1045
1046static PyObject *
1047binary_iop(PyObject *v, PyObject *w, const int iop_slot, const int op_slot,
1048 const char *op_name)
1049{
1050 PyObject *result = binary_iop1(v, w, iop_slot, op_slot);
1051 if (result == Py_NotImplemented) {
1052 Py_DECREF(result);
1053 return binop_type_error(v, w, op_name);
1054 }
1055 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001056}
1057
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001058#define INPLACE_BINOP(func, iop, op, op_name) \
1059 PyObject * \
1060 func(PyObject *v, PyObject *w) { \
1061 return binary_iop(v, w, NB_SLOT(iop), NB_SLOT(op), op_name); \
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001062 }
1063
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001064INPLACE_BINOP(PyNumber_InPlaceOr, nb_inplace_or, nb_or, "|=")
1065INPLACE_BINOP(PyNumber_InPlaceXor, nb_inplace_xor, nb_xor, "^=")
1066INPLACE_BINOP(PyNumber_InPlaceAnd, nb_inplace_and, nb_and, "&=")
1067INPLACE_BINOP(PyNumber_InPlaceLshift, nb_inplace_lshift, nb_lshift, "<<=")
1068INPLACE_BINOP(PyNumber_InPlaceRshift, nb_inplace_rshift, nb_rshift, ">>=")
1069INPLACE_BINOP(PyNumber_InPlaceSubtract, nb_inplace_subtract, nb_subtract, "-=")
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001070
1071PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001072PyNumber_InPlaceFloorDivide(PyObject *v, PyObject *w)
1073{
Guido van Rossum4668b002001-08-08 05:00:18 +00001074 return binary_iop(v, w, NB_SLOT(nb_inplace_floor_divide),
1075 NB_SLOT(nb_floor_divide), "//=");
1076}
1077
1078PyObject *
1079PyNumber_InPlaceTrueDivide(PyObject *v, PyObject *w)
1080{
Guido van Rossum4668b002001-08-08 05:00:18 +00001081 return binary_iop(v, w, NB_SLOT(nb_inplace_true_divide),
1082 NB_SLOT(nb_true_divide), "/=");
1083}
1084
1085PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001086PyNumber_InPlaceAdd(PyObject *v, PyObject *w)
1087{
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001088 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_add),
1089 NB_SLOT(nb_add));
1090 if (result == Py_NotImplemented) {
1091 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1092 Py_DECREF(result);
1093 if (m != NULL) {
1094 binaryfunc f = NULL;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001095 f = m->sq_inplace_concat;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001096 if (f == NULL)
1097 f = m->sq_concat;
1098 if (f != NULL)
1099 return (*f)(v, w);
1100 }
1101 result = binop_type_error(v, w, "+=");
Guido van Rossumbb8be932000-09-01 23:27:32 +00001102 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001103 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001104}
1105
1106PyObject *
1107PyNumber_InPlaceMultiply(PyObject *v, PyObject *w)
1108{
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001109 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_multiply),
1110 NB_SLOT(nb_multiply));
1111 if (result == Py_NotImplemented) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001112 ssizeargfunc f = NULL;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001113 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1114 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1115 Py_DECREF(result);
1116 if (mv != NULL) {
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001117 f = mv->sq_inplace_repeat;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001118 if (f == NULL)
1119 f = mv->sq_repeat;
1120 if (f != NULL)
1121 return sequence_repeat(f, v, w);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001122 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001123 else if (mw != NULL) {
1124 /* Note that the right hand operand should not be
1125 * mutated in this case so sq_inplace_repeat is not
1126 * used. */
1127 if (mw->sq_repeat)
1128 return sequence_repeat(mw->sq_repeat, w, v);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001129 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001130 result = binop_type_error(v, w, "*=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001131 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001132 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001133}
1134
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001135PyObject *
1136PyNumber_InPlaceRemainder(PyObject *v, PyObject *w)
1137{
Neil Schemenauerd46fbc32002-11-24 01:07:42 +00001138 return binary_iop(v, w, NB_SLOT(nb_inplace_remainder),
1139 NB_SLOT(nb_remainder), "%=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001140}
1141
1142PyObject *
1143PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
1144{
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001145 if (v->ob_type->tp_as_number &&
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001146 v->ob_type->tp_as_number->nb_inplace_power != NULL) {
1147 return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001148 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001149 else {
1150 return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
1151 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001152}
1153
1154
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001155/* Unary operators and functions */
Guido van Rossume15dee51995-07-18 14:12:02 +00001156
1157PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001158PyNumber_Negative(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001159{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001160 PyNumberMethods *m;
1161
1162 if (o == NULL)
1163 return null_error();
1164 m = o->ob_type->tp_as_number;
1165 if (m && m->nb_negative)
1166 return (*m->nb_negative)(o);
1167
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001168 return type_error("bad operand type for unary -: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001169}
1170
1171PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001172PyNumber_Positive(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001173{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001174 PyNumberMethods *m;
1175
1176 if (o == NULL)
1177 return null_error();
1178 m = o->ob_type->tp_as_number;
1179 if (m && m->nb_positive)
1180 return (*m->nb_positive)(o);
1181
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001182 return type_error("bad operand type for unary +: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001183}
1184
1185PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001186PyNumber_Invert(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001187{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001188 PyNumberMethods *m;
1189
1190 if (o == NULL)
1191 return null_error();
1192 m = o->ob_type->tp_as_number;
1193 if (m && m->nb_invert)
1194 return (*m->nb_invert)(o);
1195
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001196 return type_error("bad operand type for unary ~: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001197}
1198
1199PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001200PyNumber_Absolute(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001201{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001202 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001203
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001204 if (o == NULL)
1205 return null_error();
1206 m = o->ob_type->tp_as_number;
1207 if (m && m->nb_absolute)
1208 return m->nb_absolute(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001209
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001210 return type_error("bad operand type for abs(): '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001211}
1212
Guido van Rossum98297ee2007-11-06 21:34:58 +00001213/* Return a Python Int or Long from the object item
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001214 Raise TypeError if the result is not an int-or-long
Guido van Rossum98297ee2007-11-06 21:34:58 +00001215 or if the object cannot be interpreted as an index.
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001216*/
1217PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001218PyNumber_Index(PyObject *item)
1219{
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001220 PyObject *result = NULL;
1221 if (item == NULL)
1222 return null_error();
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001223 if (PyLong_Check(item)) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001224 Py_INCREF(item);
1225 return item;
1226 }
1227 if (PyIndex_Check(item)) {
Trent Nelson71792202008-04-11 23:02:37 +00001228 result = item->ob_type->tp_as_number->nb_index(item);
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001229 if (result && !PyLong_Check(result)) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001230 PyErr_Format(PyExc_TypeError,
Guido van Rossum032a2842007-02-26 05:44:27 +00001231 "__index__ returned non-int "
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001232 "(type %.200s)",
1233 result->ob_type->tp_name);
1234 Py_DECREF(result);
1235 return NULL;
1236 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001237 }
Trent Nelson71792202008-04-11 23:02:37 +00001238 else {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001239 PyErr_Format(PyExc_TypeError,
1240 "'%.200s' object cannot be interpreted "
Guido van Rossum032a2842007-02-26 05:44:27 +00001241 "as an integer", item->ob_type->tp_name);
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001242 }
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001243 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001244}
1245
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001246/* Return an error on Overflow only if err is not NULL*/
1247
1248Py_ssize_t
1249PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1250{
1251 Py_ssize_t result;
1252 PyObject *runerr;
1253 PyObject *value = PyNumber_Index(item);
1254 if (value == NULL)
1255 return -1;
1256
Christian Heimes217cfd12007-12-02 14:31:20 +00001257 /* We're done if PyLong_AsSsize_t() returns without error. */
1258 result = PyLong_AsSsize_t(value);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001259 if (result != -1 || !(runerr = PyErr_Occurred()))
1260 goto finish;
1261
1262 /* Error handling code -- only manage OverflowError differently */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001263 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001264 goto finish;
1265
1266 PyErr_Clear();
Guido van Rossum98297ee2007-11-06 21:34:58 +00001267 /* If no error-handling desired then the default clipping
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001268 is sufficient.
1269 */
1270 if (!err) {
1271 assert(PyLong_Check(value));
Guido van Rossum98297ee2007-11-06 21:34:58 +00001272 /* Whether or not it is less than or equal to
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001273 zero is determined by the sign of ob_size
1274 */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001275 if (_PyLong_Sign(value) < 0)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001276 result = PY_SSIZE_T_MIN;
1277 else
1278 result = PY_SSIZE_T_MAX;
1279 }
1280 else {
1281 /* Otherwise replace the error with caller's error object. */
1282 PyErr_Format(err,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001283 "cannot fit '%.200s' into an index-sized integer",
1284 item->ob_type->tp_name);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001285 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001286
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001287 finish:
1288 Py_DECREF(value);
1289 return result;
1290}
1291
1292
Christian Heimes15ebc882008-02-04 18:48:49 +00001293PyObject *
1294_PyNumber_ConvertIntegralToInt(PyObject *integral, const char* error_format)
1295{
1296 static PyObject *int_name = NULL;
1297 if (int_name == NULL) {
1298 int_name = PyUnicode_InternFromString("__int__");
1299 if (int_name == NULL)
1300 return NULL;
1301 }
1302
1303 if (integral && !PyLong_Check(integral)) {
1304 /* Don't go through tp_as_number->nb_int to avoid
1305 hitting the classic class fallback to __trunc__. */
1306 PyObject *int_func = PyObject_GetAttr(integral, int_name);
1307 if (int_func == NULL) {
1308 PyErr_Clear(); /* Raise a different error. */
1309 goto non_integral_error;
1310 }
1311 Py_DECREF(integral);
1312 integral = PyEval_CallObject(int_func, NULL);
1313 Py_DECREF(int_func);
1314 if (integral && !PyLong_Check(integral)) {
1315 goto non_integral_error;
1316 }
1317 }
1318 return integral;
1319
1320non_integral_error:
1321 PyErr_Format(PyExc_TypeError, error_format, Py_TYPE(integral)->tp_name);
1322 Py_DECREF(integral);
1323 return NULL;
1324}
1325
1326
Guido van Rossum9e896b32000-04-05 20:11:21 +00001327/* Add a check for embedded NULL-bytes in the argument. */
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001328static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001329long_from_string(const char *s, Py_ssize_t len)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001330{
Guido van Rossum4c08d552000-03-10 22:55:18 +00001331 char *end;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001332 PyObject *x;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001333
Guido van Rossum4c08d552000-03-10 22:55:18 +00001334 x = PyLong_FromString((char*)s, &end, 10);
Guido van Rossum9e896b32000-04-05 20:11:21 +00001335 if (x == NULL)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001336 return NULL;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001337 if (end != s + len) {
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001338 PyErr_SetString(PyExc_ValueError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001339 "null byte in argument for int()");
Guido van Rossum9e896b32000-04-05 20:11:21 +00001340 Py_DECREF(x);
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001341 return NULL;
1342 }
1343 return x;
1344}
1345
Guido van Rossume15dee51995-07-18 14:12:02 +00001346PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001347PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001348{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001349 PyNumberMethods *m;
Christian Heimes15ebc882008-02-04 18:48:49 +00001350 static PyObject *trunc_name = NULL;
1351 PyObject *trunc_func;
Guido van Rossum4c08d552000-03-10 22:55:18 +00001352 const char *buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001353 Py_ssize_t buffer_len;
Guido van Rossume15dee51995-07-18 14:12:02 +00001354
Christian Heimes15ebc882008-02-04 18:48:49 +00001355 if (trunc_name == NULL) {
1356 trunc_name = PyUnicode_InternFromString("__trunc__");
1357 if (trunc_name == NULL)
1358 return NULL;
1359 }
1360
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001361 if (o == NULL)
1362 return null_error();
Guido van Rossumddefaf32007-01-14 03:31:43 +00001363 if (PyLong_CheckExact(o)) {
1364 Py_INCREF(o);
1365 return o;
1366 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001367 m = o->ob_type->tp_as_number;
Guido van Rossumddefaf32007-01-14 03:31:43 +00001368 if (m && m->nb_int) { /* This should include subclasses of int */
1369 PyObject *res = m->nb_int(o);
1370 if (res && !PyLong_Check(res)) {
1371 PyErr_Format(PyExc_TypeError,
1372 "__int__ returned non-int (type %.200s)",
1373 res->ob_type->tp_name);
1374 Py_DECREF(res);
1375 return NULL;
1376 }
1377 return res;
1378 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001379 if (m && m->nb_long) { /* This should include subclasses of long */
Christian Heimes15ebc882008-02-04 18:48:49 +00001380 /* Classic classes always take this branch. */
Brett Cannonc3647ac2005-04-26 03:45:26 +00001381 PyObject *res = m->nb_long(o);
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001382 if (res && !PyLong_Check(res)) {
Brett Cannonc3647ac2005-04-26 03:45:26 +00001383 PyErr_Format(PyExc_TypeError,
1384 "__long__ returned non-long (type %.200s)",
1385 res->ob_type->tp_name);
1386 Py_DECREF(res);
1387 return NULL;
1388 }
1389 return res;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001390 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001391 if (PyLong_Check(o)) /* A long subclass without nb_long */
Tim Petersdb30ac42002-03-02 04:14:21 +00001392 return _PyLong_Copy((PyLongObject *)o);
Christian Heimes15ebc882008-02-04 18:48:49 +00001393 trunc_func = PyObject_GetAttr(o, trunc_name);
1394 if (trunc_func) {
1395 PyObject *truncated = PyEval_CallObject(trunc_func, NULL);
1396 PyObject *int_instance;
1397 Py_DECREF(trunc_func);
1398 /* __trunc__ is specified to return an Integral type,
1399 but long() needs to return a long. */
1400 int_instance = _PyNumber_ConvertIntegralToInt(
1401 truncated,
1402 "__trunc__ returned non-Integral (type %.200s)");
1403 return int_instance;
1404 }
1405 PyErr_Clear(); /* It's not an error if o.__trunc__ doesn't exist. */
1406
Christian Heimes72b710a2008-05-26 13:28:38 +00001407 if (PyBytes_Check(o))
Christian Heimes15ebc882008-02-04 18:48:49 +00001408 /* need to do extra error checking that PyLong_FromString()
1409 * doesn't do. In particular long('9.5') must raise an
1410 * exception, not truncate the float.
1411 */
Christian Heimes72b710a2008-05-26 13:28:38 +00001412 return long_from_string(PyBytes_AS_STRING(o),
1413 PyBytes_GET_SIZE(o));
Guido van Rossum9e896b32000-04-05 20:11:21 +00001414 if (PyUnicode_Check(o))
1415 /* The above check is done in PyLong_FromUnicode(). */
1416 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(o),
1417 PyUnicode_GET_SIZE(o),
1418 10);
Guido van Rossum4c08d552000-03-10 22:55:18 +00001419 if (!PyObject_AsCharBuffer(o, &buffer, &buffer_len))
1420 return long_from_string(buffer, buffer_len);
Guido van Rossume15dee51995-07-18 14:12:02 +00001421
Guido van Rossumddefaf32007-01-14 03:31:43 +00001422 return type_error("int() argument must be a string or a "
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001423 "number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001424}
1425
1426PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001427PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001428{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001429 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001430
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001431 if (o == NULL)
1432 return null_error();
Brett Cannonc3647ac2005-04-26 03:45:26 +00001433 m = o->ob_type->tp_as_number;
1434 if (m && m->nb_float) { /* This should include subclasses of float */
1435 PyObject *res = m->nb_float(o);
1436 if (res && !PyFloat_Check(res)) {
1437 PyErr_Format(PyExc_TypeError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001438 "__float__ returned non-float (type %.200s)",
1439 res->ob_type->tp_name);
Brett Cannonc3647ac2005-04-26 03:45:26 +00001440 Py_DECREF(res);
1441 return NULL;
1442 }
1443 return res;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001444 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001445 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
Tim Peters7a50f252001-09-10 21:28:20 +00001446 PyFloatObject *po = (PyFloatObject *)o;
1447 return PyFloat_FromDouble(po->ob_fval);
1448 }
Georg Brandl428f0642007-03-18 18:35:15 +00001449 return PyFloat_FromString(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001450}
1451
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001452
1453PyObject *
1454PyNumber_ToBase(PyObject *n, int base)
1455{
Christian Heimesa156e092008-02-16 07:38:31 +00001456 PyObject *res = NULL;
Raymond Hettinger5c960b82008-06-24 22:28:56 +00001457 PyObject *index = PyNumber_Index(n);
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001458
1459 if (!index)
1460 return NULL;
Christian Heimesa156e092008-02-16 07:38:31 +00001461 if (PyLong_Check(index))
1462 res = _PyLong_Format(index, base);
1463 else
1464 /* It should not be possible to get here, as
1465 PyNumber_Index already has a check for the same
1466 condition */
1467 PyErr_SetString(PyExc_ValueError, "PyNumber_ToBase: index not "
1468 "int or long");
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001469 Py_DECREF(index);
1470 return res;
1471}
1472
1473
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001474/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001475
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001476int
Fred Drake79912472000-07-09 04:06:11 +00001477PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001478{
Thomas Wouterscf297e42007-02-23 15:07:44 +00001479 if (PyObject_IsInstance(s, (PyObject *)&PyDict_Type))
1480 return 0;
Guido van Rossum8700b422001-09-07 20:20:11 +00001481 return s != NULL && s->ob_type->tp_as_sequence &&
1482 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001483}
1484
Martin v. Löwis18e16552006-02-15 17:27:45 +00001485Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001486PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001487{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001488 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001489
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001490 if (s == NULL) {
1491 null_error();
1492 return -1;
1493 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001494
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001495 m = s->ob_type->tp_as_sequence;
1496 if (m && m->sq_length)
1497 return m->sq_length(s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001498
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001499 type_error("object of type '%.200s' has no len()", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001500 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001501}
1502
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001503#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001504Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001505PySequence_Length(PyObject *s)
1506{
1507 return PySequence_Size(s);
1508}
1509#define PySequence_Length PySequence_Size
1510
Guido van Rossume15dee51995-07-18 14:12:02 +00001511PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001512PySequence_Concat(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001513{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001514 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001515
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001516 if (s == NULL || o == NULL)
1517 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001518
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001519 m = s->ob_type->tp_as_sequence;
1520 if (m && m->sq_concat)
1521 return m->sq_concat(s, o);
1522
Armin Rigofd163f92005-12-29 15:59:19 +00001523 /* Instances of user classes defining an __add__() method only
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001524 have an nb_add slot, not an sq_concat slot. So we fall back
Armin Rigofd163f92005-12-29 15:59:19 +00001525 to nb_add if both arguments appear to be sequences. */
1526 if (PySequence_Check(s) && PySequence_Check(o)) {
1527 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1528 if (result != Py_NotImplemented)
1529 return result;
1530 Py_DECREF(result);
1531 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001532 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001533}
1534
1535PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001536PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001537{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001538 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001539
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001540 if (o == NULL)
1541 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001542
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001543 m = o->ob_type->tp_as_sequence;
1544 if (m && m->sq_repeat)
1545 return m->sq_repeat(o, count);
1546
Armin Rigofd163f92005-12-29 15:59:19 +00001547 /* Instances of user classes defining a __mul__() method only
1548 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1549 to nb_multiply if o appears to be a sequence. */
1550 if (PySequence_Check(o)) {
1551 PyObject *n, *result;
Christian Heimes217cfd12007-12-02 14:31:20 +00001552 n = PyLong_FromSsize_t(count);
Armin Rigofd163f92005-12-29 15:59:19 +00001553 if (n == NULL)
1554 return NULL;
1555 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1556 Py_DECREF(n);
1557 if (result != Py_NotImplemented)
1558 return result;
1559 Py_DECREF(result);
1560 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001561 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001562}
1563
1564PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001565PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1566{
1567 PySequenceMethods *m;
1568
1569 if (s == NULL || o == NULL)
1570 return null_error();
1571
1572 m = s->ob_type->tp_as_sequence;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001573 if (m && m->sq_inplace_concat)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001574 return m->sq_inplace_concat(s, o);
1575 if (m && m->sq_concat)
1576 return m->sq_concat(s, o);
1577
Armin Rigofd163f92005-12-29 15:59:19 +00001578 if (PySequence_Check(s) && PySequence_Check(o)) {
1579 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1580 NB_SLOT(nb_add));
1581 if (result != Py_NotImplemented)
1582 return result;
1583 Py_DECREF(result);
1584 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001585 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001586}
1587
1588PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001589PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001590{
1591 PySequenceMethods *m;
1592
1593 if (o == NULL)
1594 return null_error();
1595
1596 m = o->ob_type->tp_as_sequence;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001597 if (m && m->sq_inplace_repeat)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001598 return m->sq_inplace_repeat(o, count);
1599 if (m && m->sq_repeat)
1600 return m->sq_repeat(o, count);
1601
Armin Rigofd163f92005-12-29 15:59:19 +00001602 if (PySequence_Check(o)) {
1603 PyObject *n, *result;
Christian Heimes217cfd12007-12-02 14:31:20 +00001604 n = PyLong_FromSsize_t(count);
Armin Rigofd163f92005-12-29 15:59:19 +00001605 if (n == NULL)
1606 return NULL;
1607 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1608 NB_SLOT(nb_multiply));
1609 Py_DECREF(n);
1610 if (result != Py_NotImplemented)
1611 return result;
1612 Py_DECREF(result);
1613 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001614 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001615}
1616
1617PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001618PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001619{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001620 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001621
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001622 if (s == NULL)
1623 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001624
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001625 m = s->ob_type->tp_as_sequence;
1626 if (m && m->sq_item) {
1627 if (i < 0) {
1628 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001629 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001630 if (l < 0)
1631 return NULL;
1632 i += l;
1633 }
1634 }
1635 return m->sq_item(s, i);
1636 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001637
Georg Brandl86b2fb92008-07-16 03:43:04 +00001638 return type_error("'%.200s' object does not support indexing", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001639}
1640
1641PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001642PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00001643{
Thomas Wouters1d75a792000-08-17 22:37:32 +00001644 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001645
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001646 if (!s) return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001647
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001648 mp = s->ob_type->tp_as_mapping;
1649 if (mp->mp_subscript) {
Thomas Wouters1d75a792000-08-17 22:37:32 +00001650 PyObject *res;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001651 PyObject *slice = _PySlice_FromIndices(i1, i2);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001652 if (!slice)
1653 return NULL;
1654 res = mp->mp_subscript(s, slice);
1655 Py_DECREF(slice);
1656 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001657 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001658
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001659 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001660}
1661
1662int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001663PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001664{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001665 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001666
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001667 if (s == NULL) {
1668 null_error();
1669 return -1;
1670 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001671
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001672 m = s->ob_type->tp_as_sequence;
1673 if (m && m->sq_ass_item) {
1674 if (i < 0) {
1675 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001676 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001677 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001678 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001679 i += l;
1680 }
1681 }
1682 return m->sq_ass_item(s, i, o);
1683 }
1684
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001685 type_error("'%.200s' object does not support item assignment", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001686 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001687}
1688
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001689int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001690PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001691{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001692 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001693
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001694 if (s == NULL) {
1695 null_error();
1696 return -1;
1697 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001698
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001699 m = s->ob_type->tp_as_sequence;
1700 if (m && m->sq_ass_item) {
1701 if (i < 0) {
1702 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001703 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001704 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001705 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001706 i += l;
1707 }
1708 }
1709 return m->sq_ass_item(s, i, (PyObject *)NULL);
1710 }
1711
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001712 type_error("'%.200s' object doesn't support item deletion", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001713 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001714}
1715
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001716int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001717PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001718{
Thomas Wouters1d75a792000-08-17 22:37:32 +00001719 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001720
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001721 if (s == NULL) {
1722 null_error();
1723 return -1;
1724 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001725
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001726 mp = s->ob_type->tp_as_mapping;
1727 if (mp->mp_ass_subscript) {
Thomas Wouters1d75a792000-08-17 22:37:32 +00001728 int res;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001729 PyObject *slice = _PySlice_FromIndices(i1, i2);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001730 if (!slice)
1731 return -1;
1732 res = mp->mp_ass_subscript(s, slice, o);
1733 Py_DECREF(slice);
1734 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001735 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00001736
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001737 type_error("'%.200s' object doesn't support slice assignment", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001738 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001739}
1740
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001741int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001742PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001743{
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001744 PyMappingMethods *mp;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001745
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001746 if (s == NULL) {
1747 null_error();
1748 return -1;
1749 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001750
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001751 mp = s->ob_type->tp_as_mapping;
1752 if (mp->mp_ass_subscript) {
1753 int res;
1754 PyObject *slice = _PySlice_FromIndices(i1, i2);
1755 if (!slice)
1756 return -1;
1757 res = mp->mp_ass_subscript(s, slice, NULL);
1758 Py_DECREF(slice);
1759 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001760 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001761 type_error("'%.200s' object doesn't support slice deletion", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001762 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001763}
1764
Guido van Rossume15dee51995-07-18 14:12:02 +00001765PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001766PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00001767{
Tim Peters6912d4d2001-05-05 03:56:37 +00001768 PyObject *it; /* iter(v) */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001769 Py_ssize_t n; /* guess for result tuple size */
Tim Peters6912d4d2001-05-05 03:56:37 +00001770 PyObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001771 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00001772
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001773 if (v == NULL)
1774 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001775
Tim Peters6912d4d2001-05-05 03:56:37 +00001776 /* Special-case the common tuple and list cases, for efficiency. */
Tim Peters4c3a0a32001-09-10 23:37:46 +00001777 if (PyTuple_CheckExact(v)) {
1778 /* Note that we can't know whether it's safe to return
1779 a tuple *subclass* instance as-is, hence the restriction
Tim Peters8ff70a92001-09-10 23:53:53 +00001780 to exact tuples here. In contrast, lists always make
1781 a copy, so there's no need for exactness below. */
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001782 Py_INCREF(v);
1783 return v;
Guido van Rossume15dee51995-07-18 14:12:02 +00001784 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001785 if (PyList_Check(v))
1786 return PyList_AsTuple(v);
1787
Tim Peters6912d4d2001-05-05 03:56:37 +00001788 /* Get iterator. */
1789 it = PyObject_GetIter(v);
1790 if (it == NULL)
Tim Peters1fc240e2001-10-26 05:06:50 +00001791 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001792
Tim Peters6912d4d2001-05-05 03:56:37 +00001793 /* Guess result size and allocate space. */
Christian Heimes255f53b2007-12-08 15:33:56 +00001794 n = _PyObject_LengthHint(v, 10);
Tim Peters6912d4d2001-05-05 03:56:37 +00001795 result = PyTuple_New(n);
1796 if (result == NULL)
1797 goto Fail;
1798
1799 /* Fill the tuple. */
1800 for (j = 0; ; ++j) {
1801 PyObject *item = PyIter_Next(it);
1802 if (item == NULL) {
1803 if (PyErr_Occurred())
1804 goto Fail;
1805 break;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001806 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001807 if (j >= n) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001808 Py_ssize_t oldn = n;
Raymond Hettinger4d012592004-12-16 10:38:38 +00001809 /* The over-allocation strategy can grow a bit faster
Guido van Rossum98297ee2007-11-06 21:34:58 +00001810 than for lists because unlike lists the
Raymond Hettinger4d012592004-12-16 10:38:38 +00001811 over-allocation isn't permanent -- we reclaim
1812 the excess before the end of this routine.
1813 So, grow by ten and then add 25%.
1814 */
1815 n += 10;
1816 n += n >> 2;
1817 if (n < oldn) {
1818 /* Check for overflow */
1819 PyErr_NoMemory();
Raymond Hettingere6bdb372004-12-16 15:10:21 +00001820 Py_DECREF(item);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001821 goto Fail;
Raymond Hettinger4d012592004-12-16 10:38:38 +00001822 }
Tim Peters4324aa32001-05-28 22:30:08 +00001823 if (_PyTuple_Resize(&result, n) != 0) {
Tim Peters12d0a6c2001-05-05 04:10:25 +00001824 Py_DECREF(item);
Tim Peters6912d4d2001-05-05 03:56:37 +00001825 goto Fail;
Tim Peters12d0a6c2001-05-05 04:10:25 +00001826 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001827 }
1828 PyTuple_SET_ITEM(result, j, item);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001829 }
1830
Tim Peters6912d4d2001-05-05 03:56:37 +00001831 /* Cut tuple back if guess was too large. */
1832 if (j < n &&
Tim Peters4324aa32001-05-28 22:30:08 +00001833 _PyTuple_Resize(&result, j) != 0)
Tim Peters6912d4d2001-05-05 03:56:37 +00001834 goto Fail;
1835
1836 Py_DECREF(it);
1837 return result;
1838
1839Fail:
1840 Py_XDECREF(result);
1841 Py_DECREF(it);
1842 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001843}
1844
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001845PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001846PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001847{
Tim Petersf553f892001-05-01 20:45:31 +00001848 PyObject *result; /* result list */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001849 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00001850
Guido van Rossum5dba9e81998-07-10 18:03:50 +00001851 if (v == NULL)
1852 return null_error();
1853
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +00001854 result = PyList_New(0);
1855 if (result == NULL)
Tim Petersf553f892001-05-01 20:45:31 +00001856 return NULL;
1857
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +00001858 rv = _PyList_Extend((PyListObject *)result, v);
1859 if (rv == NULL) {
1860 Py_DECREF(result);
Tim Petersf553f892001-05-01 20:45:31 +00001861 return NULL;
1862 }
Raymond Hettinger969d8c02004-03-17 05:24:23 +00001863 Py_DECREF(rv);
Tim Petersf553f892001-05-01 20:45:31 +00001864 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001865}
1866
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001867PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001868PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001869{
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001870 PyObject *it;
1871
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001872 if (v == NULL)
1873 return null_error();
1874
Michael W. Hudson2801fe12002-11-05 18:05:49 +00001875 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001876 Py_INCREF(v);
1877 return v;
1878 }
1879
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001880 it = PyObject_GetIter(v);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001881 if (it == NULL) {
1882 if (PyErr_ExceptionMatches(PyExc_TypeError))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001883 PyErr_SetString(PyExc_TypeError, m);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001884 return NULL;
1885 }
1886
Raymond Hettinger193814c2004-12-18 19:00:59 +00001887 v = PySequence_List(it);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001888 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001889
1890 return v;
1891}
1892
Tim Peters16a77ad2001-09-08 04:00:12 +00001893/* Iterate over seq. Result depends on the operation:
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001894 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
1895 PY_ITERSEARCH_INDEX: 0-based index of first occurence of obj in seq;
1896 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00001897 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
1898*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001899Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001900_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00001901{
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001902 Py_ssize_t n;
Tim Peters16a77ad2001-09-08 04:00:12 +00001903 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
1904 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00001905
Tim Peters16a77ad2001-09-08 04:00:12 +00001906 if (seq == NULL || obj == NULL) {
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001907 null_error();
1908 return -1;
1909 }
Tim Peters75f8e352001-05-05 11:33:43 +00001910
Tim Peters16a77ad2001-09-08 04:00:12 +00001911 it = PyObject_GetIter(seq);
Tim Peters75f8e352001-05-05 11:33:43 +00001912 if (it == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001913 type_error("argument of type '%.200s' is not iterable", seq);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001914 return -1;
Tim Peters75f8e352001-05-05 11:33:43 +00001915 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001916
Tim Peters16a77ad2001-09-08 04:00:12 +00001917 n = wrapped = 0;
Tim Peters75f8e352001-05-05 11:33:43 +00001918 for (;;) {
1919 int cmp;
1920 PyObject *item = PyIter_Next(it);
1921 if (item == NULL) {
1922 if (PyErr_Occurred())
1923 goto Fail;
1924 break;
1925 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001926
1927 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001928 Py_DECREF(item);
Tim Peters75f8e352001-05-05 11:33:43 +00001929 if (cmp < 0)
1930 goto Fail;
1931 if (cmp > 0) {
Tim Peters16a77ad2001-09-08 04:00:12 +00001932 switch (operation) {
1933 case PY_ITERSEARCH_COUNT:
Thomas Wouters89f507f2006-12-13 04:49:30 +00001934 if (n == PY_SSIZE_T_MAX) {
Tim Peters16a77ad2001-09-08 04:00:12 +00001935 PyErr_SetString(PyExc_OverflowError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00001936 "count exceeds C integer size");
Tim Peters16a77ad2001-09-08 04:00:12 +00001937 goto Fail;
1938 }
Thomas Wouters89f507f2006-12-13 04:49:30 +00001939 ++n;
Tim Peters16a77ad2001-09-08 04:00:12 +00001940 break;
1941
1942 case PY_ITERSEARCH_INDEX:
1943 if (wrapped) {
1944 PyErr_SetString(PyExc_OverflowError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00001945 "index exceeds C integer size");
Tim Peters16a77ad2001-09-08 04:00:12 +00001946 goto Fail;
1947 }
1948 goto Done;
1949
1950 case PY_ITERSEARCH_CONTAINS:
1951 n = 1;
1952 goto Done;
1953
1954 default:
1955 assert(!"unknown operation");
Tim Peters75f8e352001-05-05 11:33:43 +00001956 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001957 }
1958
1959 if (operation == PY_ITERSEARCH_INDEX) {
Thomas Wouters89f507f2006-12-13 04:49:30 +00001960 if (n == PY_SSIZE_T_MAX)
Tim Peters16a77ad2001-09-08 04:00:12 +00001961 wrapped = 1;
Thomas Wouters89f507f2006-12-13 04:49:30 +00001962 ++n;
Tim Peters75f8e352001-05-05 11:33:43 +00001963 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001964 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001965
1966 if (operation != PY_ITERSEARCH_INDEX)
1967 goto Done;
1968
1969 PyErr_SetString(PyExc_ValueError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001970 "sequence.index(x): x not in sequence");
Tim Peters16a77ad2001-09-08 04:00:12 +00001971 /* fall into failure code */
1972Fail:
1973 n = -1;
1974 /* fall through */
1975Done:
Tim Peters75f8e352001-05-05 11:33:43 +00001976 Py_DECREF(it);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001977 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00001978
Guido van Rossume15dee51995-07-18 14:12:02 +00001979}
1980
Tim Peters16a77ad2001-09-08 04:00:12 +00001981/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001982Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001983PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001984{
Tim Peters16a77ad2001-09-08 04:00:12 +00001985 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00001986}
1987
Tim Peterscb8d3682001-05-05 21:05:01 +00001988/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00001989 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00001990 */
1991int
1992PySequence_Contains(PyObject *seq, PyObject *ob)
1993{
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001994 Py_ssize_t result;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001995 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001996 if (sqm != NULL && sqm->sq_contains != NULL)
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001997 return (*sqm->sq_contains)(seq, ob);
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001998 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
1999 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00002000}
2001
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002002/* Backwards compatibility */
2003#undef PySequence_In
2004int
Fred Drake79912472000-07-09 04:06:11 +00002005PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002006{
2007 return PySequence_Contains(w, v);
2008}
2009
Neal Norwitz1fc4b772006-03-04 18:49:58 +00002010Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00002011PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002012{
Tim Peters16a77ad2001-09-08 04:00:12 +00002013 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00002014}
2015
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002016/* Operations on mappings */
2017
2018int
Fred Drake79912472000-07-09 04:06:11 +00002019PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002020{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002021 return o && o->ob_type->tp_as_mapping &&
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00002022 o->ob_type->tp_as_mapping->mp_subscript;
Guido van Rossume15dee51995-07-18 14:12:02 +00002023}
2024
Martin v. Löwis18e16552006-02-15 17:27:45 +00002025Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00002026PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002027{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002028 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00002029
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002030 if (o == NULL) {
2031 null_error();
2032 return -1;
2033 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002034
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002035 m = o->ob_type->tp_as_mapping;
2036 if (m && m->mp_length)
2037 return m->mp_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00002038
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002039 type_error("object of type '%.200s' has no len()", o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002040 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00002041}
2042
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002043#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00002044Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002045PyMapping_Length(PyObject *o)
2046{
2047 return PyMapping_Size(o);
2048}
2049#define PyMapping_Length PyMapping_Size
2050
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002051PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002052PyMapping_GetItemString(PyObject *o, char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002053{
2054 PyObject *okey, *r;
2055
2056 if (key == NULL)
2057 return null_error();
2058
Martin v. Löwis5b222132007-06-10 09:51:05 +00002059 okey = PyUnicode_FromString(key);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002060 if (okey == NULL)
2061 return NULL;
2062 r = PyObject_GetItem(o, okey);
2063 Py_DECREF(okey);
2064 return r;
2065}
2066
2067int
Fred Drake79912472000-07-09 04:06:11 +00002068PyMapping_SetItemString(PyObject *o, char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002069{
2070 PyObject *okey;
2071 int r;
2072
2073 if (key == NULL) {
2074 null_error();
2075 return -1;
2076 }
2077
Martin v. Löwis5b222132007-06-10 09:51:05 +00002078 okey = PyUnicode_FromString(key);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002079 if (okey == NULL)
Guido van Rossumed6219b1998-05-29 02:59:33 +00002080 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002081 r = PyObject_SetItem(o, okey, value);
2082 Py_DECREF(okey);
2083 return r;
2084}
2085
2086int
Fred Drake79912472000-07-09 04:06:11 +00002087PyMapping_HasKeyString(PyObject *o, char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002088{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002089 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002090
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002091 v = PyMapping_GetItemString(o, key);
2092 if (v) {
2093 Py_DECREF(v);
2094 return 1;
2095 }
2096 PyErr_Clear();
2097 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002098}
2099
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002100int
Fred Drake79912472000-07-09 04:06:11 +00002101PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002102{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002103 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002104
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002105 v = PyObject_GetItem(o, key);
2106 if (v) {
2107 Py_DECREF(v);
2108 return 1;
2109 }
2110 PyErr_Clear();
2111 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002112}
2113
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002114PyObject *
2115PyMapping_Keys(PyObject *o)
2116{
2117 PyObject *keys;
2118 PyObject *fast;
2119
2120 if (PyDict_CheckExact(o))
2121 return PyDict_Keys(o);
2122 keys = PyObject_CallMethod(o, "keys", NULL);
2123 if (keys == NULL)
2124 return NULL;
2125 fast = PySequence_Fast(keys, "o.keys() are not iterable");
2126 Py_DECREF(keys);
2127 return fast;
2128}
2129
2130PyObject *
2131PyMapping_Items(PyObject *o)
2132{
2133 PyObject *items;
2134 PyObject *fast;
2135
2136 if (PyDict_CheckExact(o))
2137 return PyDict_Items(o);
2138 items = PyObject_CallMethod(o, "items", NULL);
2139 if (items == NULL)
2140 return NULL;
2141 fast = PySequence_Fast(items, "o.items() are not iterable");
2142 Py_DECREF(items);
2143 return fast;
2144}
2145
2146PyObject *
2147PyMapping_Values(PyObject *o)
2148{
2149 PyObject *values;
2150 PyObject *fast;
2151
2152 if (PyDict_CheckExact(o))
2153 return PyDict_Values(o);
2154 values = PyObject_CallMethod(o, "values", NULL);
2155 if (values == NULL)
2156 return NULL;
2157 fast = PySequence_Fast(values, "o.values() are not iterable");
2158 Py_DECREF(values);
2159 return fast;
2160}
2161
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002162/* Operations on callable objects */
2163
2164/* XXX PyCallable_Check() is in object.c */
2165
Guido van Rossume15dee51995-07-18 14:12:02 +00002166PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002167PyObject_CallObject(PyObject *o, PyObject *a)
Guido van Rossume15dee51995-07-18 14:12:02 +00002168{
Guido van Rossum5560b742001-09-14 16:47:50 +00002169 return PyEval_CallObjectWithKeywords(o, a, NULL);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002170}
Guido van Rossume15dee51995-07-18 14:12:02 +00002171
2172PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002173PyObject_Call(PyObject *func, PyObject *arg, PyObject *kw)
2174{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002175 ternaryfunc call;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002176
2177 if ((call = func->ob_type->tp_call) != NULL) {
Thomas Wouters89d996e2007-09-08 17:39:28 +00002178 PyObject *result;
2179 if (Py_EnterRecursiveCall(" while calling a Python object"))
2180 return NULL;
2181 result = (*call)(func, arg, kw);
2182 Py_LeaveRecursiveCall();
Tim Peters6d6c1a32001-08-02 04:15:00 +00002183 if (result == NULL && !PyErr_Occurred())
2184 PyErr_SetString(
2185 PyExc_SystemError,
2186 "NULL result without error in PyObject_Call");
2187 return result;
2188 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002189 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
Fred Drake573395a2001-11-01 20:26:12 +00002190 func->ob_type->tp_name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002191 return NULL;
2192}
2193
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002194static PyObject*
2195call_function_tail(PyObject *callable, PyObject *args)
2196{
2197 PyObject *retval;
2198
2199 if (args == NULL)
2200 return NULL;
2201
2202 if (!PyTuple_Check(args)) {
2203 PyObject *a;
2204
2205 a = PyTuple_New(1);
2206 if (a == NULL) {
2207 Py_DECREF(args);
2208 return NULL;
2209 }
2210 PyTuple_SET_ITEM(a, 0, args);
2211 args = a;
2212 }
2213 retval = PyObject_Call(callable, args, NULL);
2214
2215 Py_DECREF(args);
2216
2217 return retval;
2218}
2219
Tim Peters6d6c1a32001-08-02 04:15:00 +00002220PyObject *
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002221PyObject_CallFunction(PyObject *callable, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002222{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002223 va_list va;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002224 PyObject *args;
Guido van Rossume15dee51995-07-18 14:12:02 +00002225
Fred Drakeb92cf062001-10-27 06:16:31 +00002226 if (callable == NULL)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002227 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002228
Fred Drakeb92cf062001-10-27 06:16:31 +00002229 if (format && *format) {
2230 va_start(va, format);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002231 args = Py_VaBuildValue(format, va);
Fred Drakeb92cf062001-10-27 06:16:31 +00002232 va_end(va);
2233 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002234 else
2235 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002236
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002237 return call_function_tail(callable, args);
2238}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002239
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002240PyObject *
2241_PyObject_CallFunction_SizeT(PyObject *callable, char *format, ...)
2242{
2243 va_list va;
2244 PyObject *args;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002245
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002246 if (callable == NULL)
2247 return null_error();
2248
2249 if (format && *format) {
2250 va_start(va, format);
2251 args = _Py_VaBuildValue_SizeT(format, va);
2252 va_end(va);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002253 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002254 else
2255 args = PyTuple_New(0);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002256
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002257 return call_function_tail(callable, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002258}
2259
2260PyObject *
Guido van Rossume15dee51995-07-18 14:12:02 +00002261PyObject_CallMethod(PyObject *o, char *name, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002262{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002263 va_list va;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002264 PyObject *args;
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002265 PyObject *func = NULL;
2266 PyObject *retval = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002267
Fred Drakeb92cf062001-10-27 06:16:31 +00002268 if (o == NULL || name == NULL)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002269 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002270
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002271 func = PyObject_GetAttrString(o, name);
2272 if (func == NULL) {
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002273 PyErr_SetString(PyExc_AttributeError, name);
2274 return 0;
2275 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002276
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002277 if (!PyCallable_Check(func)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002278 type_error("attribute of type '%.200s' is not callable", func);
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002279 goto exit;
2280 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002281
Fred Drakeb92cf062001-10-27 06:16:31 +00002282 if (format && *format) {
2283 va_start(va, format);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002284 args = Py_VaBuildValue(format, va);
Fred Drakeb92cf062001-10-27 06:16:31 +00002285 va_end(va);
2286 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002287 else
2288 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002289
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002290 retval = call_function_tail(func, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002291
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002292 exit:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002293 /* args gets consumed in call_function_tail */
2294 Py_XDECREF(func);
2295
2296 return retval;
2297}
2298
2299PyObject *
2300_PyObject_CallMethod_SizeT(PyObject *o, char *name, char *format, ...)
2301{
2302 va_list va;
2303 PyObject *args;
2304 PyObject *func = NULL;
2305 PyObject *retval = NULL;
2306
2307 if (o == NULL || name == NULL)
2308 return null_error();
2309
2310 func = PyObject_GetAttrString(o, name);
2311 if (func == NULL) {
2312 PyErr_SetString(PyExc_AttributeError, name);
2313 return 0;
2314 }
2315
2316 if (!PyCallable_Check(func)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002317 type_error("attribute of type '%.200s' is not callable", func);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002318 goto exit;
2319 }
2320
2321 if (format && *format) {
2322 va_start(va, format);
2323 args = _Py_VaBuildValue_SizeT(format, va);
2324 va_end(va);
2325 }
2326 else
2327 args = PyTuple_New(0);
2328
2329 retval = call_function_tail(func, args);
2330
2331 exit:
2332 /* args gets consumed in call_function_tail */
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002333 Py_XDECREF(func);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002334
2335 return retval;
Guido van Rossume15dee51995-07-18 14:12:02 +00002336}
Guido van Rossum823649d2001-03-21 18:40:58 +00002337
2338
Fred Drakeb421b8c2001-10-26 16:21:32 +00002339static PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002340objargs_mktuple(va_list va)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002341{
2342 int i, n = 0;
2343 va_list countva;
2344 PyObject *result, *tmp;
2345
2346#ifdef VA_LIST_IS_ARRAY
2347 memcpy(countva, va, sizeof(va_list));
2348#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002349#ifdef __va_copy
2350 __va_copy(countva, va);
2351#else
Fred Drakeb421b8c2001-10-26 16:21:32 +00002352 countva = va;
2353#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002354#endif
Fred Drakeb421b8c2001-10-26 16:21:32 +00002355
2356 while (((PyObject *)va_arg(countva, PyObject *)) != NULL)
2357 ++n;
2358 result = PyTuple_New(n);
2359 if (result != NULL && n > 0) {
2360 for (i = 0; i < n; ++i) {
2361 tmp = (PyObject *)va_arg(va, PyObject *);
2362 PyTuple_SET_ITEM(result, i, tmp);
2363 Py_INCREF(tmp);
2364 }
2365 }
2366 return result;
2367}
2368
2369PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002370PyObject_CallMethodObjArgs(PyObject *callable, PyObject *name, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002371{
2372 PyObject *args, *tmp;
2373 va_list vargs;
2374
2375 if (callable == NULL || name == NULL)
2376 return null_error();
2377
2378 callable = PyObject_GetAttr(callable, name);
2379 if (callable == NULL)
2380 return NULL;
2381
2382 /* count the args */
2383 va_start(vargs, name);
Fred Drakeb0c079e2001-10-28 02:39:03 +00002384 args = objargs_mktuple(vargs);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002385 va_end(vargs);
2386 if (args == NULL) {
2387 Py_DECREF(callable);
2388 return NULL;
2389 }
2390 tmp = PyObject_Call(callable, args, NULL);
2391 Py_DECREF(args);
2392 Py_DECREF(callable);
2393
2394 return tmp;
2395}
2396
2397PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002398PyObject_CallFunctionObjArgs(PyObject *callable, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002399{
2400 PyObject *args, *tmp;
2401 va_list vargs;
2402
2403 if (callable == NULL)
2404 return null_error();
2405
2406 /* count the args */
2407 va_start(vargs, callable);
Fred Drakeb0c079e2001-10-28 02:39:03 +00002408 args = objargs_mktuple(vargs);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002409 va_end(vargs);
2410 if (args == NULL)
2411 return NULL;
2412 tmp = PyObject_Call(callable, args, NULL);
2413 Py_DECREF(args);
2414
2415 return tmp;
2416}
2417
2418
Guido van Rossum823649d2001-03-21 18:40:58 +00002419/* isinstance(), issubclass() */
2420
Barry Warsawf16951c2002-04-23 22:45:44 +00002421/* abstract_get_bases() has logically 4 return states, with a sort of 0th
2422 * state that will almost never happen.
2423 *
2424 * 0. creating the __bases__ static string could get a MemoryError
2425 * 1. getattr(cls, '__bases__') could raise an AttributeError
2426 * 2. getattr(cls, '__bases__') could raise some other exception
2427 * 3. getattr(cls, '__bases__') could return a tuple
2428 * 4. getattr(cls, '__bases__') could return something other than a tuple
2429 *
2430 * Only state #3 is a non-error state and only it returns a non-NULL object
2431 * (it returns the retrieved tuple).
2432 *
2433 * Any raised AttributeErrors are masked by clearing the exception and
2434 * returning NULL. If an object other than a tuple comes out of __bases__,
2435 * then again, the return value is NULL. So yes, these two situations
2436 * produce exactly the same results: NULL is returned and no error is set.
2437 *
2438 * If some exception other than AttributeError is raised, then NULL is also
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002439 * returned, but the exception is not cleared. That's because we want the
Barry Warsawf16951c2002-04-23 22:45:44 +00002440 * exception to be propagated along.
2441 *
2442 * Callers are expected to test for PyErr_Occurred() when the return value
2443 * is NULL to decide whether a valid exception should be propagated or not.
2444 * When there's no exception to propagate, it's customary for the caller to
2445 * set a TypeError.
2446 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002447static PyObject *
2448abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002449{
2450 static PyObject *__bases__ = NULL;
2451 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002452
2453 if (__bases__ == NULL) {
Christian Heimesfe82e772008-01-28 02:38:20 +00002454 __bases__ = PyUnicode_InternFromString("__bases__");
Guido van Rossum823649d2001-03-21 18:40:58 +00002455 if (__bases__ == NULL)
Neil Schemenauer6b471292001-10-18 03:18:43 +00002456 return NULL;
Guido van Rossum823649d2001-03-21 18:40:58 +00002457 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002458 Py_ALLOW_RECURSION
Neil Schemenauer6b471292001-10-18 03:18:43 +00002459 bases = PyObject_GetAttr(cls, __bases__);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002460 Py_END_ALLOW_RECURSION
Barry Warsawf16951c2002-04-23 22:45:44 +00002461 if (bases == NULL) {
2462 if (PyErr_ExceptionMatches(PyExc_AttributeError))
2463 PyErr_Clear();
Neil Schemenauer6b471292001-10-18 03:18:43 +00002464 return NULL;
Guido van Rossum823649d2001-03-21 18:40:58 +00002465 }
Barry Warsawf16951c2002-04-23 22:45:44 +00002466 if (!PyTuple_Check(bases)) {
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002467 Py_DECREF(bases);
Barry Warsawf16951c2002-04-23 22:45:44 +00002468 return NULL;
2469 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002470 return bases;
2471}
2472
2473
2474static int
2475abstract_issubclass(PyObject *derived, PyObject *cls)
2476{
Antoine Pitrouec569b72008-08-26 22:40:48 +00002477 PyObject *bases = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002478 Py_ssize_t i, n;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002479 int r = 0;
2480
Antoine Pitrouec569b72008-08-26 22:40:48 +00002481 while (1) {
2482 if (derived == cls)
2483 return 1;
2484 bases = abstract_get_bases(derived);
2485 if (bases == NULL) {
2486 if (PyErr_Occurred())
2487 return -1;
2488 return 0;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002489 }
Antoine Pitrouec569b72008-08-26 22:40:48 +00002490 n = PyTuple_GET_SIZE(bases);
2491 if (n == 0) {
2492 Py_DECREF(bases);
2493 return 0;
2494 }
2495 /* Avoid recursivity in the single inheritance case */
2496 if (n == 1) {
2497 derived = PyTuple_GET_ITEM(bases, 0);
2498 Py_DECREF(bases);
2499 continue;
2500 }
2501 for (i = 0; i < n; i++) {
2502 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
2503 if (r != 0)
2504 break;
2505 }
2506 Py_DECREF(bases);
2507 return r;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002508 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002509}
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
Antoine Pitrouec569b72008-08-26 22:40:48 +00002526recursive_isinstance(PyObject *inst, PyObject *cls)
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 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002555 else {
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002556 if (!check_class(cls,
2557 "isinstance() arg 2 must be a class, type,"
2558 " or tuple of classes and types"))
Neil Schemenauer6b471292001-10-18 03:18:43 +00002559 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002560 icls = PyObject_GetAttr(inst, __class__);
Neil Schemenauer6b471292001-10-18 03:18:43 +00002561 if (icls == NULL) {
2562 PyErr_Clear();
2563 retval = 0;
Guido van Rossum823649d2001-03-21 18:40:58 +00002564 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002565 else {
2566 retval = abstract_issubclass(icls, cls);
2567 Py_DECREF(icls);
2568 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002569 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002570
Guido van Rossum823649d2001-03-21 18:40:58 +00002571 return retval;
2572}
2573
2574int
Brett Cannon4f653312004-03-20 22:52:14 +00002575PyObject_IsInstance(PyObject *inst, PyObject *cls)
2576{
Christian Heimesa156e092008-02-16 07:38:31 +00002577 static PyObject *name = NULL;
Guido van Rossume7ba4952007-06-06 23:52:48 +00002578 PyObject *checker;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002579
2580 /* Quick test for an exact match */
2581 if (Py_TYPE(inst) == (PyTypeObject *)cls)
2582 return 1;
2583
Antoine Pitrouec569b72008-08-26 22:40:48 +00002584 if (PyTuple_Check(cls)) {
2585 Py_ssize_t i;
2586 Py_ssize_t n;
2587 int r = 0;
2588
2589 if (Py_EnterRecursiveCall(" in __instancecheck__"))
2590 return -1;
2591 n = PyTuple_GET_SIZE(cls);
2592 for (i = 0; i < n; ++i) {
2593 PyObject *item = PyTuple_GET_ITEM(cls, i);
2594 r = PyObject_IsInstance(inst, item);
2595 if (r != 0)
2596 /* either found it, or got an error */
2597 break;
2598 }
2599 Py_LeaveRecursiveCall();
2600 return r;
2601 }
Christian Heimesa156e092008-02-16 07:38:31 +00002602 if (name == NULL) {
2603 name = PyUnicode_InternFromString("__instancecheck__");
2604 if (name == NULL)
2605 return -1;
2606 }
2607 checker = PyObject_GetAttr(cls, name);
Christian Heimese25f35e2008-03-20 10:49:03 +00002608 if (checker == NULL && PyErr_Occurred())
2609 PyErr_Clear();
Guido van Rossumadee45e2007-05-25 17:55:52 +00002610 if (checker != NULL) {
2611 PyObject *res;
2612 int ok = -1;
Guido van Rossum29478ef2007-05-29 00:39:44 +00002613 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2614 Py_DECREF(checker);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002615 return ok;
Guido van Rossum29478ef2007-05-29 00:39:44 +00002616 }
Guido van Rossumadee45e2007-05-25 17:55:52 +00002617 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
2618 Py_LeaveRecursiveCall();
2619 Py_DECREF(checker);
2620 if (res != NULL) {
2621 ok = PyObject_IsTrue(res);
2622 Py_DECREF(res);
2623 }
2624 return ok;
2625 }
Antoine Pitrouec569b72008-08-26 22:40:48 +00002626 return recursive_isinstance(inst, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002627}
2628
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002629static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002630recursive_issubclass(PyObject *derived, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002631{
Antoine Pitrouec569b72008-08-26 22:40:48 +00002632 if (PyType_Check(cls) && PyType_Check(derived)) {
2633 /* Fast path (non-recursive) */
2634 return PyType_IsSubtype((PyTypeObject *)derived, (PyTypeObject *)cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002635 }
Antoine Pitrouec569b72008-08-26 22:40:48 +00002636 if (!check_class(derived,
2637 "issubclass() arg 1 must be a class"))
2638 return -1;
2639 if (!check_class(cls,
2640 "issubclass() arg 2 must be a class"
2641 " or tuple of classes"))
2642 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002643
Antoine Pitrouec569b72008-08-26 22:40:48 +00002644 return abstract_issubclass(derived, cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002645}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002646
Brett Cannon4f653312004-03-20 22:52:14 +00002647int
2648PyObject_IsSubclass(PyObject *derived, PyObject *cls)
2649{
Christian Heimesa156e092008-02-16 07:38:31 +00002650 static PyObject *name = NULL;
Guido van Rossumadee45e2007-05-25 17:55:52 +00002651 PyObject *t, *v, *tb;
Guido van Rossume7ba4952007-06-06 23:52:48 +00002652 PyObject *checker;
Christian Heimesa156e092008-02-16 07:38:31 +00002653
Antoine Pitrouec569b72008-08-26 22:40:48 +00002654 if (PyTuple_Check(cls)) {
2655 Py_ssize_t i;
2656 Py_ssize_t n;
2657 int r = 0;
2658
2659 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
2660 return -1;
2661 n = PyTuple_GET_SIZE(cls);
2662 for (i = 0; i < n; ++i) {
2663 PyObject *item = PyTuple_GET_ITEM(cls, i);
2664 r = PyObject_IsSubclass(derived, item);
2665 if (r != 0)
2666 /* either found it, or got an error */
2667 break;
2668 }
2669 Py_LeaveRecursiveCall();
2670 return r;
2671 }
Christian Heimesa156e092008-02-16 07:38:31 +00002672 if (name == NULL) {
2673 name = PyUnicode_InternFromString("__subclasscheck__");
2674 if (name == NULL)
2675 return -1;
2676 }
Antoine Pitrouec569b72008-08-26 22:40:48 +00002677 PyErr_Fetch(&t, &v, &tb);
Christian Heimesa156e092008-02-16 07:38:31 +00002678 checker = PyObject_GetAttr(cls, name);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002679 PyErr_Restore(t, v, tb);
2680 if (checker != NULL) {
2681 PyObject *res;
2682 int ok = -1;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002683 if (Py_EnterRecursiveCall(" in __subclasscheck__")) {
2684 Py_DECREF(checker);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002685 return ok;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002686 }
Guido van Rossumadee45e2007-05-25 17:55:52 +00002687 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
2688 Py_LeaveRecursiveCall();
2689 Py_DECREF(checker);
2690 if (res != NULL) {
2691 ok = PyObject_IsTrue(res);
2692 Py_DECREF(res);
2693 }
2694 return ok;
2695 }
Antoine Pitrouec569b72008-08-26 22:40:48 +00002696 return recursive_issubclass(derived, cls);
2697}
2698
2699int
2700_PyObject_RealIsInstance(PyObject *inst, PyObject *cls)
2701{
2702 return recursive_isinstance(inst, cls);
2703}
2704
2705int
2706_PyObject_RealIsSubclass(PyObject *derived, PyObject *cls)
2707{
2708 return recursive_issubclass(derived, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002709}
2710
2711
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002712PyObject *
2713PyObject_GetIter(PyObject *o)
2714{
2715 PyTypeObject *t = o->ob_type;
2716 getiterfunc f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002717 f = t->tp_iter;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002718 if (f == NULL) {
2719 if (PySequence_Check(o))
Guido van Rossum213c7a62001-04-23 14:08:49 +00002720 return PySeqIter_New(o);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002721 return type_error("'%.200s' object is not iterable", o);
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002722 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00002723 else {
2724 PyObject *res = (*f)(o);
2725 if (res != NULL && !PyIter_Check(res)) {
2726 PyErr_Format(PyExc_TypeError,
2727 "iter() returned non-iterator "
2728 "of type '%.100s'",
2729 res->ob_type->tp_name);
2730 Py_DECREF(res);
2731 res = NULL;
2732 }
2733 return res;
2734 }
2735}
2736
Tim Petersf4848da2001-05-05 00:14:56 +00002737/* Return next item.
2738 * If an error occurs, return NULL. PyErr_Occurred() will be true.
2739 * If the iteration terminates normally, return NULL and clear the
2740 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
2741 * will be false.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002742 * Else return the next object. PyErr_Occurred() will be false.
Tim Petersf4848da2001-05-05 00:14:56 +00002743 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002744PyObject *
2745PyIter_Next(PyObject *iter)
2746{
Tim Petersf4848da2001-05-05 00:14:56 +00002747 PyObject *result;
Raymond Hettinger8049dde2003-03-01 01:44:32 +00002748 assert(PyIter_Check(iter));
Tim Petersf4848da2001-05-05 00:14:56 +00002749 result = (*iter->ob_type->tp_iternext)(iter);
2750 if (result == NULL &&
2751 PyErr_Occurred() &&
2752 PyErr_ExceptionMatches(PyExc_StopIteration))
2753 PyErr_Clear();
2754 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002755}