blob: 56e5b717a6182c8e4ae804747c2ad3568137c769 [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()) {
Benjamin Petersonb0ba27d2009-05-09 19:30:46 +000086 if (!PyErr_ExceptionMatches(PyExc_TypeError))
87 return -1;
Christian Heimes255f53b2007-12-08 15:33:56 +000088 PyErr_Clear();
Raymond Hettingere8364232009-02-02 22:55:09 +000089 }
Christian Heimes255f53b2007-12-08 15:33:56 +000090
Christian Heimes255f53b2007-12-08 15:33:56 +000091 /* try o.__length_hint__() */
Benjamin Petersona5758c02009-05-09 18:15:04 +000092 hintmeth = _PyObject_LookupSpecial(o, "__length_hint__", &hintstrobj);
93 if (hintmeth == NULL)
94 return defaultvalue;
95 ro = PyObject_CallFunctionObjArgs(hintmeth, NULL);
96 Py_DECREF(hintmeth);
Raymond Hettingere8364232009-02-02 22:55:09 +000097 if (ro == NULL) {
Benjamin Petersona5758c02009-05-09 18:15:04 +000098 if (!PyErr_ExceptionMatches(PyExc_TypeError))
99 return -1;
Benjamin Petersone18df232009-05-09 19:24:36 +0000100 PyErr_Clear();
Raymond Hettingere8364232009-02-02 22:55:09 +0000101 return defaultvalue;
102 }
Raymond Hettinger5d654122009-02-03 02:12:10 +0000103 rv = PyLong_Check(ro) ? PyLong_AsSsize_t(ro) : defaultvalue;
Christian Heimes255f53b2007-12-08 15:33:56 +0000104 Py_DECREF(ro);
Raymond Hettingere8364232009-02-02 22:55:09 +0000105 return rv;
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000106}
107
Guido van Rossume15dee51995-07-18 14:12:02 +0000108PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000109PyObject_GetItem(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +0000110{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000111 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000112
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000113 if (o == NULL || key == NULL)
114 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +0000115
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000116 m = o->ob_type->tp_as_mapping;
117 if (m && m->mp_subscript)
118 return m->mp_subscript(o, key);
Guido van Rossume15dee51995-07-18 14:12:02 +0000119
Guido van Rossum21308241998-08-13 16:44:44 +0000120 if (o->ob_type->tp_as_sequence) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000121 if (PyIndex_Check(key)) {
122 Py_ssize_t key_value;
123 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
Andrew M. Kuchling0f223d22000-02-23 22:21:50 +0000124 if (key_value == -1 && PyErr_Occurred())
125 return NULL;
126 return PySequence_GetItem(o, key_value);
127 }
Guido van Rossum64585f62001-11-24 18:24:47 +0000128 else if (o->ob_type->tp_as_sequence->sq_item)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000129 return type_error("sequence index must "
130 "be integer, not '%.200s'", key);
Guido van Rossum21308241998-08-13 16:44:44 +0000131 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000132
Georg Brandl0192bff2009-04-27 16:49:41 +0000133 return type_error("'%.200s' object is not subscriptable", o);
Guido van Rossume15dee51995-07-18 14:12:02 +0000134}
135
136int
Fred Drake79912472000-07-09 04:06:11 +0000137PyObject_SetItem(PyObject *o, PyObject *key, PyObject *value)
Guido van Rossume15dee51995-07-18 14:12:02 +0000138{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000139 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000140
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000141 if (o == NULL || key == NULL || value == NULL) {
142 null_error();
143 return -1;
144 }
145 m = o->ob_type->tp_as_mapping;
146 if (m && m->mp_ass_subscript)
147 return m->mp_ass_subscript(o, key, value);
Guido van Rossume15dee51995-07-18 14:12:02 +0000148
Guido van Rossum21308241998-08-13 16:44:44 +0000149 if (o->ob_type->tp_as_sequence) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000150 if (PyIndex_Check(key)) {
151 Py_ssize_t key_value;
152 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
Andrew M. Kuchling0f223d22000-02-23 22:21:50 +0000153 if (key_value == -1 && PyErr_Occurred())
154 return -1;
155 return PySequence_SetItem(o, key_value, value);
156 }
Guido van Rossum64585f62001-11-24 18:24:47 +0000157 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000158 type_error("sequence index must be "
159 "integer, not '%.200s'", key);
Guido van Rossum64585f62001-11-24 18:24:47 +0000160 return -1;
161 }
Guido van Rossum21308241998-08-13 16:44:44 +0000162 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000163
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000164 type_error("'%.200s' object does not support item assignment", o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000165 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +0000166}
167
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000168int
Fred Drake79912472000-07-09 04:06:11 +0000169PyObject_DelItem(PyObject *o, PyObject *key)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000170{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000171 PyMappingMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000172
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000173 if (o == NULL || key == NULL) {
174 null_error();
175 return -1;
176 }
177 m = o->ob_type->tp_as_mapping;
178 if (m && m->mp_ass_subscript)
179 return m->mp_ass_subscript(o, key, (PyObject*)NULL);
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000180
Guido van Rossum21308241998-08-13 16:44:44 +0000181 if (o->ob_type->tp_as_sequence) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000182 if (PyIndex_Check(key)) {
183 Py_ssize_t key_value;
184 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
Andrew M. Kuchling0f223d22000-02-23 22:21:50 +0000185 if (key_value == -1 && PyErr_Occurred())
186 return -1;
187 return PySequence_DelItem(o, key_value);
188 }
Guido van Rossum64585f62001-11-24 18:24:47 +0000189 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000190 type_error("sequence index must be "
191 "integer, not '%.200s'", key);
Guido van Rossum64585f62001-11-24 18:24:47 +0000192 return -1;
193 }
Guido van Rossum21308241998-08-13 16:44:44 +0000194 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000195
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000196 type_error("'%.200s' object does not support item deletion", o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000197 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000198}
199
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000200int
201PyObject_DelItemString(PyObject *o, char *key)
202{
203 PyObject *okey;
204 int ret;
205
206 if (o == NULL || key == NULL) {
207 null_error();
208 return -1;
209 }
Martin v. Löwis5b222132007-06-10 09:51:05 +0000210 okey = PyUnicode_FromString(key);
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000211 if (okey == NULL)
212 return -1;
213 ret = PyObject_DelItem(o, okey);
214 Py_DECREF(okey);
215 return ret;
216}
217
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000218/* We release the buffer right after use of this function which could
Guido van Rossum98297ee2007-11-06 21:34:58 +0000219 cause issues later on. Don't use these functions in new code.
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000220 */
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000221int
222PyObject_AsCharBuffer(PyObject *obj,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000223 const char **buffer,
224 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000225{
226 PyBufferProcs *pb;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000227 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000228
229 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
230 null_error();
231 return -1;
232 }
233 pb = obj->ob_type->tp_as_buffer;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000234 if (pb == NULL || pb->bf_getbuffer == NULL) {
Guido van Rossum4c08d552000-03-10 22:55:18 +0000235 PyErr_SetString(PyExc_TypeError,
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000236 "expected an object with the buffer interface");
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000237 return -1;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000238 }
Travis E. Oliphantddacf962007-10-13 21:03:27 +0000239 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE)) return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000240
241 *buffer = view.buf;
242 *buffer_len = view.len;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000243 if (pb->bf_releasebuffer != NULL)
244 (*pb->bf_releasebuffer)(obj, &view);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +0000245 Py_XDECREF(view.obj);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000246 return 0;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000247}
Guido van Rossum4c08d552000-03-10 22:55:18 +0000248
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000249int
250PyObject_CheckReadBuffer(PyObject *obj)
251{
Guido van Rossum98297ee2007-11-06 21:34:58 +0000252 PyBufferProcs *pb = obj->ob_type->tp_as_buffer;
Benjamin Peterson60320cb2008-09-26 21:49:22 +0000253 Py_buffer view;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000254
255 if (pb == NULL ||
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000256 pb->bf_getbuffer == NULL)
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000257 return 0;
Benjamin Peterson60320cb2008-09-26 21:49:22 +0000258 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE) == -1) {
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000259 PyErr_Clear();
260 return 0;
261 }
Benjamin Peterson60320cb2008-09-26 21:49:22 +0000262 PyBuffer_Release(&view);
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000263 return 1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000264}
265
266int PyObject_AsReadBuffer(PyObject *obj,
267 const void **buffer,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000268 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000269{
270 PyBufferProcs *pb;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000271 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000272
273 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
274 null_error();
275 return -1;
276 }
277 pb = obj->ob_type->tp_as_buffer;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000278 if (pb == NULL ||
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000279 pb->bf_getbuffer == NULL) {
Guido van Rossum4c08d552000-03-10 22:55:18 +0000280 PyErr_SetString(PyExc_TypeError,
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000281 "expected an object with a buffer interface");
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000282 return -1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000283 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000284
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000285 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE)) return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000286
287 *buffer = view.buf;
288 *buffer_len = view.len;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000289 if (pb->bf_releasebuffer != NULL)
290 (*pb->bf_releasebuffer)(obj, &view);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +0000291 Py_XDECREF(view.obj);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000292 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000293}
294
295int PyObject_AsWriteBuffer(PyObject *obj,
296 void **buffer,
Martin v. Löwis18e16552006-02-15 17:27:45 +0000297 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000298{
299 PyBufferProcs *pb;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000300 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000301
302 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
303 null_error();
304 return -1;
305 }
306 pb = obj->ob_type->tp_as_buffer;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000307 if (pb == NULL ||
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000308 pb->bf_getbuffer == NULL ||
309 ((*pb->bf_getbuffer)(obj, &view, PyBUF_WRITABLE) != 0)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000310 PyErr_SetString(PyExc_TypeError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000311 "expected an object with a writable buffer interface");
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000312 return -1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000313 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000314
315 *buffer = view.buf;
316 *buffer_len = view.len;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000317 if (pb->bf_releasebuffer != NULL)
318 (*pb->bf_releasebuffer)(obj, &view);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +0000319 Py_XDECREF(view.obj);
Guido van Rossum4c08d552000-03-10 22:55:18 +0000320 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000321}
322
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000323/* Buffer C-API for Python 3.0 */
324
325int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000326PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000327{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000328 if (!PyObject_CheckBuffer(obj)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000329 PyErr_Format(PyExc_TypeError,
330 "'%100s' does not have the buffer interface",
Christian Heimes90aa7642007-12-19 02:45:37 +0000331 Py_TYPE(obj)->tp_name);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000332 return -1;
333 }
334 return (*(obj->ob_type->tp_as_buffer->bf_getbuffer))(obj, view, flags);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000335}
336
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000337static int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000338_IsFortranContiguous(Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000339{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000340 Py_ssize_t sd, dim;
341 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000342
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000343 if (view->ndim == 0) return 1;
344 if (view->strides == NULL) return (view->ndim == 1);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000345
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000346 sd = view->itemsize;
347 if (view->ndim == 1) return (view->shape[0] == 1 ||
348 sd == view->strides[0]);
349 for (i=0; i<view->ndim; i++) {
350 dim = view->shape[i];
351 if (dim == 0) return 1;
352 if (view->strides[i] != sd) return 0;
353 sd *= dim;
354 }
355 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000356}
357
358static int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000359_IsCContiguous(Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000360{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000361 Py_ssize_t sd, dim;
362 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000363
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000364 if (view->ndim == 0) return 1;
365 if (view->strides == NULL) return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000366
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000367 sd = view->itemsize;
368 if (view->ndim == 1) return (view->shape[0] == 1 ||
369 sd == view->strides[0]);
370 for (i=view->ndim-1; i>=0; i--) {
371 dim = view->shape[i];
372 if (dim == 0) return 1;
373 if (view->strides[i] != sd) return 0;
374 sd *= dim;
375 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000376 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000377}
378
379int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000380PyBuffer_IsContiguous(Py_buffer *view, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000381{
382
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000383 if (view->suboffsets != NULL) return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000384
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000385 if (fort == 'C')
386 return _IsCContiguous(view);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000387 else if (fort == 'F')
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000388 return _IsFortranContiguous(view);
389 else if (fort == 'A')
390 return (_IsCContiguous(view) || _IsFortranContiguous(view));
391 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000392}
393
394
Guido van Rossum98297ee2007-11-06 21:34:58 +0000395void*
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000396PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000397{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000398 char* pointer;
399 int i;
400 pointer = (char *)view->buf;
401 for (i = 0; i < view->ndim; i++) {
402 pointer += view->strides[i]*indices[i];
403 if ((view->suboffsets != NULL) && (view->suboffsets[i] >= 0)) {
404 pointer = *((char**)pointer) + view->suboffsets[i];
405 }
406 }
407 return (void*)pointer;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000408}
409
410
Guido van Rossum98297ee2007-11-06 21:34:58 +0000411void
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000412_add_one_to_index_F(int nd, Py_ssize_t *index, Py_ssize_t *shape)
413{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000414 int k;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000415
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000416 for (k=0; k<nd; k++) {
417 if (index[k] < shape[k]-1) {
418 index[k]++;
419 break;
420 }
421 else {
422 index[k] = 0;
423 }
424 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000425}
426
Guido van Rossum98297ee2007-11-06 21:34:58 +0000427void
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000428_add_one_to_index_C(int nd, Py_ssize_t *index, Py_ssize_t *shape)
429{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000430 int k;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000431
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000432 for (k=nd-1; k>=0; k--) {
433 if (index[k] < shape[k]-1) {
434 index[k]++;
435 break;
436 }
437 else {
438 index[k] = 0;
439 }
440 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000441}
442
443 /* view is not checked for consistency in either of these. It is
Guido van Rossum98297ee2007-11-06 21:34:58 +0000444 assumed that the size of the buffer is view->len in
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000445 view->len / view->itemsize elements.
446 */
447
Guido van Rossum98297ee2007-11-06 21:34:58 +0000448int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000449PyBuffer_ToContiguous(void *buf, Py_buffer *view, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000450{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000451 int k;
452 void (*addone)(int, Py_ssize_t *, Py_ssize_t *);
453 Py_ssize_t *indices, elements;
454 char *dest, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000455
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000456 if (len > view->len) {
457 len = view->len;
458 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000459
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000460 if (PyBuffer_IsContiguous(view, fort)) {
461 /* simplest copy is all that is needed */
462 memcpy(buf, view->buf, len);
463 return 0;
464 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000465
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000466 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000467
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000468 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000469 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
470 if (indices == NULL) {
471 PyErr_NoMemory();
472 return -1;
473 }
474 for (k=0; k<view->ndim;k++) {
475 indices[k] = 0;
476 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000477
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000478 if (fort == 'F') {
479 addone = _add_one_to_index_F;
480 }
481 else {
482 addone = _add_one_to_index_C;
483 }
484 dest = buf;
485 /* XXX : This is not going to be the fastest code in the world
Guido van Rossum98297ee2007-11-06 21:34:58 +0000486 several optimizations are possible.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000487 */
488 elements = len / view->itemsize;
489 while (elements--) {
490 addone(view->ndim, indices, view->shape);
491 ptr = PyBuffer_GetPointer(view, indices);
492 memcpy(dest, ptr, view->itemsize);
493 dest += view->itemsize;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000494 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000495 PyMem_Free(indices);
496 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000497}
498
499int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000500PyBuffer_FromContiguous(Py_buffer *view, void *buf, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000501{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000502 int k;
503 void (*addone)(int, Py_ssize_t *, Py_ssize_t *);
504 Py_ssize_t *indices, elements;
505 char *src, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000506
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000507 if (len > view->len) {
508 len = view->len;
509 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000510
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000511 if (PyBuffer_IsContiguous(view, fort)) {
512 /* simplest copy is all that is needed */
513 memcpy(view->buf, buf, len);
514 return 0;
515 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000516
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000517 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000518
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000519 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000520 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
521 if (indices == NULL) {
522 PyErr_NoMemory();
523 return -1;
524 }
525 for (k=0; k<view->ndim;k++) {
526 indices[k] = 0;
527 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000528
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000529 if (fort == 'F') {
530 addone = _add_one_to_index_F;
531 }
532 else {
533 addone = _add_one_to_index_C;
534 }
535 src = buf;
536 /* XXX : This is not going to be the fastest code in the world
Guido van Rossum98297ee2007-11-06 21:34:58 +0000537 several optimizations are possible.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000538 */
539 elements = len / view->itemsize;
540 while (elements--) {
541 addone(view->ndim, indices, view->shape);
542 ptr = PyBuffer_GetPointer(view, indices);
543 memcpy(ptr, src, view->itemsize);
544 src += view->itemsize;
545 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000546
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000547 PyMem_Free(indices);
548 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000549}
550
Guido van Rossum98297ee2007-11-06 21:34:58 +0000551int PyObject_CopyData(PyObject *dest, PyObject *src)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000552{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000553 Py_buffer view_dest, view_src;
554 int k;
555 Py_ssize_t *indices, elements;
556 char *dptr, *sptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000557
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000558 if (!PyObject_CheckBuffer(dest) ||
559 !PyObject_CheckBuffer(src)) {
560 PyErr_SetString(PyExc_TypeError,
561 "both destination and source must have the "\
562 "buffer interface");
563 return -1;
564 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000565
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000566 if (PyObject_GetBuffer(dest, &view_dest, PyBUF_FULL) != 0) return -1;
567 if (PyObject_GetBuffer(src, &view_src, PyBUF_FULL_RO) != 0) {
Martin v. Löwis423be952008-08-13 15:53:07 +0000568 PyBuffer_Release(&view_dest);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000569 return -1;
570 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000571
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000572 if (view_dest.len < view_src.len) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000573 PyErr_SetString(PyExc_BufferError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000574 "destination is too small to receive data from source");
Martin v. Löwis423be952008-08-13 15:53:07 +0000575 PyBuffer_Release(&view_dest);
576 PyBuffer_Release(&view_src);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000577 return -1;
578 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000579
Guido van Rossum98297ee2007-11-06 21:34:58 +0000580 if ((PyBuffer_IsContiguous(&view_dest, 'C') &&
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000581 PyBuffer_IsContiguous(&view_src, 'C')) ||
Guido van Rossum98297ee2007-11-06 21:34:58 +0000582 (PyBuffer_IsContiguous(&view_dest, 'F') &&
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000583 PyBuffer_IsContiguous(&view_src, 'F'))) {
584 /* simplest copy is all that is needed */
585 memcpy(view_dest.buf, view_src.buf, view_src.len);
Martin v. Löwis423be952008-08-13 15:53:07 +0000586 PyBuffer_Release(&view_dest);
587 PyBuffer_Release(&view_src);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000588 return 0;
589 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000590
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000591 /* Otherwise a more elaborate copy scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000592
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000593 /* XXX(nnorwitz): need to check for overflow! */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000594 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*view_src.ndim);
595 if (indices == NULL) {
596 PyErr_NoMemory();
Martin v. Löwis423be952008-08-13 15:53:07 +0000597 PyBuffer_Release(&view_dest);
598 PyBuffer_Release(&view_src);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000599 return -1;
600 }
601 for (k=0; k<view_src.ndim;k++) {
602 indices[k] = 0;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000603 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000604 elements = 1;
605 for (k=0; k<view_src.ndim; k++) {
Neal Norwitzfaa54a32007-08-19 04:23:20 +0000606 /* XXX(nnorwitz): can this overflow? */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000607 elements *= view_src.shape[k];
608 }
609 while (elements--) {
610 _add_one_to_index_C(view_src.ndim, indices, view_src.shape);
611 dptr = PyBuffer_GetPointer(&view_dest, indices);
612 sptr = PyBuffer_GetPointer(&view_src, indices);
613 memcpy(dptr, sptr, view_src.itemsize);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000614 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000615 PyMem_Free(indices);
Martin v. Löwis423be952008-08-13 15:53:07 +0000616 PyBuffer_Release(&view_dest);
617 PyBuffer_Release(&view_src);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000618 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000619}
620
621void
622PyBuffer_FillContiguousStrides(int nd, Py_ssize_t *shape,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000623 Py_ssize_t *strides, int itemsize,
624 char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000625{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000626 int k;
627 Py_ssize_t sd;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000628
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000629 sd = itemsize;
630 if (fort == 'F') {
631 for (k=0; k<nd; k++) {
632 strides[k] = sd;
633 sd *= shape[k];
Guido van Rossum98297ee2007-11-06 21:34:58 +0000634 }
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000635 }
636 else {
637 for (k=nd-1; k>=0; k--) {
638 strides[k] = sd;
639 sd *= shape[k];
640 }
641 }
642 return;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000643}
644
645int
Martin v. Löwis423be952008-08-13 15:53:07 +0000646PyBuffer_FillInfo(Py_buffer *view, PyObject *obj, void *buf, Py_ssize_t len,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000647 int readonly, int flags)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000648{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000649 if (view == NULL) return 0;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000650 if (((flags & PyBUF_WRITABLE) == PyBUF_WRITABLE) &&
651 (readonly == 1)) {
652 PyErr_SetString(PyExc_BufferError,
653 "Object is not writable.");
654 return -1;
655 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000656
Martin v. Löwis423be952008-08-13 15:53:07 +0000657 view->obj = obj;
Martin v. Löwis74bbea72008-08-14 20:32:30 +0000658 if (obj)
659 Py_INCREF(obj);
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000660 view->buf = buf;
661 view->len = len;
662 view->readonly = readonly;
663 view->itemsize = 1;
664 view->format = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000665 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT)
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +0000666 view->format = "B";
667 view->ndim = 1;
668 view->shape = NULL;
669 if ((flags & PyBUF_ND) == PyBUF_ND)
670 view->shape = &(view->len);
671 view->strides = NULL;
672 if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES)
673 view->strides = &(view->itemsize);
674 view->suboffsets = NULL;
675 view->internal = NULL;
676 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000677}
678
Martin v. Löwis423be952008-08-13 15:53:07 +0000679void
680PyBuffer_Release(Py_buffer *view)
681{
682 PyObject *obj = view->obj;
Martin v. Löwis74bbea72008-08-14 20:32:30 +0000683 if (obj && Py_TYPE(obj)->tp_as_buffer && Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer)
684 Py_TYPE(obj)->tp_as_buffer->bf_releasebuffer(obj, view);
685 Py_XDECREF(obj);
686 view->obj = NULL;
Martin v. Löwis423be952008-08-13 15:53:07 +0000687}
688
Eric Smith8fd3eba2008-02-17 19:48:00 +0000689PyObject *
690PyObject_Format(PyObject *obj, PyObject *format_spec)
691{
692 static PyObject * str__format__ = NULL;
693 PyObject *meth;
694 PyObject *empty = NULL;
695 PyObject *result = NULL;
696
697 /* Initialize cached value */
698 if (str__format__ == NULL) {
699 /* Initialize static variable needed by _PyType_Lookup */
700 str__format__ = PyUnicode_FromString("__format__");
701 if (str__format__ == NULL)
702 goto done;
703 }
704
705 /* If no format_spec is provided, use an empty string */
706 if (format_spec == NULL) {
707 empty = PyUnicode_FromUnicode(NULL, 0);
708 format_spec = empty;
709 }
710
711 /* Make sure the type is initialized. float gets initialized late */
712 if (Py_TYPE(obj)->tp_dict == NULL)
713 if (PyType_Ready(Py_TYPE(obj)) < 0)
714 goto done;
715
716 /* Find the (unbound!) __format__ method (a borrowed reference) */
717 meth = _PyType_Lookup(Py_TYPE(obj), str__format__);
718 if (meth == NULL) {
719 PyErr_Format(PyExc_TypeError,
720 "Type %.100s doesn't define __format__",
721 Py_TYPE(obj)->tp_name);
722 goto done;
723 }
724
725 /* And call it, binding it to the value */
726 result = PyObject_CallFunctionObjArgs(meth, obj, format_spec, NULL);
727
728 if (result && !PyUnicode_Check(result)) {
729 PyErr_SetString(PyExc_TypeError,
730 "__format__ method did not return string");
731 Py_DECREF(result);
732 result = NULL;
733 goto done;
734 }
735
736done:
737 Py_XDECREF(empty);
738 return result;
739}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000740/* Operations on numbers */
741
742int
Fred Drake79912472000-07-09 04:06:11 +0000743PyNumber_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +0000744{
Guido van Rossum6921eca2003-02-18 16:36:28 +0000745 return o && o->ob_type->tp_as_number &&
746 (o->ob_type->tp_as_number->nb_int ||
747 o->ob_type->tp_as_number->nb_float);
Guido van Rossume15dee51995-07-18 14:12:02 +0000748}
749
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000750/* Binary operators */
Guido van Rossume15dee51995-07-18 14:12:02 +0000751
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000752#define NB_SLOT(x) offsetof(PyNumberMethods, x)
753#define NB_BINOP(nb_methods, slot) \
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000754 (*(binaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000755#define NB_TERNOP(nb_methods, slot) \
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000756 (*(ternaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000757
758/*
759 Calling scheme used for binary operations:
760
Neal Norwitz4886cc32006-08-21 17:06:07 +0000761 Order operations are tried until either a valid result or error:
762 w.op(v,w)[*], v.op(v,w), w.op(v,w)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000763
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000764 [*] only when v->ob_type != w->ob_type && w->ob_type is a subclass of
765 v->ob_type
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000766 */
767
768static PyObject *
769binary_op1(PyObject *v, PyObject *w, const int op_slot)
Guido van Rossume15dee51995-07-18 14:12:02 +0000770{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000771 PyObject *x;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000772 binaryfunc slotv = NULL;
773 binaryfunc slotw = NULL;
774
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000775 if (v->ob_type->tp_as_number != NULL)
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000776 slotv = NB_BINOP(v->ob_type->tp_as_number, op_slot);
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000777 if (w->ob_type != v->ob_type &&
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000778 w->ob_type->tp_as_number != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000779 slotw = NB_BINOP(w->ob_type->tp_as_number, op_slot);
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000780 if (slotw == slotv)
781 slotw = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000782 }
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000783 if (slotv) {
Guido van Rossum89c42642001-10-01 17:10:18 +0000784 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
785 x = slotw(v, w);
786 if (x != Py_NotImplemented)
787 return x;
788 Py_DECREF(x); /* can't do it */
789 slotw = NULL;
790 }
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000791 x = slotv(v, w);
792 if (x != Py_NotImplemented)
793 return x;
794 Py_DECREF(x); /* can't do it */
795 }
796 if (slotw) {
797 x = slotw(v, w);
798 if (x != Py_NotImplemented)
799 return x;
800 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000801 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000802 Py_INCREF(Py_NotImplemented);
803 return Py_NotImplemented;
804}
Guido van Rossum77660912002-04-16 16:32:50 +0000805
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000806static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000807binop_type_error(PyObject *v, PyObject *w, const char *op_name)
808{
809 PyErr_Format(PyExc_TypeError,
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000810 "unsupported operand type(s) for %.100s: "
811 "'%.100s' and '%.100s'",
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000812 op_name,
813 v->ob_type->tp_name,
814 w->ob_type->tp_name);
815 return NULL;
816}
817
818static PyObject *
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000819binary_op(PyObject *v, PyObject *w, const int op_slot, const char *op_name)
820{
821 PyObject *result = binary_op1(v, w, op_slot);
822 if (result == Py_NotImplemented) {
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000823 Py_DECREF(result);
824 return binop_type_error(v, w, op_name);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000825 }
826 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000827}
828
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000829
830/*
831 Calling scheme used for ternary operations:
832
Neal Norwitz4886cc32006-08-21 17:06:07 +0000833 Order operations are tried until either a valid result or error:
834 v.op(v,w,z), w.op(v,w,z), z.op(v,w,z)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000835 */
836
837static PyObject *
838ternary_op(PyObject *v,
839 PyObject *w,
840 PyObject *z,
841 const int op_slot,
842 const char *op_name)
Guido van Rossume15dee51995-07-18 14:12:02 +0000843{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000844 PyNumberMethods *mv, *mw, *mz;
Guido van Rossum84675ac2001-09-29 01:05:03 +0000845 PyObject *x = NULL;
846 ternaryfunc slotv = NULL;
847 ternaryfunc slotw = NULL;
848 ternaryfunc slotz = NULL;
Guido van Rossum77660912002-04-16 16:32:50 +0000849
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000850 mv = v->ob_type->tp_as_number;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000851 mw = w->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000852 if (mv != NULL)
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000853 slotv = NB_TERNOP(mv, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000854 if (w->ob_type != v->ob_type &&
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000855 mw != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000856 slotw = NB_TERNOP(mw, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000857 if (slotw == slotv)
858 slotw = NULL;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000859 }
Guido van Rossum84675ac2001-09-29 01:05:03 +0000860 if (slotv) {
Guido van Rossum89c42642001-10-01 17:10:18 +0000861 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
862 x = slotw(v, w, z);
863 if (x != Py_NotImplemented)
864 return x;
865 Py_DECREF(x); /* can't do it */
866 slotw = NULL;
867 }
Guido van Rossum84675ac2001-09-29 01:05:03 +0000868 x = slotv(v, w, z);
869 if (x != Py_NotImplemented)
870 return x;
871 Py_DECREF(x); /* can't do it */
872 }
873 if (slotw) {
874 x = slotw(v, w, z);
875 if (x != Py_NotImplemented)
876 return x;
877 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000878 }
879 mz = z->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +0000880 if (mz != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +0000881 slotz = NB_TERNOP(mz, op_slot);
Guido van Rossum84675ac2001-09-29 01:05:03 +0000882 if (slotz == slotv || slotz == slotw)
883 slotz = NULL;
884 if (slotz) {
885 x = slotz(v, w, z);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000886 if (x != Py_NotImplemented)
887 return x;
Guido van Rossum84675ac2001-09-29 01:05:03 +0000888 Py_DECREF(x); /* can't do it */
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000889 }
890 }
891
Guido van Rossum5c66a262001-10-22 04:12:44 +0000892 if (z == Py_None)
893 PyErr_Format(
894 PyExc_TypeError,
895 "unsupported operand type(s) for ** or pow(): "
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000896 "'%.100s' and '%.100s'",
Guido van Rossum5c66a262001-10-22 04:12:44 +0000897 v->ob_type->tp_name,
898 w->ob_type->tp_name);
899 else
900 PyErr_Format(
901 PyExc_TypeError,
902 "unsupported operand type(s) for pow(): "
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000903 "'%.100s', '%.100s', '%.100s'",
Guido van Rossum5c66a262001-10-22 04:12:44 +0000904 v->ob_type->tp_name,
905 w->ob_type->tp_name,
906 z->ob_type->tp_name);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000907 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000908}
909
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000910#define BINARY_FUNC(func, op, op_name) \
911 PyObject * \
912 func(PyObject *v, PyObject *w) { \
913 return binary_op(v, w, NB_SLOT(op), op_name); \
914 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000915
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000916BINARY_FUNC(PyNumber_Or, nb_or, "|")
917BINARY_FUNC(PyNumber_Xor, nb_xor, "^")
918BINARY_FUNC(PyNumber_And, nb_and, "&")
919BINARY_FUNC(PyNumber_Lshift, nb_lshift, "<<")
920BINARY_FUNC(PyNumber_Rshift, nb_rshift, ">>")
921BINARY_FUNC(PyNumber_Subtract, nb_subtract, "-")
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000922BINARY_FUNC(PyNumber_Divmod, nb_divmod, "divmod()")
Guido van Rossume15dee51995-07-18 14:12:02 +0000923
924PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000925PyNumber_Add(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000926{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000927 PyObject *result = binary_op1(v, w, NB_SLOT(nb_add));
928 if (result == Py_NotImplemented) {
929 PySequenceMethods *m = v->ob_type->tp_as_sequence;
Armin Rigofd163f92005-12-29 15:59:19 +0000930 Py_DECREF(result);
Jeremy Hylton0522d982002-03-08 21:28:54 +0000931 if (m && m->sq_concat) {
Armin Rigofd163f92005-12-29 15:59:19 +0000932 return (*m->sq_concat)(v, w);
Jeremy Hylton0522d982002-03-08 21:28:54 +0000933 }
Armin Rigofd163f92005-12-29 15:59:19 +0000934 result = binop_type_error(v, w, "+");
Guido van Rossume15dee51995-07-18 14:12:02 +0000935 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000936 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000937}
938
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000939static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000940sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000941{
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000942 Py_ssize_t count;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000943 if (PyIndex_Check(n)) {
944 count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000945 if (count == -1 && PyErr_Occurred())
946 return NULL;
947 }
948 else {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000949 return type_error("can't multiply sequence by "
950 "non-int of type '%.200s'", n);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000951 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +0000952 return (*repeatfunc)(seq, count);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000953}
954
955PyObject *
956PyNumber_Multiply(PyObject *v, PyObject *w)
957{
958 PyObject *result = binary_op1(v, w, NB_SLOT(nb_multiply));
959 if (result == Py_NotImplemented) {
960 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
961 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
Guido van Rossuma3a243e2002-12-31 19:50:03 +0000962 Py_DECREF(result);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000963 if (mv && mv->sq_repeat) {
964 return sequence_repeat(mv->sq_repeat, v, w);
965 }
966 else if (mw && mw->sq_repeat) {
967 return sequence_repeat(mw->sq_repeat, w, v);
968 }
969 result = binop_type_error(v, w, "*");
970 }
971 return result;
972}
973
Guido van Rossume15dee51995-07-18 14:12:02 +0000974PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +0000975PyNumber_FloorDivide(PyObject *v, PyObject *w)
976{
Guido van Rossum4668b002001-08-08 05:00:18 +0000977 return binary_op(v, w, NB_SLOT(nb_floor_divide), "//");
978}
979
980PyObject *
981PyNumber_TrueDivide(PyObject *v, PyObject *w)
982{
Guido van Rossum4668b002001-08-08 05:00:18 +0000983 return binary_op(v, w, NB_SLOT(nb_true_divide), "/");
984}
985
986PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000987PyNumber_Remainder(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000988{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000989 return binary_op(v, w, NB_SLOT(nb_remainder), "%");
Guido van Rossume15dee51995-07-18 14:12:02 +0000990}
991
992PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000993PyNumber_Power(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossume15dee51995-07-18 14:12:02 +0000994{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000995 return ternary_op(v, w, z, NB_SLOT(nb_power), "** or pow()");
Guido van Rossume15dee51995-07-18 14:12:02 +0000996}
997
Thomas Wouterse289e0b2000-08-24 20:08:19 +0000998/* Binary in-place operators */
999
1000/* The in-place operators are defined to fall back to the 'normal',
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001001 non in-place operations, if the in-place methods are not in place.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001002
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001003 - If the left hand object has the appropriate struct members, and
1004 they are filled, call the appropriate function and return the
1005 result. No coercion is done on the arguments; the left-hand object
1006 is the one the operation is performed on, and it's up to the
1007 function to deal with the right-hand object.
Guido van Rossum77660912002-04-16 16:32:50 +00001008
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001009 - Otherwise, in-place modification is not supported. Handle it exactly as
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001010 a non in-place operation of the same kind.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001011
1012 */
1013
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001014static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001015binary_iop1(PyObject *v, PyObject *w, const int iop_slot, const int op_slot)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001016{
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001017 PyNumberMethods *mv = v->ob_type->tp_as_number;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001018 if (mv != NULL) {
Neil Schemenauerb808c5c2002-11-24 01:34:49 +00001019 binaryfunc slot = NB_BINOP(mv, iop_slot);
1020 if (slot) {
1021 PyObject *x = (slot)(v, w);
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001022 if (x != Py_NotImplemented) {
1023 return x;
1024 }
1025 Py_DECREF(x);
1026 }
Thomas Woutersf2b332d2000-09-02 08:34:40 +00001027 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001028 return binary_op1(v, w, op_slot);
1029}
1030
1031static PyObject *
1032binary_iop(PyObject *v, PyObject *w, const int iop_slot, const int op_slot,
1033 const char *op_name)
1034{
1035 PyObject *result = binary_iop1(v, w, iop_slot, op_slot);
1036 if (result == Py_NotImplemented) {
1037 Py_DECREF(result);
1038 return binop_type_error(v, w, op_name);
1039 }
1040 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001041}
1042
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001043#define INPLACE_BINOP(func, iop, op, op_name) \
1044 PyObject * \
1045 func(PyObject *v, PyObject *w) { \
1046 return binary_iop(v, w, NB_SLOT(iop), NB_SLOT(op), op_name); \
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001047 }
1048
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001049INPLACE_BINOP(PyNumber_InPlaceOr, nb_inplace_or, nb_or, "|=")
1050INPLACE_BINOP(PyNumber_InPlaceXor, nb_inplace_xor, nb_xor, "^=")
1051INPLACE_BINOP(PyNumber_InPlaceAnd, nb_inplace_and, nb_and, "&=")
1052INPLACE_BINOP(PyNumber_InPlaceLshift, nb_inplace_lshift, nb_lshift, "<<=")
1053INPLACE_BINOP(PyNumber_InPlaceRshift, nb_inplace_rshift, nb_rshift, ">>=")
1054INPLACE_BINOP(PyNumber_InPlaceSubtract, nb_inplace_subtract, nb_subtract, "-=")
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001055
1056PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001057PyNumber_InPlaceFloorDivide(PyObject *v, PyObject *w)
1058{
Guido van Rossum4668b002001-08-08 05:00:18 +00001059 return binary_iop(v, w, NB_SLOT(nb_inplace_floor_divide),
1060 NB_SLOT(nb_floor_divide), "//=");
1061}
1062
1063PyObject *
1064PyNumber_InPlaceTrueDivide(PyObject *v, PyObject *w)
1065{
Guido van Rossum4668b002001-08-08 05:00:18 +00001066 return binary_iop(v, w, NB_SLOT(nb_inplace_true_divide),
1067 NB_SLOT(nb_true_divide), "/=");
1068}
1069
1070PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001071PyNumber_InPlaceAdd(PyObject *v, PyObject *w)
1072{
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001073 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_add),
1074 NB_SLOT(nb_add));
1075 if (result == Py_NotImplemented) {
1076 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1077 Py_DECREF(result);
1078 if (m != NULL) {
1079 binaryfunc f = NULL;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001080 f = m->sq_inplace_concat;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001081 if (f == NULL)
1082 f = m->sq_concat;
1083 if (f != NULL)
1084 return (*f)(v, w);
1085 }
1086 result = binop_type_error(v, w, "+=");
Guido van Rossumbb8be932000-09-01 23:27:32 +00001087 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001088 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001089}
1090
1091PyObject *
1092PyNumber_InPlaceMultiply(PyObject *v, PyObject *w)
1093{
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001094 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_multiply),
1095 NB_SLOT(nb_multiply));
1096 if (result == Py_NotImplemented) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001097 ssizeargfunc f = NULL;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001098 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1099 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1100 Py_DECREF(result);
1101 if (mv != NULL) {
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001102 f = mv->sq_inplace_repeat;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001103 if (f == NULL)
1104 f = mv->sq_repeat;
1105 if (f != NULL)
1106 return sequence_repeat(f, v, w);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001107 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001108 else if (mw != NULL) {
1109 /* Note that the right hand operand should not be
1110 * mutated in this case so sq_inplace_repeat is not
1111 * used. */
1112 if (mw->sq_repeat)
1113 return sequence_repeat(mw->sq_repeat, w, v);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001114 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001115 result = binop_type_error(v, w, "*=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001116 }
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001117 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001118}
1119
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001120PyObject *
1121PyNumber_InPlaceRemainder(PyObject *v, PyObject *w)
1122{
Neil Schemenauerd46fbc32002-11-24 01:07:42 +00001123 return binary_iop(v, w, NB_SLOT(nb_inplace_remainder),
1124 NB_SLOT(nb_remainder), "%=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001125}
1126
1127PyObject *
1128PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
1129{
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001130 if (v->ob_type->tp_as_number &&
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001131 v->ob_type->tp_as_number->nb_inplace_power != NULL) {
1132 return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001133 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001134 else {
1135 return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
1136 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001137}
1138
1139
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001140/* Unary operators and functions */
Guido van Rossume15dee51995-07-18 14:12:02 +00001141
1142PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001143PyNumber_Negative(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001144{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001145 PyNumberMethods *m;
1146
1147 if (o == NULL)
1148 return null_error();
1149 m = o->ob_type->tp_as_number;
1150 if (m && m->nb_negative)
1151 return (*m->nb_negative)(o);
1152
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001153 return type_error("bad operand type for unary -: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001154}
1155
1156PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001157PyNumber_Positive(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001158{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001159 PyNumberMethods *m;
1160
1161 if (o == NULL)
1162 return null_error();
1163 m = o->ob_type->tp_as_number;
1164 if (m && m->nb_positive)
1165 return (*m->nb_positive)(o);
1166
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001167 return type_error("bad operand type for unary +: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001168}
1169
1170PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001171PyNumber_Invert(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001172{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001173 PyNumberMethods *m;
1174
1175 if (o == NULL)
1176 return null_error();
1177 m = o->ob_type->tp_as_number;
1178 if (m && m->nb_invert)
1179 return (*m->nb_invert)(o);
1180
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001181 return type_error("bad operand type for unary ~: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001182}
1183
1184PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001185PyNumber_Absolute(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001186{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001187 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001188
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001189 if (o == NULL)
1190 return null_error();
1191 m = o->ob_type->tp_as_number;
1192 if (m && m->nb_absolute)
1193 return m->nb_absolute(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001194
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001195 return type_error("bad operand type for abs(): '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001196}
1197
Guido van Rossum98297ee2007-11-06 21:34:58 +00001198/* Return a Python Int or Long from the object item
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001199 Raise TypeError if the result is not an int-or-long
Guido van Rossum98297ee2007-11-06 21:34:58 +00001200 or if the object cannot be interpreted as an index.
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001201*/
1202PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001203PyNumber_Index(PyObject *item)
1204{
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001205 PyObject *result = NULL;
1206 if (item == NULL)
1207 return null_error();
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001208 if (PyLong_Check(item)) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001209 Py_INCREF(item);
1210 return item;
1211 }
1212 if (PyIndex_Check(item)) {
Trent Nelson71792202008-04-11 23:02:37 +00001213 result = item->ob_type->tp_as_number->nb_index(item);
Neal Norwitz1fe5f382007-08-31 04:32:55 +00001214 if (result && !PyLong_Check(result)) {
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001215 PyErr_Format(PyExc_TypeError,
Guido van Rossum032a2842007-02-26 05:44:27 +00001216 "__index__ returned non-int "
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001217 "(type %.200s)",
1218 result->ob_type->tp_name);
1219 Py_DECREF(result);
1220 return NULL;
1221 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001222 }
Trent Nelson71792202008-04-11 23:02:37 +00001223 else {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001224 PyErr_Format(PyExc_TypeError,
1225 "'%.200s' object cannot be interpreted "
Guido van Rossum032a2842007-02-26 05:44:27 +00001226 "as an integer", item->ob_type->tp_name);
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001227 }
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001228 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001229}
1230
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001231/* Return an error on Overflow only if err is not NULL*/
1232
1233Py_ssize_t
1234PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1235{
1236 Py_ssize_t result;
1237 PyObject *runerr;
1238 PyObject *value = PyNumber_Index(item);
1239 if (value == NULL)
1240 return -1;
1241
Christian Heimes217cfd12007-12-02 14:31:20 +00001242 /* We're done if PyLong_AsSsize_t() returns without error. */
1243 result = PyLong_AsSsize_t(value);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001244 if (result != -1 || !(runerr = PyErr_Occurred()))
1245 goto finish;
1246
1247 /* Error handling code -- only manage OverflowError differently */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001248 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001249 goto finish;
1250
1251 PyErr_Clear();
Guido van Rossum98297ee2007-11-06 21:34:58 +00001252 /* If no error-handling desired then the default clipping
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001253 is sufficient.
1254 */
1255 if (!err) {
1256 assert(PyLong_Check(value));
Guido van Rossum98297ee2007-11-06 21:34:58 +00001257 /* Whether or not it is less than or equal to
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001258 zero is determined by the sign of ob_size
1259 */
Guido van Rossum98297ee2007-11-06 21:34:58 +00001260 if (_PyLong_Sign(value) < 0)
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001261 result = PY_SSIZE_T_MIN;
1262 else
1263 result = PY_SSIZE_T_MAX;
1264 }
1265 else {
1266 /* Otherwise replace the error with caller's error object. */
1267 PyErr_Format(err,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001268 "cannot fit '%.200s' into an index-sized integer",
1269 item->ob_type->tp_name);
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001270 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001271
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001272 finish:
1273 Py_DECREF(value);
1274 return result;
1275}
1276
1277
Christian Heimes15ebc882008-02-04 18:48:49 +00001278PyObject *
1279_PyNumber_ConvertIntegralToInt(PyObject *integral, const char* error_format)
1280{
1281 static PyObject *int_name = NULL;
1282 if (int_name == NULL) {
1283 int_name = PyUnicode_InternFromString("__int__");
1284 if (int_name == NULL)
1285 return NULL;
1286 }
1287
1288 if (integral && !PyLong_Check(integral)) {
1289 /* Don't go through tp_as_number->nb_int to avoid
1290 hitting the classic class fallback to __trunc__. */
1291 PyObject *int_func = PyObject_GetAttr(integral, int_name);
1292 if (int_func == NULL) {
1293 PyErr_Clear(); /* Raise a different error. */
1294 goto non_integral_error;
1295 }
1296 Py_DECREF(integral);
1297 integral = PyEval_CallObject(int_func, NULL);
1298 Py_DECREF(int_func);
1299 if (integral && !PyLong_Check(integral)) {
1300 goto non_integral_error;
1301 }
1302 }
1303 return integral;
1304
1305non_integral_error:
1306 PyErr_Format(PyExc_TypeError, error_format, Py_TYPE(integral)->tp_name);
1307 Py_DECREF(integral);
1308 return NULL;
1309}
1310
1311
Guido van Rossum9e896b32000-04-05 20:11:21 +00001312/* Add a check for embedded NULL-bytes in the argument. */
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001313static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001314long_from_string(const char *s, Py_ssize_t len)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001315{
Guido van Rossum4c08d552000-03-10 22:55:18 +00001316 char *end;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001317 PyObject *x;
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001318
Guido van Rossum4c08d552000-03-10 22:55:18 +00001319 x = PyLong_FromString((char*)s, &end, 10);
Guido van Rossum9e896b32000-04-05 20:11:21 +00001320 if (x == NULL)
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001321 return NULL;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001322 if (end != s + len) {
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001323 PyErr_SetString(PyExc_ValueError,
Guido van Rossumddefaf32007-01-14 03:31:43 +00001324 "null byte in argument for int()");
Guido van Rossum9e896b32000-04-05 20:11:21 +00001325 Py_DECREF(x);
Barry Warsaw226ae6c1999-10-12 19:54:53 +00001326 return NULL;
1327 }
1328 return x;
1329}
1330
Guido van Rossume15dee51995-07-18 14:12:02 +00001331PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001332PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001333{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001334 PyNumberMethods *m;
Christian Heimes15ebc882008-02-04 18:48:49 +00001335 static PyObject *trunc_name = NULL;
1336 PyObject *trunc_func;
Guido van Rossum4c08d552000-03-10 22:55:18 +00001337 const char *buffer;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001338 Py_ssize_t buffer_len;
Guido van Rossume15dee51995-07-18 14:12:02 +00001339
Christian Heimes15ebc882008-02-04 18:48:49 +00001340 if (trunc_name == NULL) {
1341 trunc_name = PyUnicode_InternFromString("__trunc__");
1342 if (trunc_name == NULL)
1343 return NULL;
1344 }
1345
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001346 if (o == NULL)
1347 return null_error();
Guido van Rossumddefaf32007-01-14 03:31:43 +00001348 if (PyLong_CheckExact(o)) {
1349 Py_INCREF(o);
1350 return o;
1351 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001352 m = o->ob_type->tp_as_number;
Guido van Rossumddefaf32007-01-14 03:31:43 +00001353 if (m && m->nb_int) { /* This should include subclasses of int */
1354 PyObject *res = m->nb_int(o);
1355 if (res && !PyLong_Check(res)) {
1356 PyErr_Format(PyExc_TypeError,
1357 "__int__ returned non-int (type %.200s)",
1358 res->ob_type->tp_name);
1359 Py_DECREF(res);
1360 return NULL;
1361 }
1362 return res;
1363 }
Mark Dickinsone5e298f2009-01-12 20:49:19 +00001364 if (PyLong_Check(o)) /* An int subclass without nb_int */
Tim Petersdb30ac42002-03-02 04:14:21 +00001365 return _PyLong_Copy((PyLongObject *)o);
Christian Heimes15ebc882008-02-04 18:48:49 +00001366 trunc_func = PyObject_GetAttr(o, trunc_name);
1367 if (trunc_func) {
1368 PyObject *truncated = PyEval_CallObject(trunc_func, NULL);
1369 PyObject *int_instance;
1370 Py_DECREF(trunc_func);
1371 /* __trunc__ is specified to return an Integral type,
1372 but long() needs to return a long. */
1373 int_instance = _PyNumber_ConvertIntegralToInt(
1374 truncated,
1375 "__trunc__ returned non-Integral (type %.200s)");
1376 return int_instance;
1377 }
1378 PyErr_Clear(); /* It's not an error if o.__trunc__ doesn't exist. */
1379
Christian Heimes72b710a2008-05-26 13:28:38 +00001380 if (PyBytes_Check(o))
Christian Heimes15ebc882008-02-04 18:48:49 +00001381 /* need to do extra error checking that PyLong_FromString()
1382 * doesn't do. In particular long('9.5') must raise an
1383 * exception, not truncate the float.
1384 */
Christian Heimes72b710a2008-05-26 13:28:38 +00001385 return long_from_string(PyBytes_AS_STRING(o),
1386 PyBytes_GET_SIZE(o));
Guido van Rossum9e896b32000-04-05 20:11:21 +00001387 if (PyUnicode_Check(o))
1388 /* The above check is done in PyLong_FromUnicode(). */
1389 return PyLong_FromUnicode(PyUnicode_AS_UNICODE(o),
1390 PyUnicode_GET_SIZE(o),
1391 10);
Guido van Rossum4c08d552000-03-10 22:55:18 +00001392 if (!PyObject_AsCharBuffer(o, &buffer, &buffer_len))
1393 return long_from_string(buffer, buffer_len);
Guido van Rossume15dee51995-07-18 14:12:02 +00001394
Guido van Rossumddefaf32007-01-14 03:31:43 +00001395 return type_error("int() argument must be a string or a "
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001396 "number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001397}
1398
1399PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001400PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001401{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001402 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001403
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001404 if (o == NULL)
1405 return null_error();
Brett Cannonc3647ac2005-04-26 03:45:26 +00001406 m = o->ob_type->tp_as_number;
1407 if (m && m->nb_float) { /* This should include subclasses of float */
1408 PyObject *res = m->nb_float(o);
1409 if (res && !PyFloat_Check(res)) {
1410 PyErr_Format(PyExc_TypeError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001411 "__float__ returned non-float (type %.200s)",
1412 res->ob_type->tp_name);
Brett Cannonc3647ac2005-04-26 03:45:26 +00001413 Py_DECREF(res);
1414 return NULL;
1415 }
1416 return res;
Guido van Rossum9e896b32000-04-05 20:11:21 +00001417 }
Brett Cannonc3647ac2005-04-26 03:45:26 +00001418 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
Tim Peters7a50f252001-09-10 21:28:20 +00001419 PyFloatObject *po = (PyFloatObject *)o;
1420 return PyFloat_FromDouble(po->ob_fval);
1421 }
Georg Brandl428f0642007-03-18 18:35:15 +00001422 return PyFloat_FromString(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001423}
1424
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001425
1426PyObject *
1427PyNumber_ToBase(PyObject *n, int base)
1428{
Christian Heimesa156e092008-02-16 07:38:31 +00001429 PyObject *res = NULL;
Raymond Hettinger5c960b82008-06-24 22:28:56 +00001430 PyObject *index = PyNumber_Index(n);
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001431
1432 if (!index)
1433 return NULL;
Christian Heimesa156e092008-02-16 07:38:31 +00001434 if (PyLong_Check(index))
1435 res = _PyLong_Format(index, base);
1436 else
1437 /* It should not be possible to get here, as
1438 PyNumber_Index already has a check for the same
1439 condition */
1440 PyErr_SetString(PyExc_ValueError, "PyNumber_ToBase: index not "
1441 "int or long");
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001442 Py_DECREF(index);
1443 return res;
1444}
1445
1446
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001447/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001448
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001449int
Fred Drake79912472000-07-09 04:06:11 +00001450PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001451{
Thomas Wouterscf297e42007-02-23 15:07:44 +00001452 if (PyObject_IsInstance(s, (PyObject *)&PyDict_Type))
1453 return 0;
Guido van Rossum8700b422001-09-07 20:20:11 +00001454 return s != NULL && s->ob_type->tp_as_sequence &&
1455 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001456}
1457
Martin v. Löwis18e16552006-02-15 17:27:45 +00001458Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001459PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001460{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001461 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001462
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001463 if (s == NULL) {
1464 null_error();
1465 return -1;
1466 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001467
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001468 m = s->ob_type->tp_as_sequence;
1469 if (m && m->sq_length)
1470 return m->sq_length(s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001471
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001472 type_error("object of type '%.200s' has no len()", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001473 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001474}
1475
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001476#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001477Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001478PySequence_Length(PyObject *s)
1479{
1480 return PySequence_Size(s);
1481}
1482#define PySequence_Length PySequence_Size
1483
Guido van Rossume15dee51995-07-18 14:12:02 +00001484PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001485PySequence_Concat(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001486{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001487 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001488
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001489 if (s == NULL || o == NULL)
1490 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001491
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001492 m = s->ob_type->tp_as_sequence;
1493 if (m && m->sq_concat)
1494 return m->sq_concat(s, o);
1495
Armin Rigofd163f92005-12-29 15:59:19 +00001496 /* Instances of user classes defining an __add__() method only
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001497 have an nb_add slot, not an sq_concat slot. So we fall back
Armin Rigofd163f92005-12-29 15:59:19 +00001498 to nb_add if both arguments appear to be sequences. */
1499 if (PySequence_Check(s) && PySequence_Check(o)) {
1500 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1501 if (result != Py_NotImplemented)
1502 return result;
1503 Py_DECREF(result);
1504 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001505 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001506}
1507
1508PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001509PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001510{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001511 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001512
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001513 if (o == NULL)
1514 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001515
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001516 m = o->ob_type->tp_as_sequence;
1517 if (m && m->sq_repeat)
1518 return m->sq_repeat(o, count);
1519
Armin Rigofd163f92005-12-29 15:59:19 +00001520 /* Instances of user classes defining a __mul__() method only
1521 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1522 to nb_multiply if o appears to be a sequence. */
1523 if (PySequence_Check(o)) {
1524 PyObject *n, *result;
Christian Heimes217cfd12007-12-02 14:31:20 +00001525 n = PyLong_FromSsize_t(count);
Armin Rigofd163f92005-12-29 15:59:19 +00001526 if (n == NULL)
1527 return NULL;
1528 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1529 Py_DECREF(n);
1530 if (result != Py_NotImplemented)
1531 return result;
1532 Py_DECREF(result);
1533 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001534 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001535}
1536
1537PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001538PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1539{
1540 PySequenceMethods *m;
1541
1542 if (s == NULL || o == NULL)
1543 return null_error();
1544
1545 m = s->ob_type->tp_as_sequence;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001546 if (m && m->sq_inplace_concat)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001547 return m->sq_inplace_concat(s, o);
1548 if (m && m->sq_concat)
1549 return m->sq_concat(s, o);
1550
Armin Rigofd163f92005-12-29 15:59:19 +00001551 if (PySequence_Check(s) && PySequence_Check(o)) {
1552 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1553 NB_SLOT(nb_add));
1554 if (result != Py_NotImplemented)
1555 return result;
1556 Py_DECREF(result);
1557 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001558 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001559}
1560
1561PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001562PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001563{
1564 PySequenceMethods *m;
1565
1566 if (o == NULL)
1567 return null_error();
1568
1569 m = o->ob_type->tp_as_sequence;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001570 if (m && m->sq_inplace_repeat)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001571 return m->sq_inplace_repeat(o, count);
1572 if (m && m->sq_repeat)
1573 return m->sq_repeat(o, count);
1574
Armin Rigofd163f92005-12-29 15:59:19 +00001575 if (PySequence_Check(o)) {
1576 PyObject *n, *result;
Christian Heimes217cfd12007-12-02 14:31:20 +00001577 n = PyLong_FromSsize_t(count);
Armin Rigofd163f92005-12-29 15:59:19 +00001578 if (n == NULL)
1579 return NULL;
1580 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1581 NB_SLOT(nb_multiply));
1582 Py_DECREF(n);
1583 if (result != Py_NotImplemented)
1584 return result;
1585 Py_DECREF(result);
1586 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001587 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001588}
1589
1590PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001591PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001592{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001593 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001594
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001595 if (s == NULL)
1596 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001597
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001598 m = s->ob_type->tp_as_sequence;
1599 if (m && m->sq_item) {
1600 if (i < 0) {
1601 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001602 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001603 if (l < 0)
1604 return NULL;
1605 i += l;
1606 }
1607 }
1608 return m->sq_item(s, i);
1609 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001610
Georg Brandl86b2fb92008-07-16 03:43:04 +00001611 return type_error("'%.200s' object does not support indexing", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001612}
1613
1614PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001615PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00001616{
Thomas Wouters1d75a792000-08-17 22:37:32 +00001617 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001618
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001619 if (!s) return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001620
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001621 mp = s->ob_type->tp_as_mapping;
1622 if (mp->mp_subscript) {
Thomas Wouters1d75a792000-08-17 22:37:32 +00001623 PyObject *res;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001624 PyObject *slice = _PySlice_FromIndices(i1, i2);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001625 if (!slice)
1626 return NULL;
1627 res = mp->mp_subscript(s, slice);
1628 Py_DECREF(slice);
1629 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001630 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001631
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001632 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001633}
1634
1635int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001636PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001637{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001638 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001639
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001640 if (s == NULL) {
1641 null_error();
1642 return -1;
1643 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001644
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001645 m = s->ob_type->tp_as_sequence;
1646 if (m && m->sq_ass_item) {
1647 if (i < 0) {
1648 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001649 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001650 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001651 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001652 i += l;
1653 }
1654 }
1655 return m->sq_ass_item(s, i, o);
1656 }
1657
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001658 type_error("'%.200s' object does not support item assignment", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001659 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001660}
1661
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001662int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001663PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001664{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001665 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001666
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001667 if (s == NULL) {
1668 null_error();
1669 return -1;
1670 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001671
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001672 m = s->ob_type->tp_as_sequence;
1673 if (m && m->sq_ass_item) {
1674 if (i < 0) {
1675 if (m->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001676 Py_ssize_t l = (*m->sq_length)(s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001677 if (l < 0)
Guido van Rossumed6219b1998-05-29 02:59:33 +00001678 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001679 i += l;
1680 }
1681 }
1682 return m->sq_ass_item(s, i, (PyObject *)NULL);
1683 }
1684
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001685 type_error("'%.200s' object doesn't support item deletion", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001686 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001687}
1688
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001689int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001690PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001691{
Thomas Wouters1d75a792000-08-17 22:37:32 +00001692 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001693
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001694 if (s == NULL) {
1695 null_error();
1696 return -1;
1697 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001698
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001699 mp = s->ob_type->tp_as_mapping;
1700 if (mp->mp_ass_subscript) {
Thomas Wouters1d75a792000-08-17 22:37:32 +00001701 int res;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001702 PyObject *slice = _PySlice_FromIndices(i1, i2);
Thomas Wouters1d75a792000-08-17 22:37:32 +00001703 if (!slice)
1704 return -1;
1705 res = mp->mp_ass_subscript(s, slice, o);
1706 Py_DECREF(slice);
1707 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001708 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00001709
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001710 type_error("'%.200s' object doesn't support slice assignment", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001711 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001712}
1713
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001714int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001715PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001716{
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001717 PyMappingMethods *mp;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001718
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001719 if (s == NULL) {
1720 null_error();
1721 return -1;
1722 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001723
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001724 mp = s->ob_type->tp_as_mapping;
1725 if (mp->mp_ass_subscript) {
1726 int res;
1727 PyObject *slice = _PySlice_FromIndices(i1, i2);
1728 if (!slice)
1729 return -1;
1730 res = mp->mp_ass_subscript(s, slice, NULL);
1731 Py_DECREF(slice);
1732 return res;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001733 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001734 type_error("'%.200s' object doesn't support slice deletion", s);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001735 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001736}
1737
Guido van Rossume15dee51995-07-18 14:12:02 +00001738PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001739PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00001740{
Tim Peters6912d4d2001-05-05 03:56:37 +00001741 PyObject *it; /* iter(v) */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001742 Py_ssize_t n; /* guess for result tuple size */
Raymond Hettingere8364232009-02-02 22:55:09 +00001743 PyObject *result = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001744 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00001745
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001746 if (v == NULL)
1747 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00001748
Tim Peters6912d4d2001-05-05 03:56:37 +00001749 /* Special-case the common tuple and list cases, for efficiency. */
Tim Peters4c3a0a32001-09-10 23:37:46 +00001750 if (PyTuple_CheckExact(v)) {
1751 /* Note that we can't know whether it's safe to return
1752 a tuple *subclass* instance as-is, hence the restriction
Tim Peters8ff70a92001-09-10 23:53:53 +00001753 to exact tuples here. In contrast, lists always make
1754 a copy, so there's no need for exactness below. */
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001755 Py_INCREF(v);
1756 return v;
Guido van Rossume15dee51995-07-18 14:12:02 +00001757 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001758 if (PyList_Check(v))
1759 return PyList_AsTuple(v);
1760
Tim Peters6912d4d2001-05-05 03:56:37 +00001761 /* Get iterator. */
1762 it = PyObject_GetIter(v);
1763 if (it == NULL)
Tim Peters1fc240e2001-10-26 05:06:50 +00001764 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001765
Tim Peters6912d4d2001-05-05 03:56:37 +00001766 /* Guess result size and allocate space. */
Christian Heimes255f53b2007-12-08 15:33:56 +00001767 n = _PyObject_LengthHint(v, 10);
Raymond Hettingere8364232009-02-02 22:55:09 +00001768 if (n == -1)
1769 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001770 result = PyTuple_New(n);
1771 if (result == NULL)
1772 goto Fail;
1773
1774 /* Fill the tuple. */
1775 for (j = 0; ; ++j) {
1776 PyObject *item = PyIter_Next(it);
1777 if (item == NULL) {
1778 if (PyErr_Occurred())
1779 goto Fail;
1780 break;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001781 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001782 if (j >= n) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001783 Py_ssize_t oldn = n;
Raymond Hettinger4d012592004-12-16 10:38:38 +00001784 /* The over-allocation strategy can grow a bit faster
Guido van Rossum98297ee2007-11-06 21:34:58 +00001785 than for lists because unlike lists the
Raymond Hettinger4d012592004-12-16 10:38:38 +00001786 over-allocation isn't permanent -- we reclaim
1787 the excess before the end of this routine.
1788 So, grow by ten and then add 25%.
1789 */
1790 n += 10;
1791 n += n >> 2;
1792 if (n < oldn) {
1793 /* Check for overflow */
1794 PyErr_NoMemory();
Raymond Hettingere6bdb372004-12-16 15:10:21 +00001795 Py_DECREF(item);
Guido van Rossum98297ee2007-11-06 21:34:58 +00001796 goto Fail;
Raymond Hettinger4d012592004-12-16 10:38:38 +00001797 }
Tim Peters4324aa32001-05-28 22:30:08 +00001798 if (_PyTuple_Resize(&result, n) != 0) {
Tim Peters12d0a6c2001-05-05 04:10:25 +00001799 Py_DECREF(item);
Tim Peters6912d4d2001-05-05 03:56:37 +00001800 goto Fail;
Tim Peters12d0a6c2001-05-05 04:10:25 +00001801 }
Tim Peters6912d4d2001-05-05 03:56:37 +00001802 }
1803 PyTuple_SET_ITEM(result, j, item);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001804 }
1805
Tim Peters6912d4d2001-05-05 03:56:37 +00001806 /* Cut tuple back if guess was too large. */
1807 if (j < n &&
Tim Peters4324aa32001-05-28 22:30:08 +00001808 _PyTuple_Resize(&result, j) != 0)
Tim Peters6912d4d2001-05-05 03:56:37 +00001809 goto Fail;
1810
1811 Py_DECREF(it);
1812 return result;
1813
1814Fail:
1815 Py_XDECREF(result);
1816 Py_DECREF(it);
1817 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001818}
1819
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001820PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001821PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001822{
Tim Petersf553f892001-05-01 20:45:31 +00001823 PyObject *result; /* result list */
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001824 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00001825
Guido van Rossum5dba9e81998-07-10 18:03:50 +00001826 if (v == NULL)
1827 return null_error();
1828
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +00001829 result = PyList_New(0);
1830 if (result == NULL)
Tim Petersf553f892001-05-01 20:45:31 +00001831 return NULL;
1832
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +00001833 rv = _PyList_Extend((PyListObject *)result, v);
1834 if (rv == NULL) {
1835 Py_DECREF(result);
Tim Petersf553f892001-05-01 20:45:31 +00001836 return NULL;
1837 }
Raymond Hettinger969d8c02004-03-17 05:24:23 +00001838 Py_DECREF(rv);
Tim Petersf553f892001-05-01 20:45:31 +00001839 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001840}
1841
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001842PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001843PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001844{
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001845 PyObject *it;
1846
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001847 if (v == NULL)
1848 return null_error();
1849
Michael W. Hudson2801fe12002-11-05 18:05:49 +00001850 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001851 Py_INCREF(v);
1852 return v;
1853 }
1854
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001855 it = PyObject_GetIter(v);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001856 if (it == NULL) {
1857 if (PyErr_ExceptionMatches(PyExc_TypeError))
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001858 PyErr_SetString(PyExc_TypeError, m);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001859 return NULL;
1860 }
1861
Raymond Hettinger193814c2004-12-18 19:00:59 +00001862 v = PySequence_List(it);
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001863 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001864
1865 return v;
1866}
1867
Tim Peters16a77ad2001-09-08 04:00:12 +00001868/* Iterate over seq. Result depends on the operation:
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001869 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
Mark Dickinson934896d2009-02-21 20:59:32 +00001870 PY_ITERSEARCH_INDEX: 0-based index of first occurrence of obj in seq;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001871 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00001872 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
1873*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001874Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001875_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00001876{
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001877 Py_ssize_t n;
Tim Peters16a77ad2001-09-08 04:00:12 +00001878 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
1879 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00001880
Tim Peters16a77ad2001-09-08 04:00:12 +00001881 if (seq == NULL || obj == NULL) {
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001882 null_error();
1883 return -1;
1884 }
Tim Peters75f8e352001-05-05 11:33:43 +00001885
Tim Peters16a77ad2001-09-08 04:00:12 +00001886 it = PyObject_GetIter(seq);
Tim Peters75f8e352001-05-05 11:33:43 +00001887 if (it == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001888 type_error("argument of type '%.200s' is not iterable", seq);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001889 return -1;
Tim Peters75f8e352001-05-05 11:33:43 +00001890 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001891
Tim Peters16a77ad2001-09-08 04:00:12 +00001892 n = wrapped = 0;
Tim Peters75f8e352001-05-05 11:33:43 +00001893 for (;;) {
1894 int cmp;
1895 PyObject *item = PyIter_Next(it);
1896 if (item == NULL) {
1897 if (PyErr_Occurred())
1898 goto Fail;
1899 break;
1900 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001901
1902 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001903 Py_DECREF(item);
Tim Peters75f8e352001-05-05 11:33:43 +00001904 if (cmp < 0)
1905 goto Fail;
1906 if (cmp > 0) {
Tim Peters16a77ad2001-09-08 04:00:12 +00001907 switch (operation) {
1908 case PY_ITERSEARCH_COUNT:
Thomas Wouters89f507f2006-12-13 04:49:30 +00001909 if (n == PY_SSIZE_T_MAX) {
Tim Peters16a77ad2001-09-08 04:00:12 +00001910 PyErr_SetString(PyExc_OverflowError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00001911 "count exceeds C integer size");
Tim Peters16a77ad2001-09-08 04:00:12 +00001912 goto Fail;
1913 }
Thomas Wouters89f507f2006-12-13 04:49:30 +00001914 ++n;
Tim Peters16a77ad2001-09-08 04:00:12 +00001915 break;
1916
1917 case PY_ITERSEARCH_INDEX:
1918 if (wrapped) {
1919 PyErr_SetString(PyExc_OverflowError,
Thomas Wouters89f507f2006-12-13 04:49:30 +00001920 "index exceeds C integer size");
Tim Peters16a77ad2001-09-08 04:00:12 +00001921 goto Fail;
1922 }
1923 goto Done;
1924
1925 case PY_ITERSEARCH_CONTAINS:
1926 n = 1;
1927 goto Done;
1928
1929 default:
1930 assert(!"unknown operation");
Tim Peters75f8e352001-05-05 11:33:43 +00001931 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001932 }
1933
1934 if (operation == PY_ITERSEARCH_INDEX) {
Thomas Wouters89f507f2006-12-13 04:49:30 +00001935 if (n == PY_SSIZE_T_MAX)
Tim Peters16a77ad2001-09-08 04:00:12 +00001936 wrapped = 1;
Thomas Wouters89f507f2006-12-13 04:49:30 +00001937 ++n;
Tim Peters75f8e352001-05-05 11:33:43 +00001938 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001939 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001940
1941 if (operation != PY_ITERSEARCH_INDEX)
1942 goto Done;
1943
1944 PyErr_SetString(PyExc_ValueError,
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001945 "sequence.index(x): x not in sequence");
Tim Peters16a77ad2001-09-08 04:00:12 +00001946 /* fall into failure code */
1947Fail:
1948 n = -1;
1949 /* fall through */
1950Done:
Tim Peters75f8e352001-05-05 11:33:43 +00001951 Py_DECREF(it);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001952 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00001953
Guido van Rossume15dee51995-07-18 14:12:02 +00001954}
1955
Tim Peters16a77ad2001-09-08 04:00:12 +00001956/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001957Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001958PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001959{
Tim Peters16a77ad2001-09-08 04:00:12 +00001960 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00001961}
1962
Tim Peterscb8d3682001-05-05 21:05:01 +00001963/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00001964 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00001965 */
1966int
1967PySequence_Contains(PyObject *seq, PyObject *ob)
1968{
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001969 Py_ssize_t result;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001970 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001971 if (sqm != NULL && sqm->sq_contains != NULL)
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00001972 return (*sqm->sq_contains)(seq, ob);
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001973 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
1974 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00001975}
1976
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001977/* Backwards compatibility */
1978#undef PySequence_In
1979int
Fred Drake79912472000-07-09 04:06:11 +00001980PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001981{
1982 return PySequence_Contains(w, v);
1983}
1984
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001985Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00001986PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001987{
Tim Peters16a77ad2001-09-08 04:00:12 +00001988 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00001989}
1990
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001991/* Operations on mappings */
1992
1993int
Fred Drake79912472000-07-09 04:06:11 +00001994PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001995{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00001996 return o && o->ob_type->tp_as_mapping &&
Thomas Woutersd2cf20e2007-08-30 22:57:53 +00001997 o->ob_type->tp_as_mapping->mp_subscript;
Guido van Rossume15dee51995-07-18 14:12:02 +00001998}
1999
Martin v. Löwis18e16552006-02-15 17:27:45 +00002000Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00002001PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002002{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002003 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00002004
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002005 if (o == NULL) {
2006 null_error();
2007 return -1;
2008 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002009
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002010 m = o->ob_type->tp_as_mapping;
2011 if (m && m->mp_length)
2012 return m->mp_length(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00002013
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002014 type_error("object of type '%.200s' has no len()", o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002015 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00002016}
2017
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002018#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00002019Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002020PyMapping_Length(PyObject *o)
2021{
2022 return PyMapping_Size(o);
2023}
2024#define PyMapping_Length PyMapping_Size
2025
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002026PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002027PyMapping_GetItemString(PyObject *o, char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002028{
2029 PyObject *okey, *r;
2030
2031 if (key == NULL)
2032 return null_error();
2033
Martin v. Löwis5b222132007-06-10 09:51:05 +00002034 okey = PyUnicode_FromString(key);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002035 if (okey == NULL)
2036 return NULL;
2037 r = PyObject_GetItem(o, okey);
2038 Py_DECREF(okey);
2039 return r;
2040}
2041
2042int
Fred Drake79912472000-07-09 04:06:11 +00002043PyMapping_SetItemString(PyObject *o, char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002044{
2045 PyObject *okey;
2046 int r;
2047
2048 if (key == NULL) {
2049 null_error();
2050 return -1;
2051 }
2052
Martin v. Löwis5b222132007-06-10 09:51:05 +00002053 okey = PyUnicode_FromString(key);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002054 if (okey == NULL)
Guido van Rossumed6219b1998-05-29 02:59:33 +00002055 return -1;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002056 r = PyObject_SetItem(o, okey, value);
2057 Py_DECREF(okey);
2058 return r;
2059}
2060
2061int
Fred Drake79912472000-07-09 04:06:11 +00002062PyMapping_HasKeyString(PyObject *o, char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002063{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002064 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002065
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002066 v = PyMapping_GetItemString(o, key);
2067 if (v) {
2068 Py_DECREF(v);
2069 return 1;
2070 }
2071 PyErr_Clear();
2072 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002073}
2074
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002075int
Fred Drake79912472000-07-09 04:06:11 +00002076PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002077{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002078 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002079
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002080 v = PyObject_GetItem(o, key);
2081 if (v) {
2082 Py_DECREF(v);
2083 return 1;
2084 }
2085 PyErr_Clear();
2086 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002087}
2088
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002089PyObject *
2090PyMapping_Keys(PyObject *o)
2091{
2092 PyObject *keys;
2093 PyObject *fast;
2094
2095 if (PyDict_CheckExact(o))
2096 return PyDict_Keys(o);
2097 keys = PyObject_CallMethod(o, "keys", NULL);
2098 if (keys == NULL)
2099 return NULL;
2100 fast = PySequence_Fast(keys, "o.keys() are not iterable");
2101 Py_DECREF(keys);
2102 return fast;
2103}
2104
2105PyObject *
2106PyMapping_Items(PyObject *o)
2107{
2108 PyObject *items;
2109 PyObject *fast;
2110
2111 if (PyDict_CheckExact(o))
2112 return PyDict_Items(o);
2113 items = PyObject_CallMethod(o, "items", NULL);
2114 if (items == NULL)
2115 return NULL;
2116 fast = PySequence_Fast(items, "o.items() are not iterable");
2117 Py_DECREF(items);
2118 return fast;
2119}
2120
2121PyObject *
2122PyMapping_Values(PyObject *o)
2123{
2124 PyObject *values;
2125 PyObject *fast;
2126
2127 if (PyDict_CheckExact(o))
2128 return PyDict_Values(o);
2129 values = PyObject_CallMethod(o, "values", NULL);
2130 if (values == NULL)
2131 return NULL;
2132 fast = PySequence_Fast(values, "o.values() are not iterable");
2133 Py_DECREF(values);
2134 return fast;
2135}
2136
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002137/* Operations on callable objects */
2138
2139/* XXX PyCallable_Check() is in object.c */
2140
Guido van Rossume15dee51995-07-18 14:12:02 +00002141PyObject *
Fred Drake79912472000-07-09 04:06:11 +00002142PyObject_CallObject(PyObject *o, PyObject *a)
Guido van Rossume15dee51995-07-18 14:12:02 +00002143{
Guido van Rossum5560b742001-09-14 16:47:50 +00002144 return PyEval_CallObjectWithKeywords(o, a, NULL);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002145}
Guido van Rossume15dee51995-07-18 14:12:02 +00002146
2147PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002148PyObject_Call(PyObject *func, PyObject *arg, PyObject *kw)
2149{
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002150 ternaryfunc call;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002151
2152 if ((call = func->ob_type->tp_call) != NULL) {
Thomas Wouters89d996e2007-09-08 17:39:28 +00002153 PyObject *result;
2154 if (Py_EnterRecursiveCall(" while calling a Python object"))
2155 return NULL;
2156 result = (*call)(func, arg, kw);
2157 Py_LeaveRecursiveCall();
Tim Peters6d6c1a32001-08-02 04:15:00 +00002158 if (result == NULL && !PyErr_Occurred())
2159 PyErr_SetString(
2160 PyExc_SystemError,
2161 "NULL result without error in PyObject_Call");
2162 return result;
2163 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002164 PyErr_Format(PyExc_TypeError, "'%.200s' object is not callable",
Fred Drake573395a2001-11-01 20:26:12 +00002165 func->ob_type->tp_name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002166 return NULL;
2167}
2168
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002169static PyObject*
2170call_function_tail(PyObject *callable, PyObject *args)
2171{
2172 PyObject *retval;
2173
2174 if (args == NULL)
2175 return NULL;
2176
2177 if (!PyTuple_Check(args)) {
2178 PyObject *a;
2179
2180 a = PyTuple_New(1);
2181 if (a == NULL) {
2182 Py_DECREF(args);
2183 return NULL;
2184 }
2185 PyTuple_SET_ITEM(a, 0, args);
2186 args = a;
2187 }
2188 retval = PyObject_Call(callable, args, NULL);
2189
2190 Py_DECREF(args);
2191
2192 return retval;
2193}
2194
Tim Peters6d6c1a32001-08-02 04:15:00 +00002195PyObject *
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002196PyObject_CallFunction(PyObject *callable, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002197{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002198 va_list va;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002199 PyObject *args;
Guido van Rossume15dee51995-07-18 14:12:02 +00002200
Fred Drakeb92cf062001-10-27 06:16:31 +00002201 if (callable == NULL)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002202 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002203
Fred Drakeb92cf062001-10-27 06:16:31 +00002204 if (format && *format) {
2205 va_start(va, format);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002206 args = Py_VaBuildValue(format, va);
Fred Drakeb92cf062001-10-27 06:16:31 +00002207 va_end(va);
2208 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002209 else
2210 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002211
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002212 return call_function_tail(callable, args);
2213}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002214
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002215PyObject *
2216_PyObject_CallFunction_SizeT(PyObject *callable, char *format, ...)
2217{
2218 va_list va;
2219 PyObject *args;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002220
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002221 if (callable == NULL)
2222 return null_error();
2223
2224 if (format && *format) {
2225 va_start(va, format);
2226 args = _Py_VaBuildValue_SizeT(format, va);
2227 va_end(va);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002228 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002229 else
2230 args = PyTuple_New(0);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002231
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002232 return call_function_tail(callable, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002233}
2234
2235PyObject *
Guido van Rossume15dee51995-07-18 14:12:02 +00002236PyObject_CallMethod(PyObject *o, char *name, char *format, ...)
Guido van Rossume15dee51995-07-18 14:12:02 +00002237{
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002238 va_list va;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002239 PyObject *args;
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002240 PyObject *func = NULL;
2241 PyObject *retval = NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00002242
Fred Drakeb92cf062001-10-27 06:16:31 +00002243 if (o == NULL || name == NULL)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002244 return null_error();
Guido van Rossume15dee51995-07-18 14:12:02 +00002245
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002246 func = PyObject_GetAttrString(o, name);
2247 if (func == NULL) {
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002248 PyErr_SetString(PyExc_AttributeError, name);
2249 return 0;
2250 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002251
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002252 if (!PyCallable_Check(func)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002253 type_error("attribute of type '%.200s' is not callable", func);
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002254 goto exit;
2255 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002256
Fred Drakeb92cf062001-10-27 06:16:31 +00002257 if (format && *format) {
2258 va_start(va, format);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002259 args = Py_VaBuildValue(format, va);
Fred Drakeb92cf062001-10-27 06:16:31 +00002260 va_end(va);
2261 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002262 else
2263 args = PyTuple_New(0);
Guido van Rossume15dee51995-07-18 14:12:02 +00002264
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002265 retval = call_function_tail(func, args);
Guido van Rossume15dee51995-07-18 14:12:02 +00002266
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002267 exit:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002268 /* args gets consumed in call_function_tail */
2269 Py_XDECREF(func);
2270
2271 return retval;
2272}
2273
2274PyObject *
2275_PyObject_CallMethod_SizeT(PyObject *o, char *name, char *format, ...)
2276{
2277 va_list va;
2278 PyObject *args;
2279 PyObject *func = NULL;
2280 PyObject *retval = NULL;
2281
2282 if (o == NULL || name == NULL)
2283 return null_error();
2284
2285 func = PyObject_GetAttrString(o, name);
2286 if (func == NULL) {
2287 PyErr_SetString(PyExc_AttributeError, name);
2288 return 0;
2289 }
2290
2291 if (!PyCallable_Check(func)) {
Guido van Rossum98297ee2007-11-06 21:34:58 +00002292 type_error("attribute of type '%.200s' is not callable", func);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002293 goto exit;
2294 }
2295
2296 if (format && *format) {
2297 va_start(va, format);
2298 args = _Py_VaBuildValue_SizeT(format, va);
2299 va_end(va);
2300 }
2301 else
2302 args = PyTuple_New(0);
2303
2304 retval = call_function_tail(func, args);
2305
2306 exit:
2307 /* args gets consumed in call_function_tail */
Michael W. Hudson0edc7a02005-07-12 10:21:19 +00002308 Py_XDECREF(func);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002309
2310 return retval;
Guido van Rossume15dee51995-07-18 14:12:02 +00002311}
Guido van Rossum823649d2001-03-21 18:40:58 +00002312
2313
Fred Drakeb421b8c2001-10-26 16:21:32 +00002314static PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002315objargs_mktuple(va_list va)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002316{
2317 int i, n = 0;
2318 va_list countva;
2319 PyObject *result, *tmp;
2320
2321#ifdef VA_LIST_IS_ARRAY
2322 memcpy(countva, va, sizeof(va_list));
2323#else
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002324#ifdef __va_copy
2325 __va_copy(countva, va);
2326#else
Fred Drakeb421b8c2001-10-26 16:21:32 +00002327 countva = va;
2328#endif
Martin v. Löwis75d2d942002-07-28 10:23:27 +00002329#endif
Fred Drakeb421b8c2001-10-26 16:21:32 +00002330
2331 while (((PyObject *)va_arg(countva, PyObject *)) != NULL)
2332 ++n;
2333 result = PyTuple_New(n);
2334 if (result != NULL && n > 0) {
2335 for (i = 0; i < n; ++i) {
2336 tmp = (PyObject *)va_arg(va, PyObject *);
2337 PyTuple_SET_ITEM(result, i, tmp);
2338 Py_INCREF(tmp);
2339 }
2340 }
2341 return result;
2342}
2343
2344PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002345PyObject_CallMethodObjArgs(PyObject *callable, PyObject *name, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002346{
2347 PyObject *args, *tmp;
2348 va_list vargs;
2349
2350 if (callable == NULL || name == NULL)
2351 return null_error();
2352
2353 callable = PyObject_GetAttr(callable, name);
2354 if (callable == NULL)
2355 return NULL;
2356
2357 /* count the args */
2358 va_start(vargs, name);
Fred Drakeb0c079e2001-10-28 02:39:03 +00002359 args = objargs_mktuple(vargs);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002360 va_end(vargs);
2361 if (args == NULL) {
2362 Py_DECREF(callable);
2363 return NULL;
2364 }
2365 tmp = PyObject_Call(callable, args, NULL);
2366 Py_DECREF(args);
2367 Py_DECREF(callable);
2368
2369 return tmp;
2370}
2371
2372PyObject *
Fred Drakeb0c079e2001-10-28 02:39:03 +00002373PyObject_CallFunctionObjArgs(PyObject *callable, ...)
Fred Drakeb421b8c2001-10-26 16:21:32 +00002374{
2375 PyObject *args, *tmp;
2376 va_list vargs;
2377
2378 if (callable == NULL)
2379 return null_error();
2380
2381 /* count the args */
2382 va_start(vargs, callable);
Fred Drakeb0c079e2001-10-28 02:39:03 +00002383 args = objargs_mktuple(vargs);
Fred Drakeb421b8c2001-10-26 16:21:32 +00002384 va_end(vargs);
2385 if (args == NULL)
2386 return NULL;
2387 tmp = PyObject_Call(callable, args, NULL);
2388 Py_DECREF(args);
2389
2390 return tmp;
2391}
2392
2393
Guido van Rossum823649d2001-03-21 18:40:58 +00002394/* isinstance(), issubclass() */
2395
Barry Warsawf16951c2002-04-23 22:45:44 +00002396/* abstract_get_bases() has logically 4 return states, with a sort of 0th
2397 * state that will almost never happen.
2398 *
2399 * 0. creating the __bases__ static string could get a MemoryError
2400 * 1. getattr(cls, '__bases__') could raise an AttributeError
2401 * 2. getattr(cls, '__bases__') could raise some other exception
2402 * 3. getattr(cls, '__bases__') could return a tuple
2403 * 4. getattr(cls, '__bases__') could return something other than a tuple
2404 *
2405 * Only state #3 is a non-error state and only it returns a non-NULL object
2406 * (it returns the retrieved tuple).
2407 *
2408 * Any raised AttributeErrors are masked by clearing the exception and
2409 * returning NULL. If an object other than a tuple comes out of __bases__,
2410 * then again, the return value is NULL. So yes, these two situations
2411 * produce exactly the same results: NULL is returned and no error is set.
2412 *
2413 * If some exception other than AttributeError is raised, then NULL is also
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002414 * returned, but the exception is not cleared. That's because we want the
Barry Warsawf16951c2002-04-23 22:45:44 +00002415 * exception to be propagated along.
2416 *
2417 * Callers are expected to test for PyErr_Occurred() when the return value
2418 * is NULL to decide whether a valid exception should be propagated or not.
2419 * When there's no exception to propagate, it's customary for the caller to
2420 * set a TypeError.
2421 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002422static PyObject *
2423abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002424{
2425 static PyObject *__bases__ = NULL;
2426 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002427
2428 if (__bases__ == NULL) {
Christian Heimesfe82e772008-01-28 02:38:20 +00002429 __bases__ = PyUnicode_InternFromString("__bases__");
Guido van Rossum823649d2001-03-21 18:40:58 +00002430 if (__bases__ == NULL)
Neil Schemenauer6b471292001-10-18 03:18:43 +00002431 return NULL;
Guido van Rossum823649d2001-03-21 18:40:58 +00002432 }
Martin v. Löwis5b222132007-06-10 09:51:05 +00002433 Py_ALLOW_RECURSION
Neil Schemenauer6b471292001-10-18 03:18:43 +00002434 bases = PyObject_GetAttr(cls, __bases__);
Martin v. Löwis5b222132007-06-10 09:51:05 +00002435 Py_END_ALLOW_RECURSION
Barry Warsawf16951c2002-04-23 22:45:44 +00002436 if (bases == NULL) {
2437 if (PyErr_ExceptionMatches(PyExc_AttributeError))
2438 PyErr_Clear();
Neil Schemenauer6b471292001-10-18 03:18:43 +00002439 return NULL;
Guido van Rossum823649d2001-03-21 18:40:58 +00002440 }
Barry Warsawf16951c2002-04-23 22:45:44 +00002441 if (!PyTuple_Check(bases)) {
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002442 Py_DECREF(bases);
Barry Warsawf16951c2002-04-23 22:45:44 +00002443 return NULL;
2444 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002445 return bases;
2446}
2447
2448
2449static int
2450abstract_issubclass(PyObject *derived, PyObject *cls)
2451{
Antoine Pitrouec569b72008-08-26 22:40:48 +00002452 PyObject *bases = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002453 Py_ssize_t i, n;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002454 int r = 0;
2455
Antoine Pitrouec569b72008-08-26 22:40:48 +00002456 while (1) {
2457 if (derived == cls)
2458 return 1;
2459 bases = abstract_get_bases(derived);
2460 if (bases == NULL) {
2461 if (PyErr_Occurred())
2462 return -1;
2463 return 0;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002464 }
Antoine Pitrouec569b72008-08-26 22:40:48 +00002465 n = PyTuple_GET_SIZE(bases);
2466 if (n == 0) {
2467 Py_DECREF(bases);
2468 return 0;
2469 }
2470 /* Avoid recursivity in the single inheritance case */
2471 if (n == 1) {
2472 derived = PyTuple_GET_ITEM(bases, 0);
2473 Py_DECREF(bases);
2474 continue;
2475 }
2476 for (i = 0; i < n; i++) {
2477 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
2478 if (r != 0)
2479 break;
2480 }
2481 Py_DECREF(bases);
2482 return r;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002483 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002484}
2485
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002486static int
2487check_class(PyObject *cls, const char *error)
2488{
2489 PyObject *bases = abstract_get_bases(cls);
2490 if (bases == NULL) {
2491 /* Do not mask errors. */
2492 if (!PyErr_Occurred())
2493 PyErr_SetString(PyExc_TypeError, error);
2494 return 0;
2495 }
2496 Py_DECREF(bases);
2497 return -1;
2498}
2499
Brett Cannon4f653312004-03-20 22:52:14 +00002500static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002501recursive_isinstance(PyObject *inst, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002502{
2503 PyObject *icls;
2504 static PyObject *__class__ = NULL;
2505 int retval = 0;
2506
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002507 if (__class__ == NULL) {
Christian Heimesfe82e772008-01-28 02:38:20 +00002508 __class__ = PyUnicode_InternFromString("__class__");
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002509 if (__class__ == NULL)
2510 return -1;
2511 }
2512
Guido van Rossum45aecf42006-03-15 04:58:47 +00002513 if (PyType_Check(cls)) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00002514 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002515 if (retval == 0) {
2516 PyObject *c = PyObject_GetAttr(inst, __class__);
2517 if (c == NULL) {
2518 PyErr_Clear();
2519 }
2520 else {
Guido van Rossume5b130b2003-02-12 03:36:05 +00002521 if (c != (PyObject *)(inst->ob_type) &&
2522 PyType_Check(c))
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002523 retval = PyType_IsSubtype(
2524 (PyTypeObject *)c,
2525 (PyTypeObject *)cls);
2526 Py_DECREF(c);
2527 }
2528 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002529 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002530 else {
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002531 if (!check_class(cls,
2532 "isinstance() arg 2 must be a class, type,"
2533 " or tuple of classes and types"))
Neil Schemenauer6b471292001-10-18 03:18:43 +00002534 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002535 icls = PyObject_GetAttr(inst, __class__);
Neil Schemenauer6b471292001-10-18 03:18:43 +00002536 if (icls == NULL) {
2537 PyErr_Clear();
2538 retval = 0;
Guido van Rossum823649d2001-03-21 18:40:58 +00002539 }
Neil Schemenauer6b471292001-10-18 03:18:43 +00002540 else {
2541 retval = abstract_issubclass(icls, cls);
2542 Py_DECREF(icls);
2543 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002544 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002545
Guido van Rossum823649d2001-03-21 18:40:58 +00002546 return retval;
2547}
2548
2549int
Brett Cannon4f653312004-03-20 22:52:14 +00002550PyObject_IsInstance(PyObject *inst, PyObject *cls)
2551{
Christian Heimesa156e092008-02-16 07:38:31 +00002552 static PyObject *name = NULL;
Guido van Rossume7ba4952007-06-06 23:52:48 +00002553 PyObject *checker;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002554
2555 /* Quick test for an exact match */
2556 if (Py_TYPE(inst) == (PyTypeObject *)cls)
2557 return 1;
2558
Antoine Pitrouec569b72008-08-26 22:40:48 +00002559 if (PyTuple_Check(cls)) {
2560 Py_ssize_t i;
2561 Py_ssize_t n;
2562 int r = 0;
2563
2564 if (Py_EnterRecursiveCall(" in __instancecheck__"))
2565 return -1;
2566 n = PyTuple_GET_SIZE(cls);
2567 for (i = 0; i < n; ++i) {
2568 PyObject *item = PyTuple_GET_ITEM(cls, i);
2569 r = PyObject_IsInstance(inst, item);
2570 if (r != 0)
2571 /* either found it, or got an error */
2572 break;
2573 }
2574 Py_LeaveRecursiveCall();
2575 return r;
2576 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002577
2578 checker = _PyObject_LookupSpecial(cls, "__instancecheck__", &name);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002579 if (checker != NULL) {
2580 PyObject *res;
2581 int ok = -1;
Guido van Rossum29478ef2007-05-29 00:39:44 +00002582 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2583 Py_DECREF(checker);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002584 return ok;
Guido van Rossum29478ef2007-05-29 00:39:44 +00002585 }
Guido van Rossumadee45e2007-05-25 17:55:52 +00002586 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
2587 Py_LeaveRecursiveCall();
2588 Py_DECREF(checker);
2589 if (res != NULL) {
2590 ok = PyObject_IsTrue(res);
2591 Py_DECREF(res);
2592 }
2593 return ok;
2594 }
Antoine Pitrouec569b72008-08-26 22:40:48 +00002595 return recursive_isinstance(inst, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002596}
2597
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002598static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002599recursive_issubclass(PyObject *derived, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002600{
Antoine Pitrouec569b72008-08-26 22:40:48 +00002601 if (PyType_Check(cls) && PyType_Check(derived)) {
2602 /* Fast path (non-recursive) */
2603 return PyType_IsSubtype((PyTypeObject *)derived, (PyTypeObject *)cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002604 }
Antoine Pitrouec569b72008-08-26 22:40:48 +00002605 if (!check_class(derived,
2606 "issubclass() arg 1 must be a class"))
2607 return -1;
2608 if (!check_class(cls,
2609 "issubclass() arg 2 must be a class"
2610 " or tuple of classes"))
2611 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002612
Antoine Pitrouec569b72008-08-26 22:40:48 +00002613 return abstract_issubclass(derived, cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002614}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002615
Brett Cannon4f653312004-03-20 22:52:14 +00002616int
2617PyObject_IsSubclass(PyObject *derived, PyObject *cls)
2618{
Christian Heimesa156e092008-02-16 07:38:31 +00002619 static PyObject *name = NULL;
Guido van Rossume7ba4952007-06-06 23:52:48 +00002620 PyObject *checker;
Georg Brandldcfe8e42009-05-17 08:22:45 +00002621
Antoine Pitrouec569b72008-08-26 22:40:48 +00002622 if (PyTuple_Check(cls)) {
2623 Py_ssize_t i;
2624 Py_ssize_t n;
2625 int r = 0;
2626
2627 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
2628 return -1;
2629 n = PyTuple_GET_SIZE(cls);
2630 for (i = 0; i < n; ++i) {
2631 PyObject *item = PyTuple_GET_ITEM(cls, i);
2632 r = PyObject_IsSubclass(derived, item);
2633 if (r != 0)
2634 /* either found it, or got an error */
2635 break;
2636 }
2637 Py_LeaveRecursiveCall();
2638 return r;
2639 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002640
2641 checker = _PyObject_LookupSpecial(cls, "__subclasscheck__", &name);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002642 if (checker != NULL) {
2643 PyObject *res;
2644 int ok = -1;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002645 if (Py_EnterRecursiveCall(" in __subclasscheck__")) {
2646 Py_DECREF(checker);
Guido van Rossumadee45e2007-05-25 17:55:52 +00002647 return ok;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002648 }
Guido van Rossumadee45e2007-05-25 17:55:52 +00002649 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
2650 Py_LeaveRecursiveCall();
2651 Py_DECREF(checker);
2652 if (res != NULL) {
2653 ok = PyObject_IsTrue(res);
2654 Py_DECREF(res);
2655 }
2656 return ok;
2657 }
Antoine Pitrouec569b72008-08-26 22:40:48 +00002658 return recursive_issubclass(derived, cls);
2659}
2660
2661int
2662_PyObject_RealIsInstance(PyObject *inst, PyObject *cls)
2663{
2664 return recursive_isinstance(inst, cls);
2665}
2666
2667int
2668_PyObject_RealIsSubclass(PyObject *derived, PyObject *cls)
2669{
2670 return recursive_issubclass(derived, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002671}
2672
2673
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002674PyObject *
2675PyObject_GetIter(PyObject *o)
2676{
2677 PyTypeObject *t = o->ob_type;
2678 getiterfunc f = NULL;
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002679 f = t->tp_iter;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002680 if (f == NULL) {
2681 if (PySequence_Check(o))
Guido van Rossum213c7a62001-04-23 14:08:49 +00002682 return PySeqIter_New(o);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002683 return type_error("'%.200s' object is not iterable", o);
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002684 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00002685 else {
2686 PyObject *res = (*f)(o);
2687 if (res != NULL && !PyIter_Check(res)) {
2688 PyErr_Format(PyExc_TypeError,
2689 "iter() returned non-iterator "
2690 "of type '%.100s'",
2691 res->ob_type->tp_name);
2692 Py_DECREF(res);
2693 res = NULL;
2694 }
2695 return res;
2696 }
2697}
2698
Tim Petersf4848da2001-05-05 00:14:56 +00002699/* Return next item.
2700 * If an error occurs, return NULL. PyErr_Occurred() will be true.
2701 * If the iteration terminates normally, return NULL and clear the
2702 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
2703 * will be false.
Travis E. Oliphantfe9bed02007-10-12 23:27:53 +00002704 * Else return the next object. PyErr_Occurred() will be false.
Tim Petersf4848da2001-05-05 00:14:56 +00002705 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002706PyObject *
2707PyIter_Next(PyObject *iter)
2708{
Tim Petersf4848da2001-05-05 00:14:56 +00002709 PyObject *result;
Tim Petersf4848da2001-05-05 00:14:56 +00002710 result = (*iter->ob_type->tp_iternext)(iter);
2711 if (result == NULL &&
2712 PyErr_Occurred() &&
2713 PyErr_ExceptionMatches(PyExc_StopIteration))
2714 PyErr_Clear();
2715 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002716}