亿迅智能制造网
工业4.0先进制造技术信息网站!
首页 | 制造技术 | 制造设备 | 工业物联网 | 工业材料 | 设备保养维修 | 工业编程 |
home  MfgRobots >> 亿迅智能制造网 >  >> Industrial programming >> Python
Python - 使用 C 的扩展编程

上一页下一页

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

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

编写扩展的先决条件

要开始编写扩展程序,您将需要 Python 头文件。

此外,假设您对 C 或 C++ 有很好的了解,可以使用 C 编程编写任何 Python 扩展。

先看一个 Python 扩展

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

头文件 Python.h

你需要包含 Python.h C 源文件中的头文件,它使您可以访问用于将模块挂接到解释器的内部 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 对象。没有 void 这样的东西 Python 中的函数就像在 C 中一样。如果您不希望您的函数返回一个值,请返回与 Python 的 None 等效的 C 价值。 Python 头文件定义了一个宏 Py_RETURN_NONE,它为我们执行此操作。

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

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

静态 PyObject *module_func (PyObject *self, PyObject *args) { /* 在这里做你的事情。 */ Py_RETURN_NONE;}

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

方法映射表

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

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

这里是这个结构的成员的描述 -

该表需要使用由 NULL 和 0 值组成的标记来终止相应成员。

示例

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

静态 PyMethodDef 模块 _methods[] ={ { "func ", (PyCFunction)module_func , METH_NOARGS, NULL }, { NULL, NULL, 0, NULL }};

初始化函数

扩展模块的最后一部分是初始化函数。该函数在模块加载时由 Python 解释器调用。要求函数名为initModule ,其中模块 是模块的名称。

初始化函数需要从您将要构建的库中导出。 Python 头文件定义了 PyMODINIT_FUNC 以包含适当的咒语,以便在我们编译的特定环境中发生这种情况。您只需在定义函数时使用它即可。

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

PyMODINIT_FUNC init模块 () { Py_InitModule3(func , 模块 _methods, "文档字符串...");}

这里是 Py_InitModule3 的描述 功能 -

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

#include static PyObject *module_func (PyObject *self, PyObject *args) { /* 在这里做你的事情。 */ Py_RETURN_NONE;}静态 PyMethodDef 模块 _methods[] ={ { "func ", (PyCFunction)module_func , METH_NOARGS, NULL }, { NULL, NULL, 0, NULL }};PyMODINIT_FUNC init模块 () { Py_InitModule3(func , 模块 _methods, "文档字符串...");}

示例

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

#include static PyObject* helloworld(PyObject* self) { return Py_BuildValue("s", "Hello, Python extensions!!");}static char helloworld_docs[] ="helloworld( ):任何你想放在这里的消息!!\n";static PyMethodDef helloworld_funcs[] ={ {"helloworld", (PyCFunction)helloworld, METH_NOARGS, helloworld_docs}, {NULL}};void inithelloworld(void) { Py_InitModule3("helloworld", helloworld_funcs, "扩展模块示例!");}

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

构建和安装扩展

distutils package 使得以标准方式分发 Python 模块变得非常容易,包括纯 Python 和扩展模块。模块以源代码形式分发,并通过通常称为 setup.py 的安装脚本构建和安装 如下。

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

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

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

$ python setup.py install

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

导入扩展

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

#!/usr/bin/pythonimport helloworldprint helloworld.helloworld()

这将产生以下结果 -

你好,Python 扩展!!

传递函数参数

由于您很可能希望定义接受参数的函数,因此您可以为 C 函数使用其他签名之一。例如,下面的函数,它接受一些参数,将这样定义 -

静态 PyObject *module_func (PyObject *self, PyObject *args) { /* 解析 args 并在这里做一些有趣的事情。 */ Py_RETURN_NONE;}

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

静态 PyMethodDef 模块 _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 参数。这是您将要解析的对象 .第二个参数是一个格式字符串,描述了您期望它们出现的参数。每个参数由格式字符串中的一个或多个字符表示,如下所示。

静态 PyObject *module_func (PyObject *self, PyObject *args) { int i;双d;字符 *s; if (!PyArg_ParseTuple(args, "ids", &i, &d, &s)) { return NULL; } /* 在这里做一些有趣的事情。 */ Py_RETURN_NONE;}

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

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

您或许可以想出更多变体。

PyArg_ParseTuple 功能

这是 PyArg_ParseTuple 的标准签名 功能 -

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

此函数返回 0 表示错误,返回不等于 0 的值表示成功。 tuple 是 PyObject*,它是 C 函数的第二个参数。这里格式 是一个描述强制和可选参数的 C 字符串。

这是 PyArg_ParseTuple 的格式代码列表 功能 -

代码 C 型 含义
c 字符 长度为 1 的 Python 字符串变成 C 字符。
d 双重 Python 浮点数变成了 C 双精度数。
f 浮动 Python 浮点数变为 C 浮点数。
i int Python int 变成 C int。
l Python int 变成 C long。
L 长长 Python int 变成 C long long
O PyObject* 获取对 Python 参数的非 NULL 借用引用。
s 字符* 没有嵌入空值的 Python 字符串到 C char*。
s# char*+int 任何 Python 字符串到 C 地址和长度。
t# char*+int 只读单段缓冲区到 C 地址和长度。
u Py_UNICODE* 没有嵌入空值到 C 的 Python Unicode。
u# Py_UNICODE*+int 任何 Python Unicode C 地址和长度。
w# char*+int 读/写单段缓冲区到C地址和长度。
z 字符* 和 s 一样,也接受 None(将 C char* 设置为 NULL)。
z# char*+int 与 s# 一样,也接受 None(将 C char* 设置为 NULL)。
(...) 根据... Python 序列被视为每个项目一个参数。
| 以下参数是可选的。
: 格式结束,后跟函数名以显示错误信息。
; 格式结束,后跟整个错误消息文本。

返回值

Py_BuildValue 采用类似于 PyArg_ParseTuple 的格式字符串 做。不是传入正在构建的值的地址,而是传入实际值。这是一个显示如何实现添加功能的示例 -

static PyObject *foo_add(PyObject *self, PyObject *args) { int a;国际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;国际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,...)

这里格式 是一个 C 字符串,用于描述要构建的 Python 对象。 Py_BuildValue 的以下参数 是从中构建结果的 C 值。 PyObject* 结果是一个新的引用。

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

代码 C 型 含义
c 字符 一个 C 字符变成一个长度为 1 的 Python 字符串。
d 双重 C double 变成 Python 浮点数。
f 浮动 C 浮点数变成 Python 浮点数。
i int C int 变成 Python int。
l C long 变成 Python int。
N PyObject* 传递一个 Python 对象并窃取一个引用。
O PyObject* 传递一个 Python 对象并照常对其进行 INCREF。
O& convert+void* 任意转换
s 字符* C 0-terminated char* 到 Python 字符串,或 NULL 到 None。
s# char*+int C char* 和长度为 Python 字符串,或 NULL 为 None。
u Py_UNICODE* C 范围内以空字符结尾的字符串到 Python Unicode,或 NULL 到无。
u# Py_UNICODE*+int C-wide 字符串和长度为 Python Unicode,或 NULL 为 None。
w# char*+int 读/写单段缓冲区到C地址和长度。
z 字符* 和 s 一样,也接受 None(将 C char* 设置为 NULL)。
z# char*+int 与 s# 一样,也接受 None(将 C char* 设置为 NULL)。
(...) 根据... 从 C 值构建 Python 元组。
[...] 根据... 从 C 值构建 Python 列表。
{...} 根据... 从 C 值、交替键和值构建 Python 字典。

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


Python

  1. Python 装饰器
  2. Python 生成器
  3. Python 与 PHP:Python 和 PHP 有什么区别?
  4. Python 字符串:替换、连接、拆分、反转、大写和小写
  5. Python 队列:FIFO、LIFO 示例
  6. Python 时间模块