PyTuple_SetItem 的限制

Question

我有一个 Python 扩展模块，它创建一个元组作为另一个对象的属性，并在元组中设置项目。每当我在 Python 中执行此模块时，我都会收到错误 SystemError: bad argument to inside function

在阅读了 PyTuple 的文档并调试了我的程序几个小时后，我还是没明白到底是怎么回事。通过调试器运行我的程序表明问题发生在 Python 解释器内的库调用中。于是，最后我查看了Python源码，终于意识到了问题所在。 PyTuple_SetItem 函数有一个我不知道的有趣限制，也找不到明确的记录。

这是 Python 源代码中的重要函数（为了清晰起见进行了编辑）：

int PyTuple_SetItem(register PyObject *op, register Py_ssize_t i, PyObject *newitem)
{
    .....
    if (!PyTuple_Check(op) || op->ob_refcnt != 1) {
        Py_XDECREF(newitem);
        PyErr_BadInternalCall();
        return -1;
    }
    .....
}

这里重要的一行是条件 op->ob_refcnt != 1。所以问题是：你甚至不能调用 PyTuple_SetItem 除非 Tuple 的引用计数为 1。看起来这里的想法是你永远不应该使用 PyTuple_SetItem< /code> 除非在使用 PyTuple_New() 创建元组之后。我想这是有道理的，因为毕竟元组应该是不可变的，所以这个限制有助于让你的 C 代码更符合 Python 类型系统的抽象。

但是，我在任何地方都找不到此限制的记录。相关文档似乎在此处和此处，两者都没有指定此限制。文档基本上说，当您调用 PyTuple_New(X) 时，元组中的所有项目都将初始化为 NULL。由于 NULL 不是有效的 Python 值，因此扩展模块程序员需要确保在将元组返回到解释器之前，元组中的所有槽都已填充正确的 Python 值。但它并没有在任何地方说，当 Tuple 对象的引用计数为 1 时，必须执行此操作。

所以现在，问题是我基本上已经将自己编码到了一个角落，因为我没有意识到这一点（未记录？ ) 对 PyTuple_SetItem 的限制。我的代码的结构方式是，在元组本身成为另一个对象的属性之前，将项目插入到元组中非常不方便。因此，当需要填充元组中的项目时，元组已经具有更高的引用计数。

我可能必须重组我的代码，但我正在认真考虑暂时将 Tuple 上的引用计数设置为 1，插入项目，然后恢复原始引用计数。当然，我知道这是一个可怕的黑客行为，而不是任何永久的解决方案。无论如何，我想知道有关元组引用计数的要求是否在任何地方都有记录。它只是 CPython 的实现细节，还是 API 用户可以依赖的预期行为？

Answer 1

我确信您可以使用 PyTuple_SET_ITEM 而不是 PyTuple_SetItem 来绕过这些限制。 PyTuple_SET_ITEM 是在 tupleobject.h 中定义的宏，如下所示：

#define PyTuple_SET_ITEM(op, i, v) (((PyTupleObject*)(op))->ob_item[i] = v

因此，如果您绝对、绝对、完全确定：

1. op 是一个元组 对象
2. 到目前为止，您还没有初始化元组中的插槽 i
3. ，您拥有对 v 的引用，并且您想让元组窃取它，并且
4. 没有其他 Python 的机会使用元组的对象在调用 PyTuple_SET_ITEM 之前执行任何操作

，我想您可以安全地使用 PyTuple_SET_ITEM。

Answer 2

Python C API 非常的文档记录不足，如果任何地方没有提到此限制，我不会感到惊讶。

当然，一旦元组被某些东西控制，无论如何你都不应该修改它们；要么传入需要放入元组中的元素，要么使用列表。