ffpython - C++ 嵌入、扩展Python的开发库


GPL
跨平台
C/C++

软件简介

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的交互操作。
ffpython 是轻量级的,只有一个头文件,并且增加了一个方便阅读的版本,可以供想要嵌入python的开发者参考。

嵌入python

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

使用STL

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);

异常
用户可以catch标准异常,what接口返回的字符串包含了异常的traceback信息方便排查错误。示例如下:

try{
    ......
}
catch(exception& e)
{
    printf("exception traceback %s\n", 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("%s\n", __FUNCTION__);
        return ret;
    }
};
void test_reg_function()
{
    ffpython_t ffpython;
    ffpython.reg(&print_val, "print_val")
            .reg(&ops_t::return_stl, "return_stl");
    ffpython.init("ext1");
    ffpython.call<void>("fftest", "test_reg_function");
}

c++类注册到python

class foo_t
{
public:
    foo_t(int v_):m_value(v_)
    {
        printf("%s\n", __FUNCTION__);
    }
    virtual ~foo_t()
    {
        printf("%s\n", __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("%s\n", __FUNCTION__);
    }
    int m_value;
};
class dumy_t: public foo_t
{
public:
    dumy_t(int v_):foo_t(v_)
    {
        printf("%s\n", __FUNCTION__);
    }
    ~dumy_t()
    {
        printf("%s\n", __FUNCTION__);
    }
    void dump() 
    {
        printf("%s\n", __FUNCTION__);
    }
};
static foo_t* obj_test(dumy_t* p)
{
    printf("%s\n", __FUNCTION__);
    return p;
}
void test_register_base_class(ffpython_t& ffpython)
{
    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");
    ffpython.init();
    ffpython.call<void>("fftest", "test_register_base_class");
};