使用sipParseArgs/sipBuildResult进行python/C++对象的转换

SIP库是用于python/C++对象互相转换的桥梁，由于python本身运行速度非常慢，所以很多第三方模块在底层会使用C++来编写，并提供python接口供python调用，在提供对象转换时，sipParseArgs和sipBuildResult是一对经常使用的函数，其中sipParseArgs用于将python对象转换成C++对象，而sipBuildResult则用于将C++对象转换成python对象，即PyObject，由于网络上关于它们的资料非常少，因此有必要在此记录一下，如果发现有任何错误，请在评论区留言告知。

本文使用python3.8，SIP版本为6.0.3

sipParseArgs

其原型为int sipParseArgs(PyObject* sipParseErr, PyObject* obj, const char* format ...)，

返回值为非0时代表成功，为0时代表失败，obj代表需要解析的python对象，format代表解析规则（区分大小写），根据规则不同，format后面跟着的参数也不相同，具体如下：

预定义参数意义：sipSelf：即python中的self。sipTypeDef：类型定义，即形如sipType_MyType的类型定义，代表一个完整的C++类。sipCpp：指向原始的C++对象的指针。sipRes：代表C++返回值。

注意，你可以在format字符串中使用 () 来代表tuple, [] 来代表list, {}来代表dict, 例如 (id) 表示一个两个元素的tuple，第一个元素为int型,第二个元素为double型

例子：编写一个python接口函数：

假设有以下C++声明：

class MyClass
{
public:
    int setInfo(const std::string& name, int value = -1);
};

现在为MyClass类的成员函数setInfo创建python接口 ：

static PyObject* invoke_MyClass_setInfo(PyObject* sipSelf, PyObject* sipArgs)
{
    PyObject* sipParseErr = SIP_NULLPTR;
    const std::string* a0;
    int a0State = 0;
    int a1 = -1;
    MyClass* sipCpp;
    if (sipParseArgs(&sipParseErr, sipArgs, "BJ1|i", &sipSelf, sipType_MyClass, &sipCpp, sipType_std_string, &a0, &a0State, &a1))
    {
        int sipRes = sipCpp->setInfo(*a0, a1);
        sipReleaseType(const_cast(a0), sipType_std_string, a0State);
        return sipBuildResult(nullptr, "i", &sipRes);  // or use PyLong_FromLong(sipRes) directly
    }
    return SIP_NULLPTR;
}

sipBuildResult

其原型为PyObject* sipBuildResult(int* isErr, const char* format ...)

format意义与sipParseArgs一致