Python使用ctypes實現(xiàn)與C++互相調用的實踐教程
背景
小H上次使用了pybind11來調用C++的方法,這次同樣是在項目中遇到了需要在py層調用C++方法的情況,現(xiàn)在對于性能的需求更加敏感,所以需要使用C++的底層方法來獲得結果(當然也可能只是因為C++有這個方法,直接拿來用比較方便),選擇ctypes應該也是因為這個比較方便吧。
示例
在C++側,我們需要實現(xiàn)一個函數(shù),然后導出一個動態(tài)庫方法,這里樓主從py層傳入了一個回調函數(shù),返回了對應的字符結果。
在py側,首先需要使用ctypes.CDLL加載剛才編譯出的動態(tài)庫,聲明對應的方法,之后實現(xiàn)一個回調函數(shù)進行傳入。
C++動態(tài)庫實現(xiàn)
#include <iostream>
#include <string>
// 回調類型:void callback(int, const char*)
using CallbackType = void(*)(int, const char*);
extern "C" {
// 導出函數(shù):循環(huán)調用回調
void run_with_callback(CallbackType cb, int count) {
if (!cb) {
std::cerr << "[C++] callback is null" << std::endl;
return;
}
std::cout << "[C++] run_with_callback start, count = " << count << std::endl;
for (int i = 0; i < count; ++i) {
std::cout << "[C++] before calling callback, i = " << i << std::endl;
std::string message = "msg from C++ index = " + std::to_string(i);
cb(i, message.c_str()); // 回調到 Python
std::cout << "[C++] after calling callback, i = " << i << std::endl;
}
std::cout << "[C++] run_with_callback end" << std::endl;
}
} // extern "C"ps:C++ 默認會對函數(shù)名做 name mangling(名字改編),導致動態(tài)庫中的符號名變復雜;ctypes按 C ABI 去找函數(shù)名,如果不顯式用 extern "C",Python 側很難直接按名字找到
用CMake編譯成動態(tài)庫
cmake_minimum_required(VERSION 3.10)
project(pyc_callback_demo LANGUAGES CXX)
add_library(mycallback SHARED callback_lib.cpp)
set_target_properties(mycallback PROPERTIES
OUTPUT_NAME "mycallback"
CXX_STANDARD 17
CXX_STANDARD_REQUIRED YES
)構建
mkdir -p build cd build cmake .. cmake --build .
這樣就得到了一個.so文件,供py側加載。
python加載動態(tài)庫并調用
- 用 @CALLBACK_CTYPE 裝飾 Python 函數(shù),ctypes 會把它包裝成 C 函數(shù)指針。
- 字符串參數(shù)在 Python 中收到的是 bytes,需要手動解碼
import ctypes
import pathlib
import os
# 當前文件所在目錄
BASE_DIR = pathlib.Path(__file__).resolve().parent
LIB_PATH = BASE_DIR / "cpp_lib" / "build" / "libmycallback.so"
if not LIB_PATH.exists():
raise FileNotFoundError(f"找不到動態(tài)庫: {LIB_PATH}. 請先在 cpp_lib 目錄下用 CMake 編譯生成 libmycallback.so")
# 加載動態(tài)庫
lib = ctypes.CDLL(str(LIB_PATH))
# 定義 C 端回調類型
# 第二個參數(shù)用 ctypes.c_char_p(C 端是 const char*)
CALLBACK_CTYPE = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
# 聲明 C 函數(shù)的簽名:void run_with_callback(CallbackType cb, int count)
lib.run_with_callback.argtypes = [CALLBACK_CTYPE, ctypes.c_int]
lib.run_with_callback.restype = None
# Python 側的回調實現(xiàn)
@CALLBACK_CTYPE
def py_callback(i: int, msg: bytes) -> None:
# msg 是 bytes,需要按合適編碼解碼,這里假設 UTF-8
text = msg.decode("utf-8") if msg is not None else "<NULL>"
print(f"[Python] in callback, i = {i}, msg = {text}")
def main() -> None:
print("[Python] before calling C function")
# 調用 C++ 庫函數(shù),并把 Python 回調傳進去
lib.run_with_callback(py_callback, 3)
print("[Python] after calling C function")
if __name__ == "__main__":
main()
ctypes與pybind11區(qū)別
ctypes:純 Python 側綁定
不需要在 C++ 里寫任何“綁定代碼”,只要提供 C ABI 的動態(tài)庫。
Python 側通過 ctypes.CDLL、CFUNCTYPE 等描述函數(shù)簽名。
只要函數(shù)滿足“C 風格接口”(例如 extern "C" + 基本類型/指針),不在意具體是由 C 還是 C++ 實現(xiàn)。
非常適合:
- 已經(jīng)有現(xiàn)成 C 庫 / C 接口的 C++ 庫
- 簡單函數(shù)調用、回調、不復雜的數(shù)據(jù)結構
pybind11:在 C++ 側寫綁定,生成 Python 模塊
是一個頭文件庫,寫法大致像如之前提供的示例一致
編譯后得到的是一個 Python 擴展模塊(.so),import mymodule 就像普通 Python 包一樣使用。
可以非常自然地暴露:
- C++ 類、方法、構造函數(shù)
- STL 容器(
std::vector,std::map等) - 智能指針、異常、枚舉等
對復雜 C++ API 的封裝能力遠強于 ctypes。
結語
經(jīng)過這兩次學習,讓小H更加能夠體會到在代碼的世界中,語言并不是孤立的,弱化了對語言的重視程度,學習編程更應該將編程語言看作一種工具,什么時候什么情況該換就換,大家各自完成各自擅長的部分,更有利于找到性能與效率的均衡點。
到此這篇關于Python使用ctypes實現(xiàn)與C++互相調用的實踐教程的文章就介紹到這了,更多相關Python與C++互調內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
python 使用cx-freeze打包程序的實現(xiàn)
這篇文章主要介紹了python 使用cx-freeze打包程序的實現(xiàn),具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-03-03
Python Tkinter實現(xiàn)將ZIP中的CSV批量轉換為Excel
這篇文章主要為大家詳細介紹了Python如何結合Tkinter實現(xiàn)將ZIP中的CSV批量轉換為Excel,文中的示例代碼講解詳細,感興趣的小伙伴可以了解下2026-01-01
Python中利用all()來優(yōu)化減少判斷的實例分析
在本篇文章里小編給大家整理的是一篇關于Python中利用all()來優(yōu)化減少判斷的實例分析內(nèi)容,有需要的朋友們可以學習下。2021-06-06
詳解Python+Turtle繪制奧運標志的實現(xiàn)
turtle庫是Python標準庫之一,是入門級的圖形繪制函數(shù)庫。本文就將利用turtle庫繪制一個奧運標志—奧運五環(huán),感興趣的可以學習一下2022-02-02

