C++导出类到Python_c++ 导出python文件

上次稍微谈了下如何用C++写的函数来扩展Python，使Python很方便的调用用C++写的高效的、快速的函数。我们知道——Python是面向对象的，那么我们是否可以用C++写的类来扩展Python程序呢？答案是可以的！首先说明：我的Python是3.1的，与2.x在一些Python/C API有区别。

 

      一、简介 ：

比如我们有一个C++类——用于记录一个学生的信息：姓名、数学成绩、英语成绩，呃，就这些吧！也许你会说这不是没事找事么？Python也可以很简单、很快的实现这个类。但我要说的是——我只是想用这个小例子来阐述”用C++类扩展Python”的主要思想，达到举一反三的效果。只要学会了这个例子，就可以将任意复杂的类导出到Python环境供Python调用。

 

      这个类的大致雏形如下，用C++：

      

 

用Python类写这个类：

 

也很简单，就是这些成员函数的定义也大致相同。如果你能看懂上面两个不同语言定义的类，那么请继续！不然可能有些吃力。下面我们来实现这样一个操作：“用C++语言写这样一个CScore类，可以在Python Intepreter中方便的调用”。 OK，Let’s Go！

 

二、具体操作：

1> 依然新建一个Win32 DLL Project，添加一个Cpp源文件——比如是Extension_Class.cpp，保证你的Python的.../Include ../Libs路径是添加到VC系统路径中的。然后逐一添加以下代码：

 

Python.h很熟悉，是不？structmember.h又是一个新的头文件，需要用到里面的数据结构。其余不解释！

2> 也许你会很自然的直接写一个C++类，但我们会发现，事实并不是这样。接着来：

可以看到我们定义了一个结构而并不是一个类。第一个PyObject_HEAD是一个宏，我们可以在Python的Include中object.h头文件找到它的定义：

大意是PyObject_HEAD是每一个PyObject的初始段。其余的成员依次是学生的名字(m_szName)、数学成绩(m_fMath)、英语成绩(m_fEnglish)。

 

3> 有了类的定义还不够，还得对它的数据成员进行说明：

①PyMemberDef是类成员的说明结构。我只解释其中一个成员——m_szName，其余的一样。先来这个字符串”m_szName”就是导出到Python中的类成员，这个名字不一定非得和C++中相应类成员的名字相同。

②T_STRING、T_FLOAT是这个成员的数据类型的说明。不解释！

③offsetof亦是一个宏，在STDDEF.h中：

       #define offsetof(s,m)   (size_t)&(((s *)0)->m)  那么offsetof(CScore, m_szName)就是： (size_t)&(((CScore*)0)->m_szName)。

④下来是一个字符串”The …”——这是成员的DocString。其余成员依次类推。完了！

 

4> 我们知道，作为一个类，光有数据时不行的，还得有方法可供调用。下面来给这个类添加方法：

①先看类的构造、析构等内置方法：

 

 

可以看出，类的成员函数都是这样一个面孔：static void MethodName(ClassType* Self, …),如果函数有返回值的话，将void替换为Pyobject*即可。所有的函数名自己随便定。至于第一个参数Self，是必须有的，它就像Python中类方法定义时的self一样，和C++中的this指针的机理差不多。正如你所见，用它来引用类中的数据成员。

 

在构造方法中，我们通过解析参数，得到每一个成员的值。由于在构造方法中new了m_szName的内存空间，所以在析构函数中释放它。如果你看过我的上一篇《用C++扩展Python》的话，这几个函数理解起来应该很容易！

 

②CScore类的外部方法：

都很简单，是不？

③现在这个类有了Get、Set方法，还可以很方便的调用PrintInfo输出所有信息。很好很强大。

 

5> 类的所有方法的列表说明：

  

 

每一项都唯一的说明了一个类方法。下面解释之：

① 依然是static，PyMethodDef定义了方法列表说明的结构。第一个字符串”GetName”——是Python中可见的那个函数名——依然不必与C++中所对应的函数名相同，可以自己定。

②(PyCFunction)CScore_GetName——是C++中的对应的函数指针。

③METH_VARARGS——定义了从Python向C++函数传递参数的方法。METH_VARARGS指定了用Tuple传递，如果没有参数，请用METH_NOARGS。

④一个字符串”Get the Name …Instance”——是这个函数的DocString，在Python中可以用MethodName.__doc__获得。

 

6> Yeah!类的各个部件——数据成员、方法成员都已说明完毕！下面就是将这些说明列表有机的组织起来。如下：

 

不知你此刻感觉如何，我当初是被吓着了！不过回头看一下，也挺简单，一一介绍之。

①依然static！第一个字符串可以用ClassName.__name__获取，是类的内置名称。

②sizeof(CScore)——说明了类/结构的大小。

③有0的不看了，其余的有注释，其中每个位置的对应项不可搞错。比如第4项是析构函数的函数指针，第27、28项分别说明了类的所有数据、方法集合。35项是类的构造函数……

 

7> 一切对类的说明完毕，下来是对模块的说明：

 

①依然static！第一项总为PyModuleDef_HEAD_INIT。

②模块的内置名，可以用ModuleName.__name__获取。

③模块的DocString，可以用ModuleName.__doc__获取。

 

8> 好了！终于到了导出这一步了。导出函数的名字和模块的名字息息相关。

   基本上有：模块初始函数名 = PyInit_ + 模块文件名. 这是Python 3.1中的方法，2.x中可能有出入！

 

 

 

①PyType_Ready 函数，根据参数——导出类的说明信息——来判断类是否可导出。

②PyModule_Create创建这个模块。

③PyModule_AddObject将这个类加入到模块中！请注意：第一个参数为PyObject*模块对象，第二个为导出类在Python Intepreter中的名字——这个字符串依然可以和C++中所对应的类名不同！

 

 

三、测试导出模块：

 

激动人心的时候到了！我们的类究竟是否在Python中可用？下面就是——“见证奇迹的时刻！”

1>    我们很熟练的设置Win32 DLL Project生成的文件为Score.pyd——因为我们的初始函数为PyInit_Score！如果你还不知道如何设置，请参考我的《用C++扩展Python》一文。

2>    然后组建即可。在Release目录下，不出意外的话可以找到一个120多KB的Score.pyd文件。我们可以将它复制到D:/下，然后cmd、cd切换到D:/下，键入Python，得到如下界面：

 

 

3>    然后可以随心所欲的进行操作了，比如我们键入下列命令：

>>>import Score

>>>dir(Score)

>>>Score.__doc__

>>>Score.__name__

>>>Score.__file__

可以依次得到模块Score的DocString、内置模块名、模块所对应的文件名……运行结果如下：

 

4>    有待探索的东西还很多：

>>>from Score import *                   #导入模块中所有方法
>>>dir(CScore)                                 #查看类CScore的所有内置属性
>>>CScore.__doc__
>>>CScore.GetEnglish.__doc__
>>>CScore.GetMath.__name__
>>>CScore.GetName 

 

可以看到，输出的信息和我们所定义的是一致的！有一点成就感了吧？

 

 

 

 

5>    下面是重中之重——我们的类到底可不可用呢？试试先：

>>>StuScore = CScore(“Kobe Bryant”, 88, 100)

>>>StuScore.GetName()

>>>StuScore.GetMath()

>>>StuScore.GetEnglish()

>>>StuScore.PrintInfo()

 

 

 

这一幕终于出现了！！！我们看到，我们的类的确起了作用，并且工作的很好！不是吗？我们可以获得他的各种信息，也可以将其信息打包输出。当然，还可以更改：

>>>StuScore.SetMath(90.5)

>>>StuScore.SetEnglish(95)

>>>print(StuScore)

一切皆在预料之中！我们甚至可以用Python中内置的print函数输出这个类！！！请不要惊慌，我们的print函数只是简单的调用了print(str(StuScore))这个函数而已！而对内置函数str的定义是我们在C++程序中所作了的——还记得那一长串令人头痛的类信息说明结构吗？？

 

 

 

我们接着来：

>>>repr(StuScore)

>>>str(StuScore)

>>>print(str(StuScore))

 

 

 

 

依然正常工作！

我们甚至可以在类对象之间相互赋值，删除对象……

>>>Another = StuScore

>>>print(Another)

>>>del StuScore

 

 
 

 

当del时，对象自动调用C++中所定义的那个析构函数来释放所占用的内存！

 

6>    这个模块中还有一些东西有待挖掘，我想，还是留给您去探索吧——这样才会了解的深入。

 

通过这个例子我们可以看出，我们可以很方便的用C++写的类来扩展Python库！也许你不认为这是个好办法——Python自身写的类就可以啊，为什么非要用C++写的呢？但请不要忘记——在对系统处理速度要求较高的一些软件(或程序)中，可以很方便的利用C/C++的运行速度快的特点，来对Python进行扩展。

 

7>    呃，就这样完了？不会！如果你对空间大小要求较高的话，可以看到——就这么几行的一个类，却要占用120多KB的空间，如果是一个几百行的类呢？一些类呢？下面介绍一种用Python Script来生成.pyd文件的方法。准备好了吗？Go！

 

①我们新建一个Python脚本——CreatePyd.py。然后进行如下编辑：

 

     

                               

 

我们大致解释下：先导入所需的Python模块。然后用Extension函数关联一个Cpp源文件（就是我们刚刚写的那个文件）和一个要生成的模块名——注意：没有.pyd后缀。

然后调用setup函数生成一个名字name为Score的模块，版本version为1.0，描述description，作者信息author，作者邮箱author_email，还其平台platforms等等他有用的信息！

 

比如我们将这个CreateDLL.py和Extension_Class.cpp拷贝到D:/下，依然切换到D:/目录下，键入”python CreateDLL.py build”：

 

 

 

 

 

经过生成后，就会新生成一个build目录，在build/lib.win32-3.1下你可以找到Score.pyd这个文件。但它只有12KB！比用VC生成的整整小了10倍！可以试一下，它依然能正常工作。

 

8>    模块的安装：

也许你对你生成的模块比较满意，那么你可以将其拷入Python的lib目录下，以后不用切换盘符就可以方便的调用。但还有一种更为简便的方法：用命令行键入: Python CreateDLL.py install:

 

 

 

 

也许你的显示和我不同——因为我们的Python不一定安装在同一个目录下。但结果是我们在Python安装目录下的lib/site-packates下可以找到刚刚生成的.pyd模块和一个模块信息说明文件，我们用记事本打开之：

 

 

 

 

其中恰恰是我们的py脚本中给setup函数所传递的那些参数！

 

四、小结：

         好了，就这些。我们通过“创建结构--> 创建方法--> 数据成员说明-->方法说明--> 关联结构和数据、方法--> 模块说明-->生成模块”这一系列犀利的操作成功的从C++中向Python导出了一个类！