摘要

本 PEP 提议在 PyNumberMethods 中添加一个 nb_index 槽位和一个 __index__ 特殊方法，以便在 Python 明确需要整数时（例如在切片语法中，该槽位也因此得名）可以使用任意对象。

基本原理

目前，整数和长整数在切片中扮演着特殊角色，因为它们是切片语法中唯一允许的对象。换句话说，如果 X 是实现序列协议的对象，那么 X[obj1:obj2] 仅在 obj1 和 obj2 都是整数或长整数时才有效。没有办法让 obj1 和 obj2 告诉 Python 它们可以合理地用作序列的索引。这是一个不必要的限制。

例如，在 NumPy 中，有 8 种不同的整数标量，对应于 8、16、32 和 64 位的无符号和有符号整数。这些类型对象可以在 Python 期望真实整数的许多地方合理地用作整数，但由于内存布局不兼容，它们无法继承 Python 整数类型。应该有某种方法能够告诉 Python 一个对象可以像整数一样工作。

为此目的使用 nb_int（以及 __int__ 特殊方法）是不可能的，因为该方法用于将对象强制转换为整数。允许每个可以强制转换为整数的对象在 Python 期望真实整数的所有地方都用作整数是不合适的。例如，如果 __int__ 用于在切片中将对象转换为整数，那么浮点对象将被允许在切片中使用，并且 x[3.2:5.8] 将不会像预期那样引发错误。

提案

在 PyNumberMethods 中添加一个 nb_index 槽位，以及一个对应的 __index__ 特殊方法。对象可以定义一个函数放置在 nb_index 槽位中，该函数返回一个 Python 整数（int 或 long）。然后，每当 Python 需要一个 Py_ssize_t 值时，例如在 PySequence_GetSlice、PySequence_SetSlice 和 PySequence_DelSlice 中，该整数可以被适当地转换为该值。

规范

1. nb_index 槽位将具有以下签名

   PyObject *index_func (PyObject *self)
   

   返回的对象必须是 Python IntType 或 Python LongType。发生错误时应返回 NULL 并设置适当的错误。

2. __index__ 特殊方法将具有以下签名

   def __index__(self):
       return obj
   

   其中 obj 必须是 int 或 long。

3. 将添加 3 个新的抽象 C-API 函数
   1. 第一个检查对象是否支持 index 槽位以及它是否已填充。

      int PyIndex_Check(obj)
      

      如果对象定义了 nb_index 槽位，则此函数将返回 true。

   2. 第二个是 nb_index 调用的简单包装器，如果调用不可用或未返回 int 或 long，则会引发 PyExc_TypeError。由于 PyIndex_Check 在 PyNumber_Index 调用内部执行，因此您可以直接调用它并管理任何错误，而不必首先检查兼容性。

      PyObject *PyNumber_Index (PyObject *obj)
      

   3. 第三个调用有助于处理从对象获取 Py_ssize_t 值以用于索引或其他需求的常见情况。

      Py_ssize_t PyNumber_AsSsize_t(PyObject *obj, PyObject *exc)
      

      如果 obj 的 nb_index 槽位可用，则该函数将调用它，然后将返回的 Python 整数转换为 Py_ssize_t 值。如果转换顺利，则返回该值。第二个参数允许控制如果从 nb_index 返回的整数无法放入 Py_ssize_t 值中会发生什么。

      如果 exc 为 NULL，则根据 obj 的 nb_index 槽位返回的是正整数还是负整数，返回的值将被截断为 PY_SSIZE_T_MAX 或 PY_SSIZE_T_MIN。如果 exc 不为 NULL，则它是将 Python 整数或长整数转换为 Py_ssize_t 时引发的 PyExc_OverflowError 的替代错误对象。

4. 将添加一个 operator.index(obj) 函数，该函数调用等同于 obj.__index__()，如果 obj 未实现该特殊方法则会引发错误。

实施计划

1. 在 object.h 中添加 nb_index 槽位，并修改 typeobject.c 以创建 __index__ 方法
2. 将 ceval.c 中的 ISINT 宏更改为 ISINDEX，并对其进行修改以适应定义了 index 槽位的对象。
3. 修改 _PyEval_SliceIndex 函数以适应定义了 index 槽位的对象。
4. 更改所有使用 as_mapping 槽位进行下标访问的内置对象（例如列表），并使用特殊检查来检查整数是否也具有该槽位。
5. 为整数和长整数添加 nb_index 槽位（它们只需返回自身）
6. 添加 PyNumber_Index C-API，用于从任何具有 nb_index 槽位的 Python 对象返回一个整数。
7. 添加 operator.index(x) 函数。
8. 修改 arrayobject.c 和 mmapmodule.c，使其使用新的 C-API 进行下标和其他需求。
9. 添加单元测试

讨论问题

参考实现

作为补丁 1436368 提交至 SourceForge。

参考资料

版权

本文档已置于公共领域。