Понизить до производного класса pybind11 - PullRequest
Новая
       15

Понизить до производного класса pybind11

0 голосов
/ 29 мая 2019

Я использую функцию " Переопределение виртуальных функций в Python " Pybind11 для создания классов Python, которые наследуются от абстрактных классов C ++. У меня есть класс C ++ State, который в Python является подклассом MyState. В этой ситуации у меня есть MyState объект, который потерял информацию о типе, и Python считает, что это State. Мне нужно уменьшить его обратно до MyState в коде Python, и я не знаю хорошего способа сделать это.

Вот пример кода 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 голосов
/ 18 июня 2019

Я думаю, что вы, вероятно, страдаете от этого набора проблем:

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 на версии Python вашего класса в C ++ (да, но это 'сработает)
  • Просмотрите обходные пути, перечисленные в вышеупомянутых проблемах (не могу вспомнить их все)
  • Используйте наш форк pybind11, который обрабатывает это, но также перетаскивает в другиевещи: обзор RobotLocomotion / pybind11

Вы также можете отправить сообщение об одной из существующих проблем, упомянув, что вы столкнулись и с этой проблемой (просто для того, чтобы ее можно было отслеживать).

...