胶囊¶
有关使用这些对象的更多信息,请参阅 为扩展模块提供 C API。
在 3.1 版本中添加。
-
type PyCapsule¶
此
PyObject
的子类型表示一个不透明的值,对于需要通过 Python 代码将不透明值(作为 void* 指针)传递给其他 C 代码的 C 扩展模块很有用。它通常用于使在一个模块中定义的 C 函数指针可供其他模块使用,因此可以使用常规的导入机制来访问动态加载模块中定义的 C API。
-
type PyCapsule_Destructor¶
- 是 稳定 ABI 的一部分。
胶囊的析构函数回调类型。定义为
typedef void (*PyCapsule_Destructor)(PyObject *);
有关 PyCapsule_Destructor 回调的语义,请参阅
PyCapsule_New()
。
-
PyObject *PyCapsule_New(void *pointer, const char *name, PyCapsule_Destructor destructor)¶
- 返回值:新引用。 是 稳定 ABI 的一部分。
创建一个
PyCapsule
,封装 pointer。pointer 参数不能为NULL
。如果失败,则设置异常并返回
NULL
。name 字符串可以是
NULL
或指向有效 C 字符串的指针。如果非NULL
,则此字符串必须比胶囊存活时间更长。(虽然允许在 destructor 中释放它。)如果 destructor 参数不是
NULL
,则当胶囊被销毁时,它将使用胶囊作为其参数被调用。如果此胶囊将被存储为模块的属性,则 name 应指定为
modulename.attributename
。这将使其他模块能够使用PyCapsule_Import()
导入胶囊。
-
void *PyCapsule_GetPointer(PyObject *capsule, const char *name)¶
- 是 稳定 ABI 的一部分。
从胶囊中检索存储的指针。如果失败,则设置异常并返回
NULL
。name 参数必须与存储在胶囊中的名称完全匹配。如果存储在胶囊中的名称为
NULL
,则传入的name 也必须为NULL
。Python 使用 C 函数strcmp()
来比较胶囊名称。
-
PyCapsule_Destructor PyCapsule_GetDestructor(PyObject *capsule)¶
- 是 稳定 ABI 的一部分。
返回当前存储在胶囊中的析构函数。如果失败,则设置异常并返回
NULL
。胶囊可以具有
NULL
析构函数是合法的。这使得NULL
返回代码有些模棱两可;使用PyCapsule_IsValid()
或PyErr_Occurred()
来消除歧义。
-
void *PyCapsule_GetContext(PyObject *capsule)¶
- 是 稳定 ABI 的一部分。
返回当前存储在胶囊中的上下文。如果失败,则设置异常并返回
NULL
。胶囊可以具有
NULL
上下文是合法的。这使得NULL
返回代码有些模棱两可;使用PyCapsule_IsValid()
或PyErr_Occurred()
来消除歧义。
-
const char *PyCapsule_GetName(PyObject *capsule)¶
- 是 稳定 ABI 的一部分。
返回当前存储在胶囊中的名称。如果失败,则设置异常并返回
NULL
。胶囊可以合法地拥有一个
NULL
名称。这使得NULL
返回代码有些模棱两可;使用PyCapsule_IsValid()
或PyErr_Occurred()
来消除歧义。
-
void *PyCapsule_Import(const char *name, int no_block)¶
- 是 稳定 ABI 的一部分。
从模块中的胶囊属性导入指向 C 对象的指针。name 参数应指定属性的完整名称,如
module.attribute
。胶囊中存储的 name 必须与该字符串完全匹配。成功时返回胶囊的内部 pointer。失败时,设置异常并返回
NULL
。版本 3.3 中的变更: no_block 现在不再起作用。
-
int PyCapsule_IsValid(PyObject *capsule, const char *name)¶
- 是 稳定 ABI 的一部分。
确定 capsule 是否为有效的胶囊。有效的胶囊是非
NULL
,通过PyCapsule_CheckExact()
,在其中存储了非NULL
指针,并且其内部名称与 name 参数匹配。(有关胶囊名称如何比较的信息,请参阅PyCapsule_GetPointer()
。)换句话说,如果
PyCapsule_IsValid()
返回真值,则对任何访问器(任何以PyCapsule_Get
开头的函数)的调用都保证会成功。如果对象有效且与传入的名称匹配,则返回非零值。否则返回
0
。此函数不会失败。
-
int PyCapsule_SetContext(PyObject *capsule, void *context)¶
- 是 稳定 ABI 的一部分。
将 capsule 内部的上下文指针设置为 context。
成功时返回
0
。失败时返回非零值并设置异常。
-
int PyCapsule_SetDestructor(PyObject *capsule, PyCapsule_Destructor destructor)¶
- 是 稳定 ABI 的一部分。
将 capsule 内部的析构函数设置为 destructor。
成功时返回
0
。失败时返回非零值并设置异常。