Могу ли я переопределить виртуальную функцию С++ в Python с Cython?

У меня есть класс С++ с виртуальным методом:

//C++
class A
{

    public:
        A() {};
        virtual int override_me(int a) {return 2*a;};
        int calculate(int a) { return this->override_me(a) ;}

};

Что бы я хотел сделать, так это разоблачить этот класс на Python с помощью Cython, наследовать от этого класса в Python и иметь правильный переопределенный вызов:

#python:
class B(PyA):
   def override_me(self, a):
       return 5*a
b = B()
b.calculate(1)  # should return 5 instead of 2

Есть ли способ сделать это? Теперь я думаю, что было бы здорово, если бы мы могли переопределить виртуальный метод и в Cython (в файле pyx), но более важно, чтобы пользователи могли делать это в чистом питоне.

Изменить. Если это поможет, решением может быть использование приведенного здесь псевдокода: http://docs.cython.org/src/userguide/pyrex_differences.html#cpdef-functions

Но есть две проблемы:

  • Я не знаю, как записать этот псевдокод в Cython
  • возможно, есть лучший подход

Ответы

Ответ 1

Отлично!

Не достаточно, но достаточно. Я смог сделать трюк для своей собственной цели. Объединяя этот пост с источниками, связанными выше. Это было нелегко, так как я новичок в Cython, но я подтверждаю, что это единственный способ, который я мог найти через www.

Большое спасибо вам, ребята.

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

setup.py:

from distutils.core import setup
from distutils.extension import Extension
from Cython.Distutils import build_ext

setup(
    cmdclass = {'build_ext': build_ext},
    ext_modules = [
    Extension("elps", 
              sources=["elps.pyx", "src/ITestClass.cpp"],
              libraries=["elp"],
              language="c++",
              )
    ]
)

TestClass:

#ifndef TESTCLASS_H_
#define TESTCLASS_H_


namespace elps {

class TestClass {

public:
    TestClass(){};
    virtual ~TestClass(){};

    int getA() { return this->a; };
    virtual int override_me() { return 2; };
    int calculate(int a) { return a * this->override_me(); }

private:
    int a;

};

} /* namespace elps */
#endif /* TESTCLASS_H_ */

ITestClass.h:

#ifndef ITESTCLASS_H_
#define ITESTCLASS_H_

// Created by Cython when providing 'public api' keywords
#include "../elps_api.h"

#include "../../inc/TestClass.h"

namespace elps {

class ITestClass : public TestClass {
public:
    PyObject *m_obj;

    ITestClass(PyObject *obj);
    virtual ~ITestClass();
    virtual int override_me();
};

} /* namespace elps */
#endif /* ITESTCLASS_H_ */

ITestClass.cpp:

#include "ITestClass.h"

namespace elps {

ITestClass::ITestClass(PyObject *obj): m_obj(obj) {
    // Provided by "elps_api.h"
    if (import_elps()) {
    } else {
        Py_XINCREF(this->m_obj);
    }
}

ITestClass::~ITestClass() {
    Py_XDECREF(this->m_obj);
}

int ITestClass::override_me()
{
    if (this->m_obj) {
        int error;
        // Call a virtual overload, if it exists
        int result = cy_call_func(this->m_obj, (char*)"override_me", &error);
        if (error)
            // Call parent method
            result = TestClass::override_me();
        return result;
    }
    // Throw error ?
    return 0;
}

} /* namespace elps */

EDIT2: примечание о виртуальных методах PURE (это, по-видимому, довольно актуальная проблема). Как показано в приведенном выше коде, таким образом, "TestClass:: override_me()" НЕ МОЖЕТ быть чистым, поскольку он должен быть вызван в случае, если метод не переопределен в расширенном классе Python (aka: один не попадает в "ошибка" / "переопределить не найденную" часть тела "ITestClass:: override_me()".

Расширение: elps.pyx:

cimport cpython.ref as cpy_ref

cdef extern from "src/ITestClass.h" namespace "elps" :
    cdef cppclass ITestClass:
        ITestClass(cpy_ref.PyObject *obj)
        int getA()
        int override_me()
        int calculate(int a)

cdef class PyTestClass:
    cdef ITestClass* thisptr

    def __cinit__(self):
       ##print "in TestClass: allocating thisptr"
       self.thisptr = new ITestClass(<cpy_ref.PyObject*>self)
    def __dealloc__(self):
       if self.thisptr:
           ##print "in TestClass: deallocating thisptr"
           del self.thisptr

    def getA(self):
       return self.thisptr.getA()

#    def override_me(self):
#        return self.thisptr.override_me()

    cpdef int calculate(self, int a):
        return self.thisptr.calculate(a) ;


cdef public api int cy_call_func(object self, char* method, int *error):
    try:
        func = getattr(self, method);
    except AttributeError:
        error[0] = 1
    else:
        error[0] = 0
        return func()

Наконец, питон вызывает:

from elps import PyTestClass as TC;

a = TC(); 
print a.calculate(1);

class B(TC):
#   pass
    def override_me(self):
        return 5

b = B()
print b.calculate(1)

Это должно сделать предыдущую связанную работу надежно более прямолинейной, если мы обсудим здесь...

EDIT: С другой стороны, приведенный выше код можно оптимизировать с помощью 'hasattr' вместо блока try/catch:

cdef public api int cy_call_func_int_fast(object self, char* method, bint *error):
    if (hasattr(self, method)):
        error[0] = 0
        return getattr(self, method)();
    else:
        error[0] = 1

Вышеприведенный код, разумеется, имеет значение только в том случае, когда мы не переопределяем метод override_me.

Ответ 2

Решение несколько сложное, но это возможно. Здесь приведен полный рабочий пример: https://bitbucket.org/chadrik/cy-cxxfwk/overview

Вот обзор техники:

Создайте специализированный подкласс class A, целью которого будет взаимодействие с расширением cython:

// created by cython when providing 'public api' keywords:
#include "mycymodule_api.h"

class CyABase : public A
{
public:
  PyObject *m_obj;

  CyABase(PyObject *obj);
  virtual ~CyABase();
  virtual int override_me(int a);
};

Конструктор берет объект python, который является экземпляром нашего расширения cython:

CyABase::CyABase(PyObject *obj) :
  m_obj(obj)
{
  // provided by "mycymodule_api.h"
  if (import_mycymodule()) {
  } else {
    Py_XINCREF(this->m_obj);
  }
}

CyABase::~CyABase()
{
  Py_XDECREF(this->m_obj);
}

Создайте расширение этого подкласса в cython, реализуя все не виртуальные методы в стандартном режиме

cdef class A:
    cdef CyABase* thisptr
    def __init__(self):
        self.thisptr = new CyABase(
            <cpy_ref.PyObject*>self)

    #------- non-virutal methods --------
    def calculate(self):
        return self.thisptr.calculate()

Создавайте виртуальные и чистые виртуальные методы как функции public api, которые принимают в качестве аргументов экземпляр расширения, аргументы метода и указатель ошибок:

cdef public api int cy_call_override_me(object self, int a, int *error):
    try:
        func = self.override_me
    except AttributeError:
        error[0] = 1
        # not sure what to do about return value here...
    else:
        error[0] = 0
        return func(a)

Используйте эти функции в своем промежуточном С++ следующим образом:

int
CyABase::override_me(int a)
{
  if (this->m_obj) {
    int error;
    // call a virtual overload, if it exists
    int result = cy_call_override_me(this->m_obj, a, &error);
    if (error)
      // call parent method
      result = A::override_me(i);
    return result;
  }
  // throw error?
  return 0;
}

Я быстро адаптировал свой код к вашему примеру, чтобы могли быть ошибки. Взгляните на полный пример в репозитории, и он должен ответить на большинство ваших вопросов. Не стесняйтесь разветвлять его и добавлять свои собственные эксперименты, это далеко не полный!