Cython / Python / C ++-继承：将派生类作为参数传递给需要基类的函数

Question

我正在使用Cython包装一组C ++类，并允许它们使用Python接口。 下面提供了示例代码：

BaseClass.h：

#ifndef __BaseClass__
#define __BaseClass__
#include <stdio.h>
#include <stdlib.h>
#include <string>
using namespace std;
class BaseClass
{
    public:
        BaseClass(){};
        virtual ~BaseClass(){};
        virtual void SetName(string name){printf("in base set name\n");}
        virtual float Evaluate(float time){printf("in base Evaluate\n");return 0;}
        virtual bool DataExists(){printf("in base data exists\n");return false;}
};
#endif /* defined(__BaseClass__) */

DerivedClass.h：

#ifndef __DerivedClass__
#define __DerivedClass__

#include "BaseClass.h"

class DerivedClass:public BaseClass
{
    public:
        DerivedClass(){};
        virtual ~DerivedClass(){};
        virtual float Evaluate(float time){printf("in derived Evaluate\n");return 1;}
        virtual bool DataExists(){printf("in derived data exists\n");return true;}
        virtual void MyFunction(){printf("in my function\n");}
        virtual void SetObject(BaseClass *input){printf("in set object\n");}
};
#endif /* defined(__DerivedClass__) */

NextDerivedClass.h：

#ifndef __NextDerivedClass__
#define __NextDerivedClass__

#include "DerivedClass.h"

class NextDerivedClass:public DerivedClass
{
    public:
        NextDerivedClass(){};
        virtual ~NextDerivedClass(){};
        virtual void SetObject(BaseClass *input){printf("in set object of next derived class\n");}
};
#endif /* defined(__NextDerivedClass__) */

InheritTest.pyx：

cdef extern from "BaseClass.h":
cdef cppclass BaseClass:
    BaseClass() except +
    void SetName(string)
    float Evaluate(float)
    bool DataExists()

cdef extern from "DerivedClass.h":
    cdef cppclass DerivedClass(BaseClass):
        DerivedClass() except +
        void MyFunction()
        float Evaluate(float)
        bool DataExists()
        void SetObject(BaseClass *)

cdef extern from "NextDerivedClass.h":
    cdef cppclass NextDerivedClass(DerivedClass):
        NextDerivedClass() except +
        # ***  The issue is right here ***
        void SetObject(BaseClass *)

cdef class PyBaseClass:
    cdef BaseClass *thisptr
    def __cinit__(self):
        if type(self) is PyBaseClass:
            self.thisptr = new BaseClass()
    def __dealloc__(self):
        if type(self) is PyBaseClass:
            del self.thisptr

cdef class PyDerivedClass(PyBaseClass):
    cdef DerivedClass *derivedptr
    def __cinit__(self):
        self.derivedptr = self.thisptr = new DerivedClass()
    def __dealloc__(self):
        del self.derivedptr
    # def Evaluate(self, time):
    #     return self.derivedptr.Evaluate(time)
    def SetObject(self, PyBaseClass inputObject):
         self.derivedptr.SetObject(<BaseClass *>inputObject.thisptr)

cdef class PyNextDerivedClass(PyDerivedClass):
    cdef NextDerivedClass *nextDerivedptr
    def __cinit__(self):
        self.nextDerivedptr = self.thisptr = new NextDerivedClass()
    def __dealloc__(self):
        del self.nextDerivedptr
    def SetObject(self, PyBaseClass input):
        self.nextDerivedptr.SetObject(<BaseClass *>input.thisptr)

我希望能够在Python中调用SetObject，如下所示：

main.py：

from inheritTest import PyBaseClass as base
from inheritTest import PyDerivedClass as der
from inheritTest import PyNextDerivedClass as nextDer

#This works now!
a = der()
b = der()
a.SetObject(b)

#This doesn't work -- keeping the function declaration causes a overloaded error, not keeping it means the call below works, but it calls the inherited implementation (From derived class)
c = nextDer()
c.SetObject(b)

我认为这是可行的，因为这些类是相互继承的，但是它给了我以下错误：

在函数定义中未指定类型会使它认为inputObject是纯Python对象（它没有基于C的属性），在这种情况下，错误是：

对此的一种怪异解决方法是，使具有不同名称的Python函数需要不同类型的参数（例如：SetObjectWithBase，SetObjectWithDerived），然后在其实现中，调用相同的基于C的函数，将输入类型转换为类型。 我知道这是可行的，但我想避免这样做。 即使有办法我可以在函数中捕获类型错误，并在内部进行处理，我认为也可以，但我不确定如何实现。

希望这个问题有意义，如果您需要其他信息，请告诉我。

**** EDIT **** ：已对代码进行了编辑，以使基本继承有效。 经过更多的研究之后，我意识到该问题是在多个继承级别上发生的，例如，请参见上面的编辑代码。 基本上，保留NextDerivedClass的SetObject的声明会导致“模棱两可的重载方法”错误，不保留它会使我调用对象上的函数，而是调用继承的实现（来自DerivedClass）。 **

Answer 1

经过下面的答案和实验的大量帮助之后，我认为我了解在Cython中实现基本继承的工作方式，我在回答自己的问题以验证/增进我的理解，并希望能对以后的任何人有所帮助可能会遇到相关问题。 如果该说明有任何问题，请随时在下面的评论中对我进行纠正，我将对其进行编辑。 我不认为这是唯一的方法，因此我敢肯定其他方法也可以，但是这对我来说是有效的。

概述/经验教训：

因此，基本上，根据我的理解，Cython足够聪明（只要有适当的信息）就可以遍历继承树/树，并根据要调用的对象的类型来调用虚拟函数的适当实现。

重要的是要尝试镜像要包裹在.pyx文件中的C ++继承结构。 这意味着确保：

1）导入的C ++ / Cython cpp类（从声明为cdef extern from ）彼此继承，其方式与实际C ++类相同

2）对于每个导入的类，仅声明唯一的方法/成员变量（对于在两个类中实现方式不同的虚拟函数， BaseClass和DerivedClass都不应具有函数声明）。 只要一个继承自另一个，函数声明只需要在Base导入的类中。

3）Python包装器类（即PyBaseClass / PyDerivedClass ）也应该以与实际C ++类相同的方式相互继承

4）与上述类似，虚拟函数的接口仅需要存在于PyBase包装类中（不应同时放入两个类中，在实际运行代码时将调用正确的实现）。

5）对于每个从其继承或继承的Python包装器类，您需要一个if type(self) is class-name:检入__cinit__()和__dealloc__()函数。 这样可以防止出现段错误等。您不需要在树状树中检查“叶节点”（不会继承或子类化的类）

6）确保在__dealloc__()函数中，仅删除当前指针（而不删除任何继承的指针）

7）同样，在__cinit__() ，对于继承的类，请确保设置了当前指针以及指向您要创建的类型的对象的所有派生指针（即*self.nextDerivedptr = self.derivedptr = self.thisptr = new NextDerivedClass()* ）

希望以上几点在您看到下面的代码时很有道理，可以根据我的需要/打算使其运行并编译和运行。

BaseClass.h：

#ifndef __BaseClass__
#define __BaseClass__

#include <stdio.h>
#include <stdlib.h>
#include <string>

using namespace std;

class BaseClass
{
    public:
        BaseClass(){};
        virtual ~BaseClass(){};
        virtual void SetName(string name){printf("BASE: in set name\n");}
        virtual float Evaluate(float time){printf("BASE: in Evaluate\n");return 0;}
        virtual bool DataExists(){printf("BASE: in data exists\n");return false;}
};
#endif /* defined(__BaseClass__) */ 

DerivedClass.h：

#ifndef __DerivedClass__
#define __DerivedClass__

#include "BaseClass.h"
#include "string.h"

using namespace std;

class DerivedClass:public BaseClass
{
    public:
        DerivedClass(){};
        virtual ~DerivedClass(){};
        virtual void SetName(string name){printf("DERIVED CLASS: in Set name \n");}
        virtual float Evaluate(float time){printf("DERIVED CLASS: in Evaluate\n");return 1.0;}
        virtual bool DataExists(){printf("DERIVED CLASS:in data exists\n");return true;}
        virtual void MyFunction(){printf("DERIVED CLASS: in my function\n");}
        virtual void SetObject(BaseClass *input){printf("DERIVED CLASS: in set object\n");}
};
#endif /* defined(__DerivedClass__) */

NextDerivedClass.h：

    #ifndef __NextDerivedClass__
    #define __NextDerivedClass__

    #include "DerivedClass.h"

    class NextDerivedClass:public DerivedClass
    {
        public:
            NextDerivedClass(){};
            virtual ~NextDerivedClass(){};
            virtual void SetObject(BaseClass *input){printf("NEXT DERIVED CLASS: in set object\n");}
            virtual bool DataExists(){printf("NEXT DERIVED CLASS: in data exists \n");return true;}
    };
    #endif /* defined(__NextDerivedClass__) */

InheritTest.pyx：

#Necessary Compilation Options
#distutils: language = c++
#distutils: extra_compile_args = ["-std=c++11", "-g"]

#Import necessary modules
from libcpp cimport bool
from libcpp.string cimport string
from libcpp.map cimport map
from libcpp.pair cimport pair
from libcpp.vector cimport vector

cdef extern from "BaseClass.h":
    cdef cppclass BaseClass:
        BaseClass() except +
        void SetName(string)
        float Evaluate(float)
        bool DataExists()

cdef extern from "DerivedClass.h":
    cdef cppclass DerivedClass(BaseClass):
        DerivedClass() except +
        void MyFunction()
        void SetObject(BaseClass *)

cdef extern from "NextDerivedClass.h":
    cdef cppclass NextDerivedClass(DerivedClass):
        NextDerivedClass() except +

cdef class PyBaseClass:
    cdef BaseClass *thisptr
    def __cinit__(self):
        if type(self) is PyBaseClass:
            self.thisptr = new BaseClass()
    def __dealloc__(self):
        if type(self) is PyBaseClass:
            del self.thisptr
    def SetName(self, name):
        self.thisptr.SetName(name)
    def Evaluate(self, time):
        return self.thisptr.Evaluate(time)
    def DataExists(self):
        return self.thisptr.DataExists()

cdef class PyDerivedClass(PyBaseClass):
    cdef DerivedClass *derivedptr
    def __cinit__(self):
        if type(self) is PyDerivedClass:
            self.derivedptr = self.thisptr = new DerivedClass()
    def __dealloc__(self):
        if type(self) is PyBaseClass:
            del self.derivedptr
    def SetObject(self, PyBaseClass inputObject):
        self.derivedptr.SetObject(<BaseClass *>inputObject.thisptr)
    def MyFunction(self):
        self.derivedptr.MyFunction()

cdef class PyNextDerivedClass(PyDerivedClass):
    cdef NextDerivedClass *nextDerivedptr
    def __cinit__(self):
        self.nextDerivedptr = self.derivedptr = self.thisptr = new NextDerivedClass()
    def __dealloc__(self):
        del self.nextDerivedptr

test.py：

from inheritTest import PyBaseClass as base
from inheritTest import PyDerivedClass as der
from inheritTest import PyNextDerivedClass as nextDer

a = der()
b = der()
a.SetObject(b)
c = nextDer()
a.SetObject(c)
c.DataExists()
c.SetObject(b)
c.Evaluate(0.3)


baseSig = base()
signal = der()
baseSig.SetName('test')
signal.SetName('testingone')
baseSig.Evaluate(0.3)
signal.Evaluate(0.5)
signal.SetObject(b)
baseSig.DataExists()
signal.DataExists()

请注意，当我打电话时：

c = nextDer()
c.Evaluate(0.3)

Cython的工作方式是从继承树中查找“评估”的“最新”实现。 如果它存在于NextDerivedClass.h ，它将调用它（我已经尝试过并且可以工作），因为它不存在，所以它向上了一步并检查DerivedClass 。 该函数在此处实现，因此输出为：

>> DERIVED CLASS: in Evaluate

希望以后对某人有帮助，如果我的理解有误，或者只是语法/语法错误，请在下面发表评论，我将尝试解决这些问题。 再次感谢在下面回答的人，这是他们的回答的摘要，目的只是为了帮助验证我的理解。 谢谢！

Answer 2

您编写的代码无法编译。 我怀疑您真正的PyDerivedClass并不是真正从PyBaseClass派生的，就好像最后一行是

(<DerivedClass*>self.thisptr).SetObject(inputObject.thisptr)

这也可以解释您遇到的类型错误，这是我无法重现的错误。

Answer 3

老实说，这看起来像个错误。 您传递的对象是所需类的实例，但是它仍然会引发错误。 您可能希望将其显示在cython用户邮件列表中，以便主要开发人员可以查看它。

一个可能的解决方法是定义一个代表两种参数类型的融合类型 ，并在方法内部使用它。 不过，这似乎有点过分。