Skip to content

Commit a15e260

Browse files
vstinnervstinner
authored
bpo-40170: Add _PyIndex_Check() internal function (GH-19426)
Add _PyIndex_Check() function to the internal C API: fast inlined verson of PyIndex_Check(). Add Include/internal/pycore_abstract.h header file. Replace PyIndex_Check() with _PyIndex_Check() in C files of Objects and Python subdirectories.
1 parent 45ec5b9 commit a15e260

17 files changed

+72
-30
lines changed

‎Include/internal/pycore_abstract.h

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
#ifndef Py_INTERNAL_ABSTRACT_H
2+
#define Py_INTERNAL_ABSTRACT_H
3+
#ifdef __cplusplus
4+
extern "C" {
5+
#endif
6+
7+
#ifndef Py_BUILD_CORE
8+
# error "this header requires Py_BUILD_CORE define"
9+
#endif
10+
11+
// Fast inlined version of PyIndex_Check()
12+
static inline int
13+
_PyIndex_Check(PyObject *obj)
14+
{
15+
PyNumberMethods *tp_as_number = Py_TYPE(obj)->tp_as_number;
16+
return (tp_as_number != NULL && tp_as_number->nb_index != NULL);
17+
}
18+
19+
#ifdef __cplusplus
20+
}
21+
#endif
22+
#endif /* !Py_INTERNAL_ABSTRACT_H */

‎Makefile.pre.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1080,6 +1080,7 @@ PYTHON_HEADERS= \
10801080
$(srcdir)/Include/cpython/tupleobject.h \
10811081
$(srcdir)/Include/cpython/unicodeobject.h \
10821082
\
1083+
$(srcdir)/Include/internal/pycore_abstract.h \
10831084
$(srcdir)/Include/internal/pycore_accu.h \
10841085
$(srcdir)/Include/internal/pycore_atomic.h \
10851086
$(srcdir)/Include/internal/pycore_bytes_methods.h \

‎Objects/abstract.c

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
/* Abstract Object Interface (many thanks to Jim Fulton) */
22

33
#include "Python.h"
4-
#include "pycore_ceval.h" // _Py_EnterRecursiveCall()
4+
#include "pycore_abstract.h" // _PyIndex_Check()
5+
#include "pycore_ceval.h" // _Py_EnterRecursiveCall()
56
#include "pycore_pyerrors.h"
67
#include "pycore_pystate.h"
78
#include <ctype.h>
@@ -160,7 +161,7 @@ PyObject_GetItem(PyObject *o, PyObject *key)
160161

161162
ms = Py_TYPE(o)->tp_as_sequence;
162163
if (ms && ms->sq_item) {
163-
if (PyIndex_Check(key)) {
164+
if (_PyIndex_Check(key)) {
164165
Py_ssize_t key_value;
165166
key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
166167
if (key_value == -1 && PyErr_Occurred())
@@ -176,7 +177,7 @@ PyObject_GetItem(PyObject *o, PyObject *key)
176177
if (PyType_Check(o)) {
177178
PyObject *meth, *result;
178179
_Py_IDENTIFIER(__class_getitem__);
179-
180+
180181
// Special case type[int], but disallow other types so str[int] fails
181182
if ((PyTypeObject*)o == &PyType_Type) {
182183
return Py_GenericAlias(o, key);
@@ -209,7 +210,7 @@ PyObject_SetItem(PyObject *o, PyObject *key, PyObject *value)
209210
return m->mp_ass_subscript(o, key, value);
210211

211212
if (Py_TYPE(o)->tp_as_sequence) {
212-
if (PyIndex_Check(key)) {
213+
if (_PyIndex_Check(key)) {
213214
Py_ssize_t key_value;
214215
key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
215216
if (key_value == -1 && PyErr_Occurred())
@@ -241,7 +242,7 @@ PyObject_DelItem(PyObject *o, PyObject *key)
241242
return m->mp_ass_subscript(o, key, (PyObject*)NULL);
242243

243244
if (Py_TYPE(o)->tp_as_sequence) {
244-
if (PyIndex_Check(key)) {
245+
if (_PyIndex_Check(key)) {
245246
Py_ssize_t key_value;
246247
key_value = PyNumber_AsSsize_t(key, PyExc_IndexError);
247248
if (key_value == -1 && PyErr_Occurred())
@@ -1030,7 +1031,7 @@ static PyObject *
10301031
sequence_repeat(ssizeargfunc repeatfunc, PyObject *seq, PyObject *n)
10311032
{
10321033
Py_ssize_t count;
1033-
if (PyIndex_Check(n)) {
1034+
if (_PyIndex_Check(n)) {
10341035
count = PyNumber_AsSsize_t(n, PyExc_OverflowError);
10351036
if (count == -1 && PyErr_Occurred())
10361037
return NULL;
@@ -1307,15 +1308,16 @@ PyNumber_Absolute(PyObject *o)
13071308
return type_error("bad operand type for abs(): '%.200s'", o);
13081309
}
13091310

1311+
13101312
#undef PyIndex_Check
13111313

13121314
int
13131315
PyIndex_Check(PyObject *obj)
13141316
{
1315-
return Py_TYPE(obj)->tp_as_number != NULL &&
1316-
Py_TYPE(obj)->tp_as_number->nb_index != NULL;
1317+
return _PyIndex_Check(obj);
13171318
}
13181319

1320+
13191321
/* Return a Python int from the object item.
13201322
Raise TypeError if the result is not an int
13211323
or if the object cannot be interpreted as an index.
@@ -1332,7 +1334,7 @@ PyNumber_Index(PyObject *item)
13321334
Py_INCREF(item);
13331335
return item;
13341336
}
1335-
if (!PyIndex_Check(item)) {
1337+
if (!_PyIndex_Check(item)) {
13361338
PyErr_Format(PyExc_TypeError,
13371339
"'%.200s' object cannot be interpreted "
13381340
"as an integer", Py_TYPE(item)->tp_name);

‎Objects/bytearrayobject.c

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
#define PY_SSIZE_T_CLEAN
44
#include "Python.h"
5+
#include "pycore_abstract.h" // _PyIndex_Check()
56
#include "pycore_bytes_methods.h"
67
#include "pycore_object.h"
78
#include "pycore_pymem.h"
@@ -391,7 +392,7 @@ bytearray_getitem(PyByteArrayObject *self, Py_ssize_t i)
391392
static PyObject *
392393
bytearray_subscript(PyByteArrayObject *self, PyObject *index)
393394
{
394-
if (PyIndex_Check(index)) {
395+
if (_PyIndex_Check(index)) {
395396
Py_ssize_t i = PyNumber_AsSsize_t(index, PyExc_IndexError);
396397

397398
if (i == -1 && PyErr_Occurred())
@@ -610,7 +611,7 @@ bytearray_ass_subscript(PyByteArrayObject *self, PyObject *index, PyObject *valu
610611
char *buf, *bytes;
611612
buf = PyByteArray_AS_STRING(self);
612613

613-
if (PyIndex_Check(index)) {
614+
if (_PyIndex_Check(index)) {
614615
Py_ssize_t i = PyNumber_AsSsize_t(index, PyExc_IndexError);
615616

616617
if (i == -1 && PyErr_Occurred())
@@ -809,7 +810,7 @@ bytearray_init(PyByteArrayObject *self, PyObject *args, PyObject *kwds)
809810
}
810811

811812
/* Is it an int? */
812-
if (PyIndex_Check(arg)) {
813+
if (_PyIndex_Check(arg)) {
813814
count = PyNumber_AsSsize_t(arg, PyExc_OverflowError);
814815
if (count == -1 && PyErr_Occurred()) {
815816
if (!PyErr_ExceptionMatches(PyExc_TypeError))

‎Objects/bytes_methods.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
#define PY_SSIZE_T_CLEAN
22
#include "Python.h"
3+
#include "pycore_abstract.h" // _PyIndex_Check()
34
#include "pycore_bytes_methods.h"
45

56
PyDoc_STRVAR_shared(_Py_isspace__doc__,
@@ -466,7 +467,7 @@ parse_args_finds_byte(const char *function_name, PyObject *args,
466467
return 1;
467468
}
468469

469-
if (!PyIndex_Check(tmp_subobj)) {
470+
if (!_PyIndex_Check(tmp_subobj)) {
470471
PyErr_Format(PyExc_TypeError,
471472
"argument should be integer or bytes-like object, "
472473
"not '%.200s'",

‎Objects/bytesobject.c

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
#define PY_SSIZE_T_CLEAN
44

55
#include "Python.h"
6+
#include "pycore_abstract.h" // _PyIndex_Check()
67
#include "pycore_bytes_methods.h"
78
#include "pycore_object.h"
89
#include "pycore_pymem.h"
@@ -1579,7 +1580,7 @@ bytes_hash(PyBytesObject *a)
15791580
static PyObject*
15801581
bytes_subscript(PyBytesObject* self, PyObject* item)
15811582
{
1582-
if (PyIndex_Check(item)) {
1583+
if (_PyIndex_Check(item)) {
15831584
Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
15841585
if (i == -1 && PyErr_Occurred())
15851586
return NULL;
@@ -2536,7 +2537,7 @@ bytes_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
25362537
return NULL;
25372538
}
25382539
/* Is it an integer? */
2539-
if (PyIndex_Check(x)) {
2540+
if (_PyIndex_Check(x)) {
25402541
size = PyNumber_AsSsize_t(x, PyExc_OverflowError);
25412542
if (size == -1 && PyErr_Occurred()) {
25422543
if (!PyErr_ExceptionMatches(PyExc_TypeError))

‎Objects/interpreteridobject.c

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
/* InterpreterID object */
22

33
#include "Python.h"
4-
#include "internal/pycore_pystate.h"
4+
#include "pycore_abstract.h" // _PyIndex_Check()
5+
#include "pycore_pystate.h"
56
#include "interpreteridobject.h"
67

78

@@ -42,7 +43,7 @@ interp_id_converter(PyObject *arg, void *ptr)
4243
if (PyObject_TypeCheck(arg, &_PyInterpreterID_Type)) {
4344
id = ((interpid *)arg)->id;
4445
}
45-
else if (PyIndex_Check(arg)) {
46+
else if (_PyIndex_Check(arg)) {
4647
id = PyLong_AsLongLong(arg);
4748
if (id == -1 && PyErr_Occurred()) {
4849
return 0;

‎Objects/listobject.c

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
/* List object implementation */
22

33
#include "Python.h"
4+
#include "pycore_abstract.h" // _PyIndex_Check()
45
#include "pycore_object.h"
56
#include "pycore_pystate.h"
67
#include "pycore_tupleobject.h"
@@ -2800,7 +2801,7 @@ static PySequenceMethods list_as_sequence = {
28002801
static PyObject *
28012802
list_subscript(PyListObject* self, PyObject* item)
28022803
{
2803-
if (PyIndex_Check(item)) {
2804+
if (_PyIndex_Check(item)) {
28042805
Py_ssize_t i;
28052806
i = PyNumber_AsSsize_t(item, PyExc_IndexError);
28062807
if (i == -1 && PyErr_Occurred())
@@ -2855,7 +2856,7 @@ list_subscript(PyListObject* self, PyObject* item)
28552856
static int
28562857
list_ass_subscript(PyListObject* self, PyObject* item, PyObject* value)
28572858
{
2858-
if (PyIndex_Check(item)) {
2859+
if (_PyIndex_Check(item)) {
28592860
Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
28602861
if (i == -1 && PyErr_Occurred())
28612862
return -1;

‎Objects/memoryobject.c

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
*/
1212

1313
#include "Python.h"
14+
#include "pycore_abstract.h" // _PyIndex_Check()
1415
#include "pycore_object.h"
1516
#include "pycore_pymem.h"
1617
#include "pycore_pystate.h"
@@ -2421,8 +2422,9 @@ is_multiindex(PyObject *key)
24212422
size = PyTuple_GET_SIZE(key);
24222423
for (i = 0; i < size; i++) {
24232424
PyObject *x = PyTuple_GET_ITEM(key, i);
2424-
if (!PyIndex_Check(x))
2425+
if (!_PyIndex_Check(x)) {
24252426
return 0;
2427+
}
24262428
}
24272429
return 1;
24282430
}
@@ -2459,7 +2461,7 @@ memory_subscript(PyMemoryViewObject *self, PyObject *key)
24592461
}
24602462
}
24612463

2462-
if (PyIndex_Check(key)) {
2464+
if (_PyIndex_Check(key)) {
24632465
Py_ssize_t index;
24642466
index = PyNumber_AsSsize_t(key, PyExc_IndexError);
24652467
if (index == -1 && PyErr_Occurred())
@@ -2530,7 +2532,7 @@ memory_ass_sub(PyMemoryViewObject *self, PyObject *key, PyObject *value)
25302532
}
25312533
}
25322534

2533-
if (PyIndex_Check(key)) {
2535+
if (_PyIndex_Check(key)) {
25342536
Py_ssize_t index;
25352537
if (1 < view->ndim) {
25362538
PyErr_SetString(PyExc_NotImplementedError,

‎Objects/rangeobject.c

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
/* Range object implementation */
22

33
#include "Python.h"
4-
#include "structmember.h"
4+
#include "pycore_abstract.h" // _PyIndex_Check()
55
#include "pycore_tupleobject.h"
6+
#include "structmember.h"
67

78
/* Support objects whose length is > PY_SSIZE_T_MAX.
89
@@ -631,7 +632,7 @@ range_reduce(rangeobject *r, PyObject *args)
631632
static PyObject *
632633
range_subscript(rangeobject* self, PyObject* item)
633634
{
634-
if (PyIndex_Check(item)) {
635+
if (_PyIndex_Check(item)) {
635636
PyObject *i, *result;
636637
i = PyNumber_Index(item);
637638
if (!i)

‎Objects/sliceobject.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ this type and there is exactly one in existence.
1414
*/
1515

1616
#include "Python.h"
17+
#include "pycore_abstract.h" // _PyIndex_Check()
1718
#include "pycore_object.h"
1819
#include "pycore_pymem.h"
1920
#include "pycore_pystate.h"
@@ -354,7 +355,7 @@ static PyMemberDef slice_members[] = {
354355
static PyObject*
355356
evaluate_slice_index(PyObject *v)
356357
{
357-
if (PyIndex_Check(v)) {
358+
if (_PyIndex_Check(v)) {
358359
return PyNumber_Index(v);
359360
}
360361
else {

‎Objects/tupleobject.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
/* Tuple object implementation */
33

44
#include "Python.h"
5+
#include "pycore_abstract.h" // _PyIndex_Check()
56
#include "pycore_object.h"
67
#include "pycore_pystate.h"
78
#include "pycore_accu.h"
@@ -763,7 +764,7 @@ static PySequenceMethods tuple_as_sequence = {
763764
static PyObject*
764765
tuplesubscript(PyTupleObject* self, PyObject* item)
765766
{
766-
if (PyIndex_Check(item)) {
767+
if (_PyIndex_Check(item)) {
767768
Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
768769
if (i == -1 && PyErr_Occurred())
769770
return NULL;

‎Objects/unicodeobject.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
4040

4141
#define PY_SSIZE_T_CLEAN
4242
#include "Python.h"
43+
#include "pycore_abstract.h" // _PyIndex_Check()
4344
#include "pycore_bytes_methods.h"
4445
#include "pycore_fileutils.h"
4546
#include "pycore_initconfig.h"
@@ -14132,7 +14133,7 @@ unicode_subscript(PyObject* self, PyObject* item)
1413214133
if (PyUnicode_READY(self) == -1)
1413314134
return NULL;
1413414135

14135-
if (PyIndex_Check(item)) {
14136+
if (_PyIndex_Check(item)) {
1413614137
Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
1413714138
if (i == -1 && PyErr_Occurred())
1413814139
return NULL;

‎PCbuild/pythoncore.vcxproj

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,7 @@
161161
<ClInclude Include="..\Include\graminit.h" />
162162
<ClInclude Include="..\Include\grammar.h" />
163163
<ClInclude Include="..\Include\import.h" />
164+
<ClInclude Include="..\Include\internal\pycore_abstract.h" />
164165
<ClInclude Include="..\Include\internal\pycore_accu.h" />
165166
<ClInclude Include="..\Include\internal\pycore_atomic.h" />
166167
<ClInclude Include="..\Include\internal\pycore_bytes_methods.h" />

‎PCbuild/pythoncore.vcxproj.filters

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,9 @@
186186
<ClInclude Include="..\Include\import.h">
187187
<Filter>Include</Filter>
188188
</ClInclude>
189+
<ClInclude Include="..\Include\internal\pycore_abstract.h">
190+
<Filter>Include</Filter>
191+
</ClInclude>
189192
<ClInclude Include="..\Include\internal\pycore_accu.h">
190193
<Filter>Include</Filter>
191194
</ClInclude>

‎Python/ceval.c

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
#define PY_LOCAL_AGGRESSIVE
1111

1212
#include "Python.h"
13+
#include "pycore_abstract.h" // _PyIndex_Check()
1314
#include "pycore_call.h"
1415
#include "pycore_ceval.h"
1516
#include "pycore_code.h"
@@ -5089,7 +5090,7 @@ _PyEval_SliceIndex(PyObject *v, Py_ssize_t *pi)
50895090
PyThreadState *tstate = _PyThreadState_GET();
50905091
if (v != Py_None) {
50915092
Py_ssize_t x;
5092-
if (PyIndex_Check(v)) {
5093+
if (_PyIndex_Check(v)) {
50935094
x = PyNumber_AsSsize_t(v, NULL);
50945095
if (x == -1 && _PyErr_Occurred(tstate))
50955096
return 0;
@@ -5110,7 +5111,7 @@ _PyEval_SliceIndexNotNone(PyObject *v, Py_ssize_t *pi)
51105111
{
51115112
PyThreadState *tstate = _PyThreadState_GET();
51125113
Py_ssize_t x;
5113-
if (PyIndex_Check(v)) {
5114+
if (_PyIndex_Check(v)) {
51145115
x = PyNumber_AsSsize_t(v, NULL);
51155116
if (x == -1 && _PyErr_Occurred(tstate))
51165117
return 0;

0 commit comments

Comments
 (0)