Python呼叫C++系列(一)環境設定

我製作了一個SORT: Simple online and realtime tracking的C++的Python binding
歡迎參考看看
sort-cpp-pybind11
{: .prompt-tip }

第二篇連結

• 作業系統: Ubuntu 22.04
• IDE: VSCode
• CMake 3.22.1
• python 3.10.4

摘要

本系列文章將介紹如何利用Pybind11以及scikit-build來幫助我們製作Python的C++ extension，並且介紹如何把用C++實作的追蹤演算法SORT轉換成python extension

C++ 重點提示

• 編譯與直譯

Python屬於直譯式語言，而C++是屬於編譯語言。
因為我們用文字寫的程式電腦是看不懂的，必須有個工具幫我們將程式翻譯成電腦懂的機器碼，他就像我們跟電腦之間的翻譯員。
直譯語言用的是直譯器(Interpreter)他像是個即時翻譯員，當我們在命令提示字元或是Bash，輸入Python的時候，打開的就是直譯器，我們每輸入一行(或一段)的程式，直譯器會馬上幫我們翻譯成機器碼，所以我們可以直接看到輸出結果。
而編譯語言使用的是編譯器(Compiler)，他向翻譯社一樣，要把所有的程式全部都寫完後，送進編譯器一口起全部翻成機器碼。

• 標頭檔(head file)

用來描述function或是class介面的檔案，介面的意思就是function會需要什麼參數，然後回傳直會是什麼，又或者是class有哪些method、member variable和method使用的參數和回傳值。而程式實作方式(
Implement)都放在原碼檔。就像上圖的Num.h那樣。

• 原碼檔(source file)

紀錄程式實作方式的檔案，所有的實作方式都會被記錄在原碼檔。

• 動態/靜態函式庫

有時候程式提供者不想揭露實作方式的時候，可能就會給動態/靜態函式庫以及標頭檔，因為動態/靜態函式庫是機械碼所以人類是看不懂的，要使用動態/靜態函式庫我們必須利用標頭檔來了解有哪些函式可以呼叫，並且利用標頭檔來呼叫和使用動態/靜態函式庫。

以下面的程式為例，我們有兩個原始碼檔和一個標頭檔，標頭檔紀錄Num類別的成員變數和方法的輸入和輸出，原始碼檔紀錄getNum函式
的運作主程式的運作

Num的標頭檔(Num.h)

// Num.h 的內容
class Num
{
 private:
    int num;
 public:
    Num(int n);
    int getNum();
};

Num的原始碼檔(Num.cpp)

// Num.cpp 的內容
#include "Num.h"
Num::Num() : num(0) { }
Num::Num(int n): num(n) {}
int Num::getNum()
{
 return num;
} 

主程式main的原始碼檔(main.cpp)

// main.cpp 的內容
#include <iostream>
#include "Num.h"
using namespace std;
int main()
{
 Num n(35);
 cout << n.getNum() << endl;
 return 0;
} 

CMake管理C++專案

如果曾經使用過Visual Studio寫過C++的話，就會看過Visual Studio幫我們製造一個.sln檔，這個檔案記錄了專案的設定。不過不同的軟體編輯器有不同的專案檔，大家常用的軟體編輯器也都不一樣。因此CMake就扮演軟體編輯器通譯的角色，只要我們可以跟CMake說我們專案的設定，CMake就能夠幫我們製造不同軟體編輯器的專案檔，而且CMake是跨平台的，因此不管開發者是在Windows還是Linux上開發，CMake都可以幫我們產生是和的專案檔，讓開發者合作順暢。

站在CMake之上來管理Python C++混和呼叫的專案上:scikit-build

Python C++混和的專案面臨到更多複雜的設定，單純使用CMake並不好寫，而scikit-build幫我們處理好Python C++混和型的專案常用的工具或是編譯流程，省去我們重新造輪子的工。

環境設定

設定VScode和開發環境

可以參考這篇

安裝Pybind11

官方提供多樣的安裝方式，可以參考官方文件，這裡我們採用pip安裝，注意要先用venv建立虛擬環境

python3 -m venv venv
. venv/bin/activate
pip install pybind11

測試安裝

• 首先建立一個簡單的python c++ extension程式example.cpp

include <pybind11/pybind11.h>

int add(int i, int j) {
    return i + j;
}

PYBIND11_MODULE(example, m) {
    m.doc() = "pybind11 example plugin"; // optional module docstring

    m.def("add", &add, "A function that adds two numbers");
}

{:file=’example.cpp’}

• 編譯extension，注意venv必須已經啟動並且已經安裝pybind11，接著輸入以下指令，你會發現資料夾多了一個example.cpython-310-x86_64-linux-gnu.so檔案，代表動態函式庫已經編譯完成，你已經成功製作了一個python C++ extension

  c++ -O3 -Wall -shared -std=c++11 -fPIC $(python3 -m pybind11 --includes) example.cpp -o example$(python3-config --extension-suffix)

• 嘗試從python內呼叫extension

  $ python
  Python 3.9.10 (main, Jan 15 2022, 11:48:04)
  [Clang 13.0.0 (clang-1300.0.29.3)] on darwin
  Type "help", "copyright", "credits" or "license" for more information.
  import example
  example.add(1, 2)
  3
  >>>

  恭喜你完成了第一個extension!!

注意剛剛編譯的步驟我們下了一行很長的指令(c++ -O3 -Wall -shared …….)，你可能會想在Linux可以這樣編譯，那如果我的電腦是Windows或是masOS怎麼辦呢? CMake專門幫我們處理這些問題，後面我們會介紹更多CMake的用法。
{: .prompt-tip }

參考:

https://zhuanlan.zhihu.com/p/52874931
https://developer.lsst.io/
https://blog.csdn.net/zzh123353/article/details/121582409

下面的連結有些marco是舊的
https://people.duke.edu/~ccc14/cspy/18G_C++_Python_pybind11.html
https://developer.lsst.io/v/billglick-slurm-queues/coding/python_wrappers_for_cpp_with_pybind11.html