blob: 52c90259e86f3e734992371cc7fb12cdbfbacd21 [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
Guido van Rossume15dee51995-07-18 14:12:02 +000030PyObject *
Fred Drake79912472000-07-09 04:06:11 +000031PyObject_Type(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +000032{
33 PyObject *v;
34
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000035 if (o == NULL)
36 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +000037 v = (PyObject *)o->ob_type;
38 Py_INCREF(v);
39 return v;
40}
41
Martin v. Löwis18e16552006-02-15 17:27:45 +000042Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +000043PyObject_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +000044{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000045 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +000046
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000047 if (o == NULL) {
48 null_error();
49 return -1;
50 }
Guido van Rossume15dee51995-07-18 14:12:02 +000051
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000052 m = o->ob_type->tp_as_sequence;
53 if (m && m->sq_length)
54 return m->sq_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +000055
Jeremy Hylton6253f832000-07-12 12:56:19 +000056 return PyMapping_Size(o);
Guido van Rossume15dee51995-07-18 14:12:02 +000057}
58
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000059#undef PyObject_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +000060Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000061PyObject_Length(PyObject *o)
62{
63 return PyObject_Size(o);
64}
65#define PyObject_Length PyObject_Size
66
Raymond Hettinger6b27cda2005-09-24 21:23:05 +000067
Christian Heimes255f53b2007-12-08 15:33:56 +000068/* The length hint function returns a non-negative value from o.__len__()
69 or o.__length_hint__(). If those methods aren't found or return a negative
Raymond Hettingere8364232009-02-02 22:55:09 +000070 value, then the defaultvalue is returned. If one of the calls fails,
71 this function returns -1.
Christian Heimes255f53b2007-12-08 15:33:56 +000072*/
73
74Py_ssize_t
75_PyObject_LengthHint(PyObject *o, Py_ssize_t defaultvalue)
76{
77 static PyObject *hintstrobj = NULL;
Benjamin Petersona5758c02009-05-09 18:15:04 +000078 PyObject *ro, *hintmeth;
Christian Heimes255f53b2007-12-08 15:33:56 +000079 Py_ssize_t rv;
80
81 /* try o.__len__() */
82 rv = PyObject_Size(o);
83 if (rv >= 0)
84 return rv;
Raymond Hettingere8364232009-02-02 22:55:09 +000085 if (PyErr_Occurred()) {
86 if (!PyErr_ExceptionMatches(PyExc_TypeError) &&
87 !PyErr_ExceptionMatches(PyExc_AttributeError))
88 return -1;
Christian Heimes255f53b2007-12-08 15:33:56 +000089 PyErr_Clear();
Raymond Hettingere8364232009-02-02 22:55:09 +000090 }
Christian Heimes255f53b2007-12-08 15:33:56 +000091
Christian Heimes255f53b2007-12-08 15:33:56 +000092 /* try o.__length_hint__() */
Benjamin Petersona5758c02009-05-09 18:15:04 +000093 hintmeth = _PyObject_LookupSpecial(o, "__length_hint__", &hintstrobj);
94 if (hintmeth == NULL)
95 return defaultvalue;
96 ro = PyObject_CallFunctionObjArgs(hintmeth, NULL);
97 Py_DECREF(hintmeth);
Raymond Hettingere8364232009-02-02 22:55:09 +000098 if (ro == NULL) {
Benjamin Petersona5758c02009-05-09 18:15:04 +000099 if (!PyErr_ExceptionMatches(PyExc_TypeError))
100 return -1;
Benjamin Petersone18df232009-05-09 19:24:36 +0000101 PyErr_Clear();
Raymond Hettingere8364232009-02-02 22:55:09 +0000102 return defaultvalue;
103 }
Raymond Hettinger5d654122009-02-03 02:12:10 +0000104 rv = PyLong_Check(ro) ? PyLong_AsSsize_t(ro) : defaultvalue;
Christian Heimes255f53b2007-12-08 15:33:56 +0000105 Py_DECREF(ro);
Raymond Hettingere8364232009-02-02 22:55:09 +0000106 return rv;
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000107}
108
Guido van Rossume15dee51995-07-18 14:12:02 +0000109PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000110PyObject_GetItem(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +0000111{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000112 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000113
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000114 if (o == NULL || key == NULL)
115 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +0000116
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000117 m = o->ob_type->tp_as_mapping;
118 if (m && m->mp_subscript)
119 return m->mp_subscript(o, key);
Guido van Rossume15dee51995-07-18 14:12:02 +0000120
Guido van Rossum21308241998-08-13 16:44:44 +0000121 if (o->ob_type->tp_as_sequence) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000122 if (PyIndex_Check(key)) {
123 Py_ssize_t key_value;
124 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
Andrew M. Kuchling0f223d22000-02-23 22:21:50 +0000125 if (key_value == -1 && PyErr_Occurred())
126 return NULL;
127 return PySequence_GetItem(o, key_value);
128 }
Guido van Rossum64585f62001-11-24 18:24:47 +0000129 else if (o->ob_type->tp_as_sequence->sq_item)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000130 return type_error("sequence index must "
131 "be integer, not '%.200s'", key);
Guido van Rossum21308241998-08-13 16:44:44 +0000132 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000133
Georg Brandl0192bff2009-04-27 16:49:41 +0000134 return type_error("'%.200s' object is not subscriptable", o);
Guido van Rossume15dee51995-07-18 14:12:02 +0000135}
136
137int
Fred Drake79912472000-07-09 04:06:11 +0000138PyObject_SetItem(PyObject *o, PyObject *key, PyObject *value)
Guido van Rossume15dee51995-07-18 14:12:02 +0000139{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000140 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000141
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000142 if (o == NULL || key == NULL || value == NULL) {
143 null_error();
144 return -1;
145 }
146 m = o->ob_type->tp_as_mapping;
147 if (m && m->mp_ass_subscript)
148 return m->mp_ass_subscript(o, key, value);
Guido van Rossume15dee51995-07-18 14:12:02 +0000149
Guido van Rossum21308241998-08-13 16:44:44 +0000150 if (o->ob_type->tp_as_sequence) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000151 if (PyIndex_Check(key)) {
152 Py_ssize_t key_value;
153 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
Andrew M. Kuchling0f223d22000-02-23 22:21:50 +0000154 if (key_value == -1 && PyErr_Occurred())
155 return -1;
156 return PySequence_SetItem(o, key_value, value);
157 }
Guido van Rossum64585f62001-11-24 18:24:47 +0000158 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000159 type_error("sequence index must be "
160 "integer, not '%.200s'", key);
Guido van Rossum64585f62001-11-24 18:24:47 +0000161 return -1;
162 }
Guido van Rossum21308241998-08-13 16:44:44 +0000163 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000164
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000165 type_error("'%.200s' object does not support item assignment", o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000166 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +0000167}
168
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000169int
Fred Drake79912472000-07-09 04:06:11 +0000170PyObject_DelItem(PyObject *o, PyObject *key)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000171{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000172 PyMappingMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000173
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000174 if (o == NULL || key == NULL) {
175 null_error();
176 return -1;
177 }
178 m = o->ob_type->tp_as_mapping;
179 if (m && m->mp_ass_subscript)
180 return m->mp_ass_subscript(o, key, (PyObject*)NULL);
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000181
Guido van Rossum21308241998-08-13 16:44:44 +0000182 if (o->ob_type->tp_as_sequence) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000183 if (PyIndex_Check(key)) {
184 Py_ssize_t key_value;
185 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
Andrew M. Kuchling0f223d22000-02-23 22:21:50 +0000186 if (key_value == -1 && PyErr_Occurred())
187 return -1;
188 return PySequence_DelItem(o, key_value);
189 }
Guido van Rossum64585f62001-11-24 18:24:47 +0000190 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000191 type_error("sequence index must be "
192 "integer, not '%.200s'", key);
Guido van Rossum64585f62001-11-24 18:24:47 +0000193 return -1;
194 }
Guido van Rossum21308241998-08-13 16:44:44 +0000195 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000196
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000197 type_error("'%.200s' object does not support item deletion", o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000198 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000199}
200
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000201int
202PyObject_DelItemString(PyObject *o, char *key)
203{
204 PyObject *okey;
205 int ret;
206
207 if (o == NULL || key == NULL) {
208 null_error();
209 return -1;
210 }
Martin v. Löwis5b222132007-06-10 09:51:05 +0000211 okey = PyUnicode_FromString(key);
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000212 if (okey == NULL)
213 return -1;
214 ret = PyObject_DelItem(o, okey);
215 Py_DECREF(okey);
216 return ret;
217}
218
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000219/* We release the buffer right after use of this function which could
Guido van Rossum98297ee2007-11-06 21:34:58 +0000220 cause issues later on. Don't use these functions in new code.
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000221 */
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000222int
223PyObject_AsCharBuffer(PyObject *obj,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000224 const char **buffer,
225 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000226{
227 PyBufferProcs *pb;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000228 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000229
230 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
231 null_error();
232 return -1;
233 }
234 pb = obj->ob_type->tp_as_buffer;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000235 if (pb == NULL || pb->bf_getbuffer == NULL) {
Guido van Rossum4c08d552000-03-10 22:55:18 +0000236 PyErr_SetString(PyExc_TypeError,
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000237 "expected an object with the buffer interface");
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000238 return -1;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000239 }
Travis E. Oliphantddacf962007-10-13 21:03:27 +0000240 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE)) return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000241
242 *buffer = view.buf;
243 *buffer_len = view.len;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000244 if (pb->bf_releasebuffer != NULL)
245 (*pb->bf_releasebuffer)(obj, &view);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +0000246 Py_XDECREF(view.obj);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000247 return 0;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000248}
Guido van Rossum4c08d552000-03-10 22:55:18 +0000249
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000250int
251PyObject_CheckReadBuffer(PyObject *obj)
252{
Guido van Rossum98297ee2007-11-06 21:34:58 +0000253 PyBufferProcs *pb = obj->ob_type->tp_as_buffer;
Benjamin Peterson60320cb2008-09-26 21:49:22 +0000254 Py_buffer view;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000255
256 if (pb == NULL ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000257 pb->bf_getbuffer == NULL)
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000258 return 0;
Benjamin Peterson60320cb2008-09-26 21:49:22 +0000259 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE) == -1) {
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000260 PyErr_Clear();
261 return 0;
262 }
Benjamin Peterson60320cb2008-09-26 21:49:22 +0000263 PyBuffer_Release(&view);
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000264 return 1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000265}
266
267int PyObject_AsReadBuffer(PyObject *obj,
268 const void **buffer,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000269 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000270{
271 PyBufferProcs *pb;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000272 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000273
274 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
275 null_error();
276 return -1;
277 }
278 pb = obj->ob_type->tp_as_buffer;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000279 if (pb == NULL ||
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000280 pb->bf_getbuffer == NULL) {
Guido van Rossum4c08d552000-03-10 22:55:18 +0000281 PyErr_SetString(PyExc_TypeError,
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000282 "expected an object with a buffer interface");
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000283 return -1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000284 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000285
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000286 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE)) return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000287
288 *buffer = view.buf;
289 *buffer_len = view.len;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000290 if (pb->bf_releasebuffer != NULL)
291 (*pb->bf_releasebuffer)(obj, &view);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +0000292 Py_XDECREF(view.obj);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000293 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000294}
295
296int PyObject_AsWriteBuffer(PyObject *obj,
297 void **buffer,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000298 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000299{
300 PyBufferProcs *pb;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000301 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000302
303 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
304 null_error();
305 return -1;
306 }
307 pb = obj->ob_type->tp_as_buffer;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000308 if (pb == NULL ||
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000309 pb->bf_getbuffer == NULL ||
310 ((*pb->bf_getbuffer)(obj, &view, PyBUF_WRITABLE) != 0)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000311 PyErr_SetString(PyExc_TypeError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000312 "expected an object with a writable buffer interface");
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000313 return -1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000314 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000315
316 *buffer = view.buf;
317 *buffer_len = view.len;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000318 if (pb->bf_releasebuffer != NULL)
319 (*pb->bf_releasebuffer)(obj, &view);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +0000320 Py_XDECREF(view.obj);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000321 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000322}
323
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000324/* Buffer C-API for Python 3.0 */
325
326int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000327PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000328{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000329 if (!PyObject_CheckBuffer(obj)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000330 PyErr_Format(PyExc_TypeError,
331 "'%100s' does not have the buffer interface",
Christian Heimes90aa7642007-12-19 02:45:37 +0000332 Py_TYPE(obj)->tp_name);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000333 return -1;
334 }
335 return (*(obj->ob_type->tp_as_buffer->bf_getbuffer))(obj, view, flags);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000336}
337
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000338static int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000339_IsFortranContiguous(Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000340{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000341 Py_ssize_t sd, dim;
342 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000343
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000344 if (view->ndim == 0) return 1;
345 if (view->strides == NULL) return (view->ndim == 1);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000346
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000347 sd = view->itemsize;
348 if (view->ndim == 1) return (view->shape[0] == 1 ||
349 sd == view->strides[0]);
350 for (i=0; i<view->ndim; i++) {
351 dim = view->shape[i];
352 if (dim == 0) return 1;
353 if (view->strides[i] != sd) return 0;
354 sd *= dim;
355 }
356 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000357}
358
359static int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000360_IsCContiguous(Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000361{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000362 Py_ssize_t sd, dim;
363 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000364
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000365 if (view->ndim == 0) return 1;
366 if (view->strides == NULL) return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000367
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000368 sd = view->itemsize;
369 if (view->ndim == 1) return (view->shape[0] == 1 ||
370 sd == view->strides[0]);
371 for (i=view->ndim-1; i>=0; i--) {
372 dim = view->shape[i];
373 if (dim == 0) return 1;
374 if (view->strides[i] != sd) return 0;
375 sd *= dim;
376 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000377 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000378}
379
380int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000381PyBuffer_IsContiguous(Py_buffer *view, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000382{
383
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000384 if (view->suboffsets != NULL) return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000385
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000386 if (fort == 'C')
387 return _IsCContiguous(view);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000388 else if (fort == 'F')
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000389 return _IsFortranContiguous(view);
390 else if (fort == 'A')
391 return (_IsCContiguous(view) || _IsFortranContiguous(view));
392 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000393}
394
395
Guido van Rossum98297ee2007-11-06 21:34:58 +0000396void*
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000397PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000398{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000399 char* pointer;
400 int i;
401 pointer = (char *)view->buf;
402 for (i = 0; i < view->ndim; i++) {
403 pointer += view->strides[i]*indices[i];
404 if ((view->suboffsets != NULL) && (view->suboffsets[i] >= 0)) {
405 pointer = *((char**)pointer) + view->suboffsets[i];
406 }
407 }
408 return (void*)pointer;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000409}
410
411
Guido van Rossum98297ee2007-11-06 21:34:58 +0000412void
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000413_add_one_to_index_F(int nd, Py_ssize_t *index, Py_ssize_t *shape)
414{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000415 int k;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000416
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000417 for (k=0; k<nd; k++) {
418 if (index[k] < shape[k]-1) {
419 index[k]++;
420 break;
421 }
422 else {
423 index[k] = 0;
424 }
425 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000426}
427
Guido van Rossum98297ee2007-11-06 21:34:58 +0000428void
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000429_add_one_to_index_C(int nd, Py_ssize_t *index, Py_ssize_t *shape)
430{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000431 int k;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000432
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000433 for (k=nd-1; k>=0; k--) {
434 if (index[k] < shape[k]-1) {
435 index[k]++;
436 break;
437 }
438 else {
439 index[k] = 0;
440 }
441 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000442}
443
444 /* view is not checked for consistency in either of these. It is
Guido van Rossum98297ee2007-11-06 21:34:58 +0000445 assumed that the size of the buffer is view->len in
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000446 view->len / view->itemsize elements.
447 */
448
Guido van Rossum98297ee2007-11-06 21:34:58 +0000449int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000450PyBuffer_ToContiguous(void *buf, Py_buffer *view, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000451{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000452 int k;
453 void (*addone)(int, Py_ssize_t *, Py_ssize_t *);
454 Py_ssize_t *indices, elements;
455 char *dest, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000456
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000457 if (len > view->len) {
458 len = view->len;
459 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000460
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000461 if (PyBuffer_IsContiguous(view, fort)) {
462 /* simplest copy is all that is needed */
463 memcpy(buf, view->buf, len);
464 return 0;
465 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000466
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000467 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000468
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000469 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000470 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
471 if (indices == NULL) {
472 PyErr_NoMemory();
473 return -1;
474 }
475 for (k=0; k<view->ndim;k++) {
476 indices[k] = 0;
477 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000478
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000479 if (fort == 'F') {
480 addone = _add_one_to_index_F;
481 }
482 else {
483 addone = _add_one_to_index_C;
484 }
485 dest = buf;
486 /* XXX : This is not going to be the fastest code in the world
Guido van Rossum98297ee2007-11-06 21:34:58 +0000487 several optimizations are possible.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000488 */
489 elements = len / view->itemsize;
490 while (elements--) {
491 addone(view->ndim, indices, view->shape);
492 ptr = PyBuffer_GetPointer(view, indices);
493 memcpy(dest, ptr, view->itemsize);
494 dest += view->itemsize;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000495 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000496 PyMem_Free(indices);
497 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000498}
499
500int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000501PyBuffer_FromContiguous(Py_buffer *view, void *buf, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000502{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000503 int k;
504 void (*addone)(int, Py_ssize_t *, Py_ssize_t *);
505 Py_ssize_t *indices, elements;
506 char *src, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000507
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000508 if (len > view->len) {
509 len = view->len;
510 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000511
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000512 if (PyBuffer_IsContiguous(view, fort)) {
513 /* simplest copy is all that is needed */
514 memcpy(view->buf, buf, len);
515 return 0;
516 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000517
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000518 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000519
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000520 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000521 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
522 if (indices == NULL) {
523 PyErr_NoMemory();
524 return -1;
525 }
526 for (k=0; k<view->ndim;k++) {
527 indices[k] = 0;
528 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000529
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000530 if (fort == 'F') {
531 addone = _add_one_to_index_F;
532 }
533 else {
534 addone = _add_one_to_index_C;
535 }
536 src = buf;
537 /* XXX : This is not going to be the fastest code in the world
Guido van Rossum98297ee2007-11-06 21:34:58 +0000538 several optimizations are possible.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000539 */
540 elements = len / view->itemsize;
541 while (elements--) {
542 addone(view->ndim, indices, view->shape);
543 ptr = PyBuffer_GetPointer(view, indices);
544 memcpy(ptr, src, view->itemsize);
545 src += view->itemsize;
546 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000547
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000548 PyMem_Free(indices);
549 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000550}
551
Guido van Rossum98297ee2007-11-06 21:34:58 +0000552int PyObject_CopyData(PyObject *dest, PyObject *src)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000553{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000554 Py_buffer view_dest, view_src;
555 int k;
556 Py_ssize_t *indices, elements;
557 char *dptr, *sptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000558
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000559 if (!PyObject_CheckBuffer(dest) ||
560 !PyObject_CheckBuffer(src)) {
561 PyErr_SetString(PyExc_TypeError,
562 "both destination and source must have the "\
563 "buffer interface");
564 return -1;
565 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000566
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000567 if (PyObject_GetBuffer(dest, &view_dest, PyBUF_FULL) != 0) return -1;
568 if (PyObject_GetBuffer(src, &view_src, PyBUF_FULL_RO) != 0) {
Martin v. Löwis423be952008-08-13 15:53:07 +0000569 PyBuffer_Release(&view_dest);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000570 return -1;
571 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000572
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000573 if (view_dest.len < view_src.len) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000574 PyErr_SetString(PyExc_BufferError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000575 "destination is too small to receive data from source");
Martin v. Löwis423be952008-08-13 15:53:07 +0000576 PyBuffer_Release(&view_dest);
577 PyBuffer_Release(&view_src);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000578 return -1;
579 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000580
Guido van Rossum98297ee2007-11-06 21:34:58 +0000581 if ((PyBuffer_IsContiguous(&view_dest, 'C') &&
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000582 PyBuffer_IsContiguous(&view_src, 'C')) ||
Guido van Rossum98297ee2007-11-06 21:34:58 +0000583 (PyBuffer_IsContiguous(&view_dest, 'F') &&
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000584 PyBuffer_IsContiguous(&view_src, 'F'))) {
585 /* simplest copy is all that is needed */
586 memcpy(view_dest.buf, view_src.buf, view_src.len);
Martin v. Löwis423be952008-08-13 15:53:07 +0000587 PyBuffer_Release(&view_dest);
588 PyBuffer_Release(&view_src);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000589 return 0;
590 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000591
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000592 /* Otherwise a more elaborate copy scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000593
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000594 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000595 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*view_src.ndim);
596 if (indices == NULL) {
597 PyErr_NoMemory();
Martin v. Löwis423be952008-08-13 15:53:07 +0000598 PyBuffer_Release(&view_dest);
599 PyBuffer_Release(&view_src);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000600 return -1;
601 }
602 for (k=0; k<view_src.ndim;k++) {
603 indices[k] = 0;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000604 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000605 elements = 1;
606 for (k=0; k<view_src.ndim; k++) {
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000607 /* XXX(nnorwitz): can this overflow? */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000608 elements *= view_src.shape[k];
609 }
610 while (elements--) {
611 _add_one_to_index_C(view_src.ndim, indices, view_src.shape);
612 dptr = PyBuffer_GetPointer(&view_dest, indices);
613 sptr = PyBuffer_GetPointer(&view_src, indices);
614 memcpy(dptr, sptr, view_src.itemsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000615 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000616 PyMem_Free(indices);
Martin v. Löwis423be952008-08-13 15:53:07 +0000617 PyBuffer_Release(&view_dest);
618 PyBuffer_Release(&view_src);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000619 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000620}
621
622void
623PyBuffer_FillContiguousStrides(int nd, Py_ssize_t *shape,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000624 Py_ssize_t *strides, int itemsize,
625 char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000626{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000627 int k;
628 Py_ssize_t sd;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000629
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000630 sd = itemsize;
631 if (fort == 'F') {
632 for (k=0; k<nd; k++) {
633 strides[k] = sd;
634 sd *= shape[k];
Guido van Rossum98297ee2007-11-06 21:34:58 +0000635 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000636 }
637 else {
638 for (k=nd-1; k>=0; k--) {
639 strides[k] = sd;
640 sd *= shape[k];
641 }
642 }
643 return;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000644}
645
646int
Martin v. Löwis423be952008-08-13 15:53:07 +0000647PyBuffer_FillInfo(Py_buffer *view, PyObject *obj, void *buf, Py_ssize_t len,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000648 int readonly, int flags)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000649{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000650 if (view == NULL) return 0;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000651 if (((flags & PyBUF_WRITABLE) == PyBUF_WRITABLE) &&
652 (readonly == 1)) {
653 PyErr_SetString(PyExc_BufferError,
654 "Object is not writable.");
655 return -1;
656 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000657
Martin v. Löwis423be952008-08-13 15:53:07 +0000658 view->obj = obj;
Martin v. Löwis74bbea72008-08-14 20:32:30 +0000659 if (obj)
660 Py_INCREF(obj);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000661 view->buf = buf;
662 view->len = len;
663 view->readonly = readonly;
664 view->itemsize = 1;
665 view->format = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000666 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT)
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000667 view->format = "B";
668 view->ndim = 1;
669 view->shape = NULL;
670 if ((flags & PyBUF_ND) == PyBUF_ND)
671 view->shape = &(view->len);
672 view->strides = NULL;
673 if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES)
674 view->strides = &(view->itemsize);
675 view->suboffsets = NULL;
676 view->internal = NULL;
677 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000678}
679
Martin v. Löwis423be952008-08-13 15:53:07 +0000680void
681PyBuffer_Release(Py_buffer *view)
682{
683 PyObject *obj = view->obj;
Martin v. Löwis74bbea72008-08-14 20:32:30 +0000684 if (obj && Py_TYPE(obj)->tp_as_buffer && Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer)
685 Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer(obj, view);
686 Py_XDECREF(obj);
687 view->obj = NULL;
Martin v. Löwis423be952008-08-13 15:53:07 +0000688}
689
Eric Smith8fd3eba2008-02-17 19:48:00 +0000690PyObject *
691PyObject_Format(PyObject *obj, PyObject *format_spec)
692{
693 static PyObject * str__format__ = NULL;
694 PyObject *meth;
695 PyObject *empty = NULL;
696 PyObject *result = NULL;
697
698 /* Initialize cached value */
699 if (str__format__ == NULL) {
700 /* Initialize static variable needed by _PyType_Lookup */
701 str__format__ = PyUnicode_FromString("__format__");
702 if (str__format__ == NULL)
703 goto done;
704 }
705
706 /* If no format_spec is provided, use an empty string */
707 if (format_spec == NULL) {
708 empty = PyUnicode_FromUnicode(NULL, 0);
709 format_spec = empty;
710 }
711
712 /* Make sure the type is initialized. float gets initialized late */
713 if (Py_TYPE(obj)->tp_dict == NULL)
714 if (PyType_Ready(Py_TYPE(obj)) < 0)
715 goto done;
716
717 /* Find the (unbound!) __format__ method (a borrowed reference) */
718 meth = _PyType_Lookup(Py_TYPE(obj), str__format__);
719 if (meth == NULL) {
720 PyErr_Format(PyExc_TypeError,
721 "Type %.100s doesn't define __format__",
722 Py_TYPE(obj)->tp_name);
723 goto done;
724 }
725
726 /* And call it, binding it to the value */
727 result = PyObject_CallFunctionObjArgs(meth, obj, format_spec, NULL);
728
729 if (result && !PyUnicode_Check(result)) {
730 PyErr_SetString(PyExc_TypeError,
731 "__format__ method did not return string");
732 Py_DECREF(result);
733 result = NULL;
734 goto done;
735 }
736
737done:
738 Py_XDECREF(empty);
739 return result;
740}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000741/* Operations on numbers */
742
743int
Fred Drake79912472000-07-09 04:06:11 +0000744PyNumber_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +0000745{
Guido van Rossum6921eca2003-02-18 16:36:28 +0000746 return o && o->ob_type->tp_as_number &&
747 (o->ob_type->tp_as_number->nb_int ||
748 o->ob_type->tp_as_number->nb_float);
Guido van Rossume15dee51995-07-18 14:12:02 +0000749}
750
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000751/* Binary operators */
Guido van Rossume15dee51995-07-18 14:12:02 +0000752
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000753#define NB_SLOT(x) offsetof(PyNumberMethods, x)
754#define NB_BINOP(nb_methods, slot) \
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000755 (*(binaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000756#define NB_TERNOP(nb_methods, slot) \
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000757 (*(ternaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000758
759/*
760 Calling scheme used for binary operations:
761
Neal Norwitz4886cc32006-08-21 17:06:07 +0000762 Order operations are tried until either a valid result or error:
763 w.op(v,w)[*], v.op(v,w), w.op(v,w)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000764
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000765 [*] only when v->ob_type != w->ob_type && w->ob_type is a subclass of
766 v->ob_type
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000767 */
768
769static PyObject *
770binary_op1(PyObject *v, PyObject *w, const int op_slot)
Guido van Rossume15dee51995-07-18 14:12:02 +0000771{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000772 PyObject *x;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000773 binaryfunc slotv = NULL;
774 binaryfunc slotw = NULL;
775
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000776 if (v->ob_type->tp_as_number != NULL)
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000777 slotv = NB_BINOP(v->ob_type->tp_as_number, op_slot);
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000778 if (w->ob_type != v->ob_type &&
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000779 w->ob_type->tp_as_number != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000780 slotw = NB_BINOP(w->ob_type->tp_as_number, op_slot);
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000781 if (slotw == slotv)
782 slotw = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000783 }
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000784 if (slotv) {
Guido van Rossum89c42642001-10-01 17:10:18 +0000785 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
786 x = slotw(v, w);
787 if (x != Py_NotImplemented)
788 return x;
789 Py_DECREF(x); /* can't do it */
790 slotw = NULL;
791 }
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000792 x = slotv(v, w);
793 if (x != Py_NotImplemented)
794 return x;
795 Py_DECREF(x); /* can't do it */
796 }
797 if (slotw) {
798 x = slotw(v, w);
799 if (x != Py_NotImplemented)
800 return x;
801 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000802 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000803 Py_INCREF(Py_NotImplemented);
804 return Py_NotImplemented;
805}
Guido van Rossum77660912002-04-16 16:32:50 +0000806
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000807static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000808binop_type_error(PyObject *v, PyObject *w, const char *op_name)
809{
810 PyErr_Format(PyExc_TypeError,
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000811 "unsupported operand type(s) for %.100s: "
812 "'%.100s' and '%.100s'",
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000813 op_name,
814 v->ob_type->tp_name,
815 w->ob_type->tp_name);
816 return NULL;
817}
818
819static PyObject *
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000820binary_op(PyObject *v, PyObject *w, const int op_slot, const char *op_name)
821{
822 PyObject *result = binary_op1(v, w, op_slot);
823 if (result == Py_NotImplemented) {
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000824 Py_DECREF(result);
825 return binop_type_error(v, w, op_name);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000826 }
827 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000828}
829
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000830
831/*
832 Calling scheme used for ternary operations:
833
Neal Norwitz4886cc32006-08-21 17:06:07 +0000834 Order operations are tried until either a valid result or error:
835 v.op(v,w,z), w.op(v,w,z), z.op(v,w,z)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000836 */
837
838static PyObject *
839ternary_op(PyObject *v,
840 PyObject *w,
841 PyObject *z,
842 const int op_slot,
843 const char *op_name)
Guido van Rossume15dee51995-07-18 14:12:02 +0000844{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000845 PyNumberMethods *mv, *mw, *mz;
Guido van Rossum84675ac2001-09-29 01:05:03 +0000846 PyObject *x = NULL;
847 ternaryfunc slotv = NULL;
848 ternaryfunc slotw = NULL;
849 ternaryfunc slotz = NULL;
Guido van Rossum77660912002-04-16 16:32:50 +0000850
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000851 mv = v->ob_type->tp_as_number;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000852 mw = w->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000853 if (mv != NULL)
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000854 slotv = NB_TERNOP(mv, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000855 if (w->ob_type != v->ob_type &&
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000856 mw != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000857 slotw = NB_TERNOP(mw, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000858 if (slotw == slotv)
859 slotw = NULL;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000860 }
Guido van Rossum84675ac2001-09-29 01:05:03 +0000861 if (slotv) {
Guido van Rossum89c42642001-10-01 17:10:18 +0000862 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
863 x = slotw(v, w, z);
864 if (x != Py_NotImplemented)
865 return x;
866 Py_DECREF(x); /* can't do it */
867 slotw = NULL;
868 }
Guido van Rossum84675ac2001-09-29 01:05:03 +0000869 x = slotv(v, w, z);
870 if (x != Py_NotImplemented)
871 return x;
872 Py_DECREF(x); /* can't do it */
873 }
874 if (slotw) {
875 x = slotw(v, w, z);
876 if (x != Py_NotImplemented)
877 return x;
878 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000879 }
880 mz = z->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000881 if (mz != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000882 slotz = NB_TERNOP(mz, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000883 if (slotz == slotv || slotz == slotw)
884 slotz = NULL;
885 if (slotz) {
886 x = slotz(v, w, z);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000887 if (x != Py_NotImplemented)
888 return x;
Guido van Rossum84675ac2001-09-29 01:05:03 +0000889 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000890 }
891 }
892
Guido van Rossum5c66a262001-10-22 04:12:44 +0000893 if (z == Py_None)
894 PyErr_Format(
895 PyExc_TypeError,
896 "unsupported operand type(s) for ** or pow(): "
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000897 "'%.100s' and '%.100s'",
Guido van Rossum5c66a262001-10-22 04:12:44 +0000898 v->ob_type->tp_name,
899 w->ob_type->tp_name);
900 else
901 PyErr_Format(
902 PyExc_TypeError,
903 "unsupported operand type(s) for pow(): "
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000904 "'%.100s', '%.100s', '%.100s'",
Guido van Rossum5c66a262001-10-22 04:12:44 +0000905 v->ob_type->tp_name,
906 w->ob_type->tp_name,
907 z->ob_type->tp_name);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000908 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000909}
910
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000911#define BINARY_FUNC(func, op, op_name) \
912 PyObject * \
913 func(PyObject *v, PyObject *w) { \
914 return binary_op(v, w, NB_SLOT(op), op_name); \
915 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000916
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000917BINARY_FUNC(PyNumber_Or, nb_or, "|")
918BINARY_FUNC(PyNumber_Xor, nb_xor, "^")
919BINARY_FUNC(PyNumber_And, nb_and, "&")
920BINARY_FUNC(PyNumber_Lshift, nb_lshift, "<<")
921BINARY_FUNC(PyNumber_Rshift, nb_rshift, ">>")
922BINARY_FUNC(PyNumber_Subtract, nb_subtract, "-")
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000923BINARY_FUNC(PyNumber_Divmod, nb_divmod, "divmod()")
Guido van Rossume15dee51995-07-18 14:12:02 +0000924
925PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000926PyNumber_Add(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000927{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000928 PyObject *result = binary_op1(v, w, NB_SLOT(nb_add));
929 if (result == Py_NotImplemented) {
930 PySequenceMethods *m = v->ob_type->tp_as_sequence;
Armin Rigofd163f92005-12-29 15:59:19 +0000931 Py_DECREF(result);
Jeremy Hylton0522d982002-03-08 21:28:54 +0000932 if (m && m->sq_concat) {
Armin Rigofd163f92005-12-29 15:59:19 +0000933 return (*m->sq_concat)(v, w);
Jeremy Hylton0522d982002-03-08 21:28:54 +0000934 }
Armin Rigofd163f92005-12-29 15:59:19 +0000935 result = binop_type_error(v, w, "+");
Guido van Rossume15dee51995-07-18 14:12:02 +0000936 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000937 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000938}
939
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000940static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000941sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000942{
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000943 Py_ssize_t count;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000944 if (PyIndex_Check(n)) {
945 count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000946 if (count == -1 && PyErr_Occurred())
947 return NULL;
948 }
949 else {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000950 return type_error("can't multiply sequence by "
951 "non-int of type '%.200s'", n);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000952 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000953 return (*repeatfunc)(seq, count);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000954}
955
956PyObject *
957PyNumber_Multiply(PyObject *v, PyObject *w)
958{
959 PyObject *result = binary_op1(v, w, NB_SLOT(nb_multiply));
960 if (result == Py_NotImplemented) {
961 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
962 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
Guido van Rossuma3a243e2002-12-31 19:50:03 +0000963 Py_DECREF(result);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000964 if (mv && mv->sq_repeat) {
965 return sequence_repeat(mv->sq_repeat, v, w);
966 }
967 else if (mw && mw->sq_repeat) {
968 return sequence_repeat(mw->sq_repeat, w, v);
969 }
970 result = binop_type_error(v, w, "*");
971 }
972 return result;
973}
974
Guido van Rossume15dee51995-07-18 14:12:02 +0000975PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +0000976PyNumber_FloorDivide(PyObject *v, PyObject *w)
977{
Guido van Rossum4668b002001-08-08 05:00:18 +0000978 return binary_op(v, w, NB_SLOT(nb_floor_divide), "//");
979}
980
981PyObject *
982PyNumber_TrueDivide(PyObject *v, PyObject *w)
983{
Guido van Rossum4668b002001-08-08 05:00:18 +0000984 return binary_op(v, w, NB_SLOT(nb_true_divide), "/");
985}
986
987PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000988PyNumber_Remainder(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000989{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000990 return binary_op(v, w, NB_SLOT(nb_remainder), "%");
Guido van Rossume15dee51995-07-18 14:12:02 +0000991}
992
993PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000994PyNumber_Power(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossume15dee51995-07-18 14:12:02 +0000995{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000996 return ternary_op(v, w, z, NB_SLOT(nb_power), "** or pow()");
Guido van Rossume15dee51995-07-18 14:12:02 +0000997}
998
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000999/* Binary in-place operators */
1000
1001/* The in-place operators are defined to fall back to the 'normal',
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001002 non in-place operations, if the in-place methods are not in place.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001003
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001004 - If the left hand object has the appropriate struct members, and
1005 they are filled, call the appropriate function and return the
1006 result. No coercion is done on the arguments; the left-hand object
1007 is the one the operation is performed on, and it's up to the
1008 function to deal with the right-hand object.
Guido van Rossum77660912002-04-16 16:32:50 +00001009
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001010 - Otherwise, in-place modification is not supported. Handle it exactly as
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001011 a non in-place operation of the same kind.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001012
1013 */
1014
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001015static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001016binary_iop1(PyObject *v, PyObject *w, const int iop_slot, const int op_slot)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001017{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001018 PyNumberMethods *mv = v->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001019 if (mv != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +00001020 binaryfunc slot = NB_BINOP(mv, iop_slot);
1021 if (slot) {
1022 PyObject *x = (slot)(v, w);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001023 if (x != Py_NotImplemented) {
1024 return x;
1025 }
1026 Py_DECREF(x);
1027 }
Thomas Woutersf2b332d2000-09-02 08:34:40 +00001028 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001029 return binary_op1(v, w, op_slot);
1030}
1031
1032static PyObject *
1033binary_iop(PyObject *v, PyObject *w, const int iop_slot, const int op_slot,
1034 const char *op_name)
1035{
1036 PyObject *result = binary_iop1(v, w, iop_slot, op_slot);
1037 if (result == Py_NotImplemented) {
1038 Py_DECREF(result);
1039 return binop_type_error(v, w, op_name);
1040 }
1041 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001042}
1043
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001044#define INPLACE_BINOP(func, iop, op, op_name) \
1045 PyObject * \
1046 func(PyObject *v, PyObject *w) { \
1047 return binary_iop(v, w, NB_SLOT(iop), NB_SLOT(op), op_name); \
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001048 }
1049
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001050INPLACE_BINOP(PyNumber_InPlaceOr, nb_inplace_or, nb_or, "|=")
1051INPLACE_BINOP(PyNumber_InPlaceXor, nb_inplace_xor, nb_xor, "^=")
1052INPLACE_BINOP(PyNumber_InPlaceAnd, nb_inplace_and, nb_and, "&=")
1053INPLACE_BINOP(PyNumber_InPlaceLshift, nb_inplace_lshift, nb_lshift, "<<=")
1054INPLACE_BINOP(PyNumber_InPlaceRshift, nb_inplace_rshift, nb_rshift, ">>=")
1055INPLACE_BINOP(PyNumber_InPlaceSubtract, nb_inplace_subtract, nb_subtract, "-=")
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001056
1057PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001058PyNumber_InPlaceFloorDivide(PyObject *v, PyObject *w)
1059{
Guido van Rossum4668b002001-08-08 05:00:18 +00001060 return binary_iop(v, w, NB_SLOT(nb_inplace_floor_divide),
1061 NB_SLOT(nb_floor_divide), "//=");
1062}
1063
1064PyObject *
1065PyNumber_InPlaceTrueDivide(PyObject *v, PyObject *w)
1066{
Guido van Rossum4668b002001-08-08 05:00:18 +00001067 return binary_iop(v, w, NB_SLOT(nb_inplace_true_divide),
1068 NB_SLOT(nb_true_divide), "/=");
1069}
1070
1071PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001072PyNumber_InPlaceAdd(PyObject *v, PyObject *w)
1073{
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001074 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_add),
1075 NB_SLOT(nb_add));
1076 if (result == Py_NotImplemented) {
1077 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1078 Py_DECREF(result);
1079 if (m != NULL) {
1080 binaryfunc f = NULL;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001081 f = m->sq_inplace_concat;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001082 if (f == NULL)
1083 f = m->sq_concat;
1084 if (f != NULL)
1085 return (*f)(v, w);
1086 }
1087 result = binop_type_error(v, w, "+=");
Guido van Rossumbb8be932000-09-01 23:27:32 +00001088 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001089 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001090}
1091
1092PyObject *
1093PyNumber_InPlaceMultiply(PyObject *v, PyObject *w)
1094{
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001095 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_multiply),
1096 NB_SLOT(nb_multiply));
1097 if (result == Py_NotImplemented) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001098 ssizeargfunc f = NULL;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001099 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1100 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1101 Py_DECREF(result);
1102 if (mv != NULL) {
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001103 f = mv->sq_inplace_repeat;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001104 if (f == NULL)
1105 f = mv->sq_repeat;
1106 if (f != NULL)
1107 return sequence_repeat(f, v, w);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001108 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001109 else if (mw != NULL) {
1110 /* Note that the right hand operand should not be
1111 * mutated in this case so sq_inplace_repeat is not
1112 * used. */
1113 if (mw->sq_repeat)
1114 return sequence_repeat(mw->sq_repeat, w, v);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001115 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001116 result = binop_type_error(v, w, "*=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001117 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001118 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001119}
1120
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001121PyObject *
1122PyNumber_InPlaceRemainder(PyObject *v, PyObject *w)
1123{
Neil Schemenauerd46fbc32002-11-24 01:07:42 +00001124 return binary_iop(v, w, NB_SLOT(nb_inplace_remainder),
1125 NB_SLOT(nb_remainder), "%=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001126}
1127
1128PyObject *
1129PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
1130{
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001131 if (v->ob_type->tp_as_number &&
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001132 v->ob_type->tp_as_number->nb_inplace_power != NULL) {
1133 return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001134 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001135 else {
1136 return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
1137 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001138}
1139
1140
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001141/* Unary operators and functions */
Guido van Rossume15dee51995-07-18 14:12:02 +00001142
1143PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001144PyNumber_Negative(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001145{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001146 PyNumberMethods *m;
1147
1148 if (o == NULL)
1149 return null_error();
1150 m = o->ob_type->tp_as_number;
1151 if (m && m->nb_negative)
1152 return (*m->nb_negative)(o);
1153
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001154 return type_error("bad operand type for unary -: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001155}
1156
1157PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001158PyNumber_Positive(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_positive)
1166 return (*m->nb_positive)(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_Invert(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_invert)
1180 return (*m->nb_invert)(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_Absolute(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001187{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001188 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001189
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001190 if (o == NULL)
1191 return null_error();
1192 m = o->ob_type->tp_as_number;
1193 if (m && m->nb_absolute)
1194 return m->nb_absolute(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001195
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001196 return type_error("bad operand type for abs(): '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001197}
1198
Guido van Rossum98297ee2007-11-06 21:34:58 +00001199/* Return a Python Int or Long from the object item
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001200 Raise TypeError if the result is not an int-or-long
Guido van Rossum98297ee2007-11-06 21:34:58 +00001201 or if the object cannot be interpreted as an index.
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001202*/
1203PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001204PyNumber_Index(PyObject *item)
1205{
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001206 PyObject *result = NULL;
1207 if (item == NULL)
1208 return null_error();
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001209 if (PyLong_Check(item)) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001210 Py_INCREF(item);
1211 return item;
1212 }
1213 if (PyIndex_Check(item)) {
Trent Nelson71792202008-04-11 23:02:37 +00001214 result = item->ob_type->tp_as_number->nb_index(item);
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001215 if (result && !PyLong_Check(result)) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001216 PyErr_Format(PyExc_TypeError,
Guido van Rossum032a2842007-02-26 05:44:27 +00001217 "__index__ returned non-int "
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001218 "(type %.200s)",
1219 result->ob_type->tp_name);
1220 Py_DECREF(result);
1221 return NULL;
1222 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001223 }
Trent Nelson71792202008-04-11 23:02:37 +00001224 else {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001225 PyErr_Format(PyExc_TypeError,
1226 "'%.200s' object cannot be interpreted "
Guido van Rossum032a2842007-02-26 05:44:27 +00001227 "as an integer", item->ob_type->tp_name);
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001228 }
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001229 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001230}
1231
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001232/* Return an error on Overflow only if err is not NULL*/
1233
1234Py_ssize_t
1235PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1236{
1237 Py_ssize_t result;
1238 PyObject *runerr;
1239 PyObject *value = PyNumber_Index(item);
1240 if (value == NULL)
1241 return -1;
1242
Christian Heimes217cfd12007-12-02 14:31:20 +00001243 /* We're done if PyLong_AsSsize_t() returns without error. */
1244 result = PyLong_AsSsize_t(value);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001245 if (result != -1 || !(runerr = PyErr_Occurred()))
1246 goto finish;
1247
1248 /* Error handling code -- only manage OverflowError differently */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001249 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001250 goto finish;
1251
1252 PyErr_Clear();
Guido van Rossum98297ee2007-11-06 21:34:58 +00001253 /* If no error-handling desired then the default clipping
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001254 is sufficient.
1255 */
1256 if (!err) {
1257 assert(PyLong_Check(value));
Guido van Rossum98297ee2007-11-06 21:34:58 +00001258 /* Whether or not it is less than or equal to
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001259 zero is determined by the sign of ob_size
1260 */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001261 if (_PyLong_Sign(value) < 0)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001262 result = PY_SSIZE_T_MIN;
1263 else
1264 result = PY_SSIZE_T_MAX;
1265 }
1266 else {
1267 /* Otherwise replace the error with caller's error object. */
1268 PyErr_Format(err,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001269 "cannot fit '%.200s' into an index-sized integer",
1270 item->ob_type->tp_name);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001271 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001272
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001273 finish:
1274 Py_DECREF(value);
1275 return result;
1276}
1277
1278
Christian Heimes15ebc882008-02-04 18:48:49 +00001279PyObject *
1280_PyNumber_ConvertIntegralToInt(PyObject *integral, const char* error_format)
1281{
1282 static PyObject *int_name = NULL;
1283 if (int_name == NULL) {
1284 int_name = PyUnicode_InternFromString("__int__");
1285 if (int_name == NULL)
1286 return NULL;
1287 }
1288
1289 if (integral && !PyLong_Check(integral)) {
1290 /* Don't go through tp_as_number->nb_int to avoid
1291 hitting the classic class fallback to __trunc__. */
1292 PyObject *int_func = PyObject_GetAttr(integral, int_name);
1293 if (int_func == NULL) {
1294 PyErr_Clear(); /* Raise a different error. */
1295 goto non_integral_error;
1296 }
1297 Py_DECREF(integral);
1298 integral = PyEval_CallObject(int_func, NULL);
1299 Py_DECREF(int_func);
1300 if (integral && !PyLong_Check(integral)) {
1301 goto non_integral_error;
1302 }
1303 }
1304 return integral;
1305
1306non_integral_error:
1307 PyErr_Format(PyExc_TypeError, error_format, Py_TYPE(integral)->tp_name);
1308 Py_DECREF(integral);
1309 return NULL;
1310}
1311
1312
Guido van Rossum9e896b32000-04-05 20:11:21 +00001313/* Add a check for embedded NULL-bytes in the argument. */
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001314static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001315long_from_string(const char *s, Py_ssize_t len)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001316{
Guido van Rossum4c08d552000-03-10 22:55:18 +00001317 char *end;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001318 PyObject *x;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001319
Guido van Rossum4c08d552000-03-10 22:55:18 +00001320 x = PyLong_FromString((char*)s, &end, 10);
Guido van Rossum9e896b32000-04-05 20:11:21 +00001321 if (x == NULL)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001322 return NULL;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001323 if (end != s + len) {
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001324 PyErr_SetString(PyExc_ValueError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001325 "null byte in argument for int()");
Guido van Rossum9e896b32000-04-05 20:11:21 +00001326 Py_DECREF(x);
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001327 return NULL;
1328 }
1329 return x;
1330}
1331
Guido van Rossume15dee51995-07-18 14:12:02 +00001332PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001333PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001334{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001335 PyNumberMethods *m;
Christian Heimes15ebc882008-02-04 18:48:49 +00001336 static PyObject *trunc_name = NULL;
1337 PyObject *trunc_func;
Guido van Rossum4c08d552000-03-10 22:55:18 +00001338 const char *buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001339 Py_ssize_t buffer_len;
Guido van Rossume15dee51995-07-18 14:12:02 +00001340
Christian Heimes15ebc882008-02-04 18:48:49 +00001341 if (trunc_name == NULL) {
1342 trunc_name = PyUnicode_InternFromString("__trunc__");
1343 if (trunc_name == NULL)
1344 return NULL;
1345 }
1346
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001347 if (o == NULL)
1348 return null_error();
Guido van Rossumddefaf32007-01-14 03:31:43 +00001349 if (PyLong_CheckExact(o)) {
1350 Py_INCREF(o);
1351 return o;
1352 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001353 m = o->ob_type->tp_as_number;
Guido van Rossumddefaf32007-01-14 03:31:43 +00001354 if (m && m->nb_int) { /* This should include subclasses of int */
1355 PyObject *res = m->nb_int(o);
1356 if (res && !PyLong_Check(res)) {
1357 PyErr_Format(PyExc_TypeError,
1358 "__int__ returned non-int (type %.200s)",
1359 res->ob_type->tp_name);
1360 Py_DECREF(res);
1361 return NULL;
1362 }
1363 return res;
1364 }
Mark Dickinsone5e298f2009-01-12 20:49:19 +00001365 if (PyLong_Check(o)) /* An int subclass without nb_int */
Tim Petersdb30ac42002-03-02 04:14:21 +00001366 return _PyLong_Copy((PyLongObject *)o);
Christian Heimes15ebc882008-02-04 18:48:49 +00001367 trunc_func = PyObject_GetAttr(o, trunc_name);
1368 if (trunc_func) {
1369 PyObject *truncated = PyEval_CallObject(trunc_func, NULL);
1370 PyObject *int_instance;
1371 Py_DECREF(trunc_func);
1372 /* __trunc__ is specified to return an Integral type,
1373 but long() needs to return a long. */
1374 int_instance = _PyNumber_ConvertIntegralToInt(
1375 truncated,
1376 "__trunc__ returned non-Integral (type %.200s)");
1377 return int_instance;
1378 }
1379 PyErr_Clear(); /* It's not an error if o.__trunc__ doesn't exist. */
1380
Christian Heimes72b710a2008-05-26 13:28:38 +00001381 if (PyBytes_Check(o))
Christian Heimes15ebc882008-02-04 18:48:49 +00001382 /* need to do extra error checking that PyLong_FromString()
1383 * doesn't do. In particular long('9.5') must raise an
1384 * exception, not truncate the float.
1385 */
Christian Heimes72b710a2008-05-26 13:28:38 +00001386 return long_from_string(PyBytes_AS_STRING(o),
1387 PyBytes_GET_SIZE(o));
Guido van Rossum9e896b32000-04-05 20:11:21 +00001388 if (PyUnicode_Check(o))
1389 /* The above check is done in PyLong_FromUnicode(). */
1390 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(o),
1391 PyUnicode_GET_SIZE(o),
1392 10);
Guido van Rossum4c08d552000-03-10 22:55:18 +00001393 if (!PyObject_AsCharBuffer(o, &buffer, &buffer_len))
1394 return long_from_string(buffer, buffer_len);
Guido van Rossume15dee51995-07-18 14:12:02 +00001395
Guido van Rossumddefaf32007-01-14 03:31:43 +00001396 return type_error("int() argument must be a string or a "
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001397 "number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001398}
1399
1400PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001401PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001402{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001403 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001404
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001405 if (o == NULL)
1406 return null_error();
Brett Cannonc3647ac2005-04-26 03:45:26 +00001407 m = o->ob_type->tp_as_number;
1408 if (m && m->nb_float) { /* This should include subclasses of float */
1409 PyObject *res = m->nb_float(o);
1410 if (res && !PyFloat_Check(res)) {
1411 PyErr_Format(PyExc_TypeError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001412 "__float__ returned non-float (type %.200s)",
1413 res->ob_type->tp_name);
Brett Cannonc3647ac2005-04-26 03:45:26 +00001414 Py_DECREF(res);
1415 return NULL;
1416 }
1417 return res;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001418 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001419 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
Tim Peters7a50f252001-09-10 21:28:20 +00001420 PyFloatObject *po = (PyFloatObject *)o;
1421 return PyFloat_FromDouble(po->ob_fval);
1422 }
Georg Brandl428f0642007-03-18 18:35:15 +00001423 return PyFloat_FromString(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001424}
1425
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001426
1427PyObject *
1428PyNumber_ToBase(PyObject *n, int base)
1429{
Christian Heimesa156e092008-02-16 07:38:31 +00001430 PyObject *res = NULL;
Raymond Hettinger5c960b82008-06-24 22:28:56 +00001431 PyObject *index = PyNumber_Index(n);
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001432
1433 if (!index)
1434 return NULL;
Christian Heimesa156e092008-02-16 07:38:31 +00001435 if (PyLong_Check(index))
1436 res = _PyLong_Format(index, base);
1437 else
1438 /* It should not be possible to get here, as
1439 PyNumber_Index already has a check for the same
1440 condition */
1441 PyErr_SetString(PyExc_ValueError, "PyNumber_ToBase: index not "
1442 "int or long");
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001443 Py_DECREF(index);
1444 return res;
1445}
1446
1447
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001448/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001449
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001450int
Fred Drake79912472000-07-09 04:06:11 +00001451PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001452{
Thomas Wouterscf297e42007-02-23 15:07:44 +00001453 if (PyObject_IsInstance(s, (PyObject *)&PyDict_Type))
1454 return 0;
Guido van Rossum8700b422001-09-07 20:20:11 +00001455 return s != NULL && s->ob_type->tp_as_sequence &&
1456 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001457}
1458
Martin v. Löwis18e16552006-02-15 17:27:45 +00001459Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001460PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001461{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001462 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001463
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001464 if (s == NULL) {
1465 null_error();
1466 return -1;
1467 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001468
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001469 m = s->ob_type->tp_as_sequence;
1470 if (m && m->sq_length)
1471 return m->sq_length(s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001472
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001473 type_error("object of type '%.200s' has no len()", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001474 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001475}
1476
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001477#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001478Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001479PySequence_Length(PyObject *s)
1480{
1481 return PySequence_Size(s);
1482}
1483#define PySequence_Length PySequence_Size
1484
Guido van Rossume15dee51995-07-18 14:12:02 +00001485PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001486PySequence_Concat(PyObject *s, PyObject *o)
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 || o == NULL)
1491 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001492
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001493 m = s->ob_type->tp_as_sequence;
1494 if (m && m->sq_concat)
1495 return m->sq_concat(s, o);
1496
Armin Rigofd163f92005-12-29 15:59:19 +00001497 /* Instances of user classes defining an __add__() method only
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001498 have an nb_add slot, not an sq_concat slot. So we fall back
Armin Rigofd163f92005-12-29 15:59:19 +00001499 to nb_add if both arguments appear to be sequences. */
1500 if (PySequence_Check(s) && PySequence_Check(o)) {
1501 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1502 if (result != Py_NotImplemented)
1503 return result;
1504 Py_DECREF(result);
1505 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001506 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001507}
1508
1509PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001510PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001511{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001512 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001513
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001514 if (o == NULL)
1515 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001516
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001517 m = o->ob_type->tp_as_sequence;
1518 if (m && m->sq_repeat)
1519 return m->sq_repeat(o, count);
1520
Armin Rigofd163f92005-12-29 15:59:19 +00001521 /* Instances of user classes defining a __mul__() method only
1522 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1523 to nb_multiply if o appears to be a sequence. */
1524 if (PySequence_Check(o)) {
1525 PyObject *n, *result;
Christian Heimes217cfd12007-12-02 14:31:20 +00001526 n = PyLong_FromSsize_t(count);
Armin Rigofd163f92005-12-29 15:59:19 +00001527 if (n == NULL)
1528 return NULL;
1529 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1530 Py_DECREF(n);
1531 if (result != Py_NotImplemented)
1532 return result;
1533 Py_DECREF(result);
1534 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001535 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001536}
1537
1538PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001539PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1540{
1541 PySequenceMethods *m;
1542
1543 if (s == NULL || o == NULL)
1544 return null_error();
1545
1546 m = s->ob_type->tp_as_sequence;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001547 if (m && m->sq_inplace_concat)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001548 return m->sq_inplace_concat(s, o);
1549 if (m && m->sq_concat)
1550 return m->sq_concat(s, o);
1551
Armin Rigofd163f92005-12-29 15:59:19 +00001552 if (PySequence_Check(s) && PySequence_Check(o)) {
1553 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1554 NB_SLOT(nb_add));
1555 if (result != Py_NotImplemented)
1556 return result;
1557 Py_DECREF(result);
1558 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001559 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001560}
1561
1562PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001563PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001564{
1565 PySequenceMethods *m;
1566
1567 if (o == NULL)
1568 return null_error();
1569
1570 m = o->ob_type->tp_as_sequence;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001571 if (m && m->sq_inplace_repeat)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001572 return m->sq_inplace_repeat(o, count);
1573 if (m && m->sq_repeat)
1574 return m->sq_repeat(o, count);
1575
Armin Rigofd163f92005-12-29 15:59:19 +00001576 if (PySequence_Check(o)) {
1577 PyObject *n, *result;
Christian Heimes217cfd12007-12-02 14:31:20 +00001578 n = PyLong_FromSsize_t(count);
Armin Rigofd163f92005-12-29 15:59:19 +00001579 if (n == NULL)
1580 return NULL;
1581 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1582 NB_SLOT(nb_multiply));
1583 Py_DECREF(n);
1584 if (result != Py_NotImplemented)
1585 return result;
1586 Py_DECREF(result);
1587 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001588 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001589}
1590
1591PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001592PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001593{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001594 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001595
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001596 if (s == NULL)
1597 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001598
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001599 m = s->ob_type->tp_as_sequence;
1600 if (m && m->sq_item) {
1601 if (i < 0) {
1602 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001603 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001604 if (l < 0)
1605 return NULL;
1606 i += l;
1607 }
1608 }
1609 return m->sq_item(s, i);
1610 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001611
Georg Brandl86b2fb92008-07-16 03:43:04 +00001612 return type_error("'%.200s' object does not support indexing", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001613}
1614
1615PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001616PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00001617{
Thomas Wouters1d75a792000-08-17 22:37:32 +00001618 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001619
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001620 if (!s) return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001621
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001622 mp = s->ob_type->tp_as_mapping;
1623 if (mp->mp_subscript) {
Thomas Wouters1d75a792000-08-17 22:37:32 +00001624 PyObject *res;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001625 PyObject *slice = _PySlice_FromIndices(i1, i2);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001626 if (!slice)
1627 return NULL;
1628 res = mp->mp_subscript(s, slice);
1629 Py_DECREF(slice);
1630 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001631 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001632
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001633 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001634}
1635
1636int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001637PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001638{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001639 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001640
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001641 if (s == NULL) {
1642 null_error();
1643 return -1;
1644 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001645
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001646 m = s->ob_type->tp_as_sequence;
1647 if (m && m->sq_ass_item) {
1648 if (i < 0) {
1649 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001650 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001651 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001652 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001653 i += l;
1654 }
1655 }
1656 return m->sq_ass_item(s, i, o);
1657 }
1658
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001659 type_error("'%.200s' object does not support item assignment", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001660 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001661}
1662
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001663int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001664PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001665{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001666 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001667
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001668 if (s == NULL) {
1669 null_error();
1670 return -1;
1671 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001672
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001673 m = s->ob_type->tp_as_sequence;
1674 if (m && m->sq_ass_item) {
1675 if (i < 0) {
1676 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001677 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001678 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001679 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001680 i += l;
1681 }
1682 }
1683 return m->sq_ass_item(s, i, (PyObject *)NULL);
1684 }
1685
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001686 type_error("'%.200s' object doesn't support item deletion", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001687 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001688}
1689
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001690int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001691PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001692{
Thomas Wouters1d75a792000-08-17 22:37:32 +00001693 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001694
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001695 if (s == NULL) {
1696 null_error();
1697 return -1;
1698 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001699
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001700 mp = s->ob_type->tp_as_mapping;
1701 if (mp->mp_ass_subscript) {
Thomas Wouters1d75a792000-08-17 22:37:32 +00001702 int res;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001703 PyObject *slice = _PySlice_FromIndices(i1, i2);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001704 if (!slice)
1705 return -1;
1706 res = mp->mp_ass_subscript(s, slice, o);
1707 Py_DECREF(slice);
1708 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001709 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00001710
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001711 type_error("'%.200s' object doesn't support slice assignment", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001712 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001713}
1714
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001715int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001716PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001717{
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001718 PyMappingMethods *mp;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001719
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001720 if (s == NULL) {
1721 null_error();
1722 return -1;
1723 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001724
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001725 mp = s->ob_type->tp_as_mapping;
1726 if (mp->mp_ass_subscript) {
1727 int res;
1728 PyObject *slice = _PySlice_FromIndices(i1, i2);
1729 if (!slice)
1730 return -1;
1731 res = mp->mp_ass_subscript(s, slice, NULL);
1732 Py_DECREF(slice);
1733 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001734 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001735 type_error("'%.200s' object doesn't support slice deletion", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001736 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001737}
1738
Guido van Rossume15dee51995-07-18 14:12:02 +00001739PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001740PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00001741{
Tim Peters6912d4d2001-05-05 03:56:37 +00001742 PyObject *it; /* iter(v) */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001743 Py_ssize_t n; /* guess for result tuple size */
Raymond Hettingere8364232009-02-02 22:55:09 +00001744 PyObject *result = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001745 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00001746
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001747 if (v == NULL)
1748 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001749
Tim Peters6912d4d2001-05-05 03:56:37 +00001750 /* Special-case the common tuple and list cases, for efficiency. */
Tim Peters4c3a0a32001-09-10 23:37:46 +00001751 if (PyTuple_CheckExact(v)) {
1752 /* Note that we can't know whether it's safe to return
1753 a tuple *subclass* instance as-is, hence the restriction
Tim Peters8ff70a92001-09-10 23:53:53 +00001754 to exact tuples here. In contrast, lists always make
1755 a copy, so there's no need for exactness below. */
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001756 Py_INCREF(v);
1757 return v;
Guido van Rossume15dee51995-07-18 14:12:02 +00001758 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001759 if (PyList_Check(v))
1760 return PyList_AsTuple(v);
1761
Tim Peters6912d4d2001-05-05 03:56:37 +00001762 /* Get iterator. */
1763 it = PyObject_GetIter(v);
1764 if (it == NULL)
Tim Peters1fc240e2001-10-26 05:06:50 +00001765 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001766
Tim Peters6912d4d2001-05-05 03:56:37 +00001767 /* Guess result size and allocate space. */
Christian Heimes255f53b2007-12-08 15:33:56 +00001768 n = _PyObject_LengthHint(v, 10);
Raymond Hettingere8364232009-02-02 22:55:09 +00001769 if (n == -1)
1770 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001771 result = PyTuple_New(n);
1772 if (result == NULL)
1773 goto Fail;
1774
1775 /* Fill the tuple. */
1776 for (j = 0; ; ++j) {
1777 PyObject *item = PyIter_Next(it);
1778 if (item == NULL) {
1779 if (PyErr_Occurred())
1780 goto Fail;
1781 break;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001782 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001783 if (j >= n) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001784 Py_ssize_t oldn = n;
Raymond Hettinger4d012592004-12-16 10:38:38 +00001785 /* The over-allocation strategy can grow a bit faster
Guido van Rossum98297ee2007-11-06 21:34:58 +00001786 than for lists because unlike lists the
Raymond Hettinger4d012592004-12-16 10:38:38 +00001787 over-allocation isn't permanent -- we reclaim
1788 the excess before the end of this routine.
1789 So, grow by ten and then add 25%.
1790 */
1791 n += 10;
1792 n += n >> 2;
1793 if (n < oldn) {
1794 /* Check for overflow */
1795 PyErr_NoMemory();
Raymond Hettingere6bdb372004-12-16 15:10:21 +00001796 Py_DECREF(item);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001797 goto Fail;
Raymond Hettinger4d012592004-12-16 10:38:38 +00001798 }
Tim Peters4324aa32001-05-28 22:30:08 +00001799 if (_PyTuple_Resize(&result, n) != 0) {
Tim Peters12d0a6c2001-05-05 04:10:25 +00001800 Py_DECREF(item);
Tim Peters6912d4d2001-05-05 03:56:37 +00001801 goto Fail;
Tim Peters12d0a6c2001-05-05 04:10:25 +00001802 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001803 }
1804 PyTuple_SET_ITEM(result, j, item);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001805 }
1806
Tim Peters6912d4d2001-05-05 03:56:37 +00001807 /* Cut tuple back if guess was too large. */
1808 if (j < n &&
Tim Peters4324aa32001-05-28 22:30:08 +00001809 _PyTuple_Resize(&result, j) != 0)
Tim Peters6912d4d2001-05-05 03:56:37 +00001810 goto Fail;
1811
1812 Py_DECREF(it);
1813 return result;
1814
1815Fail:
1816 Py_XDECREF(result);
1817 Py_DECREF(it);
1818 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001819}
1820
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001821PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001822PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001823{
Tim Petersf553f892001-05-01 20:45:31 +00001824 PyObject *result; /* result list */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001825 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00001826
Guido van Rossum5dba9e81998-07-10 18:03:50 +00001827 if (v == NULL)
1828 return null_error();
1829
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +00001830 result = PyList_New(0);
1831 if (result == NULL)
Tim Petersf553f892001-05-01 20:45:31 +00001832 return NULL;
1833
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +00001834 rv = _PyList_Extend((PyListObject *)result, v);
1835 if (rv == NULL) {
1836 Py_DECREF(result);
Tim Petersf553f892001-05-01 20:45:31 +00001837 return NULL;
1838 }
Raymond Hettinger969d8c02004-03-17 05:24:23 +00001839 Py_DECREF(rv);
Tim Petersf553f892001-05-01 20:45:31 +00001840 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001841}
1842
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001843PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001844PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001845{
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001846 PyObject *it;
1847
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001848 if (v == NULL)
1849 return null_error();
1850
Michael W. Hudson2801fe12002-11-05 18:05:49 +00001851 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001852 Py_INCREF(v);
1853 return v;
1854 }
1855
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001856 it = PyObject_GetIter(v);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001857 if (it == NULL) {
1858 if (PyErr_ExceptionMatches(PyExc_TypeError))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001859 PyErr_SetString(PyExc_TypeError, m);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001860 return NULL;
1861 }
1862
Raymond Hettinger193814c2004-12-18 19:00:59 +00001863 v = PySequence_List(it);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001864 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001865
1866 return v;
1867}
1868
Tim Peters16a77ad2001-09-08 04:00:12 +00001869/* Iterate over seq. Result depends on the operation:
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001870 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
Mark Dickinson934896d2009-02-21 20:59:32 +00001871 PY_ITERSEARCH_INDEX: 0-based index of first occurrence of obj in seq;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001872 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00001873 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
1874*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001875Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001876_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00001877{
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001878 Py_ssize_t n;
Tim Peters16a77ad2001-09-08 04:00:12 +00001879 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
1880 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00001881
Tim Peters16a77ad2001-09-08 04:00:12 +00001882 if (seq == NULL || obj == NULL) {
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001883 null_error();
1884 return -1;
1885 }
Tim Peters75f8e352001-05-05 11:33:43 +00001886
Tim Peters16a77ad2001-09-08 04:00:12 +00001887 it = PyObject_GetIter(seq);
Tim Peters75f8e352001-05-05 11:33:43 +00001888 if (it == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001889 type_error("argument of type '%.200s' is not iterable", seq);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001890 return -1;
Tim Peters75f8e352001-05-05 11:33:43 +00001891 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001892
Tim Peters16a77ad2001-09-08 04:00:12 +00001893 n = wrapped = 0;
Tim Peters75f8e352001-05-05 11:33:43 +00001894 for (;;) {
1895 int cmp;
1896 PyObject *item = PyIter_Next(it);
1897 if (item == NULL) {
1898 if (PyErr_Occurred())
1899 goto Fail;
1900 break;
1901 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001902
1903 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001904 Py_DECREF(item);
Tim Peters75f8e352001-05-05 11:33:43 +00001905 if (cmp < 0)
1906 goto Fail;
1907 if (cmp > 0) {
Tim Peters16a77ad2001-09-08 04:00:12 +00001908 switch (operation) {
1909 case PY_ITERSEARCH_COUNT:
Thomas Wouters89f507f2006-12-13 04:49:30 +00001910 if (n == PY_SSIZE_T_MAX) {
Tim Peters16a77ad2001-09-08 04:00:12 +00001911 PyErr_SetString(PyExc_OverflowError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00001912 "count exceeds C integer size");
Tim Peters16a77ad2001-09-08 04:00:12 +00001913 goto Fail;
1914 }
Thomas Wouters89f507f2006-12-13 04:49:30 +00001915 ++n;
Tim Peters16a77ad2001-09-08 04:00:12 +00001916 break;
1917
1918 case PY_ITERSEARCH_INDEX:
1919 if (wrapped) {
1920 PyErr_SetString(PyExc_OverflowError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00001921 "index exceeds C integer size");
Tim Peters16a77ad2001-09-08 04:00:12 +00001922 goto Fail;
1923 }
1924 goto Done;
1925
1926 case PY_ITERSEARCH_CONTAINS:
1927 n = 1;
1928 goto Done;
1929
1930 default:
1931 assert(!"unknown operation");
Tim Peters75f8e352001-05-05 11:33:43 +00001932 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001933 }
1934
1935 if (operation == PY_ITERSEARCH_INDEX) {
Thomas Wouters89f507f2006-12-13 04:49:30 +00001936 if (n == PY_SSIZE_T_MAX)
Tim Peters16a77ad2001-09-08 04:00:12 +00001937 wrapped = 1;
Thomas Wouters89f507f2006-12-13 04:49:30 +00001938 ++n;
Tim Peters75f8e352001-05-05 11:33:43 +00001939 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001940 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001941
1942 if (operation != PY_ITERSEARCH_INDEX)
1943 goto Done;
1944
1945 PyErr_SetString(PyExc_ValueError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001946 "sequence.index(x): x not in sequence");
Tim Peters16a77ad2001-09-08 04:00:12 +00001947 /* fall into failure code */
1948Fail:
1949 n = -1;
1950 /* fall through */
1951Done:
Tim Peters75f8e352001-05-05 11:33:43 +00001952 Py_DECREF(it);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001953 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00001954
Guido van Rossume15dee51995-07-18 14:12:02 +00001955}
1956
Tim Peters16a77ad2001-09-08 04:00:12 +00001957/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001958Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001959PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001960{
Tim Peters16a77ad2001-09-08 04:00:12 +00001961 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00001962}
1963
Tim Peterscb8d3682001-05-05 21:05:01 +00001964/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00001965 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00001966 */
1967int
1968PySequence_Contains(PyObject *seq, PyObject *ob)
1969{
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001970 Py_ssize_t result;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001971 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001972 if (sqm != NULL && sqm->sq_contains != NULL)
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001973 return (*sqm->sq_contains)(seq, ob);
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001974 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
1975 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00001976}
1977
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001978/* Backwards compatibility */
1979#undef PySequence_In
1980int
Fred Drake79912472000-07-09 04:06:11 +00001981PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001982{
1983 return PySequence_Contains(w, v);
1984}
1985
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001986Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00001987PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001988{
Tim Peters16a77ad2001-09-08 04:00:12 +00001989 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00001990}
1991
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001992/* Operations on mappings */
1993
1994int
Fred Drake79912472000-07-09 04:06:11 +00001995PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001996{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001997 return o && o->ob_type->tp_as_mapping &&
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001998 o->ob_type->tp_as_mapping->mp_subscript;
Guido van Rossume15dee51995-07-18 14:12:02 +00001999}
2000
Martin v. Löwis18e16552006-02-15 17:27:45 +00002001Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00002002PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002003{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002004 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00002005
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002006 if (o == NULL) {
2007 null_error();
2008 return -1;
2009 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002010
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002011 m = o->ob_type->tp_as_mapping;
2012 if (m && m->mp_length)
2013 return m->mp_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00002014
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002015 type_error("object of type '%.200s' has no len()", o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002016 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00002017}
2018
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002019#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00002020Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002021PyMapping_Length(PyObject *o)
2022{
2023 return PyMapping_Size(o);
2024}
2025#define PyMapping_Length PyMapping_Size
2026
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002027PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002028PyMapping_GetItemString(PyObject *o, char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002029{
2030 PyObject *okey, *r;
2031
2032 if (key == NULL)
2033 return null_error();
2034
Martin v. Löwis5b222132007-06-10 09:51:05 +00002035 okey = PyUnicode_FromString(key);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002036 if (okey == NULL)
2037 return NULL;
2038 r = PyObject_GetItem(o, okey);
2039 Py_DECREF(okey);
2040 return r;
2041}
2042
2043int
Fred Drake79912472000-07-09 04:06:11 +00002044PyMapping_SetItemString(PyObject *o, char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002045{
2046 PyObject *okey;
2047 int r;
2048
2049 if (key == NULL) {
2050 null_error();
2051 return -1;
2052 }
2053
Martin v. Löwis5b222132007-06-10 09:51:05 +00002054 okey = PyUnicode_FromString(key);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002055 if (okey == NULL)
Guido van Rossumed6219b1998-05-29 02:59:33 +00002056 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002057 r = PyObject_SetItem(o, okey, value);
2058 Py_DECREF(okey);
2059 return r;
2060}
2061
2062int
Fred Drake79912472000-07-09 04:06:11 +00002063PyMapping_HasKeyString(PyObject *o, char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002064{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002065 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002066
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002067 v = PyMapping_GetItemString(o, key);
2068 if (v) {
2069 Py_DECREF(v);
2070 return 1;
2071 }
2072 PyErr_Clear();
2073 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002074}
2075
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002076int
Fred Drake79912472000-07-09 04:06:11 +00002077PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002078{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002079 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002080
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002081 v = PyObject_GetItem(o, key);
2082 if (v) {
2083 Py_DECREF(v);
2084 return 1;
2085 }
2086 PyErr_Clear();
2087 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002088}
2089
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002090PyObject *
2091PyMapping_Keys(PyObject *o)
2092{
2093 PyObject *keys;
2094 PyObject *fast;
2095
2096 if (PyDict_CheckExact(o))
2097 return PyDict_Keys(o);
2098 keys = PyObject_CallMethod(o, "keys", NULL);
2099 if (keys == NULL)
2100 return NULL;
2101 fast = PySequence_Fast(keys, "o.keys() are not iterable");
2102 Py_DECREF(keys);
2103 return fast;
2104}
2105
2106PyObject *
2107PyMapping_Items(PyObject *o)
2108{
2109 PyObject *items;
2110 PyObject *fast;
2111
2112 if (PyDict_CheckExact(o))
2113 return PyDict_Items(o);
2114 items = PyObject_CallMethod(o, "items", NULL);
2115 if (items == NULL)
2116 return NULL;
2117 fast = PySequence_Fast(items, "o.items() are not iterable");
2118 Py_DECREF(items);
2119 return fast;
2120}
2121
2122PyObject *
2123PyMapping_Values(PyObject *o)
2124{
2125 PyObject *values;
2126 PyObject *fast;
2127
2128 if (PyDict_CheckExact(o))
2129 return PyDict_Values(o);
2130 values = PyObject_CallMethod(o, "values", NULL);
2131 if (values == NULL)
2132 return NULL;
2133 fast = PySequence_Fast(values, "o.values() are not iterable");
2134 Py_DECREF(values);
2135 return fast;
2136}
2137
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002138/* Operations on callable objects */
2139
2140/* XXX PyCallable_Check() is in object.c */
2141
Guido van Rossume15dee51995-07-18 14:12:02 +00002142PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002143PyObject_CallObject(PyObject *o, PyObject *a)
Guido van Rossume15dee51995-07-18 14:12:02 +00002144{
Guido van Rossum5560b742001-09-14 16:47:50 +00002145 return PyEval_CallObjectWithKeywords(o, a, NULL);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002146}
Guido van Rossume15dee51995-07-18 14:12:02 +00002147
2148PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002149PyObject_Call(PyObject *func, PyObject *arg, PyObject *kw)
2150{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002151 ternaryfunc call;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002152
2153 if ((call = func->ob_type->tp_call) != NULL) {
Thomas Wouters89d996e2007-09-08 17:39:28 +00002154 PyObject *result;
2155 if (Py_EnterRecursiveCall(" while calling a Python object"))
2156 return NULL;
2157 result = (*call)(func, arg, kw);
2158 Py_LeaveRecursiveCall();
Tim Peters6d6c1a32001-08-02 04:15:00 +00002159 if (result == NULL && !PyErr_Occurred())
2160 PyErr_SetString(
2161 PyExc_SystemError,
2162 "NULL result without error in PyObject_Call");
2163 return result;
2164 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002165 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
Fred Drake573395a2001-11-01 20:26:12 +00002166 func->ob_type->tp_name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002167 return NULL;
2168}
2169
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002170static PyObject*
2171call_function_tail(PyObject *callable, PyObject *args)
2172{
2173 PyObject *retval;
2174
2175 if (args == NULL)
2176 return NULL;
2177
2178 if (!PyTuple_Check(args)) {
2179 PyObject *a;
2180
2181 a = PyTuple_New(1);
2182 if (a == NULL) {
2183 Py_DECREF(args);
2184 return NULL;
2185 }
2186 PyTuple_SET_ITEM(a, 0, args);
2187 args = a;
2188 }
2189 retval = PyObject_Call(callable, args, NULL);
2190
2191 Py_DECREF(args);
2192
2193 return retval;
2194}
2195
Tim Peters6d6c1a32001-08-02 04:15:00 +00002196PyObject *
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002197PyObject_CallFunction(PyObject *callable, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002198{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002199 va_list va;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002200 PyObject *args;
Guido van Rossume15dee51995-07-18 14:12:02 +00002201
Fred Drakeb92cf062001-10-27 06:16:31 +00002202 if (callable == NULL)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002203 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002204
Fred Drakeb92cf062001-10-27 06:16:31 +00002205 if (format && *format) {
2206 va_start(va, format);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002207 args = Py_VaBuildValue(format, va);
Fred Drakeb92cf062001-10-27 06:16:31 +00002208 va_end(va);
2209 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002210 else
2211 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002212
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002213 return call_function_tail(callable, args);
2214}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002215
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002216PyObject *
2217_PyObject_CallFunction_SizeT(PyObject *callable, char *format, ...)
2218{
2219 va_list va;
2220 PyObject *args;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002221
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002222 if (callable == NULL)
2223 return null_error();
2224
2225 if (format && *format) {
2226 va_start(va, format);
2227 args = _Py_VaBuildValue_SizeT(format, va);
2228 va_end(va);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002229 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002230 else
2231 args = PyTuple_New(0);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002232
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002233 return call_function_tail(callable, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002234}
2235
2236PyObject *
Guido van Rossume15dee51995-07-18 14:12:02 +00002237PyObject_CallMethod(PyObject *o, char *name, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002238{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002239 va_list va;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002240 PyObject *args;
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002241 PyObject *func = NULL;
2242 PyObject *retval = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002243
Fred Drakeb92cf062001-10-27 06:16:31 +00002244 if (o == NULL || name == NULL)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002245 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002246
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002247 func = PyObject_GetAttrString(o, name);
2248 if (func == NULL) {
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002249 PyErr_SetString(PyExc_AttributeError, name);
2250 return 0;
2251 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002252
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002253 if (!PyCallable_Check(func)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002254 type_error("attribute of type '%.200s' is not callable", func);
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002255 goto exit;
2256 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002257
Fred Drakeb92cf062001-10-27 06:16:31 +00002258 if (format && *format) {
2259 va_start(va, format);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002260 args = Py_VaBuildValue(format, va);
Fred Drakeb92cf062001-10-27 06:16:31 +00002261 va_end(va);
2262 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002263 else
2264 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002265
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002266 retval = call_function_tail(func, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002267
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002268 exit:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002269 /* args gets consumed in call_function_tail */
2270 Py_XDECREF(func);
2271
2272 return retval;
2273}
2274
2275PyObject *
2276_PyObject_CallMethod_SizeT(PyObject *o, char *name, char *format, ...)
2277{
2278 va_list va;
2279 PyObject *args;
2280 PyObject *func = NULL;
2281 PyObject *retval = NULL;
2282
2283 if (o == NULL || name == NULL)
2284 return null_error();
2285
2286 func = PyObject_GetAttrString(o, name);
2287 if (func == NULL) {
2288 PyErr_SetString(PyExc_AttributeError, name);
2289 return 0;
2290 }
2291
2292 if (!PyCallable_Check(func)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002293 type_error("attribute of type '%.200s' is not callable", func);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002294 goto exit;
2295 }
2296
2297 if (format && *format) {
2298 va_start(va, format);
2299 args = _Py_VaBuildValue_SizeT(format, va);
2300 va_end(va);
2301 }
2302 else
2303 args = PyTuple_New(0);
2304
2305 retval = call_function_tail(func, args);
2306
2307 exit:
2308 /* args gets consumed in call_function_tail */
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002309 Py_XDECREF(func);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002310
2311 return retval;
Guido van Rossume15dee51995-07-18 14:12:02 +00002312}
Guido van Rossum823649d2001-03-21 18:40:58 +00002313
2314
Fred Drakeb421b8c2001-10-26 16:21:32 +00002315static PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002316objargs_mktuple(va_list va)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002317{
2318 int i, n = 0;
2319 va_list countva;
2320 PyObject *result, *tmp;
2321
2322#ifdef VA_LIST_IS_ARRAY
2323 memcpy(countva, va, sizeof(va_list));
2324#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002325#ifdef __va_copy
2326 __va_copy(countva, va);
2327#else
Fred Drakeb421b8c2001-10-26 16:21:32 +00002328 countva = va;
2329#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002330#endif
Fred Drakeb421b8c2001-10-26 16:21:32 +00002331
2332 while (((PyObject *)va_arg(countva, PyObject *)) != NULL)
2333 ++n;
2334 result = PyTuple_New(n);
2335 if (result != NULL && n > 0) {
2336 for (i = 0; i < n; ++i) {
2337 tmp = (PyObject *)va_arg(va, PyObject *);
2338 PyTuple_SET_ITEM(result, i, tmp);
2339 Py_INCREF(tmp);
2340 }
2341 }
2342 return result;
2343}
2344
2345PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002346PyObject_CallMethodObjArgs(PyObject *callable, PyObject *name, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002347{
2348 PyObject *args, *tmp;
2349 va_list vargs;
2350
2351 if (callable == NULL || name == NULL)
2352 return null_error();
2353
2354 callable = PyObject_GetAttr(callable, name);
2355 if (callable == NULL)
2356 return NULL;
2357
2358 /* count the args */
2359 va_start(vargs, name);
Fred Drakeb0c079e2001-10-28 02:39:03 +00002360 args = objargs_mktuple(vargs);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002361 va_end(vargs);
2362 if (args == NULL) {
2363 Py_DECREF(callable);
2364 return NULL;
2365 }
2366 tmp = PyObject_Call(callable, args, NULL);
2367 Py_DECREF(args);
2368 Py_DECREF(callable);
2369
2370 return tmp;
2371}
2372
2373PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002374PyObject_CallFunctionObjArgs(PyObject *callable, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002375{
2376 PyObject *args, *tmp;
2377 va_list vargs;
2378
2379 if (callable == NULL)
2380 return null_error();
2381
2382 /* count the args */
2383 va_start(vargs, callable);
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 return NULL;
2388 tmp = PyObject_Call(callable, args, NULL);
2389 Py_DECREF(args);
2390
2391 return tmp;
2392}
2393
2394
Guido van Rossum823649d2001-03-21 18:40:58 +00002395/* isinstance(), issubclass() */
2396
Barry Warsawf16951c2002-04-23 22:45:44 +00002397/* abstract_get_bases() has logically 4 return states, with a sort of 0th
2398 * state that will almost never happen.
2399 *
2400 * 0. creating the __bases__ static string could get a MemoryError
2401 * 1. getattr(cls, '__bases__') could raise an AttributeError
2402 * 2. getattr(cls, '__bases__') could raise some other exception
2403 * 3. getattr(cls, '__bases__') could return a tuple
2404 * 4. getattr(cls, '__bases__') could return something other than a tuple
2405 *
2406 * Only state #3 is a non-error state and only it returns a non-NULL object
2407 * (it returns the retrieved tuple).
2408 *
2409 * Any raised AttributeErrors are masked by clearing the exception and
2410 * returning NULL. If an object other than a tuple comes out of __bases__,
2411 * then again, the return value is NULL. So yes, these two situations
2412 * produce exactly the same results: NULL is returned and no error is set.
2413 *
2414 * If some exception other than AttributeError is raised, then NULL is also
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002415 * returned, but the exception is not cleared. That's because we want the
Barry Warsawf16951c2002-04-23 22:45:44 +00002416 * exception to be propagated along.
2417 *
2418 * Callers are expected to test for PyErr_Occurred() when the return value
2419 * is NULL to decide whether a valid exception should be propagated or not.
2420 * When there's no exception to propagate, it's customary for the caller to
2421 * set a TypeError.
2422 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002423static PyObject *
2424abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002425{
2426 static PyObject *__bases__ = NULL;
2427 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002428
2429 if (__bases__ == NULL) {
Christian Heimesfe82e772008-01-28 02:38:20 +00002430 __bases__ = PyUnicode_InternFromString("__bases__");
Guido van Rossum823649d2001-03-21 18:40:58 +00002431 if (__bases__ == NULL)
Neil Schemenauer6b471292001-10-18 03:18:43 +00002432 return NULL;
Guido van Rossum823649d2001-03-21 18:40:58 +00002433 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002434 Py_ALLOW_RECURSION
Neil Schemenauer6b471292001-10-18 03:18:43 +00002435 bases = PyObject_GetAttr(cls, __bases__);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002436 Py_END_ALLOW_RECURSION
Barry Warsawf16951c2002-04-23 22:45:44 +00002437 if (bases == NULL) {
2438 if (PyErr_ExceptionMatches(PyExc_AttributeError))
2439 PyErr_Clear();
Neil Schemenauer6b471292001-10-18 03:18:43 +00002440 return NULL;
Guido van Rossum823649d2001-03-21 18:40:58 +00002441 }
Barry Warsawf16951c2002-04-23 22:45:44 +00002442 if (!PyTuple_Check(bases)) {
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002443 Py_DECREF(bases);
Barry Warsawf16951c2002-04-23 22:45:44 +00002444 return NULL;
2445 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002446 return bases;
2447}
2448
2449
2450static int
2451abstract_issubclass(PyObject *derived, PyObject *cls)
2452{
Antoine Pitrouec569b72008-08-26 22:40:48 +00002453 PyObject *bases = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002454 Py_ssize_t i, n;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002455 int r = 0;
2456
Antoine Pitrouec569b72008-08-26 22:40:48 +00002457 while (1) {
2458 if (derived == cls)
2459 return 1;
2460 bases = abstract_get_bases(derived);
2461 if (bases == NULL) {
2462 if (PyErr_Occurred())
2463 return -1;
2464 return 0;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002465 }
Antoine Pitrouec569b72008-08-26 22:40:48 +00002466 n = PyTuple_GET_SIZE(bases);
2467 if (n == 0) {
2468 Py_DECREF(bases);
2469 return 0;
2470 }
2471 /* Avoid recursivity in the single inheritance case */
2472 if (n == 1) {
2473 derived = PyTuple_GET_ITEM(bases, 0);
2474 Py_DECREF(bases);
2475 continue;
2476 }
2477 for (i = 0; i < n; i++) {
2478 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
2479 if (r != 0)
2480 break;
2481 }
2482 Py_DECREF(bases);
2483 return r;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002484 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002485}
2486
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002487static int
2488check_class(PyObject *cls, const char *error)
2489{
2490 PyObject *bases = abstract_get_bases(cls);
2491 if (bases == NULL) {
2492 /* Do not mask errors. */
2493 if (!PyErr_Occurred())
2494 PyErr_SetString(PyExc_TypeError, error);
2495 return 0;
2496 }
2497 Py_DECREF(bases);
2498 return -1;
2499}
2500
Brett Cannon4f653312004-03-20 22:52:14 +00002501static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002502recursive_isinstance(PyObject *inst, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002503{
2504 PyObject *icls;
2505 static PyObject *__class__ = NULL;
2506 int retval = 0;
2507
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002508 if (__class__ == NULL) {
Christian Heimesfe82e772008-01-28 02:38:20 +00002509 __class__ = PyUnicode_InternFromString("__class__");
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002510 if (__class__ == NULL)
2511 return -1;
2512 }
2513
Guido van Rossum45aecf42006-03-15 04:58:47 +00002514 if (PyType_Check(cls)) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00002515 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002516 if (retval == 0) {
2517 PyObject *c = PyObject_GetAttr(inst, __class__);
2518 if (c == NULL) {
2519 PyErr_Clear();
2520 }
2521 else {
Guido van Rossume5b130b2003-02-12 03:36:05 +00002522 if (c != (PyObject *)(inst->ob_type) &&
2523 PyType_Check(c))
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002524 retval = PyType_IsSubtype(
2525 (PyTypeObject *)c,
2526 (PyTypeObject *)cls);
2527 Py_DECREF(c);
2528 }
2529 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002530 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002531 else {
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002532 if (!check_class(cls,
2533 "isinstance() arg 2 must be a class, type,"
2534 " or tuple of classes and types"))
Neil Schemenauer6b471292001-10-18 03:18:43 +00002535 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002536 icls = PyObject_GetAttr(inst, __class__);
Neil Schemenauer6b471292001-10-18 03:18:43 +00002537 if (icls == NULL) {
2538 PyErr_Clear();
2539 retval = 0;
Guido van Rossum823649d2001-03-21 18:40:58 +00002540 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002541 else {
2542 retval = abstract_issubclass(icls, cls);
2543 Py_DECREF(icls);
2544 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002545 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002546
Guido van Rossum823649d2001-03-21 18:40:58 +00002547 return retval;
2548}
2549
2550int
Brett Cannon4f653312004-03-20 22:52:14 +00002551PyObject_IsInstance(PyObject *inst, PyObject *cls)
2552{
Christian Heimesa156e092008-02-16 07:38:31 +00002553 static PyObject *name = NULL;
Guido van Rossume7ba4952007-06-06 23:52:48 +00002554 PyObject *checker;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002555
2556 /* Quick test for an exact match */
2557 if (Py_TYPE(inst) == (PyTypeObject *)cls)
2558 return 1;
2559
Antoine Pitrouec569b72008-08-26 22:40:48 +00002560 if (PyTuple_Check(cls)) {
2561 Py_ssize_t i;
2562 Py_ssize_t n;
2563 int r = 0;
2564
2565 if (Py_EnterRecursiveCall(" in __instancecheck__"))
2566 return -1;
2567 n = PyTuple_GET_SIZE(cls);
2568 for (i = 0; i < n; ++i) {
2569 PyObject *item = PyTuple_GET_ITEM(cls, i);
2570 r = PyObject_IsInstance(inst, item);
2571 if (r != 0)
2572 /* either found it, or got an error */
2573 break;
2574 }
2575 Py_LeaveRecursiveCall();
2576 return r;
2577 }
Christian Heimesa156e092008-02-16 07:38:31 +00002578 if (name == NULL) {
2579 name = PyUnicode_InternFromString("__instancecheck__");
2580 if (name == NULL)
2581 return -1;
2582 }
2583 checker = PyObject_GetAttr(cls, name);
Christian Heimese25f35e2008-03-20 10:49:03 +00002584 if (checker == NULL && PyErr_Occurred())
2585 PyErr_Clear();
Guido van Rossumadee45e2007-05-25 17:55:52 +00002586 if (checker != NULL) {
2587 PyObject *res;
2588 int ok = -1;
Guido van Rossum29478ef2007-05-29 00:39:44 +00002589 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2590 Py_DECREF(checker);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002591 return ok;
Guido van Rossum29478ef2007-05-29 00:39:44 +00002592 }
Guido van Rossumadee45e2007-05-25 17:55:52 +00002593 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
2594 Py_LeaveRecursiveCall();
2595 Py_DECREF(checker);
2596 if (res != NULL) {
2597 ok = PyObject_IsTrue(res);
2598 Py_DECREF(res);
2599 }
2600 return ok;
2601 }
Antoine Pitrouec569b72008-08-26 22:40:48 +00002602 return recursive_isinstance(inst, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002603}
2604
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002605static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002606recursive_issubclass(PyObject *derived, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002607{
Antoine Pitrouec569b72008-08-26 22:40:48 +00002608 if (PyType_Check(cls) && PyType_Check(derived)) {
2609 /* Fast path (non-recursive) */
2610 return PyType_IsSubtype((PyTypeObject *)derived, (PyTypeObject *)cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002611 }
Antoine Pitrouec569b72008-08-26 22:40:48 +00002612 if (!check_class(derived,
2613 "issubclass() arg 1 must be a class"))
2614 return -1;
2615 if (!check_class(cls,
2616 "issubclass() arg 2 must be a class"
2617 " or tuple of classes"))
2618 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002619
Antoine Pitrouec569b72008-08-26 22:40:48 +00002620 return abstract_issubclass(derived, cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002621}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002622
Brett Cannon4f653312004-03-20 22:52:14 +00002623int
2624PyObject_IsSubclass(PyObject *derived, PyObject *cls)
2625{
Christian Heimesa156e092008-02-16 07:38:31 +00002626 static PyObject *name = NULL;
Guido van Rossumadee45e2007-05-25 17:55:52 +00002627 PyObject *t, *v, *tb;
Guido van Rossume7ba4952007-06-06 23:52:48 +00002628 PyObject *checker;
Christian Heimesa156e092008-02-16 07:38:31 +00002629
Antoine Pitrouec569b72008-08-26 22:40:48 +00002630 if (PyTuple_Check(cls)) {
2631 Py_ssize_t i;
2632 Py_ssize_t n;
2633 int r = 0;
2634
2635 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
2636 return -1;
2637 n = PyTuple_GET_SIZE(cls);
2638 for (i = 0; i < n; ++i) {
2639 PyObject *item = PyTuple_GET_ITEM(cls, i);
2640 r = PyObject_IsSubclass(derived, item);
2641 if (r != 0)
2642 /* either found it, or got an error */
2643 break;
2644 }
2645 Py_LeaveRecursiveCall();
2646 return r;
2647 }
Christian Heimesa156e092008-02-16 07:38:31 +00002648 if (name == NULL) {
2649 name = PyUnicode_InternFromString("__subclasscheck__");
2650 if (name == NULL)
2651 return -1;
2652 }
Antoine Pitrouec569b72008-08-26 22:40:48 +00002653 PyErr_Fetch(&t, &v, &tb);
Christian Heimesa156e092008-02-16 07:38:31 +00002654 checker = PyObject_GetAttr(cls, name);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002655 PyErr_Restore(t, v, tb);
2656 if (checker != NULL) {
2657 PyObject *res;
2658 int ok = -1;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002659 if (Py_EnterRecursiveCall(" in __subclasscheck__")) {
2660 Py_DECREF(checker);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002661 return ok;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002662 }
Guido van Rossumadee45e2007-05-25 17:55:52 +00002663 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
2664 Py_LeaveRecursiveCall();
2665 Py_DECREF(checker);
2666 if (res != NULL) {
2667 ok = PyObject_IsTrue(res);
2668 Py_DECREF(res);
2669 }
2670 return ok;
2671 }
Antoine Pitrouec569b72008-08-26 22:40:48 +00002672 return recursive_issubclass(derived, cls);
2673}
2674
2675int
2676_PyObject_RealIsInstance(PyObject *inst, PyObject *cls)
2677{
2678 return recursive_isinstance(inst, cls);
2679}
2680
2681int
2682_PyObject_RealIsSubclass(PyObject *derived, PyObject *cls)
2683{
2684 return recursive_issubclass(derived, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002685}
2686
2687
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002688PyObject *
2689PyObject_GetIter(PyObject *o)
2690{
2691 PyTypeObject *t = o->ob_type;
2692 getiterfunc f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002693 f = t->tp_iter;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002694 if (f == NULL) {
2695 if (PySequence_Check(o))
Guido van Rossum213c7a62001-04-23 14:08:49 +00002696 return PySeqIter_New(o);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002697 return type_error("'%.200s' object is not iterable", o);
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002698 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00002699 else {
2700 PyObject *res = (*f)(o);
2701 if (res != NULL && !PyIter_Check(res)) {
2702 PyErr_Format(PyExc_TypeError,
2703 "iter() returned non-iterator "
2704 "of type '%.100s'",
2705 res->ob_type->tp_name);
2706 Py_DECREF(res);
2707 res = NULL;
2708 }
2709 return res;
2710 }
2711}
2712
Tim Petersf4848da2001-05-05 00:14:56 +00002713/* Return next item.
2714 * If an error occurs, return NULL. PyErr_Occurred() will be true.
2715 * If the iteration terminates normally, return NULL and clear the
2716 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
2717 * will be false.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002718 * Else return the next object. PyErr_Occurred() will be false.
Tim Petersf4848da2001-05-05 00:14:56 +00002719 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002720PyObject *
2721PyIter_Next(PyObject *iter)
2722{
Tim Petersf4848da2001-05-05 00:14:56 +00002723 PyObject *result;
Tim Petersf4848da2001-05-05 00:14:56 +00002724 result = (*iter->ob_type->tp_iternext)(iter);
2725 if (result == NULL &&
2726 PyErr_Occurred() &&
2727 PyErr_ExceptionMatches(PyExc_StopIteration))
2728 PyErr_Clear();
2729 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002730}