如何使用SWIG封装接收numpy数组且无需显式传长度的C++函数

问题场景 #

• 基于SWIG为自研C++类库构建Python调用接口，库中大量类方法接收double*或int*类型数组参数，不会同步传入数组长度，典型方法声明如下：

void func(double* array);
void func2(double* array, double unrelated_parameter, ...);

• 需求：Python侧可直接传入numpy数组调用上述函数，无需修改原有C++库API、无需为每个函数额外新增int array_size参数。
• 约定规则：数组实际长度在对应C++类的构造函数中指定，所有传入类方法的数组长度均与构造时指定的长度匹配。
• 已尝试操作：引入numpy.i按公开指引配置后，调用时报错：TypeError: in method 'func', argument 2 of type 'double *'
• 现有公开方案局限：所有可查的numpy相关SWIG封装示例，均要求被封装的C++方法/函数新增int array_size参数，无法满足不修改原API的需求。

核心实现思路 #

不需要修改原C库代码，通过SWIG自定义类型映射（typemap）实现numpy数组到原始C指针的自动转换，数组长度校验直接从对应C类实例存储的成员变量读取，不需要在函数参数列表中额外传入长度。

具体操作步骤 #

1. 在SWIG接口文件（.i后缀）开头正确初始化numpy支持：

%module your_lib_name
%{
#define SWIG_FILE_WITH_INIT
#include "your_lib_header.h" // 替换为你自己的库头文件
%}

// 必须添加numpy初始化逻辑，否则会出现类型转换、内存访问异常
%init %{
import_array();
%}
%include "numpy.i"

2. 编写针对类成员方法的数组输入类型映射，自动完成numpy数组校验、长度校验、指针提取：

// double* 数组输入typemap
%typemap(in) double* (PyArrayObject* arr = nullptr) {
    // 校验输入类型为numpy数组
    if (!PyArray_Check($input)) {
        PyErr_SetString(PyExc_TypeError, "该参数必须传入numpy数组");
        SWIG_fail;
    }
    arr = (PyArrayObject*)$input;
    // 校验数组dtype匹配C++ double类型（对应numpy float64）
    if (PyArray_TYPE(arr) != NPY_DOUBLE) {
        PyErr_SetString(PyExc_TypeError, "数组dtype必须为np.float64");
        SWIG_fail;
    }
    // 校验数组为C连续内存布局
    if (!PyArray_IS_C_CONTIGUOUS(arr)) {
        PyErr_SetString(PyExc_ValueError, "数组必须为C连续存储，可调用np.ascontiguousarray()预处理后传入");
        SWIG_fail;
    }
    // 从当前类实例读取构造时存储的约定数组长度，替换为你类中实际存储长度的成员变量名
    const size_t expected_len = $self->array_len_;
    if (PyArray_SIZE(arr) != expected_len) {
        PyErr_Format(PyExc_ValueError, "数组长度不匹配，期望长度%zu，实际传入%zu", expected_len, (size_t)PyArray_SIZE(arr));
        SWIG_fail;
    }
    // 提取数组底层内存指针传给C++函数
    $1 = (double*)PyArray_DATA(arr);
}

// int* 数组输入typemap，逻辑与double版本一致，仅替换类型匹配规则
%typemap(in) int* (PyArrayObject* arr = nullptr) {
    if (!PyArray_Check($input)) {
        PyErr_SetString(PyExc_TypeError, "该参数必须传入numpy数组");
        SWIG_fail;
    }
    arr = (PyArrayObject*)$input;
    if (PyArray_TYPE(arr) != NPY_INT) {
        PyErr_SetString(PyExc_TypeError, "数组dtype必须为np.int32");
        SWIG_fail;
    }
    if (!PyArray_IS_C_CONTIGUOUS(arr)) {
        PyErr_SetString(PyExc_ValueError, "数组必须为C连续存储，可调用np.ascontiguousarray()预处理后传入");
        SWIG_fail;
    }
    const size_t expected_len = $self->array_len_;
    if (PyArray_SIZE(arr) != expected_len) {
        PyErr_Format(PyExc_ValueError, "数组长度不匹配，期望长度%zu，实际传入%zu", expected_len, (size_t)PyArray_SIZE(arr));
        SWIG_fail;
    }
    $1 = (int*)PyArray_DATA(arr);
}

如果类中存储长度的成员是私有属性无法直接访问，可以在接口文件的%{ ... %}块中编写简单的辅助读取函数，通过公有的get方法获取长度即可，不需要修改原有类的对外API。

3. 正常在接口文件中声明需要封装的C++类和方法即可，上述typemap会自动匹配所有参数类型为double*/int*的类成员方法，不管参数在参数列表的哪个位置（比如func2中数组参数后还有其他无关参数也能正常匹配）。

报错根因说明 #

之前出现的TypeError: in method 'func', argument 2 of type 'double *'报错，是因为numpy.i自带的默认typemap仅支持(数据类型* 数组指针, int 数组长度)成对出现的参数模式，单独出现的double*/int*参数没有匹配的转换规则，SWIG会回退到通用指针转换逻辑，无法识别numpy数组类型。

注意事项 #

• 上述typemap传入的是numpy数组持有的原始内存指针，C侧仅在函数调用生命周期内使用数组数据是安全的，不要在类成员中持久化保存该指针，否则Python侧numpy数组被垃圾回收后会触发野指针访问崩溃。如果需要长期持有数组数据，请在C侧自行拷贝内存。
• 如果存在个别double*/int*参数不是约定长度的数组（比如单值输出指针），可以在对应函数声明前用%clear double*;临时清除typemap规则，函数声明完成后再重新应用typemap，避免错误匹配。

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