将 std::list 结构转换为 Python 列表

Question

我正在为 Python 开发一个用 C++ 编写的加速器模块。它是 Dijkstra 算法的一个实现，最终 returns 指向一个 Route 对象的指针，该对象又包含一个 std::list<struct waypoint>。为了使用 Python 与该对象进行交互，我编写了以下接口文件：

%{
#include "universe.hpp"
%}

%include <std_list.i>
%include "universe.hpp"

%template(Waypoints) std::list<struct waypoint>;

这让我可以访问列表对象并为其编制索引，但它上面的迭代器无法正常工作：

>>> r
<mod.Route; proxy of <Swig Object of type 'Route *' at 0x7f6ab39ff4e0> >
>>> r.points
<mod.Waypoints; proxy of <Swig Object of type 'std::list< waypoint > *' at 0x7f6ab502d630> >
>>> r.points[0]
<mod.waypoint; proxy of <Swig Object of type 'waypoint *' at 0x7f6ab39ff540> >
>>> for x in r.points:
...     print(x)
... 
<Swig Object of type 'unknown' at 0x7f6ab39ff5d0>
swig/python detected a memory leak of type 'unknown', no destructor found.
<Swig Object of type 'unknown' at 0x7f6ab39ff5a0>
swig/python detected a memory leak of type 'unknown', no destructor found.
<Swig Object of type 'unknown' at 0x7f6ab39ff5d0>
swig/python detected a memory leak of type 'unknown', no destructor found.
...

为了解决这个问题（并使代码更易读），我想将 std::list<struct waypoint> 转换为普通的 Python 列表，因此我编写了以下类型映射：

%{
#include "universe.hpp"
%}

%typemap(out) std::list<struct waypoint> {
    $result = PyList_New(->size());

    printf("This never gets printed\n");

    for(size_t i = 0; i < ->size(); ++i) {
        PyList_SET_ITEM($result, i, [i]);
    }
}

%include <std_list.i>

%include "universe.hpp"

但是，此类型映射不起作用。事实上，列表现在只是一个SwigPyObject，根本不支持订阅。 typemap 也永远不会执行，因为它里面的 print 语句永远不会执行。我很难在网上找到有同样问题的人，我希望这里有人能帮助我找出我做错了什么。

这些是universe.hpp的最少内容：

#include <string>
#include <list>

struct Entity;

struct waypoint {
    Entity *entity;
    int type;
};

class Route {
public:
    int loops;
    double cost;
    std::list<struct waypoint> points;
};

class Entity {
public:
    float x, y, z;
    int id, seq_id;
    std::string name;
};

Answer 1

在我看来，这最初看起来像是一个 SWIG 错误。很可能不是，最简单的解决方法是微不足道的更改行：

%template(Waypoints) std::list<struct waypoint>;

简单地是：

%template(Waypoints) std::list<waypoint>;

你所有的烦恼都会过去。这足以使以下代码运行成功：

import test
r=test.Route()
r.points[0]

for x in r.points:
    print(x)

只打印：

<test.waypoint; proxy of <Swig Object of type 'waypoint *' at 0x7fe439e22ed0> >
<test.waypoint; proxy of <Swig Object of type 'waypoint *' at 0x7fe439ea5360> >

为了完整起见，这里是我意识到这一点的旅程：

基本上似乎没有生成 swig_type_info *swig::type_info<waypoint>() 的特化，因此 SwigPyIterator::next() 调用通过 SwigPyIterator::value() 以 null 指针结束 swig_type_info 用于您的 waypoint 类型，当它调用 SWIG_InternalNewPointerObj 生成 Python 代理对象时。这会导致您稍后看到未知的类型信息。

与此同时，有两种方法可以避免这种情况。首先，在 Python 中，您仍然可以使用类似以下内容的 C++ std::list 简单地获取 Python 列表：

list(map(r.points.__getitem__, range(r.points.size())))

其次，我们可以添加自己的专业化，这很简单：

%{
#include "universe.hpp"

  // Workaround: add missing specialization
  namespace swig {
    // Forward declare first
    template <typename T>
    swig_type_info *type_info();

    template <>
    swig_type_info *type_info<waypoint>() {
      return SWIGTYPE_p_waypoint;
    };
  }

%}

%include <std_list.i>
%include "universe.hpp"

%template(Waypoints) std::list<struct waypoint>;

如果我们在调试器中进一步挖掘，虽然我们看到 type_info() 的默认实现实际上调用了 traits_info<Type>::type_info()。依次调用 type_query()。在这里中断指向我们可以更清楚地看到问题是什么——我们构建的查询前面有单词 "struct "。并且为 waypoint 生成的 swig_type_info 结构在任何地方都没有 struct 一词，因此类型查询系统失败。

令我有些惊讶的是，类型查询函数使用字符串执行此操作，即使类型在编译时已知 - 我在上面使用的特化要简单得多，而且看起来很容易生成。但这实际上并不是它在这里不起作用的原因，真正的解决方案是从 %template 调用中删除 struct 这个词。

将 std::list 结构转换为 Python 列表

Converting a std::list of structs to a Python list

python

c++

swig