向下转换为pybind11派生类

时间:2019-05-29 20:12:38

标签: python c++ pybind11

我正在使用pybind11的“ Overriding virtual functions in Python”功能来创建从C ++抽象类继承的Python类。我有一个C ++类State,该类在Python中被子类化为MyState。在这种情况下,我有一些MyState对象丢失了类型信息,Python认为它是State。我需要用Python代码将其转换回MyState,但我不知道这样做的好方法。

这是C ++示例代码:

#include <memory>

#include <pybind11/pybind11.h>

namespace py = pybind11;

// ========== State ==========

class State {
 public:
  virtual ~State() = default;

  virtual void dump() = 0;
};

using StatePtr = std::shared_ptr<State>;

class PyState : public State {
 public:
  using State::State;

  void dump() override {
    PYBIND11_OVERLOAD_PURE(void, State, dump);
  }
};

// ========== Machine ==========

class Machine {
 public:
  virtual ~Machine() = default;

  virtual StatePtr begin() = 0;

  virtual StatePtr step(const StatePtr&) = 0;
};

using MachinePtr = std::shared_ptr<Machine>;

class PyMachine : public Machine {
 public:
  using Machine::Machine;

  StatePtr begin() override {
    PYBIND11_OVERLOAD_PURE(StatePtr, Machine, begin);
  }

  StatePtr step(const StatePtr& state) override {
    PYBIND11_OVERLOAD_PURE(StatePtr, Machine, step, state);
  }
};

// ========== run ==========

void run(const MachinePtr& machine) {
  StatePtr state = machine->begin();
  for (int i = 0; i < 5; ++i) {
    state = machine->step(state);
    state->dump();
  }
}

// ========== pybind11 ==========

PYBIND11_MODULE(example, m) {
  py::class_<State, StatePtr, PyState>(m, "State").def(py::init<>());
  py::class_<Machine, MachinePtr, PyMachine>(m, "Machine")
      .def(py::init<>())
      .def("begin", &Machine::begin)
      .def("step", &Machine::step);
  m.def("run", &run, "Run the machine");
}

以及Python代码:

#!/usr/bin/env python3

from example import Machine, State, run


class MyState(State):
    def __init__(self, x):
        State.__init__(self)
        self.x = x

    def dump(self):
        print(self.x)


class MyMachine(Machine):
    def __init__(self):
        Machine.__init__(self)

    def begin(self):
        return MyState(0)

    def step(self, state):
        # problem: when called from C++, `state` is an `example.State`
        # instead of `MyState`. In order to access `state.x` we need
        # some way to downcast it...
        return MyState(state.x + 1)


machine = MyMachine()

print("running machine with python")
state = machine.begin()
for _ in range(5):
    state = machine.step(state)
    state.dump()

print("running machine with C++")
run(machine)  # error

错误消息:

running machine with python
1
2
3
4
5
running machine with C++
Traceback (most recent call last):
  File "<string>", line 38, in <module>
  File "<string>", line 36, in __run
  File "/usr/local/fbcode/platform007/lib/python3.6/runpy.py", line 193, in _run_module_as_main
    "__main__", mod_spec)
  File "/usr/local/fbcode/platform007/lib/python3.6/runpy.py", line 85, in _run_code
    exec(code, run_globals)
  File "/data/users/jcai/fbsource/fbcode/buck-out/dev/gen/experimental/jcai/pybind/run_example#link-tree/run_example.py", line 38, in <module>
    run(machine)  # error
  File "/data/users/jcai/fbsource/fbcode/buck-out/dev/gen/experimental/jcai/pybind/run_example#link-tree/run_example.py", line 26, in step
    return MyState(state.x + 1)
AttributeError: 'example.State' object has no attribute 'x'

我确实有一个解决方法,基本上可以保留“向下映射” std::unordered_map<State*, py::object>,并向其注册每个创建的MyState。但我不想诉诸于此类事情。

1 个答案:

答案 0 :(得分:0)

我认为您可能正在遭受这一系列问题的困扰:

https://github.com/pybind/pybind11/issues/1774

最终,因为您只是直接返回MyState,然后直接进入C ++,所以Python解释器会失去对实例的跟踪,然后继续进行垃圾回收,以收集对象的Python部分,这就是为什么您的对象最终变得有点sliced

可能的解决方案:

  • 存储对您的返回MyState的引用,至少要足够长的时间,以便Python解释器再次获取引用。
    • 例如将return MyState(...)更改为self._stashed_state = MyState(...); return self._stashed_state
  • 看看您是否可以以某种方式incref在C ++中使用类的Python版本(不错,但是可以使用)
  • 查看前面提到的问题中列出的解决方法(无法记住所有的“ em”)
  • 使用我们的pybind11的派生叉进行处理,但还会拖入其他内容:overview for RobotLocomotion/pybind11

您可能还想发布一个现有问题,提到您也遇到了这个问题(只是为了可以对其进行跟踪)。