类型映射资源并将列表转换为矢量（和返回）

Posted 2023-02-23

【中文标题】类型映射资源并将列表转换为矢量（和返回）

【英文标题】：Typemap resources and converting a list to vector (and back)

【发布时间】：2019-10-16 03:10:17

【问题描述】：

我正在使用 SWIG 将 c++ 包装在 python 中，并且需要使用类型映射以使我的 python 脚本尽可能简单。作为第一次尝试，我只是发送 2 个列表，将它们转换为向量，添加两个向量，然后将结果返回到一个新列表中。

我的问题是，我一直发现 SWIG 手册不是很有指导性，难以理解，也没有提供任何可靠、完整的示例来说明如何编写自己的类型图。

我的问题是：

如何确保我的列表正确转换为矢量，然后再返回？ 关于如何编写类型映射以及所有语法/函数的含义是否有更好的教程/参考资料？

这是我的代码：

add_array.h

#include <vector>
#include <functional>

std::vector<int> add_array(std::vector<int> src1, std::vector<int> src2);

add_array.i

%module add_array
%
#include "add_array.h"
%

%include std_vector.i 
%template(vectorInt) std::vector<int>;

%include "add_array.h"

add_array.cpp

#include "add_array.h"
#include <cassert>
#include <cstring>

std::vector<int> add_array(std::vector<int> src1, std::vector<int> src2)   
  assert(src1.size() == src2.size());
  std::vector<int> dst;
  dst.resize(src1.size());

  for (size_t i = 0; i < src1.size(); i++) 
    dst[i] = src1[i] + src2[i];
  
  return dst;

生成文件

all:
rm -f *.so *.o *_wrap.* *.pyc *.gch add_array.py
swig -c++ -python add_array.i
g++ -fpic -c add_array_wrap.cxx add_array.h add_array.cpp -I/home/tools/anaconda3/pkgs/python-3.7.3-h0371630_0/include/python3.7m/
g++ -shared add_array_wrap.o add_array.o -o _add_array.so

array.py（这是我正在运行的文件）

import add_array

a = [1, 2, 3, 4, 5, 6]
b = [5, 6, 7, 8, 9, 10]
c = add_array.add_array(a, b)
print(c)

输出： (6, 8, 10, 12, 14, 16)

这是一个元组（我希望它是一个列表）。 看起来我很幸运，它可以将输入列表转换为向量（而另一个方向则没有那么幸运），但我真的很想知道这是如何发生的，以及如果需要的话，我如何为未来的代码更改它.

谢谢！

【参考方案1】：

我不知道是否有特定原因，但包含的std_vector.i 将输出向量转换为元组而不是列表。如果你想要一个列表，你需要编写一个自定义类型映射。

示例（无错误检查）：

%module add_array
%
#include "add_array.h"
%

%include <std_vector.i>
%template(vectorInt) std::vector<int>;

// Override the template output typemap with one that returns a list.
// An "out" typemap controls how a value is returned.
// When a function returns std::vector<int> this template will convert it to
// a Python object.  In this case, a PyList.
// 
// Note: PyObject* tmp declares a local variable that will be used by this code snippet.
// Make sure to look at the generated wrapper code and find the add_array_wrap function
// and how this code is integrated into it.
// 
%typemap(out) std::vector<int> (PyObject* tmp) %

    // Allocate a PyList object of the requested size.
    // $1 references the first type in the type list (in this case, std::vector<int>)
    // and represents the c++ return value of a function that returns
    // this type; therefore, we can call methods on that value to get the size.
    //
    // Note: The elements of the new PyList are null pointers and MUST be
    //       populated before returning it to Python.
    //
    tmp = PyList_New($1.size());

    // Populate the PyList.  PyLong_FromLong converts a C++ "long" to a
    // Python PyLong object.  PyList_SET_ITEM takes a PyList object (tmp),
    // an index (i), and a Python object to put in the list.  This particular
    // function *steals* the reference to the Python object, so you don't have to
    // Py_DECREF the object to free it later.
    //
    for(int i = 0; i < $1.size(); ++i)
        PyList_SET_ITEM(tmp,i,PyLong_FromLong($1[i]));

    // $result is where you assign the Python object that should be returned
    // after converting the C++ $1 object.  SWIG_Python_AppendOutput is not
    // well-documented, but it appends the return object to an existing
    // returned object.  It's most useful for "argout" typemaps where multiple
    // output or in/out arguments in C++ can be returned as a tuple of
    // return values in Python.  For example, a function like:
    //
    //     void func(int* pValue1, int* pValue2);
    //
    // would normally return None ($result = Py_None), but an "argout" typemap
    // could *$1 to a PyLong and use SWIG_Python_AppendOutput to add it to
    // the result.  The template would be applied twice and you'd get a tuple.
    //
    $result = SWIG_Python_AppendOutput($result,tmp);
%

%include "add_array.h"

输出：

>>> import add_array
>>> add_array.add_array([1,2,3],[4,5,6])
[5, 7, 9]

就教程而言，我只阅读过 SWIG 文档和 C 语言扩展的语言特定文档。它实际上是相当不错的文档，但你不能只是挑选和选择要阅读的内容。研究前十几个部分的基础知识，然后跳到特定于语言的部分（例如 Python）。 SWIG 安装下也有一个示例目录。

参考资料：

PyLong_FromLong PyList_New PyList_SET_ITEM std_vector.i

您必须查看 SWIG 源以获取有关 SWIG_Python_AppendOutput 的任何信息。或者只是谷歌其他例子。

【讨论】：

太棒了，这行得通。现在我只需要做一些阅读来找出原因！谢谢！

@Otherness 我会在代码中添加一些 cmets 来帮助解决这个问题。