blob: 68d06edfa6008059fd5a86b7d71a19c09be16731 [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"
Victor Stinner621cebe2018-11-12 16:53:38 +01004#include "pycore_pystate.h"
Guido van Rossumfa0b6ab1998-05-22 15:23:36 +00005#include <ctype.h>
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00006#include "structmember.h" /* we need the offsetof() macro from there */
Tim Peters64b5ce32001-09-10 20:52:51 +00007#include "longintrepr.h"
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00008
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00009
Thomas Wouters00ee7ba2006-08-21 19:07:27 +000010
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000011/* Shorthands to return certain errors */
Guido van Rossume15dee51995-07-18 14:12:02 +000012
13static PyObject *
Thomas Wouters0e3f5912006-08-11 14:57:12 +000014type_error(const char *msg, PyObject *obj)
Guido van Rossume15dee51995-07-18 14:12:02 +000015{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000016 PyErr_Format(PyExc_TypeError, msg, obj->ob_type->tp_name);
17 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +000018}
19
Guido van Rossum052b7e11996-11-11 15:08:19 +000020static PyObject *
Fred Drake79912472000-07-09 04:06:11 +000021null_error(void)
Guido van Rossume15dee51995-07-18 14:12:02 +000022{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000023 if (!PyErr_Occurred())
24 PyErr_SetString(PyExc_SystemError,
25 "null argument to internal routine");
26 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +000027}
28
Guido van Rossumcea1c8c1998-05-22 00:47:05 +000029/* Operations on any object */
30
Guido van Rossume15dee51995-07-18 14:12:02 +000031PyObject *
Fred Drake79912472000-07-09 04:06:11 +000032PyObject_Type(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +000033{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000034 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +000035
Victor Stinner71aea8e2016-08-19 16:59:55 +020036 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000037 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +020038 }
39
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000040 v = (PyObject *)o->ob_type;
41 Py_INCREF(v);
42 return v;
Guido van Rossume15dee51995-07-18 14:12:02 +000043}
44
Martin v. Löwis18e16552006-02-15 17:27:45 +000045Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +000046PyObject_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +000047{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000048 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +000049
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000050 if (o == NULL) {
51 null_error();
52 return -1;
53 }
Guido van Rossume15dee51995-07-18 14:12:02 +000054
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000055 m = o->ob_type->tp_as_sequence;
Serhiy Storchaka813f9432017-04-16 09:21:44 +030056 if (m && m->sq_length) {
57 Py_ssize_t len = m->sq_length(o);
58 assert(len >= 0 || PyErr_Occurred());
59 return len;
60 }
Guido van Rossume15dee51995-07-18 14:12:02 +000061
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000062 return PyMapping_Size(o);
Guido van Rossume15dee51995-07-18 14:12:02 +000063}
64
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000065#undef PyObject_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +000066Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000067PyObject_Length(PyObject *o)
68{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000069 return PyObject_Size(o);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +000070}
71#define PyObject_Length PyObject_Size
72
Armin Ronacheraa9a79d2012-10-06 14:03:24 +020073int
74_PyObject_HasLen(PyObject *o) {
75 return (Py_TYPE(o)->tp_as_sequence && Py_TYPE(o)->tp_as_sequence->sq_length) ||
76 (Py_TYPE(o)->tp_as_mapping && Py_TYPE(o)->tp_as_mapping->mp_length);
77}
Raymond Hettinger6b27cda2005-09-24 21:23:05 +000078
Christian Heimes255f53b2007-12-08 15:33:56 +000079/* The length hint function returns a non-negative value from o.__len__()
Armin Ronacher74b38b12012-10-07 10:29:32 +020080 or o.__length_hint__(). If those methods aren't found the defaultvalue is
81 returned. If one of the calls fails with an exception other than TypeError
82 this function returns -1.
Christian Heimes255f53b2007-12-08 15:33:56 +000083*/
84
85Py_ssize_t
Armin Ronacheraa9a79d2012-10-06 14:03:24 +020086PyObject_LengthHint(PyObject *o, Py_ssize_t defaultvalue)
Christian Heimes255f53b2007-12-08 15:33:56 +000087{
Christian Heimesb70e8a12012-10-06 17:16:39 +020088 PyObject *hint, *result;
Christian Heimes6314d162012-10-06 17:13:29 +020089 Py_ssize_t res;
Benjamin Petersonce798522012-01-22 11:24:29 -050090 _Py_IDENTIFIER(__length_hint__);
Serhiy Storchakaf740d462013-10-24 23:19:51 +030091 if (_PyObject_HasLen(o)) {
92 res = PyObject_Length(o);
Serhiy Storchaka813f9432017-04-16 09:21:44 +030093 if (res < 0) {
94 assert(PyErr_Occurred());
Serhiy Storchakaf740d462013-10-24 23:19:51 +030095 if (!PyErr_ExceptionMatches(PyExc_TypeError)) {
96 return -1;
97 }
98 PyErr_Clear();
Armin Ronacheraa9a79d2012-10-06 14:03:24 +020099 }
Serhiy Storchakaf740d462013-10-24 23:19:51 +0300100 else {
101 return res;
102 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000103 }
Christian Heimes6314d162012-10-06 17:13:29 +0200104 hint = _PyObject_LookupSpecial(o, &PyId___length_hint__);
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200105 if (hint == NULL) {
106 if (PyErr_Occurred()) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000107 return -1;
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200108 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000109 return defaultvalue;
110 }
Victor Stinnerf17c3de2016-12-06 18:46:19 +0100111 result = _PyObject_CallNoArg(hint);
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200112 Py_DECREF(hint);
113 if (result == NULL) {
114 if (PyErr_ExceptionMatches(PyExc_TypeError)) {
115 PyErr_Clear();
116 return defaultvalue;
117 }
118 return -1;
119 }
120 else if (result == Py_NotImplemented) {
121 Py_DECREF(result);
122 return defaultvalue;
123 }
124 if (!PyLong_Check(result)) {
Armin Ronacher74b38b12012-10-07 10:29:32 +0200125 PyErr_Format(PyExc_TypeError, "__length_hint__ must be an integer, not %.100s",
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200126 Py_TYPE(result)->tp_name);
127 Py_DECREF(result);
128 return -1;
129 }
Armin Ronacher74b38b12012-10-07 10:29:32 +0200130 res = PyLong_AsSsize_t(result);
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200131 Py_DECREF(result);
Armin Ronacher74b38b12012-10-07 10:29:32 +0200132 if (res < 0 && PyErr_Occurred()) {
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200133 return -1;
134 }
Armin Ronacher74b38b12012-10-07 10:29:32 +0200135 if (res < 0) {
Armin Ronacheraa9a79d2012-10-06 14:03:24 +0200136 PyErr_Format(PyExc_ValueError, "__length_hint__() should return >= 0");
137 return -1;
138 }
Armin Ronacher74b38b12012-10-07 10:29:32 +0200139 return res;
Raymond Hettinger6b27cda2005-09-24 21:23:05 +0000140}
141
Guido van Rossume15dee51995-07-18 14:12:02 +0000142PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000143PyObject_GetItem(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +0000144{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000145 PyMappingMethods *m;
Ivan Levkivskyiac281472019-02-17 23:13:46 +0000146 PySequenceMethods *ms;
Guido van Rossume15dee51995-07-18 14:12:02 +0000147
Victor Stinner71aea8e2016-08-19 16:59:55 +0200148 if (o == NULL || key == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000149 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +0200150 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000151
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000152 m = o->ob_type->tp_as_mapping;
Victor Stinnere20310f2015-11-05 13:56:58 +0100153 if (m && m->mp_subscript) {
154 PyObject *item = m->mp_subscript(o, key);
155 assert((item != NULL) ^ (PyErr_Occurred() != NULL));
156 return item;
157 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000158
Ivan Levkivskyiac281472019-02-17 23:13:46 +0000159 ms = o->ob_type->tp_as_sequence;
160 if (ms && ms->sq_item) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000161 if (PyIndex_Check(key)) {
162 Py_ssize_t key_value;
163 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
164 if (key_value == -1 && PyErr_Occurred())
165 return NULL;
166 return PySequence_GetItem(o, key_value);
167 }
Ivan Levkivskyiac281472019-02-17 23:13:46 +0000168 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000169 return type_error("sequence index must "
170 "be integer, not '%.200s'", key);
Ivan Levkivskyiac281472019-02-17 23:13:46 +0000171 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000172 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000173
Ivan Levkivskyi2b5fd1e2017-12-14 23:32:56 +0100174 if (PyType_Check(o)) {
Serhiy Storchakace5b0e92018-01-05 00:21:41 +0200175 PyObject *meth, *result, *stack[1] = {key};
Ivan Levkivskyi2b5fd1e2017-12-14 23:32:56 +0100176 _Py_IDENTIFIER(__class_getitem__);
Serhiy Storchakaf320be72018-01-25 10:49:40 +0200177 if (_PyObject_LookupAttrId(o, &PyId___class_getitem__, &meth) < 0) {
178 return NULL;
179 }
Ivan Levkivskyi2b5fd1e2017-12-14 23:32:56 +0100180 if (meth) {
Serhiy Storchakace5b0e92018-01-05 00:21:41 +0200181 result = _PyObject_FastCall(meth, stack, 1);
Ivan Levkivskyi2b5fd1e2017-12-14 23:32:56 +0100182 Py_DECREF(meth);
183 return result;
184 }
Ivan Levkivskyi2b5fd1e2017-12-14 23:32:56 +0100185 }
186
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000187 return type_error("'%.200s' object is not subscriptable", o);
Guido van Rossume15dee51995-07-18 14:12:02 +0000188}
189
190int
Fred Drake79912472000-07-09 04:06:11 +0000191PyObject_SetItem(PyObject *o, PyObject *key, PyObject *value)
Guido van Rossume15dee51995-07-18 14:12:02 +0000192{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000193 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +0000194
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000195 if (o == NULL || key == NULL || value == NULL) {
196 null_error();
197 return -1;
198 }
199 m = o->ob_type->tp_as_mapping;
200 if (m && m->mp_ass_subscript)
201 return m->mp_ass_subscript(o, key, value);
Guido van Rossume15dee51995-07-18 14:12:02 +0000202
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000203 if (o->ob_type->tp_as_sequence) {
204 if (PyIndex_Check(key)) {
205 Py_ssize_t key_value;
206 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
207 if (key_value == -1 && PyErr_Occurred())
208 return -1;
209 return PySequence_SetItem(o, key_value, value);
210 }
211 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
212 type_error("sequence index must be "
213 "integer, not '%.200s'", key);
214 return -1;
215 }
216 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000217
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000218 type_error("'%.200s' object does not support item assignment", o);
219 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +0000220}
221
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000222int
Fred Drake79912472000-07-09 04:06:11 +0000223PyObject_DelItem(PyObject *o, PyObject *key)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000224{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000225 PyMappingMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000226
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000227 if (o == NULL || key == NULL) {
228 null_error();
229 return -1;
230 }
231 m = o->ob_type->tp_as_mapping;
232 if (m && m->mp_ass_subscript)
233 return m->mp_ass_subscript(o, key, (PyObject*)NULL);
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000234
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000235 if (o->ob_type->tp_as_sequence) {
236 if (PyIndex_Check(key)) {
237 Py_ssize_t key_value;
238 key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
239 if (key_value == -1 && PyErr_Occurred())
240 return -1;
241 return PySequence_DelItem(o, key_value);
242 }
243 else if (o->ob_type->tp_as_sequence->sq_ass_item) {
244 type_error("sequence index must be "
245 "integer, not '%.200s'", key);
246 return -1;
247 }
248 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000249
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000250 type_error("'%.200s' object does not support item deletion", o);
251 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +0000252}
253
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000254int
Serhiy Storchakac6792272013-10-19 21:03:34 +0300255PyObject_DelItemString(PyObject *o, const char *key)
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000256{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000257 PyObject *okey;
258 int ret;
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000259
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000260 if (o == NULL || key == NULL) {
261 null_error();
262 return -1;
263 }
264 okey = PyUnicode_FromString(key);
265 if (okey == NULL)
266 return -1;
267 ret = PyObject_DelItem(o, okey);
268 Py_DECREF(okey);
269 return ret;
Martin v. Löwisb0d71d02002-01-05 10:50:30 +0000270}
271
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000272/* We release the buffer right after use of this function which could
Guido van Rossum98297ee2007-11-06 21:34:58 +0000273 cause issues later on. Don't use these functions in new code.
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000274 */
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000275int
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000276PyObject_CheckReadBuffer(PyObject *obj)
277{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000278 PyBufferProcs *pb = obj->ob_type->tp_as_buffer;
279 Py_buffer view;
Jeremy Hylton89c3a222001-11-09 21:59:42 +0000280
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000281 if (pb == NULL ||
282 pb->bf_getbuffer == NULL)
283 return 0;
284 if ((*pb->bf_getbuffer)(obj, &view, PyBUF_SIMPLE) == -1) {
285 PyErr_Clear();
286 return 0;
287 }
288 PyBuffer_Release(&view);
289 return 1;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000290}
291
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +0200292static int
293as_read_buffer(PyObject *obj, const void **buffer, Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000294{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000295 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000296
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000297 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
298 null_error();
299 return -1;
300 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200301 if (PyObject_GetBuffer(obj, &view, PyBUF_SIMPLE) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000302 return -1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000303
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000304 *buffer = view.buf;
305 *buffer_len = view.len;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200306 PyBuffer_Release(&view);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000307 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000308}
309
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +0200310int
311PyObject_AsCharBuffer(PyObject *obj,
312 const char **buffer,
313 Py_ssize_t *buffer_len)
314{
315 return as_read_buffer(obj, (const void **)buffer, buffer_len);
316}
317
318int PyObject_AsReadBuffer(PyObject *obj,
319 const void **buffer,
320 Py_ssize_t *buffer_len)
321{
322 return as_read_buffer(obj, buffer, buffer_len);
323}
324
Guido van Rossum4c08d552000-03-10 22:55:18 +0000325int PyObject_AsWriteBuffer(PyObject *obj,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000326 void **buffer,
327 Py_ssize_t *buffer_len)
Guido van Rossum4c08d552000-03-10 22:55:18 +0000328{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000329 PyBufferProcs *pb;
330 Py_buffer view;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000331
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000332 if (obj == NULL || buffer == NULL || buffer_len == NULL) {
333 null_error();
334 return -1;
335 }
336 pb = obj->ob_type->tp_as_buffer;
337 if (pb == NULL ||
338 pb->bf_getbuffer == NULL ||
339 ((*pb->bf_getbuffer)(obj, &view, PyBUF_WRITABLE) != 0)) {
340 PyErr_SetString(PyExc_TypeError,
R David Murray861470c2014-10-05 11:47:01 -0400341 "expected a writable bytes-like object");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000342 return -1;
343 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000344
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000345 *buffer = view.buf;
346 *buffer_len = view.len;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200347 PyBuffer_Release(&view);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000348 return 0;
Guido van Rossum4c08d552000-03-10 22:55:18 +0000349}
350
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000351/* Buffer C-API for Python 3.0 */
352
353int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000354PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000355{
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200356 PyBufferProcs *pb = obj->ob_type->tp_as_buffer;
357
358 if (pb == NULL || pb->bf_getbuffer == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000359 PyErr_Format(PyExc_TypeError,
R David Murray861470c2014-10-05 11:47:01 -0400360 "a bytes-like object is required, not '%.100s'",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000361 Py_TYPE(obj)->tp_name);
362 return -1;
363 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200364 return (*pb->bf_getbuffer)(obj, view, flags);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000365}
366
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000367static int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100368_IsFortranContiguous(const Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000369{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000370 Py_ssize_t sd, dim;
371 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000372
Stefan Krah363af442015-02-01 14:53:54 +0100373 /* 1) len = product(shape) * itemsize
374 2) itemsize > 0
375 3) len = 0 <==> exists i: shape[i] = 0 */
376 if (view->len == 0) return 1;
377 if (view->strides == NULL) { /* C-contiguous by definition */
378 /* Trivially F-contiguous */
379 if (view->ndim <= 1) return 1;
380
381 /* ndim > 1 implies shape != NULL */
382 assert(view->shape != NULL);
383
384 /* Effectively 1-d */
385 sd = 0;
386 for (i=0; i<view->ndim; i++) {
387 if (view->shape[i] > 1) sd += 1;
388 }
389 return sd <= 1;
390 }
391
392 /* strides != NULL implies both of these */
393 assert(view->ndim > 0);
394 assert(view->shape != NULL);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000395
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000396 sd = view->itemsize;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000397 for (i=0; i<view->ndim; i++) {
398 dim = view->shape[i];
Stefan Krah363af442015-02-01 14:53:54 +0100399 if (dim > 1 && view->strides[i] != sd) {
400 return 0;
401 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000402 sd *= dim;
403 }
404 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000405}
406
407static int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100408_IsCContiguous(const Py_buffer *view)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000409{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000410 Py_ssize_t sd, dim;
411 int i;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000412
Stefan Krah363af442015-02-01 14:53:54 +0100413 /* 1) len = product(shape) * itemsize
414 2) itemsize > 0
415 3) len = 0 <==> exists i: shape[i] = 0 */
416 if (view->len == 0) return 1;
417 if (view->strides == NULL) return 1; /* C-contiguous by definition */
418
419 /* strides != NULL implies both of these */
420 assert(view->ndim > 0);
421 assert(view->shape != NULL);
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000422
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000423 sd = view->itemsize;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000424 for (i=view->ndim-1; i>=0; i--) {
425 dim = view->shape[i];
Stefan Krah363af442015-02-01 14:53:54 +0100426 if (dim > 1 && view->strides[i] != sd) {
427 return 0;
428 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000429 sd *= dim;
430 }
431 return 1;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000432}
433
434int
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100435PyBuffer_IsContiguous(const Py_buffer *view, char order)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000436{
437
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000438 if (view->suboffsets != NULL) return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000439
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100440 if (order == 'C')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000441 return _IsCContiguous(view);
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100442 else if (order == 'F')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000443 return _IsFortranContiguous(view);
Stefan Krah9a2d99e2012-02-25 12:24:21 +0100444 else if (order == 'A')
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000445 return (_IsCContiguous(view) || _IsFortranContiguous(view));
446 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000447}
448
449
Guido van Rossum98297ee2007-11-06 21:34:58 +0000450void*
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000451PyBuffer_GetPointer(Py_buffer *view, Py_ssize_t *indices)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000452{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000453 char* pointer;
454 int i;
455 pointer = (char *)view->buf;
456 for (i = 0; i < view->ndim; i++) {
457 pointer += view->strides[i]*indices[i];
458 if ((view->suboffsets != NULL) && (view->suboffsets[i] >= 0)) {
459 pointer = *((char**)pointer) + view->suboffsets[i];
460 }
461 }
462 return (void*)pointer;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000463}
464
465
Guido van Rossum98297ee2007-11-06 21:34:58 +0000466void
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000467_Py_add_one_to_index_F(int nd, Py_ssize_t *index, const Py_ssize_t *shape)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000468{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000469 int k;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000470
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000471 for (k=0; k<nd; k++) {
472 if (index[k] < shape[k]-1) {
473 index[k]++;
474 break;
475 }
476 else {
477 index[k] = 0;
478 }
479 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000480}
481
Guido van Rossum98297ee2007-11-06 21:34:58 +0000482void
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000483_Py_add_one_to_index_C(int nd, Py_ssize_t *index, const Py_ssize_t *shape)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000484{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000485 int k;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000486
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000487 for (k=nd-1; k>=0; k--) {
488 if (index[k] < shape[k]-1) {
489 index[k]++;
490 break;
491 }
492 else {
493 index[k] = 0;
494 }
495 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000496}
497
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000498int
Travis E. Oliphant8ae62b62007-09-23 02:00:13 +0000499PyBuffer_FromContiguous(Py_buffer *view, void *buf, Py_ssize_t len, char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000500{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000501 int k;
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000502 void (*addone)(int, Py_ssize_t *, const Py_ssize_t *);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000503 Py_ssize_t *indices, elements;
504 char *src, *ptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000505
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000506 if (len > view->len) {
507 len = view->len;
508 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000510 if (PyBuffer_IsContiguous(view, fort)) {
511 /* simplest copy is all that is needed */
512 memcpy(view->buf, buf, len);
513 return 0;
514 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000515
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000516 /* Otherwise a more elaborate scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000517
Stefan Krah7213fcc2015-02-01 16:19:23 +0100518 /* view->ndim <= 64 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000519 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*(view->ndim));
520 if (indices == NULL) {
521 PyErr_NoMemory();
522 return -1;
523 }
524 for (k=0; k<view->ndim;k++) {
525 indices[k] = 0;
526 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000527
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000528 if (fort == 'F') {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000529 addone = _Py_add_one_to_index_F;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000530 }
531 else {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000532 addone = _Py_add_one_to_index_C;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000533 }
534 src = buf;
535 /* XXX : This is not going to be the fastest code in the world
536 several optimizations are possible.
537 */
538 elements = len / view->itemsize;
539 while (elements--) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000540 ptr = PyBuffer_GetPointer(view, indices);
541 memcpy(ptr, src, view->itemsize);
542 src += view->itemsize;
Stefan Krah7213fcc2015-02-01 16:19:23 +0100543 addone(view->ndim, indices, view->shape);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000544 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000545
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000546 PyMem_Free(indices);
547 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000548}
549
Guido van Rossum98297ee2007-11-06 21:34:58 +0000550int PyObject_CopyData(PyObject *dest, PyObject *src)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000551{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000552 Py_buffer view_dest, view_src;
553 int k;
554 Py_ssize_t *indices, elements;
555 char *dptr, *sptr;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000556
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000557 if (!PyObject_CheckBuffer(dest) ||
558 !PyObject_CheckBuffer(src)) {
559 PyErr_SetString(PyExc_TypeError,
R David Murray861470c2014-10-05 11:47:01 -0400560 "both destination and source must be "\
561 "bytes-like objects");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000562 return -1;
563 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000564
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000565 if (PyObject_GetBuffer(dest, &view_dest, PyBUF_FULL) != 0) return -1;
566 if (PyObject_GetBuffer(src, &view_src, PyBUF_FULL_RO) != 0) {
567 PyBuffer_Release(&view_dest);
568 return -1;
569 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000570
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000571 if (view_dest.len < view_src.len) {
572 PyErr_SetString(PyExc_BufferError,
573 "destination is too small to receive data from source");
574 PyBuffer_Release(&view_dest);
575 PyBuffer_Release(&view_src);
576 return -1;
577 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000578
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000579 if ((PyBuffer_IsContiguous(&view_dest, 'C') &&
580 PyBuffer_IsContiguous(&view_src, 'C')) ||
581 (PyBuffer_IsContiguous(&view_dest, 'F') &&
582 PyBuffer_IsContiguous(&view_src, 'F'))) {
583 /* simplest copy is all that is needed */
584 memcpy(view_dest.buf, view_src.buf, view_src.len);
585 PyBuffer_Release(&view_dest);
586 PyBuffer_Release(&view_src);
587 return 0;
588 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000589
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000590 /* Otherwise a more elaborate copy scheme is needed */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000591
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000592 /* XXX(nnorwitz): need to check for overflow! */
593 indices = (Py_ssize_t *)PyMem_Malloc(sizeof(Py_ssize_t)*view_src.ndim);
594 if (indices == NULL) {
595 PyErr_NoMemory();
596 PyBuffer_Release(&view_dest);
597 PyBuffer_Release(&view_src);
598 return -1;
599 }
600 for (k=0; k<view_src.ndim;k++) {
601 indices[k] = 0;
602 }
603 elements = 1;
604 for (k=0; k<view_src.ndim; k++) {
605 /* XXX(nnorwitz): can this overflow? */
606 elements *= view_src.shape[k];
607 }
608 while (elements--) {
Antoine Pitrouf68c2a72010-09-01 12:58:21 +0000609 _Py_add_one_to_index_C(view_src.ndim, indices, view_src.shape);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000610 dptr = PyBuffer_GetPointer(&view_dest, indices);
611 sptr = PyBuffer_GetPointer(&view_src, indices);
612 memcpy(dptr, sptr, view_src.itemsize);
613 }
614 PyMem_Free(indices);
615 PyBuffer_Release(&view_dest);
616 PyBuffer_Release(&view_src);
617 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000618}
619
620void
621PyBuffer_FillContiguousStrides(int nd, Py_ssize_t *shape,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000622 Py_ssize_t *strides, int itemsize,
623 char fort)
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000624{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000625 int k;
626 Py_ssize_t sd;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000628 sd = itemsize;
629 if (fort == 'F') {
630 for (k=0; k<nd; k++) {
631 strides[k] = sd;
632 sd *= shape[k];
633 }
634 }
635 else {
636 for (k=nd-1; k>=0; k--) {
637 strides[k] = sd;
638 sd *= shape[k];
639 }
640 }
641 return;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000642}
643
644int
Martin v. Löwis423be952008-08-13 15:53:07 +0000645PyBuffer_FillInfo(Py_buffer *view, PyObject *obj, void *buf, Py_ssize_t len,
Stefan Krah4e141742012-03-06 15:27:31 +0100646 int readonly, int flags)
Guido van Rossum98297ee2007-11-06 21:34:58 +0000647{
Stefan Krah5178d912015-02-03 16:57:21 +0100648 if (view == NULL) {
649 PyErr_SetString(PyExc_BufferError,
650 "PyBuffer_FillInfo: view==NULL argument is obsolete");
651 return -1;
652 }
653
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000654 if (((flags & PyBUF_WRITABLE) == PyBUF_WRITABLE) &&
655 (readonly == 1)) {
656 PyErr_SetString(PyExc_BufferError,
657 "Object is not writable.");
658 return -1;
659 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000660
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000661 view->obj = obj;
662 if (obj)
663 Py_INCREF(obj);
664 view->buf = buf;
665 view->len = len;
666 view->readonly = readonly;
667 view->itemsize = 1;
668 view->format = NULL;
669 if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT)
670 view->format = "B";
671 view->ndim = 1;
672 view->shape = NULL;
673 if ((flags & PyBUF_ND) == PyBUF_ND)
674 view->shape = &(view->len);
675 view->strides = NULL;
676 if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES)
677 view->strides = &(view->itemsize);
678 view->suboffsets = NULL;
679 view->internal = NULL;
680 return 0;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +0000681}
682
Martin v. Löwis423be952008-08-13 15:53:07 +0000683void
684PyBuffer_Release(Py_buffer *view)
685{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000686 PyObject *obj = view->obj;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200687 PyBufferProcs *pb;
688 if (obj == NULL)
689 return;
690 pb = Py_TYPE(obj)->tp_as_buffer;
691 if (pb && pb->bf_releasebuffer)
692 pb->bf_releasebuffer(obj, view);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000693 view->obj = NULL;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +0200694 Py_DECREF(obj);
Martin v. Löwis423be952008-08-13 15:53:07 +0000695}
696
Eric Smith8fd3eba2008-02-17 19:48:00 +0000697PyObject *
698PyObject_Format(PyObject *obj, PyObject *format_spec)
699{
Eric Smith8fd3eba2008-02-17 19:48:00 +0000700 PyObject *meth;
701 PyObject *empty = NULL;
702 PyObject *result = NULL;
Benjamin Petersonce798522012-01-22 11:24:29 -0500703 _Py_IDENTIFIER(__format__);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000704
Serhiy Storchakaea525a22016-09-06 22:07:53 +0300705 if (format_spec != NULL && !PyUnicode_Check(format_spec)) {
706 PyErr_Format(PyExc_SystemError,
707 "Format specifier must be a string, not %.200s",
708 Py_TYPE(format_spec)->tp_name);
709 return NULL;
710 }
711
712 /* Fast path for common types. */
713 if (format_spec == NULL || PyUnicode_GET_LENGTH(format_spec) == 0) {
714 if (PyUnicode_CheckExact(obj)) {
715 Py_INCREF(obj);
716 return obj;
717 }
718 if (PyLong_CheckExact(obj)) {
719 return PyObject_Str(obj);
720 }
721 }
722
Eric Smith8fd3eba2008-02-17 19:48:00 +0000723 /* If no format_spec is provided, use an empty string */
724 if (format_spec == NULL) {
Victor Stinner9d3b93b2011-11-22 02:27:30 +0100725 empty = PyUnicode_New(0, 0);
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000726 format_spec = empty;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000727 }
728
Serhiy Storchakaea525a22016-09-06 22:07:53 +0300729 /* Find the (unbound!) __format__ method */
Benjamin Petersonce798522012-01-22 11:24:29 -0500730 meth = _PyObject_LookupSpecial(obj, &PyId___format__);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000731 if (meth == NULL) {
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000732 if (!PyErr_Occurred())
733 PyErr_Format(PyExc_TypeError,
734 "Type %.100s doesn't define __format__",
735 Py_TYPE(obj)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000736 goto done;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000737 }
738
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000739 /* And call it. */
Victor Stinnerde4ae3d2016-12-04 22:59:09 +0100740 result = PyObject_CallFunctionObjArgs(meth, format_spec, NULL);
Benjamin Peterson6f889ad32010-06-05 02:11:45 +0000741 Py_DECREF(meth);
Eric Smith8fd3eba2008-02-17 19:48:00 +0000742
743 if (result && !PyUnicode_Check(result)) {
Ethan Furmanb95b5612015-01-23 20:05:18 -0800744 PyErr_Format(PyExc_TypeError,
745 "__format__ must return a str, not %.200s",
746 Py_TYPE(result)->tp_name);
Benjamin Petersonda2cf042010-06-05 00:45:37 +0000747 Py_DECREF(result);
748 result = NULL;
749 goto done;
Eric Smith8fd3eba2008-02-17 19:48:00 +0000750 }
751
752done:
753 Py_XDECREF(empty);
754 return result;
755}
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000756/* Operations on numbers */
757
758int
Fred Drake79912472000-07-09 04:06:11 +0000759PyNumber_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +0000760{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000761 return o && o->ob_type->tp_as_number &&
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +0200762 (o->ob_type->tp_as_number->nb_index ||
763 o->ob_type->tp_as_number->nb_int ||
764 o->ob_type->tp_as_number->nb_float);
Guido van Rossume15dee51995-07-18 14:12:02 +0000765}
766
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000767/* Binary operators */
Guido van Rossume15dee51995-07-18 14:12:02 +0000768
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000769#define NB_SLOT(x) offsetof(PyNumberMethods, x)
770#define NB_BINOP(nb_methods, slot) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000771 (*(binaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000772#define NB_TERNOP(nb_methods, slot) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000773 (*(ternaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000774
775/*
776 Calling scheme used for binary operations:
777
Neal Norwitz4886cc32006-08-21 17:06:07 +0000778 Order operations are tried until either a valid result or error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000779 w.op(v,w)[*], v.op(v,w), w.op(v,w)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000780
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000781 [*] only when v->ob_type != w->ob_type && w->ob_type is a subclass of
782 v->ob_type
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000783 */
784
785static PyObject *
786binary_op1(PyObject *v, PyObject *w, const int op_slot)
Guido van Rossume15dee51995-07-18 14:12:02 +0000787{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000788 PyObject *x;
789 binaryfunc slotv = NULL;
790 binaryfunc slotw = NULL;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000791
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000792 if (v->ob_type->tp_as_number != NULL)
793 slotv = NB_BINOP(v->ob_type->tp_as_number, op_slot);
794 if (w->ob_type != v->ob_type &&
795 w->ob_type->tp_as_number != NULL) {
796 slotw = NB_BINOP(w->ob_type->tp_as_number, op_slot);
797 if (slotw == slotv)
798 slotw = NULL;
799 }
800 if (slotv) {
801 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
802 x = slotw(v, w);
803 if (x != Py_NotImplemented)
804 return x;
805 Py_DECREF(x); /* can't do it */
806 slotw = NULL;
807 }
808 x = slotv(v, w);
809 if (x != Py_NotImplemented)
810 return x;
811 Py_DECREF(x); /* can't do it */
812 }
813 if (slotw) {
814 x = slotw(v, w);
815 if (x != Py_NotImplemented)
816 return x;
817 Py_DECREF(x); /* can't do it */
818 }
Brian Curtindfc80e32011-08-10 20:28:54 -0500819 Py_RETURN_NOTIMPLEMENTED;
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000820}
Guido van Rossum77660912002-04-16 16:32:50 +0000821
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000822static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000823binop_type_error(PyObject *v, PyObject *w, const char *op_name)
824{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000825 PyErr_Format(PyExc_TypeError,
826 "unsupported operand type(s) for %.100s: "
827 "'%.100s' and '%.100s'",
828 op_name,
829 v->ob_type->tp_name,
830 w->ob_type->tp_name);
831 return NULL;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000832}
833
834static PyObject *
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000835binary_op(PyObject *v, PyObject *w, const int op_slot, const char *op_name)
836{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000837 PyObject *result = binary_op1(v, w, op_slot);
838 if (result == Py_NotImplemented) {
839 Py_DECREF(result);
Sanyam Khurana5e2eb352017-08-18 16:07:36 +0530840
841 if (op_slot == NB_SLOT(nb_rshift) &&
842 PyCFunction_Check(v) &&
843 strcmp(((PyCFunctionObject *)v)->m_ml->ml_name, "print") == 0)
844 {
845 PyErr_Format(PyExc_TypeError,
846 "unsupported operand type(s) for %.100s: "
847 "'%.100s' and '%.100s'. Did you mean \"print(<message>, "
Sanyam Khuranaa7c449b2017-08-18 17:48:14 +0530848 "file=<output_stream>)\"?",
Sanyam Khurana5e2eb352017-08-18 16:07:36 +0530849 op_name,
850 v->ob_type->tp_name,
851 w->ob_type->tp_name);
852 return NULL;
853 }
854
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000855 return binop_type_error(v, w, op_name);
856 }
857 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000858}
859
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000860
861/*
862 Calling scheme used for ternary operations:
863
Neal Norwitz4886cc32006-08-21 17:06:07 +0000864 Order operations are tried until either a valid result or error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000865 v.op(v,w,z), w.op(v,w,z), z.op(v,w,z)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000866 */
867
868static PyObject *
869ternary_op(PyObject *v,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000870 PyObject *w,
871 PyObject *z,
872 const int op_slot,
873 const char *op_name)
Guido van Rossume15dee51995-07-18 14:12:02 +0000874{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000875 PyNumberMethods *mv, *mw, *mz;
876 PyObject *x = NULL;
877 ternaryfunc slotv = NULL;
878 ternaryfunc slotw = NULL;
879 ternaryfunc slotz = NULL;
Guido van Rossum77660912002-04-16 16:32:50 +0000880
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000881 mv = v->ob_type->tp_as_number;
882 mw = w->ob_type->tp_as_number;
883 if (mv != NULL)
884 slotv = NB_TERNOP(mv, op_slot);
885 if (w->ob_type != v->ob_type &&
886 mw != NULL) {
887 slotw = NB_TERNOP(mw, op_slot);
888 if (slotw == slotv)
889 slotw = NULL;
890 }
891 if (slotv) {
892 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
893 x = slotw(v, w, z);
894 if (x != Py_NotImplemented)
895 return x;
896 Py_DECREF(x); /* can't do it */
897 slotw = NULL;
898 }
899 x = slotv(v, w, z);
900 if (x != Py_NotImplemented)
901 return x;
902 Py_DECREF(x); /* can't do it */
903 }
904 if (slotw) {
905 x = slotw(v, w, z);
906 if (x != Py_NotImplemented)
907 return x;
908 Py_DECREF(x); /* can't do it */
909 }
910 mz = z->ob_type->tp_as_number;
911 if (mz != NULL) {
912 slotz = NB_TERNOP(mz, op_slot);
913 if (slotz == slotv || slotz == slotw)
914 slotz = NULL;
915 if (slotz) {
916 x = slotz(v, w, z);
917 if (x != Py_NotImplemented)
918 return x;
919 Py_DECREF(x); /* can't do it */
920 }
921 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000922
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000923 if (z == Py_None)
924 PyErr_Format(
925 PyExc_TypeError,
926 "unsupported operand type(s) for ** or pow(): "
927 "'%.100s' and '%.100s'",
928 v->ob_type->tp_name,
929 w->ob_type->tp_name);
930 else
931 PyErr_Format(
932 PyExc_TypeError,
933 "unsupported operand type(s) for pow(): "
934 "'%.100s', '%.100s', '%.100s'",
935 v->ob_type->tp_name,
936 w->ob_type->tp_name,
937 z->ob_type->tp_name);
938 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000939}
940
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000941#define BINARY_FUNC(func, op, op_name) \
942 PyObject * \
943 func(PyObject *v, PyObject *w) { \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000944 return binary_op(v, w, NB_SLOT(op), op_name); \
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000945 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000946
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000947BINARY_FUNC(PyNumber_Or, nb_or, "|")
948BINARY_FUNC(PyNumber_Xor, nb_xor, "^")
949BINARY_FUNC(PyNumber_And, nb_and, "&")
950BINARY_FUNC(PyNumber_Lshift, nb_lshift, "<<")
951BINARY_FUNC(PyNumber_Rshift, nb_rshift, ">>")
952BINARY_FUNC(PyNumber_Subtract, nb_subtract, "-")
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000953BINARY_FUNC(PyNumber_Divmod, nb_divmod, "divmod()")
Guido van Rossume15dee51995-07-18 14:12:02 +0000954
955PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000956PyNumber_Add(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000957{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000958 PyObject *result = binary_op1(v, w, NB_SLOT(nb_add));
959 if (result == Py_NotImplemented) {
960 PySequenceMethods *m = v->ob_type->tp_as_sequence;
961 Py_DECREF(result);
962 if (m && m->sq_concat) {
963 return (*m->sq_concat)(v, w);
964 }
965 result = binop_type_error(v, w, "+");
966 }
967 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000968}
969
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000970static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000971sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000972{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000973 Py_ssize_t count;
974 if (PyIndex_Check(n)) {
975 count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
976 if (count == -1 && PyErr_Occurred())
977 return NULL;
978 }
979 else {
980 return type_error("can't multiply sequence by "
981 "non-int of type '%.200s'", n);
982 }
983 return (*repeatfunc)(seq, count);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000984}
985
986PyObject *
987PyNumber_Multiply(PyObject *v, PyObject *w)
988{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000989 PyObject *result = binary_op1(v, w, NB_SLOT(nb_multiply));
990 if (result == Py_NotImplemented) {
991 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
992 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
993 Py_DECREF(result);
994 if (mv && mv->sq_repeat) {
995 return sequence_repeat(mv->sq_repeat, v, w);
996 }
997 else if (mw && mw->sq_repeat) {
998 return sequence_repeat(mw->sq_repeat, w, v);
999 }
1000 result = binop_type_error(v, w, "*");
1001 }
1002 return result;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001003}
1004
Guido van Rossume15dee51995-07-18 14:12:02 +00001005PyObject *
Benjamin Petersond51374e2014-04-09 23:55:56 -04001006PyNumber_MatrixMultiply(PyObject *v, PyObject *w)
1007{
1008 return binary_op(v, w, NB_SLOT(nb_matrix_multiply), "@");
1009}
1010
1011PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001012PyNumber_FloorDivide(PyObject *v, PyObject *w)
1013{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001014 return binary_op(v, w, NB_SLOT(nb_floor_divide), "//");
Guido van Rossum4668b002001-08-08 05:00:18 +00001015}
1016
1017PyObject *
1018PyNumber_TrueDivide(PyObject *v, PyObject *w)
1019{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001020 return binary_op(v, w, NB_SLOT(nb_true_divide), "/");
Guido van Rossum4668b002001-08-08 05:00:18 +00001021}
1022
1023PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001024PyNumber_Remainder(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +00001025{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001026 return binary_op(v, w, NB_SLOT(nb_remainder), "%");
Guido van Rossume15dee51995-07-18 14:12:02 +00001027}
1028
1029PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001030PyNumber_Power(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossume15dee51995-07-18 14:12:02 +00001031{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001032 return ternary_op(v, w, z, NB_SLOT(nb_power), "** or pow()");
Guido van Rossume15dee51995-07-18 14:12:02 +00001033}
1034
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001035/* Binary in-place operators */
1036
1037/* The in-place operators are defined to fall back to the 'normal',
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001038 non in-place operations, if the in-place methods are not in place.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001039
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001040 - If the left hand object has the appropriate struct members, and
1041 they are filled, call the appropriate function and return the
1042 result. No coercion is done on the arguments; the left-hand object
1043 is the one the operation is performed on, and it's up to the
1044 function to deal with the right-hand object.
Guido van Rossum77660912002-04-16 16:32:50 +00001045
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001046 - Otherwise, in-place modification is not supported. Handle it exactly as
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001047 a non in-place operation of the same kind.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001048
1049 */
1050
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001051static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001052binary_iop1(PyObject *v, PyObject *w, const int iop_slot, const int op_slot)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001053{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001054 PyNumberMethods *mv = v->ob_type->tp_as_number;
1055 if (mv != NULL) {
1056 binaryfunc slot = NB_BINOP(mv, iop_slot);
1057 if (slot) {
1058 PyObject *x = (slot)(v, w);
1059 if (x != Py_NotImplemented) {
1060 return x;
1061 }
1062 Py_DECREF(x);
1063 }
1064 }
1065 return binary_op1(v, w, op_slot);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001066}
1067
1068static PyObject *
1069binary_iop(PyObject *v, PyObject *w, const int iop_slot, const int op_slot,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001070 const char *op_name)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001071{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001072 PyObject *result = binary_iop1(v, w, iop_slot, op_slot);
1073 if (result == Py_NotImplemented) {
1074 Py_DECREF(result);
1075 return binop_type_error(v, w, op_name);
1076 }
1077 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001078}
1079
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001080#define INPLACE_BINOP(func, iop, op, op_name) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001081 PyObject * \
1082 func(PyObject *v, PyObject *w) { \
1083 return binary_iop(v, w, NB_SLOT(iop), NB_SLOT(op), op_name); \
1084 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001085
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001086INPLACE_BINOP(PyNumber_InPlaceOr, nb_inplace_or, nb_or, "|=")
1087INPLACE_BINOP(PyNumber_InPlaceXor, nb_inplace_xor, nb_xor, "^=")
1088INPLACE_BINOP(PyNumber_InPlaceAnd, nb_inplace_and, nb_and, "&=")
1089INPLACE_BINOP(PyNumber_InPlaceLshift, nb_inplace_lshift, nb_lshift, "<<=")
1090INPLACE_BINOP(PyNumber_InPlaceRshift, nb_inplace_rshift, nb_rshift, ">>=")
1091INPLACE_BINOP(PyNumber_InPlaceSubtract, nb_inplace_subtract, nb_subtract, "-=")
Benjamin Petersond51374e2014-04-09 23:55:56 -04001092INPLACE_BINOP(PyNumber_InMatrixMultiply, nb_inplace_matrix_multiply, nb_matrix_multiply, "@=")
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001093
1094PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001095PyNumber_InPlaceFloorDivide(PyObject *v, PyObject *w)
1096{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001097 return binary_iop(v, w, NB_SLOT(nb_inplace_floor_divide),
1098 NB_SLOT(nb_floor_divide), "//=");
Guido van Rossum4668b002001-08-08 05:00:18 +00001099}
1100
1101PyObject *
1102PyNumber_InPlaceTrueDivide(PyObject *v, PyObject *w)
1103{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001104 return binary_iop(v, w, NB_SLOT(nb_inplace_true_divide),
1105 NB_SLOT(nb_true_divide), "/=");
Guido van Rossum4668b002001-08-08 05:00:18 +00001106}
1107
1108PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001109PyNumber_InPlaceAdd(PyObject *v, PyObject *w)
1110{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001111 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_add),
1112 NB_SLOT(nb_add));
1113 if (result == Py_NotImplemented) {
1114 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1115 Py_DECREF(result);
1116 if (m != NULL) {
1117 binaryfunc f = NULL;
1118 f = m->sq_inplace_concat;
1119 if (f == NULL)
1120 f = m->sq_concat;
1121 if (f != NULL)
1122 return (*f)(v, w);
1123 }
1124 result = binop_type_error(v, w, "+=");
1125 }
1126 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001127}
1128
1129PyObject *
1130PyNumber_InPlaceMultiply(PyObject *v, PyObject *w)
1131{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001132 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_multiply),
1133 NB_SLOT(nb_multiply));
1134 if (result == Py_NotImplemented) {
1135 ssizeargfunc f = NULL;
1136 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1137 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1138 Py_DECREF(result);
1139 if (mv != NULL) {
1140 f = mv->sq_inplace_repeat;
1141 if (f == NULL)
1142 f = mv->sq_repeat;
1143 if (f != NULL)
1144 return sequence_repeat(f, v, w);
1145 }
1146 else if (mw != NULL) {
1147 /* Note that the right hand operand should not be
1148 * mutated in this case so sq_inplace_repeat is not
1149 * used. */
1150 if (mw->sq_repeat)
1151 return sequence_repeat(mw->sq_repeat, w, v);
1152 }
1153 result = binop_type_error(v, w, "*=");
1154 }
1155 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001156}
1157
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001158PyObject *
Benjamin Petersond51374e2014-04-09 23:55:56 -04001159PyNumber_InPlaceMatrixMultiply(PyObject *v, PyObject *w)
1160{
1161 return binary_iop(v, w, NB_SLOT(nb_inplace_matrix_multiply),
1162 NB_SLOT(nb_matrix_multiply), "@=");
1163}
1164
1165PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001166PyNumber_InPlaceRemainder(PyObject *v, PyObject *w)
1167{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001168 return binary_iop(v, w, NB_SLOT(nb_inplace_remainder),
1169 NB_SLOT(nb_remainder), "%=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001170}
1171
1172PyObject *
1173PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
1174{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001175 if (v->ob_type->tp_as_number &&
1176 v->ob_type->tp_as_number->nb_inplace_power != NULL) {
1177 return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
1178 }
1179 else {
1180 return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
1181 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001182}
1183
1184
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001185/* Unary operators and functions */
Guido van Rossume15dee51995-07-18 14:12:02 +00001186
1187PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001188PyNumber_Negative(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001189{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001190 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001191
Victor Stinner71aea8e2016-08-19 16:59:55 +02001192 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001193 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001194 }
1195
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001196 m = o->ob_type->tp_as_number;
1197 if (m && m->nb_negative)
1198 return (*m->nb_negative)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001199
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001200 return type_error("bad operand type for unary -: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001201}
1202
1203PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001204PyNumber_Positive(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001205{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001206 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001207
Victor Stinner71aea8e2016-08-19 16:59:55 +02001208 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001209 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001210 }
1211
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001212 m = o->ob_type->tp_as_number;
1213 if (m && m->nb_positive)
1214 return (*m->nb_positive)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001215
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001216 return type_error("bad operand type for unary +: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001217}
1218
1219PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001220PyNumber_Invert(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001221{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001222 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001223
Victor Stinner71aea8e2016-08-19 16:59:55 +02001224 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001225 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001226 }
1227
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001228 m = o->ob_type->tp_as_number;
1229 if (m && m->nb_invert)
1230 return (*m->nb_invert)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001231
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001232 return type_error("bad operand type for unary ~: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001233}
1234
1235PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001236PyNumber_Absolute(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001237{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001238 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001239
Victor Stinner71aea8e2016-08-19 16:59:55 +02001240 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001241 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001242 }
1243
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001244 m = o->ob_type->tp_as_number;
1245 if (m && m->nb_absolute)
1246 return m->nb_absolute(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001247
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001248 return type_error("bad operand type for abs(): '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001249}
1250
Christian Tismerea62ce72018-06-09 20:32:25 +02001251#undef PyIndex_Check
Christian Tismer83987132018-06-11 00:48:28 +02001252
Christian Tismerea62ce72018-06-09 20:32:25 +02001253int
1254PyIndex_Check(PyObject *obj)
1255{
1256 return obj->ob_type->tp_as_number != NULL &&
1257 obj->ob_type->tp_as_number->nb_index != NULL;
1258}
1259
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001260/* Return a Python int from the object item.
Serhiy Storchaka95949422013-08-27 19:40:23 +03001261 Raise TypeError if the result is not an int
Guido van Rossum98297ee2007-11-06 21:34:58 +00001262 or if the object cannot be interpreted as an index.
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001263*/
1264PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001265PyNumber_Index(PyObject *item)
1266{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001267 PyObject *result = NULL;
Victor Stinner71aea8e2016-08-19 16:59:55 +02001268 if (item == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001269 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001270 }
1271
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001272 if (PyLong_Check(item)) {
1273 Py_INCREF(item);
1274 return item;
1275 }
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001276 if (!PyIndex_Check(item)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001277 PyErr_Format(PyExc_TypeError,
1278 "'%.200s' object cannot be interpreted "
1279 "as an integer", item->ob_type->tp_name);
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001280 return NULL;
1281 }
1282 result = item->ob_type->tp_as_number->nb_index(item);
1283 if (!result || PyLong_CheckExact(result))
1284 return result;
1285 if (!PyLong_Check(result)) {
1286 PyErr_Format(PyExc_TypeError,
1287 "__index__ returned non-int (type %.200s)",
1288 result->ob_type->tp_name);
1289 Py_DECREF(result);
1290 return NULL;
1291 }
1292 /* Issue #17576: warn if 'result' not of exact type int. */
1293 if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
1294 "__index__ returned non-int (type %.200s). "
1295 "The ability to return an instance of a strict subclass of int "
1296 "is deprecated, and may be removed in a future version of Python.",
1297 result->ob_type->tp_name)) {
1298 Py_DECREF(result);
1299 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001300 }
1301 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001302}
1303
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001304/* Return an error on Overflow only if err is not NULL*/
1305
1306Py_ssize_t
1307PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1308{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001309 Py_ssize_t result;
1310 PyObject *runerr;
1311 PyObject *value = PyNumber_Index(item);
1312 if (value == NULL)
1313 return -1;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001314
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001315 /* We're done if PyLong_AsSsize_t() returns without error. */
1316 result = PyLong_AsSsize_t(value);
1317 if (result != -1 || !(runerr = PyErr_Occurred()))
1318 goto finish;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001319
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001320 /* Error handling code -- only manage OverflowError differently */
1321 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
1322 goto finish;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001323
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001324 PyErr_Clear();
1325 /* If no error-handling desired then the default clipping
1326 is sufficient.
1327 */
1328 if (!err) {
1329 assert(PyLong_Check(value));
1330 /* Whether or not it is less than or equal to
1331 zero is determined by the sign of ob_size
1332 */
1333 if (_PyLong_Sign(value) < 0)
1334 result = PY_SSIZE_T_MIN;
1335 else
1336 result = PY_SSIZE_T_MAX;
1337 }
1338 else {
1339 /* Otherwise replace the error with caller's error object. */
1340 PyErr_Format(err,
1341 "cannot fit '%.200s' into an index-sized integer",
1342 item->ob_type->tp_name);
1343 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001344
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001345 finish:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001346 Py_DECREF(value);
1347 return result;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001348}
1349
1350
Guido van Rossume15dee51995-07-18 14:12:02 +00001351PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001352PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001353{
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001354 PyObject *result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001355 PyNumberMethods *m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001356 PyObject *trunc_func;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001357 Py_buffer view;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04001358 _Py_IDENTIFIER(__trunc__);
Christian Heimes15ebc882008-02-04 18:48:49 +00001359
Victor Stinner71aea8e2016-08-19 16:59:55 +02001360 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001361 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001362 }
1363
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001364 if (PyLong_CheckExact(o)) {
1365 Py_INCREF(o);
1366 return o;
1367 }
1368 m = o->ob_type->tp_as_number;
1369 if (m && m->nb_int) { /* This should include subclasses of int */
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001370 result = _PyLong_FromNbInt(o);
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001371 if (result != NULL && !PyLong_CheckExact(result)) {
1372 Py_SETREF(result, _PyLong_Copy((PyLongObject *)result));
1373 }
1374 return result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001375 }
Benjamin Peterson1b1a8e72012-03-20 23:48:11 -04001376 trunc_func = _PyObject_LookupSpecial(o, &PyId___trunc__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001377 if (trunc_func) {
INADA Naoki72dccde2017-02-16 09:26:01 +09001378 result = _PyObject_CallNoArg(trunc_func);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001379 Py_DECREF(trunc_func);
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001380 if (result == NULL || PyLong_CheckExact(result)) {
1381 return result;
1382 }
1383 if (PyLong_Check(result)) {
1384 Py_SETREF(result, _PyLong_Copy((PyLongObject *)result));
1385 return result;
1386 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001387 /* __trunc__ is specified to return an Integral type,
Martin Panter7462b6492015-11-02 03:37:02 +00001388 but int() needs to return an int. */
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001389 m = result->ob_type->tp_as_number;
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001390 if (m == NULL || (m->nb_index == NULL && m->nb_int == NULL)) {
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001391 PyErr_Format(
1392 PyExc_TypeError,
1393 "__trunc__ returned non-Integral (type %.200s)",
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001394 result->ob_type->tp_name);
1395 Py_DECREF(result);
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001396 return NULL;
1397 }
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +02001398 Py_SETREF(result, _PyLong_FromNbIndexOrNbInt(result));
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001399 if (result != NULL && !PyLong_CheckExact(result)) {
1400 Py_SETREF(result, _PyLong_Copy((PyLongObject *)result));
1401 }
1402 return result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001403 }
Benjamin Peterson1b1a8e72012-03-20 23:48:11 -04001404 if (PyErr_Occurred())
1405 return NULL;
Christian Heimes15ebc882008-02-04 18:48:49 +00001406
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001407 if (PyUnicode_Check(o))
1408 /* The below check is done in PyLong_FromUnicode(). */
1409 return PyLong_FromUnicodeObject(o, 10);
1410
Martin Pantereeb896c2015-11-07 02:32:21 +00001411 if (PyBytes_Check(o))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001412 /* need to do extra error checking that PyLong_FromString()
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03001413 * doesn't do. In particular int('9\x005') must raise an
1414 * exception, not truncate at the null.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001415 */
Martin Pantereeb896c2015-11-07 02:32:21 +00001416 return _PyLong_FromBytes(PyBytes_AS_STRING(o),
1417 PyBytes_GET_SIZE(o), 10);
1418
1419 if (PyByteArray_Check(o))
1420 return _PyLong_FromBytes(PyByteArray_AS_STRING(o),
1421 PyByteArray_GET_SIZE(o), 10);
1422
1423 if (PyObject_GetBuffer(o, &view, PyBUF_SIMPLE) == 0) {
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001424 PyObject *bytes;
Martin Pantereeb896c2015-11-07 02:32:21 +00001425
1426 /* Copy to NUL-terminated buffer. */
1427 bytes = PyBytes_FromStringAndSize((const char *)view.buf, view.len);
1428 if (bytes == NULL) {
1429 PyBuffer_Release(&view);
1430 return NULL;
1431 }
1432 result = _PyLong_FromBytes(PyBytes_AS_STRING(bytes),
1433 PyBytes_GET_SIZE(bytes), 10);
1434 Py_DECREF(bytes);
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001435 PyBuffer_Release(&view);
1436 return result;
1437 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001438
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001439 return type_error("int() argument must be a string, a bytes-like object "
1440 "or a number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001441}
1442
1443PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001444PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001445{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001446 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001447
Victor Stinner71aea8e2016-08-19 16:59:55 +02001448 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001449 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001450 }
1451
Serhiy Storchaka16931c32016-06-03 21:42:55 +03001452 if (PyFloat_CheckExact(o)) {
1453 Py_INCREF(o);
1454 return o;
1455 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001456 m = o->ob_type->tp_as_number;
1457 if (m && m->nb_float) { /* This should include subclasses of float */
1458 PyObject *res = m->nb_float(o);
Serhiy Storchaka16931c32016-06-03 21:42:55 +03001459 double val;
1460 if (!res || PyFloat_CheckExact(res)) {
1461 return res;
1462 }
1463 if (!PyFloat_Check(res)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001464 PyErr_Format(PyExc_TypeError,
Serhiy Storchaka16931c32016-06-03 21:42:55 +03001465 "%.50s.__float__ returned non-float (type %.50s)",
1466 o->ob_type->tp_name, res->ob_type->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001467 Py_DECREF(res);
1468 return NULL;
1469 }
Serhiy Storchaka16931c32016-06-03 21:42:55 +03001470 /* Issue #26983: warn if 'res' not of exact type float. */
1471 if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
1472 "%.50s.__float__ returned non-float (type %.50s). "
1473 "The ability to return an instance of a strict subclass of float "
1474 "is deprecated, and may be removed in a future version of Python.",
1475 o->ob_type->tp_name, res->ob_type->tp_name)) {
1476 Py_DECREF(res);
1477 return NULL;
1478 }
1479 val = PyFloat_AS_DOUBLE(res);
1480 Py_DECREF(res);
1481 return PyFloat_FromDouble(val);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001482 }
1483 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
Serhiy Storchaka16931c32016-06-03 21:42:55 +03001484 return PyFloat_FromDouble(PyFloat_AS_DOUBLE(o));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001485 }
1486 return PyFloat_FromString(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001487}
1488
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001489
1490PyObject *
1491PyNumber_ToBase(PyObject *n, int base)
1492{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001493 PyObject *res = NULL;
1494 PyObject *index = PyNumber_Index(n);
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001495
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001496 if (!index)
1497 return NULL;
1498 if (PyLong_Check(index))
1499 res = _PyLong_Format(index, base);
1500 else
1501 /* It should not be possible to get here, as
1502 PyNumber_Index already has a check for the same
1503 condition */
Serhiy Storchaka95949422013-08-27 19:40:23 +03001504 PyErr_SetString(PyExc_ValueError, "PyNumber_ToBase: index not int");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001505 Py_DECREF(index);
1506 return res;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001507}
1508
1509
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001510/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001511
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001512int
Fred Drake79912472000-07-09 04:06:11 +00001513PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001514{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001515 if (PyDict_Check(s))
1516 return 0;
Alexey Izbyshevb57b4ac2018-08-26 02:52:27 +03001517 return s->ob_type->tp_as_sequence &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001518 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001519}
1520
Martin v. Löwis18e16552006-02-15 17:27:45 +00001521Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001522PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001523{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001524 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001525
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001526 if (s == NULL) {
1527 null_error();
1528 return -1;
1529 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001530
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001531 m = s->ob_type->tp_as_sequence;
Serhiy Storchaka813f9432017-04-16 09:21:44 +03001532 if (m && m->sq_length) {
1533 Py_ssize_t len = m->sq_length(s);
1534 assert(len >= 0 || PyErr_Occurred());
1535 return len;
1536 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001537
Serhiy Storchakaa6fdddb2018-07-23 23:43:42 +03001538 if (s->ob_type->tp_as_mapping && s->ob_type->tp_as_mapping->mp_length) {
1539 type_error("%.200s is not a sequence", s);
1540 return -1;
1541 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001542 type_error("object of type '%.200s' has no len()", s);
1543 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001544}
1545
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001546#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001547Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001548PySequence_Length(PyObject *s)
1549{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001550 return PySequence_Size(s);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001551}
1552#define PySequence_Length PySequence_Size
1553
Guido van Rossume15dee51995-07-18 14:12:02 +00001554PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001555PySequence_Concat(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001556{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001557 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001558
Victor Stinner71aea8e2016-08-19 16:59:55 +02001559 if (s == NULL || o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001560 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001561 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001562
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001563 m = s->ob_type->tp_as_sequence;
1564 if (m && m->sq_concat)
1565 return m->sq_concat(s, o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001566
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567 /* Instances of user classes defining an __add__() method only
1568 have an nb_add slot, not an sq_concat slot. So we fall back
1569 to nb_add if both arguments appear to be sequences. */
1570 if (PySequence_Check(s) && PySequence_Check(o)) {
1571 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1572 if (result != Py_NotImplemented)
1573 return result;
1574 Py_DECREF(result);
1575 }
1576 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001577}
1578
1579PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001580PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001581{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001582 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001583
Victor Stinner71aea8e2016-08-19 16:59:55 +02001584 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001585 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001586 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001587
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001588 m = o->ob_type->tp_as_sequence;
1589 if (m && m->sq_repeat)
1590 return m->sq_repeat(o, count);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001591
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001592 /* Instances of user classes defining a __mul__() method only
1593 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1594 to nb_multiply if o appears to be a sequence. */
1595 if (PySequence_Check(o)) {
1596 PyObject *n, *result;
1597 n = PyLong_FromSsize_t(count);
1598 if (n == NULL)
1599 return NULL;
1600 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1601 Py_DECREF(n);
1602 if (result != Py_NotImplemented)
1603 return result;
1604 Py_DECREF(result);
1605 }
1606 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001607}
1608
1609PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001610PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1611{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001612 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001613
Victor Stinner71aea8e2016-08-19 16:59:55 +02001614 if (s == NULL || o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001615 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001616 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001617
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001618 m = s->ob_type->tp_as_sequence;
1619 if (m && m->sq_inplace_concat)
1620 return m->sq_inplace_concat(s, o);
1621 if (m && m->sq_concat)
1622 return m->sq_concat(s, o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001623
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 if (PySequence_Check(s) && PySequence_Check(o)) {
1625 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1626 NB_SLOT(nb_add));
1627 if (result != Py_NotImplemented)
1628 return result;
1629 Py_DECREF(result);
1630 }
1631 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001632}
1633
1634PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001635PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001636{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001637 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001638
Victor Stinner71aea8e2016-08-19 16:59:55 +02001639 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001640 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001641 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001642
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001643 m = o->ob_type->tp_as_sequence;
1644 if (m && m->sq_inplace_repeat)
1645 return m->sq_inplace_repeat(o, count);
1646 if (m && m->sq_repeat)
1647 return m->sq_repeat(o, count);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001648
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001649 if (PySequence_Check(o)) {
1650 PyObject *n, *result;
1651 n = PyLong_FromSsize_t(count);
1652 if (n == NULL)
1653 return NULL;
1654 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1655 NB_SLOT(nb_multiply));
1656 Py_DECREF(n);
1657 if (result != Py_NotImplemented)
1658 return result;
1659 Py_DECREF(result);
1660 }
1661 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001662}
1663
1664PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001665PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001666{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001667 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001668
Victor Stinner71aea8e2016-08-19 16:59:55 +02001669 if (s == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001670 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001671 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001672
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001673 m = s->ob_type->tp_as_sequence;
1674 if (m && m->sq_item) {
1675 if (i < 0) {
1676 if (m->sq_length) {
1677 Py_ssize_t l = (*m->sq_length)(s);
Victor Stinnere20310f2015-11-05 13:56:58 +01001678 if (l < 0) {
1679 assert(PyErr_Occurred());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001680 return NULL;
Victor Stinnere20310f2015-11-05 13:56:58 +01001681 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001682 i += l;
1683 }
1684 }
1685 return m->sq_item(s, i);
1686 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001687
Serhiy Storchakaa6fdddb2018-07-23 23:43:42 +03001688 if (s->ob_type->tp_as_mapping && s->ob_type->tp_as_mapping->mp_subscript) {
1689 return type_error("%.200s is not a sequence", s);
1690 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001691 return type_error("'%.200s' object does not support indexing", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001692}
1693
1694PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001695PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00001696{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001697 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001698
Victor Stinner71aea8e2016-08-19 16:59:55 +02001699 if (!s) {
1700 return null_error();
1701 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001702
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001703 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001704 if (mp && mp->mp_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001705 PyObject *res;
1706 PyObject *slice = _PySlice_FromIndices(i1, i2);
1707 if (!slice)
1708 return NULL;
1709 res = mp->mp_subscript(s, slice);
1710 Py_DECREF(slice);
1711 return res;
1712 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001713
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001714 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001715}
1716
1717int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001718PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001719{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001720 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001721
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001722 if (s == NULL) {
1723 null_error();
1724 return -1;
1725 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001726
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001727 m = s->ob_type->tp_as_sequence;
1728 if (m && m->sq_ass_item) {
1729 if (i < 0) {
1730 if (m->sq_length) {
1731 Py_ssize_t l = (*m->sq_length)(s);
Serhiy Storchaka813f9432017-04-16 09:21:44 +03001732 if (l < 0) {
1733 assert(PyErr_Occurred());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001734 return -1;
Serhiy Storchaka813f9432017-04-16 09:21:44 +03001735 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001736 i += l;
1737 }
1738 }
1739 return m->sq_ass_item(s, i, o);
1740 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001741
Serhiy Storchakaa6fdddb2018-07-23 23:43:42 +03001742 if (s->ob_type->tp_as_mapping && s->ob_type->tp_as_mapping->mp_ass_subscript) {
1743 type_error("%.200s is not a sequence", s);
1744 return -1;
1745 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001746 type_error("'%.200s' object does not support item assignment", s);
1747 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001748}
1749
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001750int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001751PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001752{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001753 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001754
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001755 if (s == NULL) {
1756 null_error();
1757 return -1;
1758 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001759
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001760 m = s->ob_type->tp_as_sequence;
1761 if (m && m->sq_ass_item) {
1762 if (i < 0) {
1763 if (m->sq_length) {
1764 Py_ssize_t l = (*m->sq_length)(s);
Serhiy Storchaka813f9432017-04-16 09:21:44 +03001765 if (l < 0) {
1766 assert(PyErr_Occurred());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001767 return -1;
Serhiy Storchaka813f9432017-04-16 09:21:44 +03001768 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001769 i += l;
1770 }
1771 }
1772 return m->sq_ass_item(s, i, (PyObject *)NULL);
1773 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001774
Serhiy Storchakaa6fdddb2018-07-23 23:43:42 +03001775 if (s->ob_type->tp_as_mapping && s->ob_type->tp_as_mapping->mp_ass_subscript) {
1776 type_error("%.200s is not a sequence", s);
1777 return -1;
1778 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001779 type_error("'%.200s' object doesn't support item deletion", s);
1780 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001781}
1782
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001783int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001784PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001785{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001786 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001787
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001788 if (s == NULL) {
1789 null_error();
1790 return -1;
1791 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001792
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001793 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001794 if (mp && mp->mp_ass_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001795 int res;
1796 PyObject *slice = _PySlice_FromIndices(i1, i2);
1797 if (!slice)
1798 return -1;
1799 res = mp->mp_ass_subscript(s, slice, o);
1800 Py_DECREF(slice);
1801 return res;
1802 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00001803
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001804 type_error("'%.200s' object doesn't support slice assignment", s);
1805 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001806}
1807
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001808int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001809PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001810{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001811 PyMappingMethods *mp;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001812
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001813 if (s == NULL) {
1814 null_error();
1815 return -1;
1816 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001817
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001818 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001819 if (mp && mp->mp_ass_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001820 int res;
1821 PyObject *slice = _PySlice_FromIndices(i1, i2);
1822 if (!slice)
1823 return -1;
1824 res = mp->mp_ass_subscript(s, slice, NULL);
1825 Py_DECREF(slice);
1826 return res;
1827 }
1828 type_error("'%.200s' object doesn't support slice deletion", s);
1829 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001830}
1831
Guido van Rossume15dee51995-07-18 14:12:02 +00001832PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001833PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00001834{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001835 PyObject *it; /* iter(v) */
1836 Py_ssize_t n; /* guess for result tuple size */
1837 PyObject *result = NULL;
1838 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00001839
Victor Stinner71aea8e2016-08-19 16:59:55 +02001840 if (v == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001841 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001842 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001843
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001844 /* Special-case the common tuple and list cases, for efficiency. */
1845 if (PyTuple_CheckExact(v)) {
1846 /* Note that we can't know whether it's safe to return
1847 a tuple *subclass* instance as-is, hence the restriction
1848 to exact tuples here. In contrast, lists always make
1849 a copy, so there's no need for exactness below. */
1850 Py_INCREF(v);
1851 return v;
1852 }
Raymond Hettinger610a51f2015-05-17 14:45:58 -07001853 if (PyList_CheckExact(v))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001854 return PyList_AsTuple(v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001855
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001856 /* Get iterator. */
1857 it = PyObject_GetIter(v);
1858 if (it == NULL)
1859 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001860
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001861 /* Guess result size and allocate space. */
Armin Ronacheraa9a79d2012-10-06 14:03:24 +02001862 n = PyObject_LengthHint(v, 10);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001863 if (n == -1)
1864 goto Fail;
1865 result = PyTuple_New(n);
1866 if (result == NULL)
1867 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001868
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001869 /* Fill the tuple. */
1870 for (j = 0; ; ++j) {
1871 PyObject *item = PyIter_Next(it);
1872 if (item == NULL) {
1873 if (PyErr_Occurred())
1874 goto Fail;
1875 break;
1876 }
1877 if (j >= n) {
Martin Pantere8db8612016-07-25 02:30:05 +00001878 size_t newn = (size_t)n;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001879 /* The over-allocation strategy can grow a bit faster
1880 than for lists because unlike lists the
1881 over-allocation isn't permanent -- we reclaim
1882 the excess before the end of this routine.
1883 So, grow by ten and then add 25%.
1884 */
Martin Pantere8db8612016-07-25 02:30:05 +00001885 newn += 10u;
1886 newn += newn >> 2;
1887 if (newn > PY_SSIZE_T_MAX) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001888 /* Check for overflow */
1889 PyErr_NoMemory();
1890 Py_DECREF(item);
1891 goto Fail;
1892 }
Martin Pantere8db8612016-07-25 02:30:05 +00001893 n = (Py_ssize_t)newn;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001894 if (_PyTuple_Resize(&result, n) != 0) {
1895 Py_DECREF(item);
1896 goto Fail;
1897 }
1898 }
1899 PyTuple_SET_ITEM(result, j, item);
1900 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001901
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001902 /* Cut tuple back if guess was too large. */
1903 if (j < n &&
1904 _PyTuple_Resize(&result, j) != 0)
1905 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001906
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001907 Py_DECREF(it);
1908 return result;
Tim Peters6912d4d2001-05-05 03:56:37 +00001909
1910Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001911 Py_XDECREF(result);
1912 Py_DECREF(it);
1913 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001914}
1915
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001916PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001917PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001918{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001919 PyObject *result; /* result list */
1920 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00001921
Victor Stinner71aea8e2016-08-19 16:59:55 +02001922 if (v == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001923 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001924 }
Guido van Rossum5dba9e81998-07-10 18:03:50 +00001925
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001926 result = PyList_New(0);
1927 if (result == NULL)
1928 return NULL;
Tim Petersf553f892001-05-01 20:45:31 +00001929
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001930 rv = _PyList_Extend((PyListObject *)result, v);
1931 if (rv == NULL) {
1932 Py_DECREF(result);
1933 return NULL;
1934 }
1935 Py_DECREF(rv);
1936 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001937}
1938
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001939PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001940PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001941{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001942 PyObject *it;
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001943
Victor Stinner71aea8e2016-08-19 16:59:55 +02001944 if (v == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001945 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001946 }
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001947
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001948 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
1949 Py_INCREF(v);
1950 return v;
1951 }
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001952
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001953 it = PyObject_GetIter(v);
1954 if (it == NULL) {
1955 if (PyErr_ExceptionMatches(PyExc_TypeError))
1956 PyErr_SetString(PyExc_TypeError, m);
1957 return NULL;
1958 }
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001959
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001960 v = PySequence_List(it);
1961 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001962
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001963 return v;
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001964}
1965
Tim Peters16a77ad2001-09-08 04:00:12 +00001966/* Iterate over seq. Result depends on the operation:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001967 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
1968 PY_ITERSEARCH_INDEX: 0-based index of first occurrence of obj in seq;
1969 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00001970 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
1971*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001972Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001973_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00001974{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001975 Py_ssize_t n;
1976 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
1977 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00001978
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001979 if (seq == NULL || obj == NULL) {
1980 null_error();
1981 return -1;
1982 }
Tim Peters75f8e352001-05-05 11:33:43 +00001983
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001984 it = PyObject_GetIter(seq);
1985 if (it == NULL) {
1986 type_error("argument of type '%.200s' is not iterable", seq);
1987 return -1;
1988 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001989
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001990 n = wrapped = 0;
1991 for (;;) {
1992 int cmp;
1993 PyObject *item = PyIter_Next(it);
1994 if (item == NULL) {
1995 if (PyErr_Occurred())
1996 goto Fail;
1997 break;
1998 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001999
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002000 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
2001 Py_DECREF(item);
2002 if (cmp < 0)
2003 goto Fail;
2004 if (cmp > 0) {
2005 switch (operation) {
2006 case PY_ITERSEARCH_COUNT:
2007 if (n == PY_SSIZE_T_MAX) {
2008 PyErr_SetString(PyExc_OverflowError,
2009 "count exceeds C integer size");
2010 goto Fail;
2011 }
2012 ++n;
2013 break;
Tim Peters16a77ad2001-09-08 04:00:12 +00002014
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002015 case PY_ITERSEARCH_INDEX:
2016 if (wrapped) {
2017 PyErr_SetString(PyExc_OverflowError,
2018 "index exceeds C integer size");
2019 goto Fail;
2020 }
2021 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00002022
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002023 case PY_ITERSEARCH_CONTAINS:
2024 n = 1;
2025 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00002026
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002027 default:
Barry Warsawb2e57942017-09-14 18:13:16 -07002028 Py_UNREACHABLE();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002029 }
2030 }
Tim Peters16a77ad2001-09-08 04:00:12 +00002031
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002032 if (operation == PY_ITERSEARCH_INDEX) {
2033 if (n == PY_SSIZE_T_MAX)
2034 wrapped = 1;
2035 ++n;
2036 }
2037 }
Tim Peters16a77ad2001-09-08 04:00:12 +00002038
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002039 if (operation != PY_ITERSEARCH_INDEX)
2040 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00002041
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002042 PyErr_SetString(PyExc_ValueError,
2043 "sequence.index(x): x not in sequence");
2044 /* fall into failure code */
Tim Peters16a77ad2001-09-08 04:00:12 +00002045Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002046 n = -1;
2047 /* fall through */
Tim Peters16a77ad2001-09-08 04:00:12 +00002048Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002049 Py_DECREF(it);
2050 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00002051
Guido van Rossume15dee51995-07-18 14:12:02 +00002052}
2053
Tim Peters16a77ad2001-09-08 04:00:12 +00002054/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00002055Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00002056PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002057{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002058 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00002059}
2060
Tim Peterscb8d3682001-05-05 21:05:01 +00002061/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00002062 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00002063 */
2064int
2065PySequence_Contains(PyObject *seq, PyObject *ob)
2066{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002067 Py_ssize_t result;
2068 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
2069 if (sqm != NULL && sqm->sq_contains != NULL)
2070 return (*sqm->sq_contains)(seq, ob);
2071 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
2072 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00002073}
2074
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002075/* Backwards compatibility */
2076#undef PySequence_In
2077int
Fred Drake79912472000-07-09 04:06:11 +00002078PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002079{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002080 return PySequence_Contains(w, v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002081}
2082
Neal Norwitz1fc4b772006-03-04 18:49:58 +00002083Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00002084PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002085{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002086 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00002087}
2088
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002089/* Operations on mappings */
2090
2091int
Fred Drake79912472000-07-09 04:06:11 +00002092PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002093{
Benjamin Peterson21992272011-12-28 12:01:31 -06002094 return o && o->ob_type->tp_as_mapping &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002095 o->ob_type->tp_as_mapping->mp_subscript;
Guido van Rossume15dee51995-07-18 14:12:02 +00002096}
2097
Martin v. Löwis18e16552006-02-15 17:27:45 +00002098Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00002099PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002100{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002101 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00002102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002103 if (o == NULL) {
2104 null_error();
2105 return -1;
2106 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002107
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002108 m = o->ob_type->tp_as_mapping;
Serhiy Storchaka813f9432017-04-16 09:21:44 +03002109 if (m && m->mp_length) {
2110 Py_ssize_t len = m->mp_length(o);
2111 assert(len >= 0 || PyErr_Occurred());
2112 return len;
2113 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002114
Serhiy Storchakaa6fdddb2018-07-23 23:43:42 +03002115 if (o->ob_type->tp_as_sequence && o->ob_type->tp_as_sequence->sq_length) {
2116 type_error("%.200s is not a mapping", o);
2117 return -1;
2118 }
2119 /* PyMapping_Size() can be called from PyObject_Size(). */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002120 type_error("object of type '%.200s' has no len()", o);
2121 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00002122}
2123
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002124#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00002125Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002126PyMapping_Length(PyObject *o)
2127{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002128 return PyMapping_Size(o);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002129}
2130#define PyMapping_Length PyMapping_Size
2131
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002132PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +03002133PyMapping_GetItemString(PyObject *o, const char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002134{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002135 PyObject *okey, *r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002136
Victor Stinner71aea8e2016-08-19 16:59:55 +02002137 if (key == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002138 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02002139 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002140
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002141 okey = PyUnicode_FromString(key);
2142 if (okey == NULL)
2143 return NULL;
2144 r = PyObject_GetItem(o, okey);
2145 Py_DECREF(okey);
2146 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002147}
2148
2149int
Serhiy Storchakac6792272013-10-19 21:03:34 +03002150PyMapping_SetItemString(PyObject *o, const char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002151{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002152 PyObject *okey;
2153 int r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002154
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002155 if (key == NULL) {
2156 null_error();
2157 return -1;
2158 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002159
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002160 okey = PyUnicode_FromString(key);
2161 if (okey == NULL)
2162 return -1;
2163 r = PyObject_SetItem(o, okey, value);
2164 Py_DECREF(okey);
2165 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002166}
2167
2168int
Serhiy Storchakac6792272013-10-19 21:03:34 +03002169PyMapping_HasKeyString(PyObject *o, const char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002170{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002171 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002172
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002173 v = PyMapping_GetItemString(o, key);
2174 if (v) {
2175 Py_DECREF(v);
2176 return 1;
2177 }
2178 PyErr_Clear();
2179 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002180}
2181
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002182int
Fred Drake79912472000-07-09 04:06:11 +00002183PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002184{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002185 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002186
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002187 v = PyObject_GetItem(o, key);
2188 if (v) {
2189 Py_DECREF(v);
2190 return 1;
2191 }
2192 PyErr_Clear();
2193 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002194}
2195
Oren Milman0ccc0f62017-10-08 11:17:46 +03002196/* This function is quite similar to PySequence_Fast(), but specialized to be
2197 a helper for PyMapping_Keys(), PyMapping_Items() and PyMapping_Values().
2198 */
2199static PyObject *
2200method_output_as_list(PyObject *o, _Py_Identifier *meth_id)
2201{
2202 PyObject *it, *result, *meth_output;
2203
2204 assert(o != NULL);
2205 meth_output = _PyObject_CallMethodId(o, meth_id, NULL);
2206 if (meth_output == NULL || PyList_CheckExact(meth_output)) {
2207 return meth_output;
2208 }
2209 it = PyObject_GetIter(meth_output);
2210 if (it == NULL) {
2211 if (PyErr_ExceptionMatches(PyExc_TypeError)) {
2212 PyErr_Format(PyExc_TypeError,
2213 "%.200s.%U() returned a non-iterable (type %.200s)",
2214 Py_TYPE(o)->tp_name,
2215 meth_id->object,
2216 Py_TYPE(meth_output)->tp_name);
2217 }
2218 Py_DECREF(meth_output);
2219 return NULL;
2220 }
2221 Py_DECREF(meth_output);
2222 result = PySequence_List(it);
2223 Py_DECREF(it);
2224 return result;
2225}
2226
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002227PyObject *
2228PyMapping_Keys(PyObject *o)
2229{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002230 _Py_IDENTIFIER(keys);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002231
Oren Milman0ccc0f62017-10-08 11:17:46 +03002232 if (o == NULL) {
2233 return null_error();
2234 }
2235 if (PyDict_CheckExact(o)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002236 return PyDict_Keys(o);
Oren Milman0ccc0f62017-10-08 11:17:46 +03002237 }
2238 return method_output_as_list(o, &PyId_keys);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002239}
2240
2241PyObject *
2242PyMapping_Items(PyObject *o)
2243{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002244 _Py_IDENTIFIER(items);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002245
Oren Milman0ccc0f62017-10-08 11:17:46 +03002246 if (o == NULL) {
2247 return null_error();
2248 }
2249 if (PyDict_CheckExact(o)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002250 return PyDict_Items(o);
Oren Milman0ccc0f62017-10-08 11:17:46 +03002251 }
2252 return method_output_as_list(o, &PyId_items);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002253}
2254
2255PyObject *
2256PyMapping_Values(PyObject *o)
2257{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002258 _Py_IDENTIFIER(values);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002259
Oren Milman0ccc0f62017-10-08 11:17:46 +03002260 if (o == NULL) {
2261 return null_error();
2262 }
2263 if (PyDict_CheckExact(o)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002264 return PyDict_Values(o);
Oren Milman0ccc0f62017-10-08 11:17:46 +03002265 }
2266 return method_output_as_list(o, &PyId_values);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002267}
2268
Guido van Rossum823649d2001-03-21 18:40:58 +00002269/* isinstance(), issubclass() */
2270
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002271/* abstract_get_bases() has logically 4 return states:
Barry Warsawf16951c2002-04-23 22:45:44 +00002272 *
Barry Warsawf16951c2002-04-23 22:45:44 +00002273 * 1. getattr(cls, '__bases__') could raise an AttributeError
2274 * 2. getattr(cls, '__bases__') could raise some other exception
2275 * 3. getattr(cls, '__bases__') could return a tuple
2276 * 4. getattr(cls, '__bases__') could return something other than a tuple
2277 *
2278 * Only state #3 is a non-error state and only it returns a non-NULL object
2279 * (it returns the retrieved tuple).
2280 *
2281 * Any raised AttributeErrors are masked by clearing the exception and
2282 * returning NULL. If an object other than a tuple comes out of __bases__,
2283 * then again, the return value is NULL. So yes, these two situations
2284 * produce exactly the same results: NULL is returned and no error is set.
2285 *
2286 * If some exception other than AttributeError is raised, then NULL is also
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002287 * returned, but the exception is not cleared. That's because we want the
Barry Warsawf16951c2002-04-23 22:45:44 +00002288 * exception to be propagated along.
2289 *
2290 * Callers are expected to test for PyErr_Occurred() when the return value
2291 * is NULL to decide whether a valid exception should be propagated or not.
2292 * When there's no exception to propagate, it's customary for the caller to
2293 * set a TypeError.
2294 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002295static PyObject *
2296abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002297{
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002298 _Py_IDENTIFIER(__bases__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002299 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002300
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002301 Py_ALLOW_RECURSION
Serhiy Storchakaf320be72018-01-25 10:49:40 +02002302 (void)_PyObject_LookupAttrId(cls, &PyId___bases__, &bases);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002303 Py_END_ALLOW_RECURSION
Serhiy Storchakaf320be72018-01-25 10:49:40 +02002304 if (bases != NULL && !PyTuple_Check(bases)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002305 Py_DECREF(bases);
2306 return NULL;
2307 }
2308 return bases;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002309}
2310
2311
2312static int
2313abstract_issubclass(PyObject *derived, PyObject *cls)
2314{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002315 PyObject *bases = NULL;
2316 Py_ssize_t i, n;
2317 int r = 0;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002318
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002319 while (1) {
2320 if (derived == cls)
2321 return 1;
2322 bases = abstract_get_bases(derived);
2323 if (bases == NULL) {
2324 if (PyErr_Occurred())
2325 return -1;
2326 return 0;
2327 }
2328 n = PyTuple_GET_SIZE(bases);
2329 if (n == 0) {
2330 Py_DECREF(bases);
2331 return 0;
2332 }
2333 /* Avoid recursivity in the single inheritance case */
2334 if (n == 1) {
2335 derived = PyTuple_GET_ITEM(bases, 0);
2336 Py_DECREF(bases);
2337 continue;
2338 }
2339 for (i = 0; i < n; i++) {
2340 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
2341 if (r != 0)
2342 break;
2343 }
2344 Py_DECREF(bases);
2345 return r;
2346 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002347}
2348
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002349static int
2350check_class(PyObject *cls, const char *error)
2351{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002352 PyObject *bases = abstract_get_bases(cls);
2353 if (bases == NULL) {
2354 /* Do not mask errors. */
2355 if (!PyErr_Occurred())
2356 PyErr_SetString(PyExc_TypeError, error);
2357 return 0;
2358 }
2359 Py_DECREF(bases);
2360 return -1;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002361}
2362
Brett Cannon4f653312004-03-20 22:52:14 +00002363static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002364recursive_isinstance(PyObject *inst, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002365{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002366 PyObject *icls;
Serhiy Storchakaf320be72018-01-25 10:49:40 +02002367 int retval;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002368 _Py_IDENTIFIER(__class__);
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002369
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002370 if (PyType_Check(cls)) {
2371 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
2372 if (retval == 0) {
Serhiy Storchakaf320be72018-01-25 10:49:40 +02002373 retval = _PyObject_LookupAttrId(inst, &PyId___class__, &icls);
2374 if (icls != NULL) {
2375 if (icls != (PyObject *)(inst->ob_type) && PyType_Check(icls)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002376 retval = PyType_IsSubtype(
Serhiy Storchakaf320be72018-01-25 10:49:40 +02002377 (PyTypeObject *)icls,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002378 (PyTypeObject *)cls);
Serhiy Storchakaf320be72018-01-25 10:49:40 +02002379 }
2380 else {
2381 retval = 0;
2382 }
2383 Py_DECREF(icls);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002384 }
2385 }
2386 }
2387 else {
2388 if (!check_class(cls,
Benjamin Petersone893af52010-06-28 19:43:42 +00002389 "isinstance() arg 2 must be a type or tuple of types"))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002390 return -1;
Serhiy Storchakaf320be72018-01-25 10:49:40 +02002391 retval = _PyObject_LookupAttrId(inst, &PyId___class__, &icls);
2392 if (icls != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002393 retval = abstract_issubclass(icls, cls);
2394 Py_DECREF(icls);
2395 }
2396 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002397
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002398 return retval;
Guido van Rossum823649d2001-03-21 18:40:58 +00002399}
2400
2401int
Brett Cannon4f653312004-03-20 22:52:14 +00002402PyObject_IsInstance(PyObject *inst, PyObject *cls)
2403{
Benjamin Petersonce798522012-01-22 11:24:29 -05002404 _Py_IDENTIFIER(__instancecheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002405 PyObject *checker;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002406
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002407 /* Quick test for an exact match */
2408 if (Py_TYPE(inst) == (PyTypeObject *)cls)
2409 return 1;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002410
Georg Brandl72b8a802014-10-03 09:26:37 +02002411 /* We know what type's __instancecheck__ does. */
2412 if (PyType_CheckExact(cls)) {
2413 return recursive_isinstance(inst, cls);
2414 }
2415
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002416 if (PyTuple_Check(cls)) {
2417 Py_ssize_t i;
2418 Py_ssize_t n;
2419 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002420
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002421 if (Py_EnterRecursiveCall(" in __instancecheck__"))
2422 return -1;
2423 n = PyTuple_GET_SIZE(cls);
2424 for (i = 0; i < n; ++i) {
2425 PyObject *item = PyTuple_GET_ITEM(cls, i);
2426 r = PyObject_IsInstance(inst, item);
2427 if (r != 0)
2428 /* either found it, or got an error */
2429 break;
2430 }
2431 Py_LeaveRecursiveCall();
2432 return r;
2433 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002434
Benjamin Petersonce798522012-01-22 11:24:29 -05002435 checker = _PyObject_LookupSpecial(cls, &PyId___instancecheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002436 if (checker != NULL) {
2437 PyObject *res;
2438 int ok = -1;
2439 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2440 Py_DECREF(checker);
2441 return ok;
2442 }
Victor Stinnerde4ae3d2016-12-04 22:59:09 +01002443 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002444 Py_LeaveRecursiveCall();
2445 Py_DECREF(checker);
2446 if (res != NULL) {
2447 ok = PyObject_IsTrue(res);
2448 Py_DECREF(res);
2449 }
2450 return ok;
2451 }
2452 else if (PyErr_Occurred())
2453 return -1;
Georg Brandl72b8a802014-10-03 09:26:37 +02002454 /* Probably never reached anymore. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002455 return recursive_isinstance(inst, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002456}
2457
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002458static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002459recursive_issubclass(PyObject *derived, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002460{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002461 if (PyType_Check(cls) && PyType_Check(derived)) {
2462 /* Fast path (non-recursive) */
2463 return PyType_IsSubtype((PyTypeObject *)derived, (PyTypeObject *)cls);
2464 }
2465 if (!check_class(derived,
2466 "issubclass() arg 1 must be a class"))
2467 return -1;
2468 if (!check_class(cls,
2469 "issubclass() arg 2 must be a class"
2470 " or tuple of classes"))
2471 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002472
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002473 return abstract_issubclass(derived, cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002474}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002475
Brett Cannon4f653312004-03-20 22:52:14 +00002476int
2477PyObject_IsSubclass(PyObject *derived, PyObject *cls)
2478{
Benjamin Petersonce798522012-01-22 11:24:29 -05002479 _Py_IDENTIFIER(__subclasscheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002480 PyObject *checker;
Georg Brandldcfe8e42009-05-17 08:22:45 +00002481
Georg Brandl72b8a802014-10-03 09:26:37 +02002482 /* We know what type's __subclasscheck__ does. */
2483 if (PyType_CheckExact(cls)) {
2484 /* Quick test for an exact match */
2485 if (derived == cls)
2486 return 1;
2487 return recursive_issubclass(derived, cls);
2488 }
2489
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002490 if (PyTuple_Check(cls)) {
2491 Py_ssize_t i;
2492 Py_ssize_t n;
2493 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002494
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002495 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
2496 return -1;
2497 n = PyTuple_GET_SIZE(cls);
2498 for (i = 0; i < n; ++i) {
2499 PyObject *item = PyTuple_GET_ITEM(cls, i);
2500 r = PyObject_IsSubclass(derived, item);
2501 if (r != 0)
2502 /* either found it, or got an error */
2503 break;
2504 }
2505 Py_LeaveRecursiveCall();
2506 return r;
2507 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002508
Benjamin Petersonce798522012-01-22 11:24:29 -05002509 checker = _PyObject_LookupSpecial(cls, &PyId___subclasscheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002510 if (checker != NULL) {
2511 PyObject *res;
2512 int ok = -1;
2513 if (Py_EnterRecursiveCall(" in __subclasscheck__")) {
2514 Py_DECREF(checker);
2515 return ok;
2516 }
Victor Stinnerde4ae3d2016-12-04 22:59:09 +01002517 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002518 Py_LeaveRecursiveCall();
2519 Py_DECREF(checker);
2520 if (res != NULL) {
2521 ok = PyObject_IsTrue(res);
2522 Py_DECREF(res);
2523 }
2524 return ok;
2525 }
2526 else if (PyErr_Occurred())
2527 return -1;
Georg Brandl72b8a802014-10-03 09:26:37 +02002528 /* Probably never reached anymore. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002529 return recursive_issubclass(derived, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00002530}
2531
2532int
2533_PyObject_RealIsInstance(PyObject *inst, PyObject *cls)
2534{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002535 return recursive_isinstance(inst, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00002536}
2537
2538int
2539_PyObject_RealIsSubclass(PyObject *derived, PyObject *cls)
2540{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002541 return recursive_issubclass(derived, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002542}
2543
2544
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002545PyObject *
2546PyObject_GetIter(PyObject *o)
2547{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002548 PyTypeObject *t = o->ob_type;
Victor Stinner14e6d092016-12-09 17:08:59 +01002549 getiterfunc f;
2550
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002551 f = t->tp_iter;
2552 if (f == NULL) {
2553 if (PySequence_Check(o))
2554 return PySeqIter_New(o);
2555 return type_error("'%.200s' object is not iterable", o);
2556 }
2557 else {
2558 PyObject *res = (*f)(o);
2559 if (res != NULL && !PyIter_Check(res)) {
2560 PyErr_Format(PyExc_TypeError,
2561 "iter() returned non-iterator "
2562 "of type '%.100s'",
2563 res->ob_type->tp_name);
2564 Py_DECREF(res);
2565 res = NULL;
2566 }
2567 return res;
2568 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00002569}
2570
Christian Tismerea62ce72018-06-09 20:32:25 +02002571#undef PyIter_Check
Christian Tismer83987132018-06-11 00:48:28 +02002572
Christian Tismerea62ce72018-06-09 20:32:25 +02002573int PyIter_Check(PyObject *obj)
2574{
2575 return obj->ob_type->tp_iternext != NULL &&
2576 obj->ob_type->tp_iternext != &_PyObject_NextNotImplemented;
2577}
2578
Tim Petersf4848da2001-05-05 00:14:56 +00002579/* Return next item.
2580 * If an error occurs, return NULL. PyErr_Occurred() will be true.
2581 * If the iteration terminates normally, return NULL and clear the
2582 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
2583 * will be false.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002584 * Else return the next object. PyErr_Occurred() will be false.
Tim Petersf4848da2001-05-05 00:14:56 +00002585 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002586PyObject *
2587PyIter_Next(PyObject *iter)
2588{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002589 PyObject *result;
2590 result = (*iter->ob_type->tp_iternext)(iter);
2591 if (result == NULL &&
2592 PyErr_Occurred() &&
2593 PyErr_ExceptionMatches(PyExc_StopIteration))
2594 PyErr_Clear();
2595 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002596}
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002597
2598
2599/*
2600 * Flatten a sequence of bytes() objects into a C array of
2601 * NULL terminated string pointers with a NULL char* terminating the array.
2602 * (ie: an argv or env list)
2603 *
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002604 * Memory allocated for the returned list is allocated using PyMem_Malloc()
2605 * and MUST be freed by _Py_FreeCharPArray().
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002606 */
2607char *const *
2608_PySequence_BytesToCharpArray(PyObject* self)
2609{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002610 char **array;
2611 Py_ssize_t i, argc;
2612 PyObject *item = NULL;
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002613 Py_ssize_t size;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002614
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002615 argc = PySequence_Size(self);
2616 if (argc == -1)
2617 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002618
Stefan Krah7cacd2e2012-08-21 08:16:09 +02002619 assert(argc >= 0);
2620
2621 if ((size_t)argc > (PY_SSIZE_T_MAX-sizeof(char *)) / sizeof(char *)) {
2622 PyErr_NoMemory();
2623 return NULL;
2624 }
2625
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002626 array = PyMem_Malloc((argc + 1) * sizeof(char *));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002627 if (array == NULL) {
2628 PyErr_NoMemory();
2629 return NULL;
2630 }
2631 for (i = 0; i < argc; ++i) {
2632 char *data;
2633 item = PySequence_GetItem(self, i);
Stefan Krahfd24f9e2012-08-20 11:04:24 +02002634 if (item == NULL) {
2635 /* NULL terminate before freeing. */
2636 array[i] = NULL;
2637 goto fail;
2638 }
Serhiy Storchakad174d242017-06-23 19:39:27 +03002639 /* check for embedded null bytes */
2640 if (PyBytes_AsStringAndSize(item, &data, NULL) < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002641 /* NULL terminate before freeing. */
2642 array[i] = NULL;
2643 goto fail;
2644 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002645 size = PyBytes_GET_SIZE(item) + 1;
2646 array[i] = PyMem_Malloc(size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002647 if (!array[i]) {
2648 PyErr_NoMemory();
2649 goto fail;
2650 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002651 memcpy(array[i], data, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002652 Py_DECREF(item);
2653 }
2654 array[argc] = NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002655
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002656 return array;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002657
2658fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002659 Py_XDECREF(item);
2660 _Py_FreeCharPArray(array);
2661 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002662}
2663
2664
2665/* Free's a NULL terminated char** array of C strings. */
2666void
2667_Py_FreeCharPArray(char *const array[])
2668{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002669 Py_ssize_t i;
2670 for (i = 0; array[i] != NULL; ++i) {
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002671 PyMem_Free(array[i]);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002672 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002673 PyMem_Free((void*)array);
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002674}