靜態(tài)庫封裝成python模塊的方法

很多硬件廠商的底層設(shè)備驅(qū)動都是以庫的形式提供給開發(fā)者，有的是動態(tài)庫，有的是靜態(tài)庫。開發(fā)上層應(yīng)用，最快速便捷的方式當(dāng)然還是用 python，對于動態(tài)庫，可以用 python 的 ctypes 庫進行加載，而對于靜態(tài)庫，則要麻煩一些，今天折騰了很長時間，總算跑通了最簡流程。

主要方法

靜態(tài)庫（LIB）是在編譯鏈接階段被靜態(tài)地鏈接到程序中的，因此無法直接在 Python 中調(diào)用。Python 只能直接調(diào)用動態(tài)鏈接庫（DLL）。

如果想在 Python 中使用靜態(tài)庫的功能，主要有以下幾種方法：

1. 將靜態(tài)庫轉(zhuǎn)換為動態(tài)庫：可以通過使用相應(yīng)的編譯器（例如，Visual Studio 或 GCC）將靜態(tài)庫轉(zhuǎn)換為動態(tài)庫（DLL）。這樣就可以直接在 Python 中調(diào)用動態(tài)庫了。
2. 使用 C/C++ 擴展模塊：可以使用 Python 的 C/C++ 擴展機制，將靜態(tài)庫中的函數(shù)封裝為 C/C++ 擴展模塊，然后在 Python 中調(diào)用這些模塊。通過這種方式，可以直接在 Python 中使用靜態(tài)庫的功能。
3. 使用第三方工具：有些第三方工具可以幫助將靜態(tài)庫轉(zhuǎn)換為 Python 可用的動態(tài)庫或 C/C++ 擴展模塊。例如，Cython 可以將 C/C++ 代碼轉(zhuǎn)換為 Python 可執(zhí)行的代碼；SWIG 可以生成用于 Python 的 C/C++ 接口代碼。

需要注意的是，將靜態(tài)庫轉(zhuǎn)換為動態(tài)庫或者創(chuàng)建 C/C++ 擴展模塊都需要一定的 C/C++ 編程經(jīng)驗。如果你不熟悉 C/C++，可以考慮使用其他方法解決問題，如尋找已經(jīng)有 Python 綁定的動態(tài)庫或者使用其他庫或工具實現(xiàn)相同的功能。

Cython

今天主要嘗試了用 Cython 將靜態(tài)庫封裝成 python 模塊。

首先新建一個文件夾用作今天的操場：

# 以 lib_test 為例
mkdir lib_test && cd lib_test

在lib_test目錄下新建my_static_lib.h和my_static_lib.cpp兩個文件，并分別寫入以下內(nèi)容：

// my_static_lib.h
#ifndef MY_STATIC_LIB_H
#define MY_STATIC_LIB_H

#ifdef __cplusplus
extern "C" {
#endif

void function1();
void function2();
void function3();
void function4();
void function5();
void function6();
void function7();
void function8();
void function9();
void function10();

#ifdef __cplusplus
}
#endif

#endif

// my_static_lib.cpp
#include < iostream >
#include "my_static_lib.h"

void function1()
{
    std::cout < < "This is function 1." < < std::endl;
}

void function2()
{
    std::cout < < "This is function 2." < < std::endl;
}

void function3()
{
    std::cout < < "This is function 3." < < std::endl;
}

void function4()
{
    std::cout < < "This is function 4." < < std::endl;
}

void function5()
{
    std::cout < < "This is function 5." < < std::endl;
}

void function6()
{
    std::cout < < "This is function 6." < < std::endl;
}

void function7()
{
    std::cout < < "This is function 7." < < std::endl;
}

void function8()
{
    std::cout < < "This is function 8." < < std::endl;
}

void function9()
{
    std::cout < < "This is function 9." < < std::endl;
}

void function10()
{
    std::cout < < "This is function 10." < < std::endl;
}

然后編寫CMakeLists.txt文件：

cmake_minimum_required(VERSION 3.0)
project(my_static_library)

# 設(shè)置編譯器為C++
set(CMAKE_CXX_STANDARD 11)

# 添加靜態(tài)庫的源文件
add_library(my_static_lib STATIC
    my_static_lib.cpp
)

構(gòu)建生成靜態(tài)庫：

# 新建 build 目錄
mkdir build && cd build

# 生成 vs 解決方案
cmake ..

# 構(gòu)建
cmake --build .

安裝Cython：

pip install cython

在lib_test目錄下新建my_static_lib.pyx和setup.py兩個文件，并寫入以下內(nèi)容：

# my_static_lib.pyx
cdef extern from "my_static_lib.h":
    void function1()
    void function2()
    void function3()
    void function4()
    void function5()
    void function6()
    void function7()
    void function8()
    void function9()
    void function10()

def py_function1():
    function1()

def py_function2():
    function2()

def py_function3():
    function3()

def py_function4():
    function4()

def py_function5():
    function5()

def py_function6():
    function6()

def py_function7():
    function7()

def py_function8():
    function8()

def py_function9():
    function9()

def py_function10():
    function10()

# setup.py
from setuptools import Extension, setup
from Cython.Build import cythonize

setup(
    ext_modules=cythonize(Extension("my_static_lib", ["my_static_lib.pyx"], extra_link_args=["/LIBPATH:PATH	omy_static_lib.lib"], libraries=["my_static_lib"]))
)

注意將示例中的PATH omy_static_lib.lib替換為實際的靜態(tài)庫所在絕對路徑。

然后執(zhí)行：

# 回到 lib_test 目錄下
cd ..
python .setup.py build_ext -i

測試一下：

? python
Python 3.8.10 (tags/v3.8.10:3d8993a, May  3 2021, 11:48:03) [MSC v.1928 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
> >?> import my_static_lib
> >?> my_static_lib.py_function()
Traceback (most recent call last):
  File "< stdin >", line 1, in < module >
AttributeError: module 'my_static_lib' has no attribute 'py_function'
> >?> my_static_lib.py_function1()
This is function 1.
> >?> my_static_lib.py_function5()
This is function 5.
> >?> my_static_lib.py_function10()
This is function 10.