摘要

本 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 需要（例如在PySequence_GetSlice、PySequence_SetSlice和PySequence_DelSlice中）一个Py_ssize_t值时，可以将此整数适当地转换为Py_ssize_t值。

规范

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. 第一个检查对象是否支持索引槽位，以及它是否已填充。

      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，则返回值将被裁剪到PY_SSIZE_T_MAX或PY_SSIZE_T_MIN，具体取决于 obj 的nb_index槽位返回正整数还是负整数。如果 exc 不为 NULL，则它是将被设置为替换PyExc_OverflowError的错误对象，当 Python 整数或长整数转换为Py_ssize_t时，会引发该错误。

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

实施计划

1. 在object.h中添加nb_index槽位，并修改typeobject.c以创建__index__方法
2. 将ceval.c中的ISINT宏更改为ISINDEX，并修改它以适应定义了索引槽位的对象。
3. 更改_PyEval_SliceIndex函数以适应定义了索引槽位的对象。
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。

参考文献

版权

本文档已进入公有领域。