ubuntu下python导入.so库

ubuntu下python导入.so库

最近遇到了python导入c++编译的 .so库的问题，发觉挺有意思，于是写下这篇blog以作记录。

1. 什么是.so文件？

.so文件全称是Shared Object，是一种共享文件格式，主要是在Unix和类Unix操作系统（如Linux和BSD）上进行使用，这些文件可以包含多个程序同时加载和使用的代码和数据。为什么会有这种.so库文件，共享库（.so文件）通过促进代码重用、节省资源、简化更新和维护、增强灵活性和动态性、提高开发效率以及集中管理安全性和稳定性，极大地提升了软件开发和部署的效率和质量。这些优势使得共享库成为现代软件开发中不可或缺的一部分。更重要的是，这样可以保护厂商的技术源码，使得这部分对于用户来说是黑箱，只将接口部分暴露给用户。

2. 使用python脚本编译.so库文件

这里举个简单的例子，使用python脚本来编译.so库文件，在编译之前，我们需要安装gcc、g++和cython

sudo apt install gcc
sudo apt install g++
sudo apt install cython

如果使用了conda或者miniconda这类的虚拟环境管理，还要激活虚拟环境，然后

pip install cython

这样我们的准备工作就做好了，然后可以开始编写python脚本了
一、编写python脚本文件：
mymodule.py

# mymodule.py
class MyClass:
    def hello(self):
        print("Hello from MyClass")

二、编写cython脚本文件：
mymodule.pyx

# mymodule.pyx
cdef class MyClass:
    def hello(self):
        print("Hello from MyClass")

三、编写setup.py用于配置：
setup.py

from setuptools import setup
from setuptools.extension import Extension
from Cython.Build import cythonize

extensions = [
    Extension("mymodule", ["mymodule.pyx"]),
]

setup(
    ext_modules=cythonize(extensions),
)

然后激活你包含python的虚拟环境

python setup.py build_ext --inplace

这样就会生成一个.so库文件，这个文件名类似于mylib.cpython-<version>-<platform>.so，例如，mymodule.cpython-312-x86_64-linux-gnu.so，为了方便可以将这个文件重命名为mymodule.so，然后我们就可以在代码中使用它了

四、在python使用.so库：
test.py

from mymodule import MyClass

obj = MyClass()
obj.hello()

运行效果如下：

Reference

[1]python调用c++模块.so库, 互相回传数据(ctypes、pybind11)