将可变数量的参数传递给嵌入式 python API

Question

今天我正在阅读有关 C++ 中的嵌入式 python 的文章

https://docs.python.org/3/extending/embedding.html

所以，我可以在 C++ 中调用 python 代码。

但在我看来，API 示例中调用 python 的方式并不酷。

我正在考虑以任意方式从 C++ 调用 python 函数，例如：

py_call(script_path,module_name,str1,int2,long3,float4,str5,double6);

或

py_call(script_path,module_name,x,y,z,title);

但我需要使用parameter pack。这是我第一次看到参数包。我一直卡在这里，我不知道如何替换以下代码中的argc 和argv 参数：

template<typename T, typename... Targs>
void py_call(
        const string &script,
        const string &module,
        T value, Targs... Fargs
    )
{
    PyObject *pName, *pModule, *pFunc;
    PyObject *pArgs, *pValue;
    int i;

    pName = PyUnicode_DecodeFSDefault(script.c_str());
    /* Error checking of pName left out */

    pModule = PyImport_Import(pName);
    Py_DECREF(pName);
    if (pModule != NULL) {
        pFunc = PyObject_GetAttrString(pModule, module.c_str());
        /* pFunc is a new reference */

        if (pFunc && PyCallable_Check(pFunc)) {
            pArgs = PyTuple_New(argc - 3);
            for (i = 0; i < argc - 3; ++i) {
                pValue = PyLong_FromLong(atoi(argv[i + 3]));
                if (!pValue) {
                    Py_DECREF(pArgs);
                    Py_DECREF(pModule);
                    fprintf(stderr, "Cannot convert argument\n");
                    return 1;
                }
                /* pValue reference stolen here: */
                PyTuple_SetItem(pArgs, i, pValue);
            }
            pValue = PyObject_CallObject(pFunc, pArgs);
            Py_DECREF(pArgs);
            if (pValue != NULL) {
                printf("Result of call: %ld\n", PyLong_AsLong(pValue));
                Py_DECREF(pValue);
            }
            else {
                Py_DECREF(pFunc);
                Py_DECREF(pModule);
                PyErr_Print();
                fprintf(stderr,"Call failed\n");
                return 1;
            }
        }
        else
        {
            if (PyErr_Occurred())
                PyErr_Print();
            fprintf(stderr, "Cannot find function \"%s\"\n", module.c_str());
        }
        Py_XDECREF(pFunc);
        Py_DECREF(pModule);
    }
    else
    {
        PyErr_Print();
        fprintf(stderr, "Failed to load \"%s\"\n",script.c_str());
        return 1;
    }
}

PS。 argc=sizeof...(Fargs)+1 或 argc=sizeof...(Fargs) 取决于功能实现。

Answer 1

我建议将 argv 元组的构造与您的其余代码分开。为了构造这个元组，您需要遍历参数包并通过重载为每个参数创建一个PyObject。 C++11 版本可能看起来像这样：

void to_py_tuple_impl(PyObject*, size_t) {}

template<typename ParamType, typename... ParamTypesTail>
void to_py_tuple_impl(PyObject* tpl, size_t index, const ParamType& param, const ParamTypesTail&... tail)
{
    // error checking omitted for clarity
    PyTuple_SetItem(tpl, index, to_py_object(param));
    to_py_tuple_impl(tpl, index + 1, tail...);
}

template<typename... ParamTypes>
PyObject* to_py_tuple(const ParamTypes&... args)
{
    PyObject* tpl = PyTuple_New(sizeof...(ParamTypes));
    to_py_tuple_impl(tpl, 0, args...);
    return tpl;
}

如果您必须坚持使用 C++11，则需要使用递归函数来迭代 args - 这就是 to_py_tuple_impl 所做的。为简单起见，我已将其包装成 to_py_tuple。

此代码为每个参数调用to_py_object，以便将其转换为PyObject*，并将该对象插入到一个元组中。

to_py_object可以重载支持多种类型，例如：

PyObject* to_py_object(const std::string& str)
{
    return PyUnicode_FromStringAndSize(str.c_str(), str.size());
}

PyObject* to_py_object(const char* str)
{
    retrurn PyUnicode_FromString(str);
}

使用模板和std::enable_if可以减少重载次数：

// Converts all integer types:
template<typename T>
std::enable_if_t<std::is_integral<T>::value, PyObject*> to_py_object(T value)
{
    return PyLong_FromLong(value);
}

// Converts all floating point types:
template<typename T>
std::enable_if_t<std::is_floating_point<T>::value, PyObject*> to_py_object(T value)
{
    return PyFloat_FromDouble(value);
}

现在，您可以将其插入您的 py_call 函数中：

template<typename T, typename... Targs>
void py_call(
        const string &script,
        const string &module,
        T value, Targs... Fargs
    )
{
    PyObject *pName, *pModule, *pFunc;
    PyObject *pArgs, *pValue;
    int i;

    pName = PyUnicode_DecodeFSDefault(script.c_str());
    /* Error checking of pName left out */

    pModule = PyImport_Import(pName);
    Py_DECREF(pName);
    if (pModule != NULL) {
        pFunc = PyObject_GetAttrString(pModule, module.c_str());
        /* pFunc is a new reference */

        if (pFunc && PyCallable_Check(pFunc)) {
            pArgs = to_py_tuple(Fargs...);
            pValue = PyObject_CallObject(pFunc, pArgs);

            ...