blob: 0565ba34f5b8234f4d6249be655de990f775005d [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 &&
762 (o->ob_type->tp_as_number->nb_int ||
763 o->ob_type->tp_as_number->nb_float);
Guido van Rossume15dee51995-07-18 14:12:02 +0000764}
765
Guido van Rossumcea1c8c1998-05-22 00:47:05 +0000766/* Binary operators */
Guido van Rossume15dee51995-07-18 14:12:02 +0000767
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000768#define NB_SLOT(x) offsetof(PyNumberMethods, x)
769#define NB_BINOP(nb_methods, slot) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000770 (*(binaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000771#define NB_TERNOP(nb_methods, slot) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000772 (*(ternaryfunc*)(& ((char*)nb_methods)[slot]))
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000773
774/*
775 Calling scheme used for binary operations:
776
Neal Norwitz4886cc32006-08-21 17:06:07 +0000777 Order operations are tried until either a valid result or error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000778 w.op(v,w)[*], v.op(v,w), w.op(v,w)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000779
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000780 [*] only when v->ob_type != w->ob_type && w->ob_type is a subclass of
781 v->ob_type
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000782 */
783
784static PyObject *
785binary_op1(PyObject *v, PyObject *w, const int op_slot)
Guido van Rossume15dee51995-07-18 14:12:02 +0000786{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 PyObject *x;
788 binaryfunc slotv = NULL;
789 binaryfunc slotw = NULL;
Guido van Rossum4bb1e362001-09-28 23:49:48 +0000790
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000791 if (v->ob_type->tp_as_number != NULL)
792 slotv = NB_BINOP(v->ob_type->tp_as_number, op_slot);
793 if (w->ob_type != v->ob_type &&
794 w->ob_type->tp_as_number != NULL) {
795 slotw = NB_BINOP(w->ob_type->tp_as_number, op_slot);
796 if (slotw == slotv)
797 slotw = NULL;
798 }
799 if (slotv) {
800 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
801 x = slotw(v, w);
802 if (x != Py_NotImplemented)
803 return x;
804 Py_DECREF(x); /* can't do it */
805 slotw = NULL;
806 }
807 x = slotv(v, w);
808 if (x != Py_NotImplemented)
809 return x;
810 Py_DECREF(x); /* can't do it */
811 }
812 if (slotw) {
813 x = slotw(v, w);
814 if (x != Py_NotImplemented)
815 return x;
816 Py_DECREF(x); /* can't do it */
817 }
Brian Curtindfc80e32011-08-10 20:28:54 -0500818 Py_RETURN_NOTIMPLEMENTED;
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000819}
Guido van Rossum77660912002-04-16 16:32:50 +0000820
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000821static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000822binop_type_error(PyObject *v, PyObject *w, const char *op_name)
823{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000824 PyErr_Format(PyExc_TypeError,
825 "unsupported operand type(s) for %.100s: "
826 "'%.100s' and '%.100s'",
827 op_name,
828 v->ob_type->tp_name,
829 w->ob_type->tp_name);
830 return NULL;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000831}
832
833static PyObject *
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000834binary_op(PyObject *v, PyObject *w, const int op_slot, const char *op_name)
835{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000836 PyObject *result = binary_op1(v, w, op_slot);
837 if (result == Py_NotImplemented) {
838 Py_DECREF(result);
Sanyam Khurana5e2eb352017-08-18 16:07:36 +0530839
840 if (op_slot == NB_SLOT(nb_rshift) &&
841 PyCFunction_Check(v) &&
842 strcmp(((PyCFunctionObject *)v)->m_ml->ml_name, "print") == 0)
843 {
844 PyErr_Format(PyExc_TypeError,
845 "unsupported operand type(s) for %.100s: "
846 "'%.100s' and '%.100s'. Did you mean \"print(<message>, "
Sanyam Khuranaa7c449b2017-08-18 17:48:14 +0530847 "file=<output_stream>)\"?",
Sanyam Khurana5e2eb352017-08-18 16:07:36 +0530848 op_name,
849 v->ob_type->tp_name,
850 w->ob_type->tp_name);
851 return NULL;
852 }
853
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000854 return binop_type_error(v, w, op_name);
855 }
856 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000857}
858
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000859
860/*
861 Calling scheme used for ternary operations:
862
Neal Norwitz4886cc32006-08-21 17:06:07 +0000863 Order operations are tried until either a valid result or error:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000864 v.op(v,w,z), w.op(v,w,z), z.op(v,w,z)
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000865 */
866
867static PyObject *
868ternary_op(PyObject *v,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000869 PyObject *w,
870 PyObject *z,
871 const int op_slot,
872 const char *op_name)
Guido van Rossume15dee51995-07-18 14:12:02 +0000873{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000874 PyNumberMethods *mv, *mw, *mz;
875 PyObject *x = NULL;
876 ternaryfunc slotv = NULL;
877 ternaryfunc slotw = NULL;
878 ternaryfunc slotz = NULL;
Guido van Rossum77660912002-04-16 16:32:50 +0000879
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000880 mv = v->ob_type->tp_as_number;
881 mw = w->ob_type->tp_as_number;
882 if (mv != NULL)
883 slotv = NB_TERNOP(mv, op_slot);
884 if (w->ob_type != v->ob_type &&
885 mw != NULL) {
886 slotw = NB_TERNOP(mw, op_slot);
887 if (slotw == slotv)
888 slotw = NULL;
889 }
890 if (slotv) {
891 if (slotw && PyType_IsSubtype(w->ob_type, v->ob_type)) {
892 x = slotw(v, w, z);
893 if (x != Py_NotImplemented)
894 return x;
895 Py_DECREF(x); /* can't do it */
896 slotw = NULL;
897 }
898 x = slotv(v, w, z);
899 if (x != Py_NotImplemented)
900 return x;
901 Py_DECREF(x); /* can't do it */
902 }
903 if (slotw) {
904 x = slotw(v, w, z);
905 if (x != Py_NotImplemented)
906 return x;
907 Py_DECREF(x); /* can't do it */
908 }
909 mz = z->ob_type->tp_as_number;
910 if (mz != NULL) {
911 slotz = NB_TERNOP(mz, op_slot);
912 if (slotz == slotv || slotz == slotw)
913 slotz = NULL;
914 if (slotz) {
915 x = slotz(v, w, z);
916 if (x != Py_NotImplemented)
917 return x;
918 Py_DECREF(x); /* can't do it */
919 }
920 }
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000921
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000922 if (z == Py_None)
923 PyErr_Format(
924 PyExc_TypeError,
925 "unsupported operand type(s) for ** or pow(): "
926 "'%.100s' and '%.100s'",
927 v->ob_type->tp_name,
928 w->ob_type->tp_name);
929 else
930 PyErr_Format(
931 PyExc_TypeError,
932 "unsupported operand type(s) for pow(): "
933 "'%.100s', '%.100s', '%.100s'",
934 v->ob_type->tp_name,
935 w->ob_type->tp_name,
936 z->ob_type->tp_name);
937 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +0000938}
939
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000940#define BINARY_FUNC(func, op, op_name) \
941 PyObject * \
942 func(PyObject *v, PyObject *w) { \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000943 return binary_op(v, w, NB_SLOT(op), op_name); \
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000944 }
Guido van Rossume15dee51995-07-18 14:12:02 +0000945
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000946BINARY_FUNC(PyNumber_Or, nb_or, "|")
947BINARY_FUNC(PyNumber_Xor, nb_xor, "^")
948BINARY_FUNC(PyNumber_And, nb_and, "&")
949BINARY_FUNC(PyNumber_Lshift, nb_lshift, "<<")
950BINARY_FUNC(PyNumber_Rshift, nb_rshift, ">>")
951BINARY_FUNC(PyNumber_Subtract, nb_subtract, "-")
Neil Schemenauer5a1f0152001-01-04 01:39:06 +0000952BINARY_FUNC(PyNumber_Divmod, nb_divmod, "divmod()")
Guido van Rossume15dee51995-07-18 14:12:02 +0000953
954PyObject *
Fred Drake79912472000-07-09 04:06:11 +0000955PyNumber_Add(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +0000956{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000957 PyObject *result = binary_op1(v, w, NB_SLOT(nb_add));
958 if (result == Py_NotImplemented) {
959 PySequenceMethods *m = v->ob_type->tp_as_sequence;
960 Py_DECREF(result);
961 if (m && m->sq_concat) {
962 return (*m->sq_concat)(v, w);
963 }
964 result = binop_type_error(v, w, "+");
965 }
966 return result;
Guido van Rossume15dee51995-07-18 14:12:02 +0000967}
968
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000969static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000970sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000971{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000972 Py_ssize_t count;
973 if (PyIndex_Check(n)) {
974 count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
975 if (count == -1 && PyErr_Occurred())
976 return NULL;
977 }
978 else {
979 return type_error("can't multiply sequence by "
980 "non-int of type '%.200s'", n);
981 }
982 return (*repeatfunc)(seq, count);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +0000983}
984
985PyObject *
986PyNumber_Multiply(PyObject *v, PyObject *w)
987{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000988 PyObject *result = binary_op1(v, w, NB_SLOT(nb_multiply));
989 if (result == Py_NotImplemented) {
990 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
991 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
992 Py_DECREF(result);
993 if (mv && mv->sq_repeat) {
994 return sequence_repeat(mv->sq_repeat, v, w);
995 }
996 else if (mw && mw->sq_repeat) {
997 return sequence_repeat(mw->sq_repeat, w, v);
998 }
999 result = binop_type_error(v, w, "*");
1000 }
1001 return result;
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001002}
1003
Guido van Rossume15dee51995-07-18 14:12:02 +00001004PyObject *
Benjamin Petersond51374e2014-04-09 23:55:56 -04001005PyNumber_MatrixMultiply(PyObject *v, PyObject *w)
1006{
1007 return binary_op(v, w, NB_SLOT(nb_matrix_multiply), "@");
1008}
1009
1010PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001011PyNumber_FloorDivide(PyObject *v, PyObject *w)
1012{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001013 return binary_op(v, w, NB_SLOT(nb_floor_divide), "//");
Guido van Rossum4668b002001-08-08 05:00:18 +00001014}
1015
1016PyObject *
1017PyNumber_TrueDivide(PyObject *v, PyObject *w)
1018{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001019 return binary_op(v, w, NB_SLOT(nb_true_divide), "/");
Guido van Rossum4668b002001-08-08 05:00:18 +00001020}
1021
1022PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001023PyNumber_Remainder(PyObject *v, PyObject *w)
Guido van Rossume15dee51995-07-18 14:12:02 +00001024{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001025 return binary_op(v, w, NB_SLOT(nb_remainder), "%");
Guido van Rossume15dee51995-07-18 14:12:02 +00001026}
1027
1028PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001029PyNumber_Power(PyObject *v, PyObject *w, PyObject *z)
Guido van Rossume15dee51995-07-18 14:12:02 +00001030{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001031 return ternary_op(v, w, z, NB_SLOT(nb_power), "** or pow()");
Guido van Rossume15dee51995-07-18 14:12:02 +00001032}
1033
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001034/* Binary in-place operators */
1035
1036/* The in-place operators are defined to fall back to the 'normal',
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001037 non in-place operations, if the in-place methods are not in place.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001038
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001039 - If the left hand object has the appropriate struct members, and
1040 they are filled, call the appropriate function and return the
1041 result. No coercion is done on the arguments; the left-hand object
1042 is the one the operation is performed on, and it's up to the
1043 function to deal with the right-hand object.
Guido van Rossum77660912002-04-16 16:32:50 +00001044
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001045 - Otherwise, in-place modification is not supported. Handle it exactly as
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001046 a non in-place operation of the same kind.
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001047
1048 */
1049
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001050static PyObject *
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001051binary_iop1(PyObject *v, PyObject *w, const int iop_slot, const int op_slot)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001052{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001053 PyNumberMethods *mv = v->ob_type->tp_as_number;
1054 if (mv != NULL) {
1055 binaryfunc slot = NB_BINOP(mv, iop_slot);
1056 if (slot) {
1057 PyObject *x = (slot)(v, w);
1058 if (x != Py_NotImplemented) {
1059 return x;
1060 }
1061 Py_DECREF(x);
1062 }
1063 }
1064 return binary_op1(v, w, op_slot);
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001065}
1066
1067static PyObject *
1068binary_iop(PyObject *v, PyObject *w, const int iop_slot, const int op_slot,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001069 const char *op_name)
Neil Schemenauerd4b0fea2002-12-30 20:18:15 +00001070{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001071 PyObject *result = binary_iop1(v, w, iop_slot, op_slot);
1072 if (result == Py_NotImplemented) {
1073 Py_DECREF(result);
1074 return binop_type_error(v, w, op_name);
1075 }
1076 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001077}
1078
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001079#define INPLACE_BINOP(func, iop, op, op_name) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001080 PyObject * \
1081 func(PyObject *v, PyObject *w) { \
1082 return binary_iop(v, w, NB_SLOT(iop), NB_SLOT(op), op_name); \
1083 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001084
Neil Schemenauer5a1f0152001-01-04 01:39:06 +00001085INPLACE_BINOP(PyNumber_InPlaceOr, nb_inplace_or, nb_or, "|=")
1086INPLACE_BINOP(PyNumber_InPlaceXor, nb_inplace_xor, nb_xor, "^=")
1087INPLACE_BINOP(PyNumber_InPlaceAnd, nb_inplace_and, nb_and, "&=")
1088INPLACE_BINOP(PyNumber_InPlaceLshift, nb_inplace_lshift, nb_lshift, "<<=")
1089INPLACE_BINOP(PyNumber_InPlaceRshift, nb_inplace_rshift, nb_rshift, ">>=")
1090INPLACE_BINOP(PyNumber_InPlaceSubtract, nb_inplace_subtract, nb_subtract, "-=")
Benjamin Petersond51374e2014-04-09 23:55:56 -04001091INPLACE_BINOP(PyNumber_InMatrixMultiply, nb_inplace_matrix_multiply, nb_matrix_multiply, "@=")
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001092
1093PyObject *
Guido van Rossum4668b002001-08-08 05:00:18 +00001094PyNumber_InPlaceFloorDivide(PyObject *v, PyObject *w)
1095{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001096 return binary_iop(v, w, NB_SLOT(nb_inplace_floor_divide),
1097 NB_SLOT(nb_floor_divide), "//=");
Guido van Rossum4668b002001-08-08 05:00:18 +00001098}
1099
1100PyObject *
1101PyNumber_InPlaceTrueDivide(PyObject *v, PyObject *w)
1102{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001103 return binary_iop(v, w, NB_SLOT(nb_inplace_true_divide),
1104 NB_SLOT(nb_true_divide), "/=");
Guido van Rossum4668b002001-08-08 05:00:18 +00001105}
1106
1107PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001108PyNumber_InPlaceAdd(PyObject *v, PyObject *w)
1109{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001110 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_add),
1111 NB_SLOT(nb_add));
1112 if (result == Py_NotImplemented) {
1113 PySequenceMethods *m = v->ob_type->tp_as_sequence;
1114 Py_DECREF(result);
1115 if (m != NULL) {
1116 binaryfunc f = NULL;
1117 f = m->sq_inplace_concat;
1118 if (f == NULL)
1119 f = m->sq_concat;
1120 if (f != NULL)
1121 return (*f)(v, w);
1122 }
1123 result = binop_type_error(v, w, "+=");
1124 }
1125 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001126}
1127
1128PyObject *
1129PyNumber_InPlaceMultiply(PyObject *v, PyObject *w)
1130{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001131 PyObject *result = binary_iop1(v, w, NB_SLOT(nb_inplace_multiply),
1132 NB_SLOT(nb_multiply));
1133 if (result == Py_NotImplemented) {
1134 ssizeargfunc f = NULL;
1135 PySequenceMethods *mv = v->ob_type->tp_as_sequence;
1136 PySequenceMethods *mw = w->ob_type->tp_as_sequence;
1137 Py_DECREF(result);
1138 if (mv != NULL) {
1139 f = mv->sq_inplace_repeat;
1140 if (f == NULL)
1141 f = mv->sq_repeat;
1142 if (f != NULL)
1143 return sequence_repeat(f, v, w);
1144 }
1145 else if (mw != NULL) {
1146 /* Note that the right hand operand should not be
1147 * mutated in this case so sq_inplace_repeat is not
1148 * used. */
1149 if (mw->sq_repeat)
1150 return sequence_repeat(mw->sq_repeat, w, v);
1151 }
1152 result = binop_type_error(v, w, "*=");
1153 }
1154 return result;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001155}
1156
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001157PyObject *
Benjamin Petersond51374e2014-04-09 23:55:56 -04001158PyNumber_InPlaceMatrixMultiply(PyObject *v, PyObject *w)
1159{
1160 return binary_iop(v, w, NB_SLOT(nb_inplace_matrix_multiply),
1161 NB_SLOT(nb_matrix_multiply), "@=");
1162}
1163
1164PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001165PyNumber_InPlaceRemainder(PyObject *v, PyObject *w)
1166{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001167 return binary_iop(v, w, NB_SLOT(nb_inplace_remainder),
1168 NB_SLOT(nb_remainder), "%=");
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001169}
1170
1171PyObject *
1172PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
1173{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001174 if (v->ob_type->tp_as_number &&
1175 v->ob_type->tp_as_number->nb_inplace_power != NULL) {
1176 return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
1177 }
1178 else {
1179 return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
1180 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001181}
1182
1183
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001184/* Unary operators and functions */
Guido van Rossume15dee51995-07-18 14:12:02 +00001185
1186PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001187PyNumber_Negative(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001188{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001189 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001190
Victor Stinner71aea8e2016-08-19 16:59:55 +02001191 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001192 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001193 }
1194
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001195 m = o->ob_type->tp_as_number;
1196 if (m && m->nb_negative)
1197 return (*m->nb_negative)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001198
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001199 return type_error("bad operand type for unary -: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001200}
1201
1202PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001203PyNumber_Positive(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001204{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001205 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001206
Victor Stinner71aea8e2016-08-19 16:59:55 +02001207 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001208 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001209 }
1210
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001211 m = o->ob_type->tp_as_number;
1212 if (m && m->nb_positive)
1213 return (*m->nb_positive)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001214
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001215 return type_error("bad operand type for unary +: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001216}
1217
1218PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001219PyNumber_Invert(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001220{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001221 PyNumberMethods *m;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001222
Victor Stinner71aea8e2016-08-19 16:59:55 +02001223 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001224 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001225 }
1226
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001227 m = o->ob_type->tp_as_number;
1228 if (m && m->nb_invert)
1229 return (*m->nb_invert)(o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001230
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001231 return type_error("bad operand type for unary ~: '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001232}
1233
1234PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001235PyNumber_Absolute(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001236{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001237 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001238
Victor Stinner71aea8e2016-08-19 16:59:55 +02001239 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001240 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001241 }
1242
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001243 m = o->ob_type->tp_as_number;
1244 if (m && m->nb_absolute)
1245 return m->nb_absolute(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001246
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001247 return type_error("bad operand type for abs(): '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001248}
1249
Christian Tismerea62ce72018-06-09 20:32:25 +02001250#undef PyIndex_Check
Christian Tismer83987132018-06-11 00:48:28 +02001251
Christian Tismerea62ce72018-06-09 20:32:25 +02001252int
1253PyIndex_Check(PyObject *obj)
1254{
1255 return obj->ob_type->tp_as_number != NULL &&
1256 obj->ob_type->tp_as_number->nb_index != NULL;
1257}
1258
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001259/* Return a Python int from the object item.
Serhiy Storchaka95949422013-08-27 19:40:23 +03001260 Raise TypeError if the result is not an int
Guido van Rossum98297ee2007-11-06 21:34:58 +00001261 or if the object cannot be interpreted as an index.
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001262*/
1263PyObject *
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001264PyNumber_Index(PyObject *item)
1265{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001266 PyObject *result = NULL;
Victor Stinner71aea8e2016-08-19 16:59:55 +02001267 if (item == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001268 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001269 }
1270
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001271 if (PyLong_Check(item)) {
1272 Py_INCREF(item);
1273 return item;
1274 }
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001275 if (!PyIndex_Check(item)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001276 PyErr_Format(PyExc_TypeError,
1277 "'%.200s' object cannot be interpreted "
1278 "as an integer", item->ob_type->tp_name);
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001279 return NULL;
1280 }
1281 result = item->ob_type->tp_as_number->nb_index(item);
1282 if (!result || PyLong_CheckExact(result))
1283 return result;
1284 if (!PyLong_Check(result)) {
1285 PyErr_Format(PyExc_TypeError,
1286 "__index__ returned non-int (type %.200s)",
1287 result->ob_type->tp_name);
1288 Py_DECREF(result);
1289 return NULL;
1290 }
1291 /* Issue #17576: warn if 'result' not of exact type int. */
1292 if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
1293 "__index__ returned non-int (type %.200s). "
1294 "The ability to return an instance of a strict subclass of int "
1295 "is deprecated, and may be removed in a future version of Python.",
1296 result->ob_type->tp_name)) {
1297 Py_DECREF(result);
1298 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001299 }
1300 return result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00001301}
1302
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001303/* Return an error on Overflow only if err is not NULL*/
1304
1305Py_ssize_t
1306PyNumber_AsSsize_t(PyObject *item, PyObject *err)
1307{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001308 Py_ssize_t result;
1309 PyObject *runerr;
1310 PyObject *value = PyNumber_Index(item);
1311 if (value == NULL)
1312 return -1;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001313
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001314 /* We're done if PyLong_AsSsize_t() returns without error. */
1315 result = PyLong_AsSsize_t(value);
1316 if (result != -1 || !(runerr = PyErr_Occurred()))
1317 goto finish;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001318
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001319 /* Error handling code -- only manage OverflowError differently */
1320 if (!PyErr_GivenExceptionMatches(runerr, PyExc_OverflowError))
1321 goto finish;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001322
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001323 PyErr_Clear();
1324 /* If no error-handling desired then the default clipping
1325 is sufficient.
1326 */
1327 if (!err) {
1328 assert(PyLong_Check(value));
1329 /* Whether or not it is less than or equal to
1330 zero is determined by the sign of ob_size
1331 */
1332 if (_PyLong_Sign(value) < 0)
1333 result = PY_SSIZE_T_MIN;
1334 else
1335 result = PY_SSIZE_T_MAX;
1336 }
1337 else {
1338 /* Otherwise replace the error with caller's error object. */
1339 PyErr_Format(err,
1340 "cannot fit '%.200s' into an index-sized integer",
1341 item->ob_type->tp_name);
1342 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001343
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001344 finish:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001345 Py_DECREF(value);
1346 return result;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +00001347}
1348
1349
Guido van Rossume15dee51995-07-18 14:12:02 +00001350PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001351PyNumber_Long(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001352{
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001353 PyObject *result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001354 PyNumberMethods *m;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001355 PyObject *trunc_func;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001356 Py_buffer view;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04001357 _Py_IDENTIFIER(__trunc__);
Christian Heimes15ebc882008-02-04 18:48:49 +00001358
Victor Stinner71aea8e2016-08-19 16:59:55 +02001359 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001360 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001361 }
1362
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001363 if (PyLong_CheckExact(o)) {
1364 Py_INCREF(o);
1365 return o;
1366 }
1367 m = o->ob_type->tp_as_number;
1368 if (m && m->nb_int) { /* This should include subclasses of int */
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001369 result = (PyObject *)_PyLong_FromNbInt(o);
1370 if (result != NULL && !PyLong_CheckExact(result)) {
1371 Py_SETREF(result, _PyLong_Copy((PyLongObject *)result));
1372 }
1373 return result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001374 }
Benjamin Peterson1b1a8e72012-03-20 23:48:11 -04001375 trunc_func = _PyObject_LookupSpecial(o, &PyId___trunc__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001376 if (trunc_func) {
INADA Naoki72dccde2017-02-16 09:26:01 +09001377 result = _PyObject_CallNoArg(trunc_func);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001378 Py_DECREF(trunc_func);
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001379 if (result == NULL || PyLong_CheckExact(result)) {
1380 return result;
1381 }
1382 if (PyLong_Check(result)) {
1383 Py_SETREF(result, _PyLong_Copy((PyLongObject *)result));
1384 return result;
1385 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001386 /* __trunc__ is specified to return an Integral type,
Martin Panter7462b6492015-11-02 03:37:02 +00001387 but int() needs to return an int. */
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001388 m = result->ob_type->tp_as_number;
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001389 if (m == NULL || m->nb_int == NULL) {
1390 PyErr_Format(
1391 PyExc_TypeError,
1392 "__trunc__ returned non-Integral (type %.200s)",
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001393 result->ob_type->tp_name);
1394 Py_DECREF(result);
Serhiy Storchaka31a65542013-12-11 21:07:54 +02001395 return NULL;
1396 }
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001397 Py_SETREF(result, (PyObject *)_PyLong_FromNbInt(result));
1398 if (result != NULL && !PyLong_CheckExact(result)) {
1399 Py_SETREF(result, _PyLong_Copy((PyLongObject *)result));
1400 }
1401 return result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001402 }
Benjamin Peterson1b1a8e72012-03-20 23:48:11 -04001403 if (PyErr_Occurred())
1404 return NULL;
Christian Heimes15ebc882008-02-04 18:48:49 +00001405
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001406 if (PyUnicode_Check(o))
1407 /* The below check is done in PyLong_FromUnicode(). */
1408 return PyLong_FromUnicodeObject(o, 10);
1409
Martin Pantereeb896c2015-11-07 02:32:21 +00001410 if (PyBytes_Check(o))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001411 /* need to do extra error checking that PyLong_FromString()
Serhiy Storchakaf6d0aee2013-08-03 20:55:06 +03001412 * doesn't do. In particular int('9\x005') must raise an
1413 * exception, not truncate at the null.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001414 */
Martin Pantereeb896c2015-11-07 02:32:21 +00001415 return _PyLong_FromBytes(PyBytes_AS_STRING(o),
1416 PyBytes_GET_SIZE(o), 10);
1417
1418 if (PyByteArray_Check(o))
1419 return _PyLong_FromBytes(PyByteArray_AS_STRING(o),
1420 PyByteArray_GET_SIZE(o), 10);
1421
1422 if (PyObject_GetBuffer(o, &view, PyBUF_SIMPLE) == 0) {
Serhiy Storchaka54cd1962016-08-21 20:03:08 +03001423 PyObject *bytes;
Martin Pantereeb896c2015-11-07 02:32:21 +00001424
1425 /* Copy to NUL-terminated buffer. */
1426 bytes = PyBytes_FromStringAndSize((const char *)view.buf, view.len);
1427 if (bytes == NULL) {
1428 PyBuffer_Release(&view);
1429 return NULL;
1430 }
1431 result = _PyLong_FromBytes(PyBytes_AS_STRING(bytes),
1432 PyBytes_GET_SIZE(bytes), 10);
1433 Py_DECREF(bytes);
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001434 PyBuffer_Release(&view);
1435 return result;
1436 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001437
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001438 return type_error("int() argument must be a string, a bytes-like object "
1439 "or a number, not '%.200s'", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001440}
1441
1442PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001443PyNumber_Float(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001444{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001445 PyNumberMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001446
Victor Stinner71aea8e2016-08-19 16:59:55 +02001447 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001449 }
1450
Serhiy Storchaka16931c32016-06-03 21:42:55 +03001451 if (PyFloat_CheckExact(o)) {
1452 Py_INCREF(o);
1453 return o;
1454 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001455 m = o->ob_type->tp_as_number;
1456 if (m && m->nb_float) { /* This should include subclasses of float */
1457 PyObject *res = m->nb_float(o);
Serhiy Storchaka16931c32016-06-03 21:42:55 +03001458 double val;
1459 if (!res || PyFloat_CheckExact(res)) {
1460 return res;
1461 }
1462 if (!PyFloat_Check(res)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001463 PyErr_Format(PyExc_TypeError,
Serhiy Storchaka16931c32016-06-03 21:42:55 +03001464 "%.50s.__float__ returned non-float (type %.50s)",
1465 o->ob_type->tp_name, res->ob_type->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001466 Py_DECREF(res);
1467 return NULL;
1468 }
Serhiy Storchaka16931c32016-06-03 21:42:55 +03001469 /* Issue #26983: warn if 'res' not of exact type float. */
1470 if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
1471 "%.50s.__float__ returned non-float (type %.50s). "
1472 "The ability to return an instance of a strict subclass of float "
1473 "is deprecated, and may be removed in a future version of Python.",
1474 o->ob_type->tp_name, res->ob_type->tp_name)) {
1475 Py_DECREF(res);
1476 return NULL;
1477 }
1478 val = PyFloat_AS_DOUBLE(res);
1479 Py_DECREF(res);
1480 return PyFloat_FromDouble(val);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001481 }
1482 if (PyFloat_Check(o)) { /* A float subclass with nb_float == NULL */
Serhiy Storchaka16931c32016-06-03 21:42:55 +03001483 return PyFloat_FromDouble(PyFloat_AS_DOUBLE(o));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001484 }
1485 return PyFloat_FromString(o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001486}
1487
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001488
1489PyObject *
1490PyNumber_ToBase(PyObject *n, int base)
1491{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001492 PyObject *res = NULL;
1493 PyObject *index = PyNumber_Index(n);
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001494
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001495 if (!index)
1496 return NULL;
1497 if (PyLong_Check(index))
1498 res = _PyLong_Format(index, base);
1499 else
1500 /* It should not be possible to get here, as
1501 PyNumber_Index already has a check for the same
1502 condition */
Serhiy Storchaka95949422013-08-27 19:40:23 +03001503 PyErr_SetString(PyExc_ValueError, "PyNumber_ToBase: index not int");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001504 Py_DECREF(index);
1505 return res;
Guido van Rossumcd16bf62007-06-13 18:07:49 +00001506}
1507
1508
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001509/* Operations on sequences */
Guido van Rossume15dee51995-07-18 14:12:02 +00001510
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001511int
Fred Drake79912472000-07-09 04:06:11 +00001512PySequence_Check(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001513{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001514 if (PyDict_Check(s))
1515 return 0;
Alexey Izbyshevb57b4ac2018-08-26 02:52:27 +03001516 return s->ob_type->tp_as_sequence &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001517 s->ob_type->tp_as_sequence->sq_item != NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001518}
1519
Martin v. Löwis18e16552006-02-15 17:27:45 +00001520Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00001521PySequence_Size(PyObject *s)
Guido van Rossume15dee51995-07-18 14:12:02 +00001522{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001523 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001524
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001525 if (s == NULL) {
1526 null_error();
1527 return -1;
1528 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001529
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001530 m = s->ob_type->tp_as_sequence;
Serhiy Storchaka813f9432017-04-16 09:21:44 +03001531 if (m && m->sq_length) {
1532 Py_ssize_t len = m->sq_length(s);
1533 assert(len >= 0 || PyErr_Occurred());
1534 return len;
1535 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001536
Serhiy Storchakaa6fdddb2018-07-23 23:43:42 +03001537 if (s->ob_type->tp_as_mapping && s->ob_type->tp_as_mapping->mp_length) {
1538 type_error("%.200s is not a sequence", s);
1539 return -1;
1540 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001541 type_error("object of type '%.200s' has no len()", s);
1542 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001543}
1544
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001545#undef PySequence_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00001546Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001547PySequence_Length(PyObject *s)
1548{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001549 return PySequence_Size(s);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00001550}
1551#define PySequence_Length PySequence_Size
1552
Guido van Rossume15dee51995-07-18 14:12:02 +00001553PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001554PySequence_Concat(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001555{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001556 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001557
Victor Stinner71aea8e2016-08-19 16:59:55 +02001558 if (s == NULL || o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001559 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001560 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001561
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001562 m = s->ob_type->tp_as_sequence;
1563 if (m && m->sq_concat)
1564 return m->sq_concat(s, o);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001565
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001566 /* Instances of user classes defining an __add__() method only
1567 have an nb_add slot, not an sq_concat slot. So we fall back
1568 to nb_add if both arguments appear to be sequences. */
1569 if (PySequence_Check(s) && PySequence_Check(o)) {
1570 PyObject *result = binary_op1(s, o, NB_SLOT(nb_add));
1571 if (result != Py_NotImplemented)
1572 return result;
1573 Py_DECREF(result);
1574 }
1575 return type_error("'%.200s' object can't be concatenated", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001576}
1577
1578PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001579PySequence_Repeat(PyObject *o, Py_ssize_t count)
Guido van Rossume15dee51995-07-18 14:12:02 +00001580{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001581 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001582
Victor Stinner71aea8e2016-08-19 16:59:55 +02001583 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001584 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001585 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001586
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001587 m = o->ob_type->tp_as_sequence;
1588 if (m && m->sq_repeat)
1589 return m->sq_repeat(o, count);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001590
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001591 /* Instances of user classes defining a __mul__() method only
1592 have an nb_multiply slot, not an sq_repeat slot. so we fall back
1593 to nb_multiply if o appears to be a sequence. */
1594 if (PySequence_Check(o)) {
1595 PyObject *n, *result;
1596 n = PyLong_FromSsize_t(count);
1597 if (n == NULL)
1598 return NULL;
1599 result = binary_op1(o, n, NB_SLOT(nb_multiply));
1600 Py_DECREF(n);
1601 if (result != Py_NotImplemented)
1602 return result;
1603 Py_DECREF(result);
1604 }
1605 return type_error("'%.200s' object can't be repeated", o);
Guido van Rossume15dee51995-07-18 14:12:02 +00001606}
1607
1608PyObject *
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001609PySequence_InPlaceConcat(PyObject *s, PyObject *o)
1610{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001611 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001612
Victor Stinner71aea8e2016-08-19 16:59:55 +02001613 if (s == NULL || o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001614 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001615 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001616
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001617 m = s->ob_type->tp_as_sequence;
1618 if (m && m->sq_inplace_concat)
1619 return m->sq_inplace_concat(s, o);
1620 if (m && m->sq_concat)
1621 return m->sq_concat(s, o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001622
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001623 if (PySequence_Check(s) && PySequence_Check(o)) {
1624 PyObject *result = binary_iop1(s, o, NB_SLOT(nb_inplace_add),
1625 NB_SLOT(nb_add));
1626 if (result != Py_NotImplemented)
1627 return result;
1628 Py_DECREF(result);
1629 }
1630 return type_error("'%.200s' object can't be concatenated", s);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001631}
1632
1633PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001634PySequence_InPlaceRepeat(PyObject *o, Py_ssize_t count)
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001635{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001636 PySequenceMethods *m;
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001637
Victor Stinner71aea8e2016-08-19 16:59:55 +02001638 if (o == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001639 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001640 }
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001641
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001642 m = o->ob_type->tp_as_sequence;
1643 if (m && m->sq_inplace_repeat)
1644 return m->sq_inplace_repeat(o, count);
1645 if (m && m->sq_repeat)
1646 return m->sq_repeat(o, count);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001647
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001648 if (PySequence_Check(o)) {
1649 PyObject *n, *result;
1650 n = PyLong_FromSsize_t(count);
1651 if (n == NULL)
1652 return NULL;
1653 result = binary_iop1(o, n, NB_SLOT(nb_inplace_multiply),
1654 NB_SLOT(nb_multiply));
1655 Py_DECREF(n);
1656 if (result != Py_NotImplemented)
1657 return result;
1658 Py_DECREF(result);
1659 }
1660 return type_error("'%.200s' object can't be repeated", o);
Thomas Wouterse289e0b2000-08-24 20:08:19 +00001661}
1662
1663PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001664PySequence_GetItem(PyObject *s, Py_ssize_t i)
Guido van Rossume15dee51995-07-18 14:12:02 +00001665{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001666 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001667
Victor Stinner71aea8e2016-08-19 16:59:55 +02001668 if (s == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001669 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001670 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001671
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001672 m = s->ob_type->tp_as_sequence;
1673 if (m && m->sq_item) {
1674 if (i < 0) {
1675 if (m->sq_length) {
1676 Py_ssize_t l = (*m->sq_length)(s);
Victor Stinnere20310f2015-11-05 13:56:58 +01001677 if (l < 0) {
1678 assert(PyErr_Occurred());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001679 return NULL;
Victor Stinnere20310f2015-11-05 13:56:58 +01001680 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001681 i += l;
1682 }
1683 }
1684 return m->sq_item(s, i);
1685 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001686
Serhiy Storchakaa6fdddb2018-07-23 23:43:42 +03001687 if (s->ob_type->tp_as_mapping && s->ob_type->tp_as_mapping->mp_subscript) {
1688 return type_error("%.200s is not a sequence", s);
1689 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001690 return type_error("'%.200s' object does not support indexing", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001691}
1692
1693PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00001694PySequence_GetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossume15dee51995-07-18 14:12:02 +00001695{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001696 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001697
Victor Stinner71aea8e2016-08-19 16:59:55 +02001698 if (!s) {
1699 return null_error();
1700 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001701
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001702 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001703 if (mp && mp->mp_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001704 PyObject *res;
1705 PyObject *slice = _PySlice_FromIndices(i1, i2);
1706 if (!slice)
1707 return NULL;
1708 res = mp->mp_subscript(s, slice);
1709 Py_DECREF(slice);
1710 return res;
1711 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001712
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001713 return type_error("'%.200s' object is unsliceable", s);
Guido van Rossume15dee51995-07-18 14:12:02 +00001714}
1715
1716int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001717PySequence_SetItem(PyObject *s, Py_ssize_t i, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001718{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001719 PySequenceMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00001720
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001721 if (s == NULL) {
1722 null_error();
1723 return -1;
1724 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001725
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001726 m = s->ob_type->tp_as_sequence;
1727 if (m && m->sq_ass_item) {
1728 if (i < 0) {
1729 if (m->sq_length) {
1730 Py_ssize_t l = (*m->sq_length)(s);
Serhiy Storchaka813f9432017-04-16 09:21:44 +03001731 if (l < 0) {
1732 assert(PyErr_Occurred());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001733 return -1;
Serhiy Storchaka813f9432017-04-16 09:21:44 +03001734 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001735 i += l;
1736 }
1737 }
1738 return m->sq_ass_item(s, i, o);
1739 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001740
Serhiy Storchakaa6fdddb2018-07-23 23:43:42 +03001741 if (s->ob_type->tp_as_mapping && s->ob_type->tp_as_mapping->mp_ass_subscript) {
1742 type_error("%.200s is not a sequence", s);
1743 return -1;
1744 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001745 type_error("'%.200s' object does not support item assignment", s);
1746 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001747}
1748
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001749int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001750PySequence_DelItem(PyObject *s, Py_ssize_t i)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001751{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001752 PySequenceMethods *m;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001753
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001754 if (s == NULL) {
1755 null_error();
1756 return -1;
1757 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001758
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001759 m = s->ob_type->tp_as_sequence;
1760 if (m && m->sq_ass_item) {
1761 if (i < 0) {
1762 if (m->sq_length) {
1763 Py_ssize_t l = (*m->sq_length)(s);
Serhiy Storchaka813f9432017-04-16 09:21:44 +03001764 if (l < 0) {
1765 assert(PyErr_Occurred());
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001766 return -1;
Serhiy Storchaka813f9432017-04-16 09:21:44 +03001767 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001768 i += l;
1769 }
1770 }
1771 return m->sq_ass_item(s, i, (PyObject *)NULL);
1772 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001773
Serhiy Storchakaa6fdddb2018-07-23 23:43:42 +03001774 if (s->ob_type->tp_as_mapping && s->ob_type->tp_as_mapping->mp_ass_subscript) {
1775 type_error("%.200s is not a sequence", s);
1776 return -1;
1777 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001778 type_error("'%.200s' object doesn't support item deletion", s);
1779 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001780}
1781
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001782int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001783PySequence_SetSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00001784{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001785 PyMappingMethods *mp;
Guido van Rossume15dee51995-07-18 14:12:02 +00001786
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001787 if (s == NULL) {
1788 null_error();
1789 return -1;
1790 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001791
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001792 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001793 if (mp && mp->mp_ass_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001794 int res;
1795 PyObject *slice = _PySlice_FromIndices(i1, i2);
1796 if (!slice)
1797 return -1;
1798 res = mp->mp_ass_subscript(s, slice, o);
1799 Py_DECREF(slice);
1800 return res;
1801 }
Thomas Wouters1d75a792000-08-17 22:37:32 +00001802
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001803 type_error("'%.200s' object doesn't support slice assignment", s);
1804 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00001805}
1806
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001807int
Martin v. Löwis18e16552006-02-15 17:27:45 +00001808PySequence_DelSlice(PyObject *s, Py_ssize_t i1, Py_ssize_t i2)
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001809{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001810 PyMappingMethods *mp;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001811
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001812 if (s == NULL) {
1813 null_error();
1814 return -1;
1815 }
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001816
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001817 mp = s->ob_type->tp_as_mapping;
Benjamin Peterson568867a2010-09-11 16:02:03 +00001818 if (mp && mp->mp_ass_subscript) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001819 int res;
1820 PyObject *slice = _PySlice_FromIndices(i1, i2);
1821 if (!slice)
1822 return -1;
1823 res = mp->mp_ass_subscript(s, slice, NULL);
1824 Py_DECREF(slice);
1825 return res;
1826 }
1827 type_error("'%.200s' object doesn't support slice deletion", s);
1828 return -1;
Guido van Rossum6cdc6f41996-08-21 17:41:54 +00001829}
1830
Guido van Rossume15dee51995-07-18 14:12:02 +00001831PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001832PySequence_Tuple(PyObject *v)
Guido van Rossume15dee51995-07-18 14:12:02 +00001833{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001834 PyObject *it; /* iter(v) */
1835 Py_ssize_t n; /* guess for result tuple size */
1836 PyObject *result = NULL;
1837 Py_ssize_t j;
Guido van Rossume15dee51995-07-18 14:12:02 +00001838
Victor Stinner71aea8e2016-08-19 16:59:55 +02001839 if (v == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001840 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001841 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001842
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001843 /* Special-case the common tuple and list cases, for efficiency. */
1844 if (PyTuple_CheckExact(v)) {
1845 /* Note that we can't know whether it's safe to return
1846 a tuple *subclass* instance as-is, hence the restriction
1847 to exact tuples here. In contrast, lists always make
1848 a copy, so there's no need for exactness below. */
1849 Py_INCREF(v);
1850 return v;
1851 }
Raymond Hettinger610a51f2015-05-17 14:45:58 -07001852 if (PyList_CheckExact(v))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001853 return PyList_AsTuple(v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001854
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001855 /* Get iterator. */
1856 it = PyObject_GetIter(v);
1857 if (it == NULL)
1858 return NULL;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001859
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001860 /* Guess result size and allocate space. */
Armin Ronacheraa9a79d2012-10-06 14:03:24 +02001861 n = PyObject_LengthHint(v, 10);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001862 if (n == -1)
1863 goto Fail;
1864 result = PyTuple_New(n);
1865 if (result == NULL)
1866 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001867
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001868 /* Fill the tuple. */
1869 for (j = 0; ; ++j) {
1870 PyObject *item = PyIter_Next(it);
1871 if (item == NULL) {
1872 if (PyErr_Occurred())
1873 goto Fail;
1874 break;
1875 }
1876 if (j >= n) {
Martin Pantere8db8612016-07-25 02:30:05 +00001877 size_t newn = (size_t)n;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001878 /* The over-allocation strategy can grow a bit faster
1879 than for lists because unlike lists the
1880 over-allocation isn't permanent -- we reclaim
1881 the excess before the end of this routine.
1882 So, grow by ten and then add 25%.
1883 */
Martin Pantere8db8612016-07-25 02:30:05 +00001884 newn += 10u;
1885 newn += newn >> 2;
1886 if (newn > PY_SSIZE_T_MAX) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001887 /* Check for overflow */
1888 PyErr_NoMemory();
1889 Py_DECREF(item);
1890 goto Fail;
1891 }
Martin Pantere8db8612016-07-25 02:30:05 +00001892 n = (Py_ssize_t)newn;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001893 if (_PyTuple_Resize(&result, n) != 0) {
1894 Py_DECREF(item);
1895 goto Fail;
1896 }
1897 }
1898 PyTuple_SET_ITEM(result, j, item);
1899 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00001900
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001901 /* Cut tuple back if guess was too large. */
1902 if (j < n &&
1903 _PyTuple_Resize(&result, j) != 0)
1904 goto Fail;
Tim Peters6912d4d2001-05-05 03:56:37 +00001905
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001906 Py_DECREF(it);
1907 return result;
Tim Peters6912d4d2001-05-05 03:56:37 +00001908
1909Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001910 Py_XDECREF(result);
1911 Py_DECREF(it);
1912 return NULL;
Guido van Rossume15dee51995-07-18 14:12:02 +00001913}
1914
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001915PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001916PySequence_List(PyObject *v)
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001917{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001918 PyObject *result; /* result list */
1919 PyObject *rv; /* return value from PyList_Extend */
Guido van Rossum4669fb41997-04-02 05:31:09 +00001920
Victor Stinner71aea8e2016-08-19 16:59:55 +02001921 if (v == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001922 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001923 }
Guido van Rossum5dba9e81998-07-10 18:03:50 +00001924
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001925 result = PyList_New(0);
1926 if (result == NULL)
1927 return NULL;
Tim Petersf553f892001-05-01 20:45:31 +00001928
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001929 rv = _PyList_Extend((PyListObject *)result, v);
1930 if (rv == NULL) {
1931 Py_DECREF(result);
1932 return NULL;
1933 }
1934 Py_DECREF(rv);
1935 return result;
Guido van Rossum3c5936a1996-12-05 21:51:24 +00001936}
1937
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001938PyObject *
Fred Drake79912472000-07-09 04:06:11 +00001939PySequence_Fast(PyObject *v, const char *m)
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001940{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001941 PyObject *it;
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001942
Victor Stinner71aea8e2016-08-19 16:59:55 +02001943 if (v == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001944 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02001945 }
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001946
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001947 if (PyList_CheckExact(v) || PyTuple_CheckExact(v)) {
1948 Py_INCREF(v);
1949 return v;
1950 }
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001951
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001952 it = PyObject_GetIter(v);
1953 if (it == NULL) {
1954 if (PyErr_ExceptionMatches(PyExc_TypeError))
1955 PyErr_SetString(PyExc_TypeError, m);
1956 return NULL;
1957 }
Raymond Hettinger2fb70292004-01-11 23:26:51 +00001958
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001959 v = PySequence_List(it);
1960 Py_DECREF(it);
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001961
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001962 return v;
Andrew M. Kuchling74042d62000-06-18 18:43:14 +00001963}
1964
Tim Peters16a77ad2001-09-08 04:00:12 +00001965/* Iterate over seq. Result depends on the operation:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001966 PY_ITERSEARCH_COUNT: -1 if error, else # of times obj appears in seq.
1967 PY_ITERSEARCH_INDEX: 0-based index of first occurrence of obj in seq;
1968 set ValueError and return -1 if none found; also return -1 on error.
Tim Peters16a77ad2001-09-08 04:00:12 +00001969 Py_ITERSEARCH_CONTAINS: return 1 if obj in seq, else 0; -1 on error.
1970*/
Neal Norwitz1fc4b772006-03-04 18:49:58 +00001971Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00001972_PySequence_IterSearch(PyObject *seq, PyObject *obj, int operation)
Guido van Rossume15dee51995-07-18 14:12:02 +00001973{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001974 Py_ssize_t n;
1975 int wrapped; /* for PY_ITERSEARCH_INDEX, true iff n wrapped around */
1976 PyObject *it; /* iter(seq) */
Guido van Rossume15dee51995-07-18 14:12:02 +00001977
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001978 if (seq == NULL || obj == NULL) {
1979 null_error();
1980 return -1;
1981 }
Tim Peters75f8e352001-05-05 11:33:43 +00001982
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001983 it = PyObject_GetIter(seq);
1984 if (it == NULL) {
1985 type_error("argument of type '%.200s' is not iterable", seq);
1986 return -1;
1987 }
Guido van Rossume15dee51995-07-18 14:12:02 +00001988
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001989 n = wrapped = 0;
1990 for (;;) {
1991 int cmp;
1992 PyObject *item = PyIter_Next(it);
1993 if (item == NULL) {
1994 if (PyErr_Occurred())
1995 goto Fail;
1996 break;
1997 }
Tim Peters16a77ad2001-09-08 04:00:12 +00001998
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001999 cmp = PyObject_RichCompareBool(obj, item, Py_EQ);
2000 Py_DECREF(item);
2001 if (cmp < 0)
2002 goto Fail;
2003 if (cmp > 0) {
2004 switch (operation) {
2005 case PY_ITERSEARCH_COUNT:
2006 if (n == PY_SSIZE_T_MAX) {
2007 PyErr_SetString(PyExc_OverflowError,
2008 "count exceeds C integer size");
2009 goto Fail;
2010 }
2011 ++n;
2012 break;
Tim Peters16a77ad2001-09-08 04:00:12 +00002013
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002014 case PY_ITERSEARCH_INDEX:
2015 if (wrapped) {
2016 PyErr_SetString(PyExc_OverflowError,
2017 "index exceeds C integer size");
2018 goto Fail;
2019 }
2020 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00002021
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002022 case PY_ITERSEARCH_CONTAINS:
2023 n = 1;
2024 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00002025
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002026 default:
Barry Warsawb2e57942017-09-14 18:13:16 -07002027 Py_UNREACHABLE();
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002028 }
2029 }
Tim Peters16a77ad2001-09-08 04:00:12 +00002030
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002031 if (operation == PY_ITERSEARCH_INDEX) {
2032 if (n == PY_SSIZE_T_MAX)
2033 wrapped = 1;
2034 ++n;
2035 }
2036 }
Tim Peters16a77ad2001-09-08 04:00:12 +00002037
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002038 if (operation != PY_ITERSEARCH_INDEX)
2039 goto Done;
Tim Peters16a77ad2001-09-08 04:00:12 +00002040
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002041 PyErr_SetString(PyExc_ValueError,
2042 "sequence.index(x): x not in sequence");
2043 /* fall into failure code */
Tim Peters16a77ad2001-09-08 04:00:12 +00002044Fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002045 n = -1;
2046 /* fall through */
Tim Peters16a77ad2001-09-08 04:00:12 +00002047Done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002048 Py_DECREF(it);
2049 return n;
Tim Peters75f8e352001-05-05 11:33:43 +00002050
Guido van Rossume15dee51995-07-18 14:12:02 +00002051}
2052
Tim Peters16a77ad2001-09-08 04:00:12 +00002053/* Return # of times o appears in s. */
Neal Norwitz1fc4b772006-03-04 18:49:58 +00002054Py_ssize_t
Tim Peters16a77ad2001-09-08 04:00:12 +00002055PySequence_Count(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002056{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002057 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_COUNT);
Guido van Rossume15dee51995-07-18 14:12:02 +00002058}
2059
Tim Peterscb8d3682001-05-05 21:05:01 +00002060/* Return -1 if error; 1 if ob in seq; 0 if ob not in seq.
Tim Peters16a77ad2001-09-08 04:00:12 +00002061 * Use sq_contains if possible, else defer to _PySequence_IterSearch().
Tim Peterscb8d3682001-05-05 21:05:01 +00002062 */
2063int
2064PySequence_Contains(PyObject *seq, PyObject *ob)
2065{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002066 Py_ssize_t result;
2067 PySequenceMethods *sqm = seq->ob_type->tp_as_sequence;
2068 if (sqm != NULL && sqm->sq_contains != NULL)
2069 return (*sqm->sq_contains)(seq, ob);
2070 result = _PySequence_IterSearch(seq, ob, PY_ITERSEARCH_CONTAINS);
2071 return Py_SAFE_DOWNCAST(result, Py_ssize_t, int);
Tim Peterscb8d3682001-05-05 21:05:01 +00002072}
2073
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002074/* Backwards compatibility */
2075#undef PySequence_In
2076int
Fred Drake79912472000-07-09 04:06:11 +00002077PySequence_In(PyObject *w, PyObject *v)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002078{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002079 return PySequence_Contains(w, v);
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002080}
2081
Neal Norwitz1fc4b772006-03-04 18:49:58 +00002082Py_ssize_t
Fred Drake79912472000-07-09 04:06:11 +00002083PySequence_Index(PyObject *s, PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002084{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002085 return _PySequence_IterSearch(s, o, PY_ITERSEARCH_INDEX);
Guido van Rossume15dee51995-07-18 14:12:02 +00002086}
2087
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002088/* Operations on mappings */
2089
2090int
Fred Drake79912472000-07-09 04:06:11 +00002091PyMapping_Check(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002092{
Benjamin Peterson21992272011-12-28 12:01:31 -06002093 return o && o->ob_type->tp_as_mapping &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002094 o->ob_type->tp_as_mapping->mp_subscript;
Guido van Rossume15dee51995-07-18 14:12:02 +00002095}
2096
Martin v. Löwis18e16552006-02-15 17:27:45 +00002097Py_ssize_t
Jeremy Hylton6253f832000-07-12 12:56:19 +00002098PyMapping_Size(PyObject *o)
Guido van Rossume15dee51995-07-18 14:12:02 +00002099{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002100 PyMappingMethods *m;
Guido van Rossume15dee51995-07-18 14:12:02 +00002101
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002102 if (o == NULL) {
2103 null_error();
2104 return -1;
2105 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002106
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002107 m = o->ob_type->tp_as_mapping;
Serhiy Storchaka813f9432017-04-16 09:21:44 +03002108 if (m && m->mp_length) {
2109 Py_ssize_t len = m->mp_length(o);
2110 assert(len >= 0 || PyErr_Occurred());
2111 return len;
2112 }
Guido van Rossume15dee51995-07-18 14:12:02 +00002113
Serhiy Storchakaa6fdddb2018-07-23 23:43:42 +03002114 if (o->ob_type->tp_as_sequence && o->ob_type->tp_as_sequence->sq_length) {
2115 type_error("%.200s is not a mapping", o);
2116 return -1;
2117 }
2118 /* PyMapping_Size() can be called from PyObject_Size(). */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002119 type_error("object of type '%.200s' has no len()", o);
2120 return -1;
Guido van Rossume15dee51995-07-18 14:12:02 +00002121}
2122
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002123#undef PyMapping_Length
Martin v. Löwis18e16552006-02-15 17:27:45 +00002124Py_ssize_t
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002125PyMapping_Length(PyObject *o)
2126{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002127 return PyMapping_Size(o);
Marc-André Lemburgcf5f3582000-07-17 09:22:55 +00002128}
2129#define PyMapping_Length PyMapping_Size
2130
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002131PyObject *
Serhiy Storchakac6792272013-10-19 21:03:34 +03002132PyMapping_GetItemString(PyObject *o, const char *key)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002133{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002134 PyObject *okey, *r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002135
Victor Stinner71aea8e2016-08-19 16:59:55 +02002136 if (key == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002137 return null_error();
Victor Stinner71aea8e2016-08-19 16:59:55 +02002138 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002139
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002140 okey = PyUnicode_FromString(key);
2141 if (okey == NULL)
2142 return NULL;
2143 r = PyObject_GetItem(o, okey);
2144 Py_DECREF(okey);
2145 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002146}
2147
2148int
Serhiy Storchakac6792272013-10-19 21:03:34 +03002149PyMapping_SetItemString(PyObject *o, const char *key, PyObject *value)
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002150{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002151 PyObject *okey;
2152 int r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002153
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002154 if (key == NULL) {
2155 null_error();
2156 return -1;
2157 }
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002158
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002159 okey = PyUnicode_FromString(key);
2160 if (okey == NULL)
2161 return -1;
2162 r = PyObject_SetItem(o, okey, value);
2163 Py_DECREF(okey);
2164 return r;
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002165}
2166
2167int
Serhiy Storchakac6792272013-10-19 21:03:34 +03002168PyMapping_HasKeyString(PyObject *o, const char *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002169{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002170 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002171
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002172 v = PyMapping_GetItemString(o, key);
2173 if (v) {
2174 Py_DECREF(v);
2175 return 1;
2176 }
2177 PyErr_Clear();
2178 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002179}
2180
Guido van Rossumcea1c8c1998-05-22 00:47:05 +00002181int
Fred Drake79912472000-07-09 04:06:11 +00002182PyMapping_HasKey(PyObject *o, PyObject *key)
Guido van Rossume15dee51995-07-18 14:12:02 +00002183{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002184 PyObject *v;
Guido van Rossume15dee51995-07-18 14:12:02 +00002185
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002186 v = PyObject_GetItem(o, key);
2187 if (v) {
2188 Py_DECREF(v);
2189 return 1;
2190 }
2191 PyErr_Clear();
2192 return 0;
Guido van Rossume15dee51995-07-18 14:12:02 +00002193}
2194
Oren Milman0ccc0f62017-10-08 11:17:46 +03002195/* This function is quite similar to PySequence_Fast(), but specialized to be
2196 a helper for PyMapping_Keys(), PyMapping_Items() and PyMapping_Values().
2197 */
2198static PyObject *
2199method_output_as_list(PyObject *o, _Py_Identifier *meth_id)
2200{
2201 PyObject *it, *result, *meth_output;
2202
2203 assert(o != NULL);
2204 meth_output = _PyObject_CallMethodId(o, meth_id, NULL);
2205 if (meth_output == NULL || PyList_CheckExact(meth_output)) {
2206 return meth_output;
2207 }
2208 it = PyObject_GetIter(meth_output);
2209 if (it == NULL) {
2210 if (PyErr_ExceptionMatches(PyExc_TypeError)) {
2211 PyErr_Format(PyExc_TypeError,
2212 "%.200s.%U() returned a non-iterable (type %.200s)",
2213 Py_TYPE(o)->tp_name,
2214 meth_id->object,
2215 Py_TYPE(meth_output)->tp_name);
2216 }
2217 Py_DECREF(meth_output);
2218 return NULL;
2219 }
2220 Py_DECREF(meth_output);
2221 result = PySequence_List(it);
2222 Py_DECREF(it);
2223 return result;
2224}
2225
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002226PyObject *
2227PyMapping_Keys(PyObject *o)
2228{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002229 _Py_IDENTIFIER(keys);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002230
Oren Milman0ccc0f62017-10-08 11:17:46 +03002231 if (o == NULL) {
2232 return null_error();
2233 }
2234 if (PyDict_CheckExact(o)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002235 return PyDict_Keys(o);
Oren Milman0ccc0f62017-10-08 11:17:46 +03002236 }
2237 return method_output_as_list(o, &PyId_keys);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002238}
2239
2240PyObject *
2241PyMapping_Items(PyObject *o)
2242{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002243 _Py_IDENTIFIER(items);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002244
Oren Milman0ccc0f62017-10-08 11:17:46 +03002245 if (o == NULL) {
2246 return null_error();
2247 }
2248 if (PyDict_CheckExact(o)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002249 return PyDict_Items(o);
Oren Milman0ccc0f62017-10-08 11:17:46 +03002250 }
2251 return method_output_as_list(o, &PyId_items);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002252}
2253
2254PyObject *
2255PyMapping_Values(PyObject *o)
2256{
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02002257 _Py_IDENTIFIER(values);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002258
Oren Milman0ccc0f62017-10-08 11:17:46 +03002259 if (o == NULL) {
2260 return null_error();
2261 }
2262 if (PyDict_CheckExact(o)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002263 return PyDict_Values(o);
Oren Milman0ccc0f62017-10-08 11:17:46 +03002264 }
2265 return method_output_as_list(o, &PyId_values);
Guido van Rossumcc2b0162007-02-11 06:12:03 +00002266}
2267
Guido van Rossum823649d2001-03-21 18:40:58 +00002268/* isinstance(), issubclass() */
2269
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002270/* abstract_get_bases() has logically 4 return states:
Barry Warsawf16951c2002-04-23 22:45:44 +00002271 *
Barry Warsawf16951c2002-04-23 22:45:44 +00002272 * 1. getattr(cls, '__bases__') could raise an AttributeError
2273 * 2. getattr(cls, '__bases__') could raise some other exception
2274 * 3. getattr(cls, '__bases__') could return a tuple
2275 * 4. getattr(cls, '__bases__') could return something other than a tuple
2276 *
2277 * Only state #3 is a non-error state and only it returns a non-NULL object
2278 * (it returns the retrieved tuple).
2279 *
2280 * Any raised AttributeErrors are masked by clearing the exception and
2281 * returning NULL. If an object other than a tuple comes out of __bases__,
2282 * then again, the return value is NULL. So yes, these two situations
2283 * produce exactly the same results: NULL is returned and no error is set.
2284 *
2285 * If some exception other than AttributeError is raised, then NULL is also
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002286 * returned, but the exception is not cleared. That's because we want the
Barry Warsawf16951c2002-04-23 22:45:44 +00002287 * exception to be propagated along.
2288 *
2289 * Callers are expected to test for PyErr_Occurred() when the return value
2290 * is NULL to decide whether a valid exception should be propagated or not.
2291 * When there's no exception to propagate, it's customary for the caller to
2292 * set a TypeError.
2293 */
Neil Schemenauer6b471292001-10-18 03:18:43 +00002294static PyObject *
2295abstract_get_bases(PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002296{
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002297 _Py_IDENTIFIER(__bases__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002298 PyObject *bases;
Guido van Rossum823649d2001-03-21 18:40:58 +00002299
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002300 Py_ALLOW_RECURSION
Serhiy Storchakaf320be72018-01-25 10:49:40 +02002301 (void)_PyObject_LookupAttrId(cls, &PyId___bases__, &bases);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002302 Py_END_ALLOW_RECURSION
Serhiy Storchakaf320be72018-01-25 10:49:40 +02002303 if (bases != NULL && !PyTuple_Check(bases)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002304 Py_DECREF(bases);
2305 return NULL;
2306 }
2307 return bases;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002308}
2309
2310
2311static int
2312abstract_issubclass(PyObject *derived, PyObject *cls)
2313{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002314 PyObject *bases = NULL;
2315 Py_ssize_t i, n;
2316 int r = 0;
Neil Schemenauer6b471292001-10-18 03:18:43 +00002317
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002318 while (1) {
2319 if (derived == cls)
2320 return 1;
2321 bases = abstract_get_bases(derived);
2322 if (bases == NULL) {
2323 if (PyErr_Occurred())
2324 return -1;
2325 return 0;
2326 }
2327 n = PyTuple_GET_SIZE(bases);
2328 if (n == 0) {
2329 Py_DECREF(bases);
2330 return 0;
2331 }
2332 /* Avoid recursivity in the single inheritance case */
2333 if (n == 1) {
2334 derived = PyTuple_GET_ITEM(bases, 0);
2335 Py_DECREF(bases);
2336 continue;
2337 }
2338 for (i = 0; i < n; i++) {
2339 r = abstract_issubclass(PyTuple_GET_ITEM(bases, i), cls);
2340 if (r != 0)
2341 break;
2342 }
2343 Py_DECREF(bases);
2344 return r;
2345 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002346}
2347
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002348static int
2349check_class(PyObject *cls, const char *error)
2350{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002351 PyObject *bases = abstract_get_bases(cls);
2352 if (bases == NULL) {
2353 /* Do not mask errors. */
2354 if (!PyErr_Occurred())
2355 PyErr_SetString(PyExc_TypeError, error);
2356 return 0;
2357 }
2358 Py_DECREF(bases);
2359 return -1;
Walter Dörwaldd9a6ad32002-12-12 16:41:44 +00002360}
2361
Brett Cannon4f653312004-03-20 22:52:14 +00002362static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002363recursive_isinstance(PyObject *inst, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002364{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002365 PyObject *icls;
Serhiy Storchakaf320be72018-01-25 10:49:40 +02002366 int retval;
Benjamin Peterson9fc9bf42012-03-20 23:26:41 -04002367 _Py_IDENTIFIER(__class__);
Guido van Rossum03bc7d32003-02-12 03:32:58 +00002368
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002369 if (PyType_Check(cls)) {
2370 retval = PyObject_TypeCheck(inst, (PyTypeObject *)cls);
2371 if (retval == 0) {
Serhiy Storchakaf320be72018-01-25 10:49:40 +02002372 retval = _PyObject_LookupAttrId(inst, &PyId___class__, &icls);
2373 if (icls != NULL) {
2374 if (icls != (PyObject *)(inst->ob_type) && PyType_Check(icls)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002375 retval = PyType_IsSubtype(
Serhiy Storchakaf320be72018-01-25 10:49:40 +02002376 (PyTypeObject *)icls,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002377 (PyTypeObject *)cls);
Serhiy Storchakaf320be72018-01-25 10:49:40 +02002378 }
2379 else {
2380 retval = 0;
2381 }
2382 Py_DECREF(icls);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002383 }
2384 }
2385 }
2386 else {
2387 if (!check_class(cls,
Benjamin Petersone893af52010-06-28 19:43:42 +00002388 "isinstance() arg 2 must be a type or tuple of types"))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002389 return -1;
Serhiy Storchakaf320be72018-01-25 10:49:40 +02002390 retval = _PyObject_LookupAttrId(inst, &PyId___class__, &icls);
2391 if (icls != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002392 retval = abstract_issubclass(icls, cls);
2393 Py_DECREF(icls);
2394 }
2395 }
Guido van Rossum823649d2001-03-21 18:40:58 +00002396
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002397 return retval;
Guido van Rossum823649d2001-03-21 18:40:58 +00002398}
2399
2400int
Brett Cannon4f653312004-03-20 22:52:14 +00002401PyObject_IsInstance(PyObject *inst, PyObject *cls)
2402{
Benjamin Petersonce798522012-01-22 11:24:29 -05002403 _Py_IDENTIFIER(__instancecheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002404 PyObject *checker;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002405
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002406 /* Quick test for an exact match */
2407 if (Py_TYPE(inst) == (PyTypeObject *)cls)
2408 return 1;
Christian Heimesd5e2b6f2008-03-19 21:50:51 +00002409
Georg Brandl72b8a802014-10-03 09:26:37 +02002410 /* We know what type's __instancecheck__ does. */
2411 if (PyType_CheckExact(cls)) {
2412 return recursive_isinstance(inst, cls);
2413 }
2414
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002415 if (PyTuple_Check(cls)) {
2416 Py_ssize_t i;
2417 Py_ssize_t n;
2418 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002419
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002420 if (Py_EnterRecursiveCall(" in __instancecheck__"))
2421 return -1;
2422 n = PyTuple_GET_SIZE(cls);
2423 for (i = 0; i < n; ++i) {
2424 PyObject *item = PyTuple_GET_ITEM(cls, i);
2425 r = PyObject_IsInstance(inst, item);
2426 if (r != 0)
2427 /* either found it, or got an error */
2428 break;
2429 }
2430 Py_LeaveRecursiveCall();
2431 return r;
2432 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002433
Benjamin Petersonce798522012-01-22 11:24:29 -05002434 checker = _PyObject_LookupSpecial(cls, &PyId___instancecheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002435 if (checker != NULL) {
2436 PyObject *res;
2437 int ok = -1;
2438 if (Py_EnterRecursiveCall(" in __instancecheck__")) {
2439 Py_DECREF(checker);
2440 return ok;
2441 }
Victor Stinnerde4ae3d2016-12-04 22:59:09 +01002442 res = PyObject_CallFunctionObjArgs(checker, inst, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002443 Py_LeaveRecursiveCall();
2444 Py_DECREF(checker);
2445 if (res != NULL) {
2446 ok = PyObject_IsTrue(res);
2447 Py_DECREF(res);
2448 }
2449 return ok;
2450 }
2451 else if (PyErr_Occurred())
2452 return -1;
Georg Brandl72b8a802014-10-03 09:26:37 +02002453 /* Probably never reached anymore. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002454 return recursive_isinstance(inst, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002455}
2456
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002457static int
Antoine Pitrouec569b72008-08-26 22:40:48 +00002458recursive_issubclass(PyObject *derived, PyObject *cls)
Guido van Rossum823649d2001-03-21 18:40:58 +00002459{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002460 if (PyType_Check(cls) && PyType_Check(derived)) {
2461 /* Fast path (non-recursive) */
2462 return PyType_IsSubtype((PyTypeObject *)derived, (PyTypeObject *)cls);
2463 }
2464 if (!check_class(derived,
2465 "issubclass() arg 1 must be a class"))
2466 return -1;
2467 if (!check_class(cls,
2468 "issubclass() arg 2 must be a class"
2469 " or tuple of classes"))
2470 return -1;
Guido van Rossum823649d2001-03-21 18:40:58 +00002471
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002472 return abstract_issubclass(derived, cls);
Guido van Rossum823649d2001-03-21 18:40:58 +00002473}
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002474
Brett Cannon4f653312004-03-20 22:52:14 +00002475int
2476PyObject_IsSubclass(PyObject *derived, PyObject *cls)
2477{
Benjamin Petersonce798522012-01-22 11:24:29 -05002478 _Py_IDENTIFIER(__subclasscheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002479 PyObject *checker;
Georg Brandldcfe8e42009-05-17 08:22:45 +00002480
Georg Brandl72b8a802014-10-03 09:26:37 +02002481 /* We know what type's __subclasscheck__ does. */
2482 if (PyType_CheckExact(cls)) {
2483 /* Quick test for an exact match */
2484 if (derived == cls)
2485 return 1;
2486 return recursive_issubclass(derived, cls);
2487 }
2488
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002489 if (PyTuple_Check(cls)) {
2490 Py_ssize_t i;
2491 Py_ssize_t n;
2492 int r = 0;
Antoine Pitrouec569b72008-08-26 22:40:48 +00002493
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002494 if (Py_EnterRecursiveCall(" in __subclasscheck__"))
2495 return -1;
2496 n = PyTuple_GET_SIZE(cls);
2497 for (i = 0; i < n; ++i) {
2498 PyObject *item = PyTuple_GET_ITEM(cls, i);
2499 r = PyObject_IsSubclass(derived, item);
2500 if (r != 0)
2501 /* either found it, or got an error */
2502 break;
2503 }
2504 Py_LeaveRecursiveCall();
2505 return r;
2506 }
Benjamin Peterson88fe5f92009-05-16 21:55:24 +00002507
Benjamin Petersonce798522012-01-22 11:24:29 -05002508 checker = _PyObject_LookupSpecial(cls, &PyId___subclasscheck__);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002509 if (checker != NULL) {
2510 PyObject *res;
2511 int ok = -1;
2512 if (Py_EnterRecursiveCall(" in __subclasscheck__")) {
2513 Py_DECREF(checker);
2514 return ok;
2515 }
Victor Stinnerde4ae3d2016-12-04 22:59:09 +01002516 res = PyObject_CallFunctionObjArgs(checker, derived, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002517 Py_LeaveRecursiveCall();
2518 Py_DECREF(checker);
2519 if (res != NULL) {
2520 ok = PyObject_IsTrue(res);
2521 Py_DECREF(res);
2522 }
2523 return ok;
2524 }
2525 else if (PyErr_Occurred())
2526 return -1;
Georg Brandl72b8a802014-10-03 09:26:37 +02002527 /* Probably never reached anymore. */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002528 return recursive_issubclass(derived, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00002529}
2530
2531int
2532_PyObject_RealIsInstance(PyObject *inst, PyObject *cls)
2533{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002534 return recursive_isinstance(inst, cls);
Antoine Pitrouec569b72008-08-26 22:40:48 +00002535}
2536
2537int
2538_PyObject_RealIsSubclass(PyObject *derived, PyObject *cls)
2539{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002540 return recursive_issubclass(derived, cls);
Brett Cannon4f653312004-03-20 22:52:14 +00002541}
2542
2543
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002544PyObject *
2545PyObject_GetIter(PyObject *o)
2546{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002547 PyTypeObject *t = o->ob_type;
Victor Stinner14e6d092016-12-09 17:08:59 +01002548 getiterfunc f;
2549
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002550 f = t->tp_iter;
2551 if (f == NULL) {
2552 if (PySequence_Check(o))
2553 return PySeqIter_New(o);
2554 return type_error("'%.200s' object is not iterable", o);
2555 }
2556 else {
2557 PyObject *res = (*f)(o);
2558 if (res != NULL && !PyIter_Check(res)) {
2559 PyErr_Format(PyExc_TypeError,
2560 "iter() returned non-iterator "
2561 "of type '%.100s'",
2562 res->ob_type->tp_name);
2563 Py_DECREF(res);
2564 res = NULL;
2565 }
2566 return res;
2567 }
Guido van Rossum213c7a62001-04-23 14:08:49 +00002568}
2569
Christian Tismerea62ce72018-06-09 20:32:25 +02002570#undef PyIter_Check
Christian Tismer83987132018-06-11 00:48:28 +02002571
Christian Tismerea62ce72018-06-09 20:32:25 +02002572int PyIter_Check(PyObject *obj)
2573{
2574 return obj->ob_type->tp_iternext != NULL &&
2575 obj->ob_type->tp_iternext != &_PyObject_NextNotImplemented;
2576}
2577
Tim Petersf4848da2001-05-05 00:14:56 +00002578/* Return next item.
2579 * If an error occurs, return NULL. PyErr_Occurred() will be true.
2580 * If the iteration terminates normally, return NULL and clear the
2581 * PyExc_StopIteration exception (if it was set). PyErr_Occurred()
2582 * will be false.
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002583 * Else return the next object. PyErr_Occurred() will be false.
Tim Petersf4848da2001-05-05 00:14:56 +00002584 */
Guido van Rossum213c7a62001-04-23 14:08:49 +00002585PyObject *
2586PyIter_Next(PyObject *iter)
2587{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002588 PyObject *result;
2589 result = (*iter->ob_type->tp_iternext)(iter);
2590 if (result == NULL &&
2591 PyErr_Occurred() &&
2592 PyErr_ExceptionMatches(PyExc_StopIteration))
2593 PyErr_Clear();
2594 return result;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +00002595}
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002596
2597
2598/*
2599 * Flatten a sequence of bytes() objects into a C array of
2600 * NULL terminated string pointers with a NULL char* terminating the array.
2601 * (ie: an argv or env list)
2602 *
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002603 * Memory allocated for the returned list is allocated using PyMem_Malloc()
2604 * and MUST be freed by _Py_FreeCharPArray().
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002605 */
2606char *const *
2607_PySequence_BytesToCharpArray(PyObject* self)
2608{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002609 char **array;
2610 Py_ssize_t i, argc;
2611 PyObject *item = NULL;
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002612 Py_ssize_t size;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002613
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002614 argc = PySequence_Size(self);
2615 if (argc == -1)
2616 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002617
Stefan Krah7cacd2e2012-08-21 08:16:09 +02002618 assert(argc >= 0);
2619
2620 if ((size_t)argc > (PY_SSIZE_T_MAX-sizeof(char *)) / sizeof(char *)) {
2621 PyErr_NoMemory();
2622 return NULL;
2623 }
2624
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002625 array = PyMem_Malloc((argc + 1) * sizeof(char *));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002626 if (array == NULL) {
2627 PyErr_NoMemory();
2628 return NULL;
2629 }
2630 for (i = 0; i < argc; ++i) {
2631 char *data;
2632 item = PySequence_GetItem(self, i);
Stefan Krahfd24f9e2012-08-20 11:04:24 +02002633 if (item == NULL) {
2634 /* NULL terminate before freeing. */
2635 array[i] = NULL;
2636 goto fail;
2637 }
Serhiy Storchakad174d242017-06-23 19:39:27 +03002638 /* check for embedded null bytes */
2639 if (PyBytes_AsStringAndSize(item, &data, NULL) < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002640 /* NULL terminate before freeing. */
2641 array[i] = NULL;
2642 goto fail;
2643 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002644 size = PyBytes_GET_SIZE(item) + 1;
2645 array[i] = PyMem_Malloc(size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002646 if (!array[i]) {
2647 PyErr_NoMemory();
2648 goto fail;
2649 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002650 memcpy(array[i], data, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002651 Py_DECREF(item);
2652 }
2653 array[argc] = NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002654
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002655 return array;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002656
2657fail:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002658 Py_XDECREF(item);
2659 _Py_FreeCharPArray(array);
2660 return NULL;
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002661}
2662
2663
2664/* Free's a NULL terminated char** array of C strings. */
2665void
2666_Py_FreeCharPArray(char *const array[])
2667{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002668 Py_ssize_t i;
2669 for (i = 0; array[i] != NULL; ++i) {
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002670 PyMem_Free(array[i]);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002671 }
Victor Stinner0e2d3cf2013-07-07 17:22:41 +02002672 PyMem_Free((void*)array);
Gregory P. Smithfb94c5f2010-03-14 06:49:55 +00002673}