C/c++编写Python扩展的方法,与Rust大致是相同的,如果不论语言本身的语法带来的繁琐的话,就单纯以开发步骤和模式来看,原生语言写扩展的步骤更为标准和简单。
大致来说,有如下三个步骤:
下面我们来看看用C语言编写上面那个say hello 应该怎么做:
编写一个返回char* 类型的方法,C语言没有String类型,所以要字符串只能弄个字符指针或者字符数组,但是这中方式,恰恰是C/C++最被人诟病的地方之一:很容易造成悬垂指针。不过这不是我们今天的内容,先pass,暂且不提。
编写一个Python扩展的封装函数,如下所示:
static PyObject * sayhello_func(PyObject *self,PyOject *args){xxxx…… }
简单解释一下,C/C++编写的Python扩展,需要返回C语言的Python对象,在Python的标准文档里面,声明了所有C语言与Python语言参数的转换标准,这个大家有兴趣自己去翻一下帮助文档就行。
另外,在这个封装的方法里面,还需要对Python调用时候传递的参数进行验证和转换,不过这几句话是模板化,只要你不传递复杂的对象,基本上直接套用模板就行。
需要编写一个静态的Python模块定义的数组,这个数组用来定义这个Python模块各项元数据,比如调用方法的对外暴露名称、执行业务功能的方法是哪个、参数类型是什么等等。
还要编写一个静态结构体,这个结构体是对外暴露的API帮助部分,在Python里面通过help方法可以获取到这些信息。
最后进行一个模块化封装,把上面的这些元数据、配置项和方法封装在一起,进行打包。
全部编写完成之后,你可以自定义一个main函数,来测试一下方法是否可用,确定没问题之后,就可以在Python中打包编译安装了:
一般打包都用Python的setuptools来做,编写好setup.py文件,设置各种编译项,然后直接用
python setup.py install
命令,就可以直接编译并且安装到你的Python环境中去了。
然后就可以用Python标准包的方式,进行导入和调用。
我们来对比一下C/C++和Rust对Python的扩展开发,可以得到如下结论:
Rust编写的扩展比C/C++编写的扩展,从代码量、繁琐程度来看,都要优化很多,大量的工作都交给编译器和包管理器来做了。
C/C++编写的扩展,结构上要比Rust更加严谨,但是显得太落后,有一种上古时代的历史厚重感……
C/C++编写的代码,直接在Python里面进行编译和安装,似乎看起来要简单一些,不像裸奔的Rust那样,还要手动改名。
不过,下面我们要介绍的内容,就可以把这第三条直接拍死在岸上了。
所谓的脚手架,就是指在建筑施工的时候,为了保证各施工过程顺利进行而搭设的工作平台,施工完成之后会被拆卸掉的东西。
maturin这个PyO3的官方脚手架,就是用来辅助我们编写Rust的Python扩展的一个辅助平台。
maturin这个工具,就是用Rust写的一个Python扩展工具包,我们直接可以通过PIP进行安装即可。
然后利用这个工具包,我们可以很方便的构筑一个PyO3工程,并且能够实现简便的编译、打包和安装过程。
做为脚手架,最大好处就是简单方便,只需要一个命令,就可以生成所有的配置项,包括示例代码:
写完所有的功能代码之后,也只需要一个命令,就可以一次性自动完成编译、安装全过程:
安装好的包,就已经是标准的Python站点包了,不但可以在Python环境中导入和调用,也可以通过pip进行管理:
下面是maturin的一些相关参数:
这里需要说明的是,build这个参数,需要在后面加上-f 参数,否则在windows上面build的出错,其他的参数,例如develop则不会出差,所以有些疑惑。(有文章提到是build的一个bug,未能确定)