Rust 开发系列PyO3：Rust与Python的联动编程(中)

Posted 2023-03-10 虾神说D

第三节：对比C语言的Python原生扩展开发模式

C/c++编写Python扩展的方法，与Rust大致是相同的，如果不论语言本身的语法带来的繁琐的话，就单纯以开发步骤和模式来看，原生语言写扩展的步骤更为标准和简单。

大致来说，有如下三个步骤：

1. 编写业务逻辑代码。一般来说，以C语言或者C++语言编写的业务逻辑代码，这个步骤可以完全不考虑Python和其他的内容，就是纯粹的C/C++内容。
2. 写完业务逻辑之后，需要对代码进行包装和声明，用以在Python中暴露和进行交互调度。这一步在C/C++里面就比较繁琐了，我们在下页PPT中给大家做具体的介绍。
3. 就是进行编译，这里不是用C/C++直接进行编译，而是使用Python的setup.py方法来编程为Python模块，注意，在windows上面，需要安装VC，使用cl.exe，而在Linux上一般用gcc。

下面我们来看看用C语言编写上面那个say hello 应该怎么做：

1. 编写一个返回char* 类型的方法，C语言没有String类型，所以要字符串只能弄个字符指针或者字符数组，但是这中方式，恰恰是C/C++最被人诟病的地方之一：很容易造成悬垂指针。不过这不是我们今天的内容，先pass，暂且不提。

2. 编写一个Python扩展的封装函数，如下所示：

static PyObject * sayhello_func(PyObject *self,PyOject *args)
    xxxx
    ……

简单解释一下，C/C++编写的Python扩展，需要返回C语言的Python对象，在Python的标准文档里面，声明了所有C语言与Python语言参数的转换标准，这个大家有兴趣自己去翻一下帮助文档就行。

另外，在这个封装的方法里面，还需要对Python调用时候传递的参数进行验证和转换，不过这几句话是模板化，只要你不传递复杂的对象，基本上直接套用模板就行。

1. 需要编写一个静态的Python模块定义的数组，这个数组用来定义这个Python模块各项元数据，比如调用方法的对外暴露名称、执行业务功能的方法是哪个、参数类型是什么等等。

2. 还要编写一个静态结构体，这个结构体是对外暴露的API帮助部分，在Python里面通过help方法可以获取到这些信息。

3. 最后进行一个模块化封装，把上面的这些元数据、配置项和方法封装在一起，进行打包。

全部编写完成之后，你可以自定义一个main函数，来测试一下方法是否可用，确定没问题之后，就可以在Python中打包编译安装了：

一般打包都用Python的setuptools来做，编写好setup.py文件，设置各种编译项，然后直接用

python setup.py install

命令，就可以直接编译并且安装到你的Python环境中去了。

然后就可以用Python标准包的方式，进行导入和调用。

我们来对比一下C/C++和Rust对Python的扩展开发，可以得到如下结论：

1. Rust编写的扩展比C/C++编写的扩展，从代码量、繁琐程度来看，都要优化很多，大量的工作都交给编译器和包管理器来做了。

2. C/C++编写的扩展，结构上要比Rust更加严谨，但是显得太落后，有一种上古时代的历史厚重感……

3. C/C++编写的代码，直接在Python里面进行编译和安装，似乎看起来要简单一些，不像裸奔的Rust那样，还要手动改名。

不过，下面我们要介绍的内容，就可以把这第三条直接拍死在岸上了。

第四节：PyO3的官方脚手架maturin

所谓的脚手架，就是指在建筑施工的时候，为了保证各施工过程顺利进行而搭设的工作平台，施工完成之后会被拆卸掉的东西。

maturin这个PyO3的官方脚手架，就是用来辅助我们编写Rust的Python扩展的一个辅助平台。

maturin这个工具，就是用Rust写的一个Python扩展工具包，我们直接可以通过PIP进行安装即可。

然后利用这个工具包，我们可以很方便的构筑一个PyO3工程，并且能够实现简便的编译、打包和安装过程。

做为脚手架，最大好处就是简单方便，只需要一个命令，就可以生成所有的配置项，包括示例代码：

写完所有的功能代码之后，也只需要一个命令，就可以一次性自动完成编译、安装全过程：

安装好的包，就已经是标准的Python站点包了，不但可以在Python环境中导入和调用，也可以通过pip进行管理：

下面是maturin的一些相关参数：

 

这里需要说明的是，build这个参数，需要在后面加上-f 参数，否则在windows上面build的出错，其他的参数，例如develop则不会出差，所以有些疑惑。(有文章提到是build的一个bug，未能确定)