C++使用ffpython嵌入和擴展python（python2和python3）

摘要:

在服務器編程中，經常會用到python腳本技術。Python是最流行的腳本之一，并且python擁有定義良好的C API接口，同時又有豐富的文檔，與C++結合非常的適合。通常情況下使用C++封裝機制，而用python腳本實現策略或者是控制。使用python和C++結合的技術擁有如下優勢：

• 主體系統使用C++實現，保持系統的高效。
• 控制部分使用python，增加開發效率，python的內存垃圾回收，豐富的類庫都使C++開發者獲益匪淺。
• Python腳本可以運行期重載，可以實現控制部分不停機熱更新。

C++與python的編程范式有很大不同，當使用python C API調用python時，python中的一些特有機制會給C++開發者帶來很多困惑。常常使用python C API時需要注意如下幾點:

• Python 使用引用計數管理內存，調用python C API時對于返回值返回的是借用的引用還是新的引用，需要根據文檔仔細確認。否則輕則出現內存泄露，重則程序崩潰。
• Python中的數據結構與C++的有很大不同。Python常用的有tuple，list，dict。而c++常用的事vector，list，map，并且c++是強類型的。當c++與python進行交互時，C++層希望操作python數據結構就像操作c++ STL一樣方便，而在python腳本層，又希望c++傳入的參數或返回值都是原生的python數據
• C++中常用的指針傳遞對象，當嵌入python時，需要把c++對象傳遞到python中。 ffpython是專門方便C++嵌入python開發的類庫，基于ffpython一方面可以輕松的將python集成到C++系統，另一方面，C++對象或接口也可以很容易被python使用，總之ffpython簡化了c++與python的交互操作。

嵌入python

最簡單的使用python的方式是把python腳本當作配置，如獲取腳本中的一個字符串變量。Python的腳本文件會被python虛擬機import為module，和python的標準庫的module實際上是相似的概念。ffpython封裝了獲取python module中的變量的操作。

printf("sys.version=%sn", ffpython.get_global_var<string>("sys", "version").c_str());

上面的代碼獲取python標準庫中sys的version變量值，ffpython通過模板函數的自動將python的str類型自動適配到c++的string類型。get_global_var是獲取變量的接口，與之對應的是設置變量的借口get_global_var：

ffpython.get_global_var("fftest", "global_var", "OhNice"); printf("fftest.global_var=%sn", ffpython.get_global_var<string>("fftest", "global_var").c_str());

調用python函數是嵌入python非常常用的操作，ffpython中提供了call接口用于調用python中的module的函數：

printf("time.asctime=%sn", ffpython.call<string>("time", "asctime").c_str());

上面的代碼調用time模塊的asctime方法，我們也可以使用call接口調用我們自己編寫的函數：

int a1 = 100; float a2 = 3.14f; string a3 = "OhWell"; ffpython.call<void>("fftest", "test_base", a1, a2, a3);

Call被定義為模版函數，傳入的參數會自動適配到python相應的類型。對應的python函數為：

def test_base(a1, a2, a3):print('test_base', a1, a2, a3)return 0

上面的python函數接受三個參數，c++傳入了三個標準類型參數，實際上call接口最多支持9個泛型參數，常用的stl 參數是被支持的：

void test_stl(ffpython_t& ffpython) {vector<int> a1;a1.push_back(100);a1.push_back(200);list<string> a2; a2.push_back("Oh");a2.push_back("Nice");vector<list<string> > a3;a3.push_back(a2);ffpython.call<bool>("fftest", "test_stl", a1, a2, a3); }

對應調用的python函數為：

def test_stl(a1, a2, a3):print('test_stl', a1, a2, a3)return True

不但STL泛型被支持，嵌套定義的類似vector > 的結構都是被支持的，vector和list都會轉換成python的list結構，而map則轉換為dict結構。

調用call接口必須指定接收的返回值類型，可以使用void忽略返回值，除了可以使用標準類型，stl接口也可以被使用，python中的tuple和list可以轉換成vector和list，dict則可以被轉換成map。需要注意的是，若類型沒有匹配，call函數將會拋出異常。用戶可以catch標準異常，what接口返回的字符串包含了異常的traceback信息方便排查錯誤。示例如下：

try{......}catch(exception& e){printf("exception traceback %sn", e.what());}

擴展python

ffpython 可以注冊static函數到python中，全局的C風格的static函數和類中定義的static函數都可以被注冊到python中，示例如下：

static int print_val(int a1, float a2, const string& a3, const vector<double>& a4) {printf("%s[%d,%f,%s,%d]n", __FUNCTION__, a1, a2, a3.c_str(), a4.size());return 0; } struct ops_t {static list<int> return_stl(){list<int> ret;ret.push_back(1024);printf("%sn", __FUNCTION__);return ret;} };std::string test_reg_function(ffpython_t& ffpython) {ffpython.reg(&print_val, "print_val").reg(&ops_t::return_stl, "return_stl");ffpython.reg_class<foo_t, PYCTOR(int)>("foo_t").reg(&foo_t::get_value, "get_value").reg(&foo_t::set_value, "set_value").reg(&foo_t::test_stl, "test_stl").reg_property(&foo_t::m_value, "m_value");ffpython.reg_class<dumy_t, PYCTOR(int)>("dumy_t", "dumy_t class inherit foo_t ctor <int>", "foo_t").reg(&dumy_t::dump, "dump");ffpython.reg(obj_test, "obj_test");return "cppext"; }

以上代碼注冊了兩個接口給python，然后調用fftest文件中的test_reg_function測試兩個接口，fftest.py中定義測試代碼：

def test_reg_function():import ext1ext1.print_val(123, 45.6 , "----789---", [3.14])ret = ext1.return_stl()print('test_reg_function', ret)

這兩個接口雖然簡單，但是說明了ffpython注冊的接口支持多個參數，參數類型可以是標準C++類型，也可以是STL泛型。同樣返回值的類型也是如此。

使用ffpython 注冊C++的對象也很容易，ffpython支持注冊c++類的構造函數，成員變量，成員方法到python，示例代碼如下：

class foo_t { public:foo_t(int v_):m_value(v_){printf("%sn", __FUNCTION__);}virtual ~foo_t(){printf("%sn", __FUNCTION__);}int get_value() const { return m_value; }void set_value(int v_) { m_value = v_; }void test_stl(map<string, list<int> >& v_) {printf("%sn", __FUNCTION__);}int m_value; };class dumy_t: public foo_t { public:dumy_t(int v_):foo_t(v_){printf("%sn", __FUNCTION__);}~dumy_t(){printf("%sn", __FUNCTION__);}void dump() {printf("%sn", __FUNCTION__);} };static foo_t* obj_test(dumy_t* p) {printf("%sn", __FUNCTION__);return p; }

當c++類型被注冊到python中后，python中使用該類型就像python內建的類型一樣方便，需要注意的是，如果python中動態的創建了c++對象，那么他是被python的GC管理生命周期的，所以當變量不在被引用時，c++對象的析構函數被調用。對應的fftest.py中測試的腳本代碼為：

def test_register_base_class():import ext2foo = ext2.foo_t(20130426)print("test_register_base_class get_val:", foo.get_value())foo.set_value(778899)print("test_register_base_class get_val:", foo.get_value(), foo.m_value)foo.test_stl({"key": [11,22,33] })print('test_register_base_class test_register_base_class', foo)

同前邊所訴的原則相同，支持C++ 標準內建類型和STL 泛型。當這個python函數返回時，foo_t的析構函數會被調用。

dumy_t是foo_t的子類。使用ffpython可以方便表示兩個類型的關系。如果基類已經定義的接口，子類不需要重復定義，比如要注冊子類：

ffpython.reg_class<dumy_t, PYCTOR(int)>("dumy_t", "dumy_t class inherit foo_t ctor <int>", "foo_t").reg(&dumy_t::dump, "dump");void test_register_inherit_class(ffpython_t& ffpython) {ffpython.call<void>("fftest", "test_register_inherit_class"); };

只需要單獨注冊一下子類特有的接口，其他接口自動從foo_t基類中繼承而來，相應的測試python腳本代碼為：

def test_register_inherit_class():import ext2dumy = ext2.dumy_t(20130426)print("test_register_inherit_class get_val:", dumy.get_value())dumy.set_value(778899)print("test_register_inherit_class get_val:", dumy.get_value(), dumy.m_value)dumy.test_stl({"key": [11,22,33] })dumy.dump()print('test_register_inherit_class', dumy)

ffpython中一個非常用用的特性是，c++創建的對象可以傳遞到python中，而python使用起來就像正常的python對象一樣，另外python創建的c++對象也可以傳遞到c++中，簡單示例代碼：

ffpython.reg(obj_test, "obj_test");void test_cpp_obj_to_py(ffpython_t& ffpython) {foo_t tmp_foo(2013);ffpython.call<void>("fftest", "test_cpp_obj_to_py", &tmp_foo); }void test_cpp_obj_py_obj(ffpython_t& ffpython) {dumy_t tmp_foo(2013);foo_t* p = ffpython.call<foo_t*>("fftest", "test_cpp_obj_py_obj", &tmp_foo); }

相應的fftest.py中的測試腳本代碼為：

def test_cpp_obj_to_py(foo):import ext2print("test_cpp_obj_to_py get_val:", foo.get_value())foo.set_value(778899)print("test_cpp_obj_to_py get_val:", foo.get_value(), foo.m_value)foo.test_stl({"key": [11,22,33] })print('test_cpp_obj_to_py test_register_base_class', foo)def test_cpp_obj_py_obj(dumy):import ext2print("test_cpp_obj_py_obj get_val:", dumy.get_value())dumy.set_value(778899)print("test_cpp_obj_py_obj get_val:", dumy.get_value(), dumy.m_value)dumy.test_stl({"key": [11,22,33] })dumy.dump()ext2.obj_test(dumy)print('test_cpp_obj_py_obj', dumy)return dumy

總結：

• ffpython 支持c++調用python函數，獲取和設置模塊內的變量
• ffpython call接口最多支持9個泛型參數，支持的類型包括c++內建的類型和STL 泛型。以及已經被注冊的c++類的指針類型。返回值的類型約束同樣如此。c++ STL中的vector和list對應于python的tuple和list，map類型則對應于dict。
• ffpython支持將c++的靜態函數注冊到python中。
• ffpython支持c++類的注冊，并且支持繼承。Python中操作c++對象就像操作原生python對象一樣。
• ffpython注冊的c++類在python中被創建后，將會由python GC負責回收內存。
• ffpython 類庫只有一個文件，并且不依賴其他第三方庫，非常容易集成到項目中。而且ffpython遵從開源協議。
• ffpython使用c++模板技術，封裝了python C API的使用細節，保持精巧和簡潔，效率和完全的python C API編寫的代碼幾乎相同。ffpython的實現可以作為非常好的python C API的示例。
• Github項目地址：https://github.com/fanchy/ffpython
• 更多文章 http://h2cloud.org

總結

以上是生活随笔為你收集整理的python get()函数_C++使用ffpython嵌入和扩展python（python2和python3）的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。