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)

1
2
3
4
5
6
7
8
9
// Num.h 的內容
class Num
{
private:
int num;
public:
Num(int n);
int getNum();
};

Num的原始碼檔(Num.cpp)

1
2
3
4
5
6
7
8
// Num.cpp 的內容
#include "Num.h"
Num::Num() : num(0) { }
Num::Num(int n): num(n) {}
int Num::getNum()
{
return num;
}

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

1
2
3
4
5
6
7
8
9
10
// 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建立虛擬環境

1
2
3
python3 -m venv venv
. venv/bin/activate
pip install pybind11

測試安裝

  • 首先建立一個簡單的python c++ extension程式example.cpp
1
2
3
4
5
6
7
8
9
10
11
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
    1
    c++ -O3 -Wall -shared -std=c++11 -fPIC $(python3 -m pybind11 --includes) example.cpp -o example$(python3-config --extension-suffix)
  • 嘗試從python內呼叫extension
    1
    2
    3
    4
    5
    6
    7
    8
    $ 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

TensorRT系列(一)環境設定

本文章版本資訊

  • TensorRT 8.6.1

apt 安裝TensorRT的方法

https://docs.nvidia.com/deeplearning/tensorrt/archives/tensorrt-861/install-guide/index.html#installing-debian

利用Docker 建立TensorRT環境

docker tensorrt的版本與tensorrt版本對應表
https://docs.nvidia.com/deeplearning/frameworks/support-matrix/index.html

1
docker run --gpus all -it --rm -v local_dir:container_dir nvcr.io/nvidia/tensorrt:22.07-py3

其中local_dir換成自己電腦的某一個資料夾,他將與Docker container共用,container_dir換成container裡面的資料夾路徑

參考:
https://docs.nvidia.com/deeplearning/tensorrt/quick-start-guide/index.html#install
https://github.com/wang-xinyu/tensorrtx#tutorials

Python OpenCV圖片裁剪

OpenCV 座標

Python OpenCV 裁剪圖片

OpenCV 的蒲覑本質上就是一個 numpy array, 因此可以利用numpy array提供的方法來完成裁剪圖片的功能

1
crop_img = img[y:y+h, x:x+w] # x, y 為圖片的裁剪圖片的左上角座標,h, w 分別為裁剪圖片的高和寬

參考:
https://stackoverflow.com/a/15589825

fastapi使用自己的openapi檔

步驟

  • 參考官方離線版文件的說明
  • 寫一個route可以回傳openapi的json
  • 把openapi_url=app.openapi_url改型成
    1
    openapi_url=<回傳openapi json 的route>

ssh連線設定

非對稱式加密

  • 非對稱式加密有兩把key,一把只能加密,一把只能解密
  • 非對稱式加密public key是公開給外界,作為解密專用key,只能解密用對應的private key加密的內容
  • 非對稱式加密private key必須妥善保存,作為加密專用key,只被對應的public key解密

public key像帳號,private key像密碼

把自己的的public key提供給目標連線電腦,就像在那台帳號註冊帳號一樣

ssh會把public key存在~/.ssh/authorized_keys這個檔案裡面

  1. 利用ssh-copy-id複製public key到ssh server主機
  • linux
    1
    ssh-copy-id 192.168.122.7  # 指令為ssh-copy-id 遠端主機的ip
  • windows
    在powershell中沒有ssh-copy-id這個指令,不過我們可以用下面指令達成相同目標
    1
    type $env:USERPROFILE\.ssh\id_rsa.pub | ssh {IP-ADDRESS-OR-FQDN} "cat >> .ssh/authorized_keys"

參考:
https://kb.iu.edu/d/aews
https://www.chrisjhart.com/Windows-10-ssh-copy-id/

更改主機名稱後RabbitMQ無法啟動

作業系統: Windows10

更改主機名稱後,會發現rabbitmq無法啟動,這時候要重新安裝Service。
注意:需要備份的資料先備份起來

  1. 利用rabbitmq提供的bat(RabbitMQ Service - remove.bat),並且以系統管理員執行
  2. 利用rabbitmq提供的bat(RabbitMQ Service - (re)install.bat),並且以系統管理員執行重新安裝service
  3. 利用rabbitmq提供的bat(RabbitMQ Service - start.bat),並且以系統管理員執行重新安裝service啟動服務
  4. 成功後會看到log資料夾出現新的log,rabbit@(新的主機名稱).log,代表成功了。

參考: https://dennymichael.net/2014/06/16/rabbitmq-change-the-hostname/

用vim作為Python IDE

vim版本:8.2

安裝套件管理員Vundle

  1. 下載Vundle plugin manager並且放到VIM套件資料夾

    1
    git clone https://github.com/gmarik/Vundle.vim.git ~/.vim/bundle/Vundle.vim
  2. 建立套件管理檔

    1
    touch ~/.vimrc
  3. 將下面指令複製到~/.vimrc檔案裡面

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    set nocompatible              " required
    filetype off " required

    " set the runtime path to include Vundle and initialize
    set rtp+=~/.vim/bundle/Vundle.vim
    call vundle#begin()

    " alternatively, pass a path where Vundle should install plugins
    "call vundle#begin('~/some/path/here')

    " let Vundle manage Vundle, required
    Plugin 'gmarik/Vundle.vim'

    " add all your plugins here (note older versions of Vundle
    " used Bundle instead of Plugin)

    " ...

    " All of your Plugins must be added before the following line
    call vundle#end() " required
    filetype plugin indent on " required
  4. 安裝套件

    1. 先開啟vim
    2. 輸入:
    3. PluginInstall

操作

  • 分割畫面

    1. .vimrc 加入下面幾行
      1
      2
      3
      4
      5
      "split navigations
      nnoremap <C-J> <C-W><C-J>
      nnoremap <C-K> <C-W><C-K>
      nnoremap <C-L> <C-W><C-L>
      nnoremap <C-H> <C-W><C-H>
    2. ctrl加上vim的方向鍵(J下, K上, L右, H左)就可以移動到不同地方的split
  • Buffers

    • :ls可以看到buffer清單
    • 可以在輸入:ls後直接:b ,就可以不用記下buffer number
  • 程式碼收折

    • 在.vimrc加入下面幾行

      1
      2
      3
      4
      5
      6
      " Enable folding
      set foldmethod=indent
      set foldlevel=99

      " Enable folding with the spacebar
      nnoremap <space> za
    • 之後就可用空白鍵收折程式碼

    • 如果想要看到收折的程式碼的docstrings 可以在.vimrc加入這行

      1
      let g:SimpylFold_docstring_preview=1

參考:
vim 快捷鍵 : http://stackoverflow.com/a/5400978/1799408

https://www.openvim.com/
https://realpython.com/vim-and-python-a-match-made-in-heaven/

breakpoints : https://github.com/puremourning/vimspector

Visual Studio + CMake製作Python Extension

版本資訊
Visual Studio 2019
CMake 3.24
Python3.8.10

設定Opencv

  • 編譯OpenCV

  • 設定windows的環境變數 OpenCV_ROOT 到OpenCVConfig.cmake所在的資料夾(CMake 3.12之後的功能,文件

  • 從編譯好的OpenCVConfig.cmake我們可以看OpenCV提供了那些CMake變數給我們使用,可以參考這裡

  • 讓CMake複製dll文件

  • 設定CMake尋找Python.h

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
find_package(Python 3 REQUIRED 
COMPONENTS Interpreter Development.Module NumPy) # New in cmake 3.19

include_directories(${Python_INCLUDE_DIRS})
link_directories(${Python_LIBRARY_DIRS})
message(STATUS "Python Location: ${Python_INCLUDE_DIRS}")

include_directories(${Python_NumPy_INCLUDE_DIRS})
message(STATUS "NumPy Location: ${Python_NumPy_INCLUDE_DIRS}")

find_package(OpenCV REQUIRED)
if (OpenCV_FOUND)
# If the package has been found, several variables will
# be set, you can find the full list with descriptions
# in the OpenCVConfig.cmake file.
# Print some message showing some of them
include_directories(${OpenCV_INCLUDE_DIRS})
link_libraries(${OpenCV_LIBRARIES})
message(STATUS "OpenCV library status:")
message(STATUS " version: ${OpenCV_VERSION}")
message(STATUS " include path: ${OpenCV_INCLUDE_DIRS}")
else ()
message(FATAL_ERROR "Could not locate OpenCV")
endif()

原碼參考:

參考:
Python.h位置

CMake尋找Python