【splishsplash】splishsplash安装并使用python binding

简介

python binding不是本体，而是使用了一个叫pybind11的c++库，将c++的API暴露给python。这样就能用python去调用c++库中的函数和类了。
pySplishsplash这个文件夹下面的源码都是为了暴露API而写的。

我们这里不管这些，只要安装和使用即可。

安装

1 在cmake中指定-DUSE_PYTHON_BINDINGS=On选项

这个用cmake-gui是找不到的，必须用命令行形式

cmake -S . -B build -DUSE_PYTHON_BINDINGS=On

这和我们手动用GUI是完全一致的
-S表示源码位置
-B表示Build位置
-D则表示Define一个宏，cmake中的编译开关是用宏来定义的。后面的USE_PYTHON_BINDINGS=On可以加空格也可以不加，一般习惯不加空格（这样的习惯好奇怪啊，我也不知道为什么大家都这么做…）

然后就构建好了开启pybind功能的工程。

下面是编译。

2 利用python wheel编译

既然是python程序，那么就要用python的编译方法。
python有一个库叫做wheel。它就是用来编译程序的。可以认为它就是替代了VS或者make编译的那一步。

python setup.py bdist_wheel

这一句就相当于make，或者VS里面的MSBuild

中间会出现一些报错，有关gbk的，无需担心

只要稍微改一下代码就行

setup.py
115-116行加一个 encoding=“utf-8”，即改为：

with open(os.path.join(cur_dir, "README.md"), 'r', encoding="utf-8") as f:
    long_description = f.read()

然后就会开始编译了。结果出来是个whl文件。

3 pip install

最后还要pip install一下（pip不光能安装远程库，也当然能装本地库）

pip install build/dist/pySPlisHSPlasH-2.8.3-cp37-cp37m-win_amd64.whl

注意这里的版本号要和自己的python版本对应上。其实就是找到build/dist文件夹下的*.whl文件就可以了。这是一个二进制的安装包文件。

出现下面这行字表示安装成功

Successfully installed numpy-1.19.3 pySPlisHSPlasH-2.11.2

.pyd文件就是安装的本体（一个包）。可以直接用import pysplishsplash的方式导入该包。

3 运行

build\lib.win-amd64-3.9\目录下会出现

那个文件夹就是脚本
那个pyd文件就是pysplishsplash包

用VS Code打开文件夹

运行simulator.py脚本（点那个三角或者control+F5）

就会弹窗让你选择json了

空格运行即可。可见到程序名为[Python] SPlisHSPlasH

其实也可以单步调试，比如按下F5
就出现了调试窗口。

不过现在还不知道能不能进入base.run()。进不去的话就调试了个寂寞。

完毕。