Python SWIG：C++输出参数转返回值及类型转换技术求助

我之前处理过类似的SWIG接口修改需求，刚好可以给你一些实用的方案！针对你说的C++函数接收两个ResultType输出参数，要转为Python中接收x/y、返回(result1, result2)元组的场景，有两种常用的实现方式，我分别给你详细说明：

假设你的C++函数原型 #

先明确一下我们要处理的目标函数，假设它的原型是这样的：

// 原C++函数：接收两个输出参数，以及输入x、y
void calculate_results(ResultType& out_res1, ResultType& out_res2, int x, int y);

我们要让Python里可以这样调用：

res1, res2 = calculate_results(10, 20)

方案1：用SWIG Typemap直接修改接口 #

这是最直接的方式，通过SWIG的typemap特性，直接修改原函数在Python层的调用行为，不需要额外写包装函数。

步骤1：定义输入参数的typemap（跳过Python传入） #

我们告诉SWIG：这两个ResultType输出参数不需要Python调用者传入，由SWIG自动创建临时对象作为输出载体：

// 为第一个输出参数创建临时对象，Python调用时不接收该参数（numinputs=0）
%typemap(in, numinputs=0) ResultType& out_res1 (ResultType temp_obj) {
    $1 = &temp_obj;
}

// 第二个输出参数同理
%typemap(in, numinputs=0) ResultType& out_res2 (ResultType temp_obj) {
    $1 = &temp_obj;
}

步骤2：定义输出参数的typemap（打包为元组返回） #

函数执行完成后，把两个填充好的ResultType对象转换成Python对象，打包成元组替换原函数的返回值（原函数是void，默认返回None）：

%typemap(argout) ResultType& out_res1, ResultType& out_res2 {
    // 将C++的ResultType转为Python对象
    PyObject* py_res1 = SWIG_NewPointerObj(
        SWIG_as_voidptr(*$1), 
        $descriptor(ResultType), 
        SWIG_POINTER_OWN  // 这里注意：如果Python需要接管对象内存用OWN，否则用NOSAVE
    );
    PyObject* py_res2 = SWIG_NewPointerObj(
        SWIG_as_voidptr(*$2), 
        $descriptor(ResultType), 
        SWIG_POINTER_OWN
    );

    // 打包成Python元组
    PyObject* result_tuple = PyTuple_New(2);
    PyTuple_SetItem(result_tuple, 0, py_res1);
    PyTuple_SetItem(result_tuple, 1, py_res2);

    // 替换原函数的返回值
    $result = result_tuple;
}

步骤3：引入原函数 #

最后在SWIG接口文件中引入你的C++头文件和函数声明：

%include "your_library_header.h"
void calculate_results(ResultType& out_res1, ResultType& out_res2, int x, int y);

方案2：用SWIG %inline写包装函数（更直观） #

如果你觉得typemap语法有点复杂，可以用%inline在SWIG中直接写一个C++包装函数，调用原函数并返回std::pair，SWIG会自动把std::pair转换成Python元组。

步骤1：引入std::pair的SWIG支持 #

首先要让SWIG认识std::pair：

%include "std_pair.i"
// 为ResultType的pair创建模板实例
%template(ResultPair) std::pair<ResultType, ResultType>;

步骤2：编写包装函数 #

在SWIG接口中定义一个包装函数，内部调用原函数并返回结果对：

%inline %{
#include "your_library_header.h"

// 包装函数：只接收x、y，返回结果对
std::pair<ResultType, ResultType> calculate_results(int x, int y) {
    ResultType res1, res2;
    // 调用原C++函数填充结果
    calculate_results(res1, res2, x, y);
    return std::make_pair(res1, res2);
}
%}

可选：隐藏原函数（避免命名冲突） #

如果担心原函数和包装函数重名，可以用%rename把原函数隐藏：

// 把原函数重命名为内部名称，避免和包装函数冲突
%rename(_calculate_results) calculate_results;

%inline %{
#include "your_library_header.h"

std::pair<ResultType, ResultType> calculate_results(int x, int y) {
    ResultType res1, res2;
    _calculate_results(res1, res2, x, y);
    return std::make_pair(res1, res2);
}
%}

关键注意事项 #

• 内存管理：如果ResultType包含动态分配的内存，一定要注意SWIG_POINTER_OWN和SWIG_POINTER_NOSAVE的选择：
  • SWIG_POINTER_OWN：Python接管对象所有权，负责后续释放内存
  • SWIG_POINTER_NOSAVE：C++侧保留所有权，Python只作为引用
• 容器类型支持：如果ResultType是标准容器（比如std::vector），记得先引入对应的SWIG库（比如%include "std_vector.i"），SWIG会自动处理类型转换。

内容的提问来源于stack exchange，提问作者user19650