Windows上でC++のコードをpybind11経由でPythonから呼び出す．

# 本日は

様々な理由からC++のコードをPythonから呼び出したい！！！という需要は一定量であるものと信じているこの頃です．しかもWindows上で．本日はこの願いをかなえるための手段の一つとしてpybind11を用いた方法を紹介します．

Mac, Linux の場合はすでに事例が紹介されています．

- [pybind11でC++の関数をpythonから使う](https://qiita.com/ignis_fatuus/items/c7523c0fe2bc2f415d5)
- [[python高速化]pybind11によるc++組み込み](https://qiita.com/exy81/items/e309df7e33d4ff20a91a#_reference-c8a52580111447fade09)
- [C++ プログラムに pybind11 で Python を組み込んでみる](https://qiita.com/benikabocha/items/5ec6b471de0d10aaf2df#_reference-96008381f8af90051d5f)
# ここで用いたツール

- pybind11
- Python3.5（Miniconda）
- Visual Studio 2017

[ドキュメント](http://pybind11.readthedocs.io/en/master/basics.html)が言うには：
> On Windows, only Visual Studio 2015 and newer are supported since pybind11 relies on various C++11 language features that break older versions of Visual Studio.

とのことです．現在は２０１８年．新しいVisualStudioを使っていきましょう．

# 準備(pybind11の準備)

```shell-session
> pip install pybind11
``` 

これでOKです．pybind11はヘッダーだけで構成されているようなので好みに応じてgit clone でソースを落としてということも可能のようですね．

ここでは `pip install` の方法で導入したと仮定して話を進めていきます．

## どこにソースが入ったかを確認

pybind11のヘッダーを探します．

私のPythonのパスは次の通りです．
![wherepython.png](https://qiita-image-store.s3.amazonaws.com/0/135978/59f77b0b-f14a-0ef7-c987-c9fa2c0bda7e.png)

これを手掛かりにインストールされた場所を探します．私の環境の場合結論から言うと C:\ProgramData\Miniconda3\include の直下に存在します．

![includepybind11.png](https://qiita-image-store.s3.amazonaws.com/0/135978/fa574fca-82b2-517b-2d25-f19f09985397.png)

C:\ProgramData\Miniconda3 のパスの部分は皆さんの環境によって場所が異なりますので以下適宜読み替えてください．

ついでに C:\ProgramData\Miniconda3\libs も眺めておきます．

![image.png](https://qiita-image-store.s3.amazonaws.com/0/135978/e9f8e12e-6eb7-a53d-d173-7c500a248087.png)

これらのパスはVisualStudioの設定で用います．

# VisualStudio起動

Visual Studioを起動してソルーション・プロジェクトを作る・・・のまえにC++のコードを呼び出すときのモジュール名を考えます．
ここでは `pybindtest` というモジュール名で後でPythonから呼び出すことを想定している，つまり

```python
import pybindtest
```

として使うことを想定して準備します．

ソルーションを作成しプロジェクト名を`pybindtest`として設定します．ここでは空のプロジェクトを指定します．

![pybindsln.png](https://qiita-image-store.s3.amazonaws.com/0/135978/67408e66-aa3a-ed1e-22f8-918d12e8f804.png)

# プロパティを編集

ソリューションエクスプローラー（たぶんIDEの画面の右側）の`pybindtest` プロジェクトのプロパティからいろいろと設定していきます．

![image.png](https://qiita-image-store.s3.amazonaws.com/0/135978/b16e9a86-cd6b-0880-6f11-a5567374622b.png)


![pybindproperty.png](https://qiita-image-store.s3.amazonaws.com/0/135978/dc1c96f0-dd40-3eed-1916-51faef6a8887.png)

構成の種類をダイナミックライブラリとして設定．ターゲット拡張子をpydに変更します．

## インクルードディレクトリ・ライブラリディレクトリの編集

pybind11 のソースの場所，libs の場所を上で見つけていたのでそれらのパスを各々インクルードディレクトリとライブラリディレクトリに追加します．

![directorysetting.png](https://qiita-image-store.s3.amazonaws.com/0/135978/4d0dbc9f-4682-a274-2895-b2a45197e90a.png)

## リンカーの設定

入力->追加依存ファイルの部分にpython35.libを追加．

![linkersetting.png](https://qiita-image-store.s3.amazonaws.com/0/135978/0afb833f-c678-94c9-9077-385615152eb3.png)

# ソース，ヘッダーファイルを追加

以上でプロジェクトの準備ができました．
あとはソースを追加していきます．

ここではSource.cpp Header.hを各々次のようなものとします．

```C++:Header.h
#include<vector>
#include <utility>
using namespace::std;

int add(int x, int y);

class POINT {
private:
	int x;
	int y;
public:
	int sum;
	POINT(pair<int, int> xy) { this->x = xy.first; this->y = xy.second; this->sum = this->x + this->y; }
	POINT(int x, int y) { this->x = x; this->y = y; this->sum = x + y; }
	int X() { return x; }
	int Y() { return y; }
	POINT operator+(const POINT &v) const { return POINT(this->x + v.x, this->y + v.y); }
	std::string toString() const {
		return "(" + std::to_string(this->x) + ", " + std::to_string(this->y) + ")";
	}
};
```

```C++:Source.cpp 
//References:
//http://pybind11.readthedocs.io/en/stable/classes.html
//https://qiita.com/ignis_fatuus/items/c7523c0fe2bc2f415d50
//https://qiita.com/exy81/items/e309df7e33d4ff20a91a#_reference-c8a52580111447fade09
//http://pybind11.readthedocs.io/en/stable/advanced/classes.html#operator-overloading
//http://pybind11.readthedocs.io/en/stable/classes.html#overloaded-methods

#include <pybind11/pybind11.h>
#include <pybind11/stl.h> // vector用
#include <pybind11/operators.h>//operator
#include "Header.h"


using namespace::std;

int add(int x, int y) {
	return x + y;
}

namespace py = pybind11;
PYBIND11_MODULE(pybindtest, m) {
	m.doc() = "pybind11 example plugin";
	m.def("add", &add);
	py::class_<POINT>(m, "POINT")
		.def(py::init<int, int>())
		.def(py::init<pair<int, int>>())
		.def_readwrite("sum", &POINT::sum)
		.def_property_readonly("x", &POINT::X)
		.def_property_readonly("y", &POINT::Y)
		.def(py::self + py::self)
		.def("__repr__", &POINT::toString);
}
```

`PYBIND11_MODULE(pybindtest, m)` の部分ですが，プロジェクト名を指定しておかないとPython側から呼び出したときに失敗します．

あと一歩です．
あとはソルーションをビルドしてください．

pybindtest.pyd というのができていればOKです．

![image.png](https://qiita-image-store.s3.amazonaws.com/0/135978/08b8fa2b-0fc3-149c-1dd8-71e547c8d67f.png)

# れっつ呼び出しFrom Python

準備は整いました．次のコードを呼び出すことができれば完成です．

```python:test.py
import pybindtest
from pybindtest import add, POINT

print('doc=', pybindtest.__doc__)
x1, y1 = 1, 2
print("add({},{})=".format(x1, y1), pybindtest.add(x1, y1))

x2, y2 = 3, 4

p = POINT(x1, y1)
q = POINT([x2, y2])

print('p=', p)
print('q=', q)
print('p+q=', p+q)
print('p.x,p.y=', p.x, p.y)
```

C++側のPOINTクラスのコンストラクタを複数定義できるのですが，それに対応するPython側の呼び出しができるのがすごいと思ったこの頃です．あとC++側でPOINTクラスの＋演算子を定義をしておくことでPythonがわでのPOINTクラスどうしの足し算が可能になります．

ということが

http://pybind11.readthedocs.io/en/stable/advanced/classes.html#operator-overloading

に書いてあります．

また def_property_readonly を用いることでC++のプライベート機能をPython側でも保つことができます．

ということが

http://pybind11.readthedocs.io/en/stable/classes.html

に書いてあります．

# 感想

意外とドキュメントがわかりやすくてpybind11便利だなーと感じだこの頃です．
以前はBoostを使っていたのですが，これからはpybind11も視野に入れていこうと思いました．

以上です．