胶囊

3.1 新版功能.

这个 PyObject 的子类型代表着一个任意值，当需要通过 Python 代码将任意值（以 void* 指针的形式）从 C 扩展模块传递给其他 C 代码时非常有用。它通常用于将指向一个模块中定义的 C 语言函数指针传递给其他模块，以便可以从那里调用它们。这允许通过正常的模块导入机制访问动态加载的模块中的 C API。

PyCapsule_Destructor

这种类型的一个析构器返回一个胶囊，定义如下：

参阅来获取 PyCapsule_Destructor 返回值的语义。

int PyCapsule_CheckExact(PyObject *p)

如果参数是一个则返回 True

PyObject PyCapsule_New(void **pointer, const char *name, destructor)

Return value: New reference.

Create a PyCapsule encapsulating the pointer. The pointer argument may not be NULL.

On failure, set an exception and return NULL.

The name string may either be NULL or a pointer to a valid C string. If non-NULL, this string must outlive the capsule. (Though it is permitted to free it inside the destructor.)

If the destructor argument is not NULL, it will be called with the capsule as its argument when it is destroyed.

void PyCapsule_GetPointer( **capsule, const char *name)

Retrieve the pointer stored in the capsule. On failure, set an exception and return NULL.

The name parameter must compare exactly to the name stored in the capsule. If the name stored in the capsule is NULL, the name passed in must also be NULL. Python uses the C function strcmp() to compare capsule names.

PyCapsule_Destructor ( *capsule)

Return the current destructor stored in the capsule. On failure, set an exception and return NULL.

It is legal for a capsule to have a NULL destructor. This makes a NULL return code somewhat ambiguous; use PyCapsule_IsValid() or to disambiguate.

void PyCapsule_GetContext(PyObject **capsule)

Return the current context stored in the capsule. On failure, set an exception and return NULL.

It is legal for a capsule to have a NULL context. This makes a NULL return code somewhat ambiguous; use or PyErr_Occurred() to disambiguate.

const char PyCapsule_GetName( **capsule)

Return the current name stored in the capsule. On failure, set an exception and return NULL.

It is legal for a capsule to have a NULL name. This makes a NULL return code somewhat ambiguous; use PyCapsule_IsValid() or to disambiguate.

void PyCapsule_Import(const char **name, int no_block)

从一个模块的 capsule 属性导入指向 C 对象的指针。 name 形参应当指定属性的完整名称，与 module.attribute 中的一致。保存在 capsule 中的 name 必须完全匹配此字符串。如果 no_block 为真值，则以无阻塞模式导入模块 (使用 PyImport_ImportModuleNoBlock())。如果 no_block 为假值，则以传统模式导入模块 (使用 )。

int PyCapsule_IsValid(PyObject capsule*, const char name*)

Determines whether or not capsule is a valid capsule. A valid capsule is non-NULL, passes , has a non-NULL pointer stored in it, and its internal name matches the name parameter. (See PyCapsule_GetPointer() for information on how capsule names are compared.)

换句话说，如果返回真值，则任何对访问器（以 PyCapsule_Get() 开头的任何函数）的调用都保证会成功。

如果对象有效并且匹配传入的名称则返回非零值。否则返回 0。此函数一定不会失败。

int (PyObject capsule*, void context*)

将 capsule 内部的上下文指针设为 context。

成功时返回 0。失败时返回非零值并设置一个异常。

int PyCapsule_SetDestructor( *capsule, PyCapsule_Destructor destructor)

将 capsule 内部的析构器设为 destructor。

成功时返回 0。失败时返回非零值并设置一个异常。

int PyCapsule_SetName( capsule*, const char name*)

Set the name inside capsule to name. If non-NULL, the name must outlive the capsule. If the previous name stored in the capsule was not NULL, no attempt is made to free it.

成功时返回 0。失败时返回非零值并设置一个异常。

int PyCapsule_SetPointer(PyObject capsule*, void pointer*)

成功时返回 0。失败时返回非零值并设置一个异常。