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

Question

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

%{
#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($1->size());

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

    for(size_t i = 0; i < $1->size(); ++i) {
        PyList_SET_ITEM($result, i, $1[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++ 中轻松获得 Python 列表 std::list使用类似的东西:

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”这个词。和 swig_type_info为 waypoint 生成的结构在任何地方都没有单词 struct，因此类型查询系统失败。

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