2009/03/23

C++扩展和嵌入Python

作者 时间 标签：

C++扩展和嵌入Python
作者：胡金山 来源：www.vckbase.com

Paper source

下载源代码

Python简介

Python是一种简单易学，功能强大的解释型编程语言，它有简洁明了的语法，高效率的高层数据结构，能够简单而有效地实现面向对象编程，特别适用于快速应用程序开发，也可以用来开发大规模的重要的商业应用。Python是一个理想的脚本语言。
Python免费开源，可移植到多种操作系统，只要避免使用依赖于特定操作系统的特性，Python程序无需修改就可以在各种平台上面运行。
Python拥有现代编程语言所具有的一切强大功能，Python标准库十分庞大，可以帮助开发者处理各种工作，如：图形用户界面、文件处理、多媒体、正 则表达式、文档生成、单元测试、线程、数据库、网络通讯、网页浏览器、CGI、FTP、电子邮件、XML、HTML、WAV文件、密码系统、Tk和其他与 系统有关的操作。只要安装了Python，这些功能都是可用的除了标准库以外，还有许多其他高质量的库，如wxPython、Twisted和 Python图形库等等数不胜数。
Python容易扩展和嵌入。Python提供的许多标准模块支持C或者C++接口。Python和C可以一起工作，它可以嵌入到C或者C++的应用程序 当中，因此可用Python语言为应用程序提供脚本接口，由于支持跨语言开发，可用Python设计概念化应用程序，并逐步移植到C，使用前不必用C 重写应用程序。(Jython使Python可以和Java一起工作，使开发者可以在Python里面调Java的包，也可以在Java里面使用 Python的对象。还有更妙的,由于Jython的解释器完全用Java编写，因此可以在支持Java的任何平台上部署Python程序，甚至WEB浏 览器也可以直接运行Python脚本。)

提出问题

在某个C++应用程序中，我们用一组插件来实现一些具有统一接口的功能，我们使用Python来代替动态链接库形式的插件，这样可以方便地根据需求的变化 改写脚本代码，而不是必须重新编译链接二进制的动态链接库。Python强大的功能足以胜任，但是有一些操作系统特定的功能需要用C++来实现，再由 Python调用。所以，最基础地，我们需要做到：
  1. 把Python嵌入到C++应用程序中，在C++程序中调用Python函数和获得变量的值；
  2. 用C++为Python编写扩展模块(动态链接库)，在Python程序中调用C++开发的扩展功能函数。

常用的Python/C API介绍

下面是例子中用到的几个Python/C API的简要介绍及示例代码。注意，这并不是这些函数的详细介绍，而仅仅是我们所用到的功能简介，更详细内容请参考文档[1]、[2]、[3]、[4]。
打开Microsoft Visual Studio .NET 2003，新建一个控制台程序
  1. #include

并在main函数里加入示例代码。
  1. //先定义一些变量
  3. char *cstr;
  4. PyObject *pstr, *pmod, *pdict;
  5. PyObject *pfunc, *pargs;

1. void Py_Initialize( )

初始化Python解释器，在C++程序中使用其它Python/C API之前，必须调用此函数，如果调用失败，将产生一个致命的错误。例：
  1. Py_Initialize();

2. int PyRun_SimpleString( const char *command)

执行一段Python代码，就好象是在__main__ 函数里面执行一样。例：
  1. PyRun_SimpleString("from time import time,ctime "
  2. "print ''Today is'',ctime(time()) ");

3. PyObject* PyImport_ImportModule( char *name)

导入一个Python模块，参数name可以是*.py文件的文件名。相当于Python内建函数__import__()。例：
  1. pmod = PyImport_ImportModule("mymod"); //mymod.py

4. PyObject* PyModule_GetDict( PyObject *module)

相当于Python模块对象的__dict__ 属性，得到模块名称空间下的字典对象。例：
  1. pdict = PyModule_GetDict(pmod);

5. PyObject* PyRun_String( const char *str, int start, PyObject *globals, PyObject *locals)

执行一段Python代码。
  1. pstr = PyRun_String("message", Py_eval_input, pdict, pdict);

6. int PyArg_Parse( PyObject *args, char *format, ...)

解构Python数据为C的类型，这样C程序中才可以使用Python里的数据。例：
  1. /* convert to C and print it*/
  2. PyArg_Parse(pstr, "s", &cstr);
  3. printf("%s ", cstr);

7. PyObject* PyObject_GetAttrString( PyObject *o, char *attr_name)

返回模块对象o中的attr_name 属性或函数，相当于Python中表达式语句：o.attr_name。例：
  1. /* to call mymod.transform(mymod.message) */
  2. pfunc = PyObject_GetAttrString(pmod, "transform");

8. PyObject* Py_BuildValue( char *format, ...)

构建一个参数列表，把C类型转换为Python对象，使Python可以使用C类型数据，例：
  1. cstr="this is hjs''s test, to uppercase";
  2. pargs = Py_BuildValue("(s)", cstr);

9. PyEval_CallObject(PyObject* pfunc, PyObject* pargs)

此函数有两个参数，都指向Python对象指针，pfunc是要调用的Python 函数，通常可用PyObject_GetAttrString()获得；pargs是函数的参数列表，通常可用Py_BuildValue()构建。例：
  1. pstr = PyEval_CallObject(pfunc, pargs);
  2. PyArg_Parse(pstr, "s", &cstr);
  3. printf("%s ", cstr);

10. void Py_Finalize( )

关闭Python解释器，释放解释器所占用的资源。例：
  1. Py_Finalize();


Python2.4环境没有提供调试版本的Python24d.lib，所以上述示例在release模式下编译。编译完成后，把可行文件和附2给出的 mymod.py文件放在一起，再点击即可运行。为了简化编程，附3 给出了simplepy.h。这样，调用mymod.transform变成如下形式：
  1. //#include”simplepy.h”
  2. CSimplepy py;
  3. py.ImportModule("mymod");
  4. std::string str=py.CallObject("transform",
  5. "this is hjs''s test, to uppercase");
  6. printf("%s ", str.c_str());


接下来，我们来用C++为Python编写扩展模块(动态链接库)，并在Python程序中调用C++开发的扩展功能函数。生成一个取名为pyUtil的Win32 DLL工程，除了pyUtil.cpp文件以外，从工程中移除所有其它文件，并填入如下的代码：
  1. // pyUtil.cpp
  2. #ifdef PYUTIL_EXPORTS
  3. #define PYUTIL_API __declspec(dllexport)
  4. #else
  5. #define PYUTIL_API __declspec(dllimport)
  6. #endif
  8. #include
  9. #include
  10. #include
  11. BOOL APIENTRY DllMain( HANDLE hModule,
  12. DWORD ul_reason_for_call,
  13. LPVOID lpReserved
  14. ?)
  15. {
  16. switch (ul_reason_for_call)
  17. {
  18. case DLL_PROCESS_ATTACH:
  19. case DLL_THREAD_ATTACH:
  20. case DLL_THREAD_DETACH:
  21. case DLL_PROCESS_DETACH:
  22. break;
  23. }
  24. return TRUE;
  25. }
  26. std::string Recognise_Img(const std::string url)
  27. {
  28. //返回结果
  29. return "从dll中返回的数据... : " +url;
  30. }
  31. static PyObject* Recognise(PyObject *self, PyObject *args)
  32. {
  33. const char *url;
  34. std::string sts;
  35. if (!PyArg_ParseTuple(args, "s", &url))
  36. return NULL;
  37. sts = Recognise_Img(url);
  38. return Py_BuildValue("s", sts.c_str() );
  39. }
  40. static PyMethodDef AllMyMethods[] = {
  41. {"Recognise", Recognise, METH_VARARGS},//暴露给Python的函数
  42. {NULL, NULL} /* Sentinel */
  43. };
  44. extern "C" PYUTIL_API void initpyUtil()
  45. {
  46. PyObject *m, *d;
  47. m = Py_InitModule("pyUtil", AllMyMethods); //初始化本模块，并暴露函数
  48. d = PyModule_GetDict(m);
  49. }


在Python代码中调用这个动态链接库：
  1. import pyUtil
  2. result = pyUtil.Recognise("input url of specific data")
  3. print "the result is: "+ result

用C++为Python写扩展时，如果您愿意使用Boost.Python库的话，开发过程会变得更开心J，要编写一个与上述pyUtil同样功能的动态 链接库，只需把文件内容替换为下面的代码。当然，编译需要boost_python.lib支持，运行需要boost_python.dll支持。
  1. #include
  2. #include
  3. using namespace boost::python;
  4. #pragma comment(lib, "boost_python.lib")
  5. std::string strtmp;
  6. char const* Recognise(const char* url)
  7. {
  8. strtmp ="从dll中返回的数据... : ";
  9. strtmp+=url;
  10. return strtmp.c_str();
  11. }
  12. BOOST_PYTHON_MODULE(pyUtil)
  13. {
  14. def("Recognise", Recognise);
  15. }


所有示例都在Microsoft Windows XP Professional + Microsoft Visual Studio .NET 2003 + Python2.4环境下测试通过，本文所用的Boost库为1.33版本。

参考资料

  1. Python Documentation Release 2.4.1. 2005.3.30，如果您以默认方式安装了Python2.4，那么该文档的位置在C:\Program Files\Python24\Doc\Python24.chm；
  2. Michael Dawson. Python Programming for the Absolute Beginner. Premier Press. 2003；
  3. Mark Lutz. Programming Python, 2nd Edition. O''Reilly. 2001.3 ；
  4. Mark Hammond, Andy Robinson. Python Programming on Win32. O''Reilly. 2000.1 ；
Python主页：http://www.python.org；
Boost库主面：www.boost.org；

附1 text.txt

this is test text in text.txt.

附2 mymod.py

  1. import string
  2. message = ''original string''
  3. message =message+message
  4. msg_error=""
  5. try:
  6. text_file = open("text.txt", "r")
  7. whole_thing = text_file.read()
  8. print whole_thing
  9. text_file.close()
  10. except IOError, (errno, strerror):
  11. print "I/O error(%s): %s" % (errno, strerror)
  12. def transform(input):
  13. #input = string.replace(input, ''life'', ''Python'')
  14. return string.upper(input)
  15. def change_msg(nul):
  16. global message #如果没有此行，message是函数里头的局部变量
  17. message=''string changed''
  18. return message
  19. def r_file(nul):
  20. return whole_thing
  21. def get_msg(nul):
  22. return message

附3 simplepy.h

  1. #ifndef _SIMPLEPY_H_
  2. #define _SIMPLEPY_H_
  3. // simplepy.h v1.0
  4. // Purpose: facilities for Embedded Python.
  5. // by hujinshan @2005年9月2日9:13:02
  6. #include
  7. using std::string;
  8. #include
  9. //--------------------------------------------------------------------
  10. // Purpose: ease the job to embed Python into C++ applications
  11. // by hujinshan @2005年9月2日9:13:18
  12. //--------------------------------------------------------------------
  13. class CSimplepy // : private noncopyable
  14. {
  15. public:
  16. ///constructor
  17. CSimplepy()
  18. {
  19. Py_Initialize();
  20. pstr=NULL, pmod=NULL, pdict=NULL;
  21. pfunc=NULL, pargs=NULL;
  22. }
  23. ///destructor
  24. virtual ~CSimplepy()
  25. {
  26. Py_Finalize();
  27. }
  28. ///import the user module
  29. bool ImportModule(const char* mod_name)
  30. {
  31. try{
  32. pmod = PyImport_ImportModule(const_cast(mod_name));
  33. if(pmod==NULL)
  34. return false;
  35. pdict = PyModule_GetDict(pmod);
  36. }
  37. catch(...)
  38. {
  39. return false;
  40. }
  41. if(pmod!=NULL && pdict!=NULL)
  42. return true;
  43. else
  44. return false;
  45. }
  46. ///Executes the Python source code from command in the __main__ module.
  47. ///If __main__ does not already exist, it is created.
  48. ///Returns 0 on success or -1 if an exception was raised.
  49. ///If there was an error, there is no way to get the exception information.
  50. int Run_SimpleString(const char* str)
  51. {
  52. return PyRun_SimpleString(const_cast(str) );
  53. }
  54. ///PyRun_String("message", Py_eval_input, pdict, pdict);
  55. ///Execute Python source code from str in the context specified by the dictionaries globals.
  56. ///The parameter start specifies the start token that should be used to parse the source code.
  57. ///Returns the result of executing the code as a Python object, or NULL if an exception was raised.
  58. string Run_String(const char* str)
  59. {
  60. char *cstr;
  61. pstr = PyRun_String(str, Py_eval_input, pdict, pdict);
  62. if(pstr==NULL)
  63. throw ("when Run_String, there is an exception was raised by Python environment.");
  64. PyArg_Parse(pstr, "s", &cstr);
  65. return string(cstr);
  66. }
  67. ///support olny one parameter for python function, I think it''s just enough.
  68. string CallObject(const char* func_name, const char* parameter)
  69. {
  70. pfunc=NULL;
  71. pfunc = PyObject_GetAttrString(pmod, const_cast(func_name));
  72. if(pfunc==NULL)
  73. throw (string("do not found in Python module for: ")
  74. +func_name).c_str();
  75. char* cstr;
  76. pargs = Py_BuildValue("(s)", const_cast(parameter));
  77. pstr = PyEval_CallObject(pfunc, pargs);
  78. if(pstr==NULL)
  79. throw ("when PyEval_CallObject, there is an exception was raised by Python environment");
  80. PyArg_Parse(pstr, "s", &cstr);
  81. return string(cstr);
  82. }
  83. //PyObject *args;
  84. //args = Py_BuildValue("(si)", label, count); /* make arg-list */
  85. //pres = PyEval_CallObject(Handler, args);
  86. protected:
  87. PyObject *pstr, *pmod, *pdict;
  88. PyObject *pfunc, *pargs;
  89. };
  90. #endif // _SIMPLEPY_H_
  91. // end of file

没有评论:

发表评论

订阅： 博文评论 (Atom)