Python - 进一步扩展

使用 C、C++ 或 Java 等任何编译语言编写的任何代码都可以集成或导入到另一个 Python 脚本中。该代码被视为“扩展”。

Python 扩展模块只不过是一个普通的 C 库。在 Unix 机器上，这些库通常以.so结尾（表示共享对象）。在 Windows 计算机上，您通常会看到.dll（用于动态链接库）。

编写扩展的先决条件

要开始编写扩展，您将需要 Python 头文件。

在 Unix 机器上，这通常需要安装特定于开发人员的软件包。
Windows 用户在使用二进制 Python 安装程序时将这些标头作为包的一部分获得。

此外，假设您具有良好的 C 或 C++ 知识，可以使用 C 编程编写任何 Python 扩展。

首先看一下Python扩展

第一次查看 Python 扩展模块时，您需要将代码分为四个部分 -

头文件Python.h。
您想要作为模块接口公开的 C 函数。
映射函数名称的表，Python 开发人员将它们视为扩展模块内的 C 函数。
初始化函数。

头文件Python.h

您需要在 C 源文件中包含 Python.h 头文件，这样您就可以访问用于将模块挂接到解释器的内部 Python API。

确保在您可能需要的任何其他标头之前包含 Python.h。您需要在包含文件后添加要从 Python 调用的函数。

C 函数

函数的 C 实现的签名始终采用以下三种形式之一 -

static PyObject *MyFunction(PyObject *self, PyObject *args);
static PyObject *MyFunctionWithKeywords(PyObject *self,
   PyObject *args,
   PyObject *kw);
static PyObject *MyFunctionWithNoArgs(PyObject *self);

前面的每一个声明都会返回一个 Python 对象。Python 中不存在像 C 中那样的 void 函数。如果您不希望函数返回值，请返回与 Python 的None值等效的 C 语言。Python 头文件定义了一个宏 Py_RETURN_NONE，它为我们执行此操作。

C 函数的名称可以是您喜欢的任何名称，因为它们在扩展模块之外永远不会出现。它们被定义为静态函数。

您的 C 函数通常通过将 Python 模块和函数名称组合在一起来命名，如下所示 -

static PyObject *module_func(PyObject *self, PyObject *args) {
   /* Do your stuff here. */
   Py_RETURN_NONE;
}

这是模块 module 内一个名为 func 的 Python 函数。您将把指向 C 函数的指针放入通常在源代码中接下来出现的模块的方法表中。

方法映射表

该方法表是 PyMethodDef 结构的简单数组。该结构看起来像这样 -

struct PyMethodDef {
   char *ml_name;
   PyCFunction ml_meth;
   int ml_flags;
   char *ml_doc;
};

这是该结构成员的描述 -

ml_name - 这是 Python 解释器在 Python 程序中使用时呈现的函数名称。
ml_meth - 这是具有上一节中描述的任何一个签名的函数的地址。
ml_flags - 这告诉解释器 ml_meth 正在使用三个签名中的哪一个。
- 该标志的值通常为 METH_VARARGS。
- 如果您想允许关键字参数进入您的函数，则可以将此标志与 METH_KEYWORDS 进行按位或运算。
- 它也可以具有 METH_NOARGS 值，表示您不想接受任何参数。
mml_doc - 这是该函数的文档字符串，如果您不想编写文档字符串，则可以为 NULL。

该表需要以由 NULL 和相应成员的 0 值组成的哨兵来终止。

例子

对于上面定义的函数，我们有以下方法映射表 -

static PyMethodDef module_methods[] = {
   { "func", (PyCFunction)module_func, METH_NOARGS, NULL },
   { NULL, NULL, 0, NULL }
};

初始化函数

扩展模块的最后一部分是初始化函数。当模块加载时，Python 解释器会调用此函数。该函数需要命名为initModule，其中 Module 是模块的名称。

初始化函数需要从您将构建的库中导出。Python 标头定义 PyMODINIT_FUNC 以包含针对我们正在编译的特定环境发生的适当的咒语。您所要做的就是在定义函数时使用它。

您的 C 初始化函数通常具有以下总体结构 -

PyMODINIT_FUNC initModule() {
   Py_InitModule3(func, module_methods, "docstring...");
}

这是 Py_InitModule3 函数的描述 -

func - 这是要导出的函数。
module_methods - 这是上面定义的映射表名称。
docstring - 这是您想要在扩展中给出的注释。

将所有这些放在一起，看起来如下 -

#include <Python.h>
static PyObject *module_func(PyObject *self, PyObject *args) {
   /* Do your stuff here. */
   Py_RETURN_NONE;
}
static PyMethodDef module_methods[] = {
   { "func", (PyCFunction)module_func, METH_NOARGS, NULL },
   { NULL, NULL, 0, NULL }
};
PyMODINIT_FUNC initModule() {
   Py_InitModule3(func, module_methods, "docstring...");
}

例子

一个利用上述所有概念的简单示例 -

#include <Python.h>
static PyObject* helloworld(PyObject* self)
{
   return Py_BuildValue("s", "Hello, Python extensions!!");
}
static char helloworld_docs[] =
   "helloworld( ): Any message you want to put here!!\n";
static PyMethodDef helloworld_funcs[] = {
   {"helloworld", (PyCFunction)helloworld,
   METH_NOARGS, helloworld_docs},
   {NULL}
};
void inithelloworld(void)
{
   Py_InitModule3("helloworld", helloworld_funcs,
      "Extension module example!");
}

这里Py_BuildValue函数用于构建 Python 值。将以上代码保存在 hello.c 文件中。我们将了解如何编译和安装该模块以从 Python 脚本调用。

构建和安装扩展

distutils包使得以标准方式分发 Python 模块（包括纯 Python 和扩展模块）变得非常容易。模块以源形式分发，通过通常称为setup.pyas的安装脚本构建和安装。

对于上述模块，您需要准备以下 setup.py 脚本 -

from distutils.core import setup, Extension
setup(name='helloworld', version='1.0', \
   ext_modules=[Extension('helloworld', ['hello.c'])])

现在，使用以下命令，该命令将使用正确的编译器和链接器命令和标志执行所有需要的编译和链接步骤，并将生成的动态库复制到适当的目录中 -

$ python setup.py install

在基于 Unix 的系统上，您很可能需要以 root 身份运行此命令，以获得写入 site-packages 目录的权限。这在 Windows 上通常不是问题。

导入扩展

安装扩展后，您将能够在 Python 脚本中导入并调用该扩展，如下所示 -

import helloworld
print helloworld.helloworld()

这将产生以下输出-

Hello, Python extensions!!

传递函数参数

由于您很可能想要定义接受参数的函数，因此您可以为 C 函数使用其他签名之一。例如，下面的函数接受一定数量的参数，其定义如下：

static PyObject *module_func(PyObject *self, PyObject *args) {
   /* Parse args and do something interesting here. */
   Py_RETURN_NONE;
}

包含新函数条目的方法表如下所示 -

static PyMethodDef module_methods[] = {
   { "func", (PyCFunction)module_func, METH_NOARGS, NULL },
   { "func", module_func, METH_VARARGS, NULL },
   { NULL, NULL, 0, NULL }
};

您可以使用 API PyArg_ParseTuple函数从传递到 C 函数的一个 PyObject 指针中提取参数。

PyArg_ParseTuple的第一个参数是 args 参数。这是您将要解析的对象。第二个参数是一个格式字符串，描述您期望出现的参数。每个参数都由格式字符串中的一个或多个字符表示，如下所示。

static PyObject *module_func(PyObject *self, PyObject *args) {
   int i;
   double d;
   char *s;
   if (!PyArg_ParseTuple(args, "ids", &i, &d, &s)) {
      return NULL;
   }

   /* Do something interesting here. */
   Py_RETURN_NONE;
}

编译模块的新版本并导入它使您能够使用任意数量的任意类型的参数调用新函数 -

module.func(1, s="three", d=2.0)
module.func(i=1, d=2.0, s="three")
module.func(s="three", d=2.0, i=1)

您也许可以想出更多的变化。

PyArg_ParseTuple 函数

re 是PyArg_ParseTuple函数的标准签名-

int PyArg_ParseTuple(PyObject* tuple,char* format,...)

如果出现错误，该函数将返回 0；如果成功，则返回不等于 0 的值。Tuple 是 PyObject*，它是 C 函数的第二个参数。这里的 format 是一个描述强制参数和可选参数的 C 字符串。

以下是PyArg_ParseTuple函数的格式代码列表-

代码	C型	意义
C	字符	长度为 1 的 Python 字符串变成 C 字符。
d	双倍的	Python 的 float 变成了 C 的 double。
F	漂浮	Python 浮点数变成了 C 浮点数。
我	整数	Python int 变成了 C int。
我	长的	Python int 变为 C long。
L	长长	Python int 变为 C long long。
氧	PyObject*	获取对 Python 参数的非 NULL 借用引用。
S	字符*	不向 C char* 嵌入空值的 Python 字符串。
s#	字符*+整数	任何 Python 字符串到 C 地址和长度。
t#	字符*+整数	只读单段缓冲区的 C 地址和长度。
你	Py_UNICODE*	Python Unicode 没有嵌入 C 的空值。
你#	Py_UNICODE*+int	任何 Python Unicode C 地址和长度。
w#	字符*+整数	读/写单段缓冲区的 C 地址和长度。
z	字符*	与 s 一样，也接受 None（将 C char* 设置为 NULL）。
z#	字符*+整数	与 s# 一样，也接受 None（将 C char* 设置为 NULL）。
（...）	按照 ...	Python 序列被视为每一项一个参数。
\|		以下参数是可选的。
：		格式结束，后跟错误消息的函数名称。
;		格式结束，后跟整个错误消息文本。

返回值

Py_BuildValue接受格式字符串，就像PyArg_ParseTuple一样。您不是传递正在构建的值的地址，而是传递实际值。下面是一个示例，展示了如何实现添加功能。

static PyObject *foo_add(PyObject *self, PyObject *args) {
   int a;
   int b;
   if (!PyArg_ParseTuple(args, "ii", &a, &b)) {
      return NULL;
   }
   return Py_BuildValue("i", a + b);
}

如果用 Python 实现，它会是这样的 -

def add(a, b):
   return (a + b)

您可以从函数中返回两个值，如下所示。这可以使用 Python 中的列表来捕获。

static PyObject *foo_add_subtract(PyObject *self, PyObject *args) {
   int a;
   int b;
   if (!PyArg_ParseTuple(args, "ii", &a, &b)) {
      return NULL;
   }
   return Py_BuildValue("ii", a + b, a - b);
}

如果用 Python 实现，它会是这样的 -

def add_subtract(a, b):
   return (a + b, a - b)

Py_BuildValue 函数

这是Py_BuildValue函数的标准签名-

PyObject* Py_BuildValue(char* format,...)

这里的 format 是一个 C 字符串，描述了要构建的 Python 对象。Py_BuildValue的以下参数是构建结果的 C 值。PyObject *结果是一个新的引用。

下表列出了常用的代码字符串，其中零个或多个代码字符串被连接成字符串格式。

代码	C型	意义
C	字符	AC char 变成长度为 1 的 Python 字符串。
d	双倍的	AC double 变成 Python float。
F	漂浮	AC 浮点数变成了 Python 浮点数。
我	整数	C int 变成 Python int
我	长的	AC long 变成 Python int
氮	PyObject*	传递一个 Python 对象并窃取一个引用。
氧	PyObject*	传递一个 Python 对象并像平常一样对其进行 INCREF。
奥&	转换+无效*	任意转换
s	字符*	C 0 结尾的 char* 到 Python 字符串，或者 NULL 到 None。
s#	字符*+整数	C char* 和长度为 Python 字符串，或 NULL 为 None。
你	Py_UNICODE*	C 范围、以 null 结尾的字符串到 Python Unicode，或 NULL 到 None。
你#	Py_UNICODE*+int	C 宽字符串和长度为 Python Unicode，或 NULL 为 None。
w#	字符*+整数	读/写单段缓冲区的 C 地址和长度。
z	字符*	与 s 一样，也接受 None（将 C char* 设置为 NULL）。
z#	字符*+整数	与 s# 一样，也接受 None（将 C char* 设置为 NULL）。
（...）	按照 ...	从 C 值构建 Python 元组。
[...]	按照 ...	从 C 值构建 Python 列表。
{...}	按照 ...	从 C 值、交替键和值构建 Python 字典。

代码 {...} 从偶数个 C 值（交替的键和值）构建字典。例如， Py_BuildValue("{issi}",23,"zig","zag",42) 返回一个类似于 Python 的 {23:'zig','zag':42} 的字典