devbox
花生_TL007
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

C++使用Python/C API_python c++ api

作者：花生_TL007 | 2024-04-10 21:34:30

赞

踩

python c++ api

目录

配置环境

第一步 导入Python3路径

第二步 测试环境

 运行例程

1. 直接运行Python代码段

2. 运行Python脚本

3. 导入Python模块，调用Python函数

4. 调用Python类

参考资料

配置环境

环境：Windows10、Visual Studio 2019、Python3.x

打开VS，建立空项目。

第一步 导入Python3路径

1. 项目→属性→C/C++→常规→附加包含目录，添加Python3安装路径\include。

该文件夹下有Python.h，这就是C++调用Python的API前一定要include的库。

 2.  项目→属性→VC++目录→库目录，添加Python3安装路径\libs。

 3. 项目→属性→链接器→输入→附加依赖项，添加Python3安装路径\libs\python39.lib。（如果Python版本是3.7则可以写python37.lib，以此类推）

4. 检查版本： 检查一下自己下载的Python是x86还是x64版本的，如果与VS版本不一致，可以在VS窗口上方调整项目版本。

第二步 测试环境

这是一个简单的helloworld程序。如果能够成功运行，则可以直接进入下一节。

  1. #include <Python.h>
  2.  
  3. int main(int argc, char* argv[])
  4. {
  5. 	Py_Initialize();
  6. 	PyRun_SimpleString("print('Hello, world!')");
  7. 	Py_Finalize();
  8. 	return 0;
  9. }

 运行结果：

如果出现错误：LINK : fatal error LNK1104: 无法打开文件“python39_d.lib”，则说明没有安装Python的Debug功能，需要为Python增加Debug功能。增加方法如下图：

（注：针对该错误，除了本文中提到的方法，网上还有其它办法可供选择：扩展Python模块系列(一)----开发环境配置 - 建木 - 博客园 (cnblogs.com)。）

 运行例程

C++调用Python的结构都如下：

  1. #include <Python.h>
  2.  
  3. int main(int argc, char* argv[])
  4. {
  5. 	Py_Initialize(); //初始化
  6.  
  7.     //... ...
  8.  
  9. 	Py_Finalize(); //结束，释放资源
  10.  
  11. 	return 0;
  12. }

注：下文仅包含C++运行或调用Python代码段、脚本、函数、类的基本方法，不包含进阶用法。

考虑到便利性，也由于其在 Python 解释器中被广泛使用， "Python.h" 还包含了一些标准头文件: <stdio.h> ， <string.h> ， <errno.h> 和 <stdlib.h> 。 如果后面的头文件在你的系统上不存在，它还会直接声明函数 malloc () ， free () 和 realloc () 。

——Python官方文档

1. 直接运行Python代码段

  1. #include <Python.h>
  2.  
  3. int main(int argc, char* argv[])
  4. {
  5. 	Py_Initialize(); 
  6.  
  7. 	PyRun_SimpleString("print('Hello from Python string')");
  8.  
  9. 	Py_Finalize(); 
  10. 	return 0;
  11. }

2. 运行Python脚本

源目录下helloScript.py：

print("Hello from Python script")

C++：

  1. //my_python.c
  2. #include <Python.h>
  3.  
  4. int main(int argc, char* argv[])
  5. {
  6. 	Py_Initialize(); 
  7.  
  8. 	PyObject* obj = Py_BuildValue("s", "helloScript.py");
  9. 	FILE* file = _Py_fopen_obj(obj, "r+");
  10. 	if (file != NULL)
  11. 	{
  12. 		PyRun_SimpleFile(file, "helloScript.py");
  13. 	}
  14.  
  15. 	Py_Finalize(); 
  16. 	return 0;
  17. }

3. 导入Python模块，调用Python函数

源目录下hello.py：

  1. def Hello():
  2.     print("Hello from Python module")
  3.  
  4. def Add(a, b):
  5.     print ("Add function: ", end="")
  6.     print (str(a) + " + " + str(b) + " = " + str(a+b))
  7.     return a + b

C++：

  1. #include <Python.h>
  2.  
  3. int main(int argc, char* argv[])
  4. {
  5. 	Py_Initialize(); 
  6.  
  7. 	//必须修改Python路径，否则会找不到Python模块
  8.     PyRun_SimpleString("import sys");
  9. 	PyRun_SimpleString("sys.path.append('./')");
  10.  
  11. 	PyObject* pModule = NULL;
  12. 	PyObject* pFunc = NULL;
  13.  
  14.     //import模块
  15. 	pModule = PyImport_ImportModule("hello");//模块文件名
  16.     //找不到模块则报错
  17. 	if (pModule == nullptr) {
  18. 		PyErr_Print();
  19. 		Py_Finalize();
  20. 		return 0;
  21. 	}
  22.  
  23.     //1. 调用不带参数的函数 Hello()
  24. 	pFunc = PyObject_GetAttrString(pModule, "Hello");//函数名
  25. 	PyObject_CallFunction(pFunc, NULL);//调用函数
  26.  
  27. 	//2. 调用带参数的函数 Add(a, b)
  28.     PyObject* pAdd = NULL;
  29. 	PyObject* args = NULL;
  30. 	pAdd = PyObject_GetAttrString(pModule, "Add");
  31. 	args = Py_BuildValue("(ii)", 123, 456); //设置传入Add的参数
  32. 	PyObject* pRet = PyObject_CallObject(pAdd, args); //pRet = Add(123, 456)
  33.  
  34. 	//输出返回值
  35.     int ans = 0;
  36. 	PyArg_Parse(pRet, "i", &ans);//返回类型转换
  37. 	printf("Return C++: ans = %d\n", ans);
  38.  
  39. 	Py_Finalize(); 
  40.  
  41. 	return 0;
  42. }

4. 调用Python类

注：调用类中方法的API不止一套，建议去官网看看，并且建议使用Python3.9版本以上才支持的API，那些API对类的支持更好，不容易出现需要手动加入Python类的self参数的问题。

源目录下helloClass.py：

  1. class myClass:
  2.     welcome = "Hello from Python class attribute"
  3.  
  4.     def hello(self):
  5.         print("Hello from Python class method")
  6.  
  7.     def minus(self, a, b):
  8.         print(str(a) + " - " + str(b) + " = " + str(a-b))
  9.         return a-b

C++：

（1）Python3.9以下可用：

  1. #include <Python.h>
  2.  
  3. int main(int argc, char* argv[])
  4. {
  5. 	Py_Initialize(); 
  6.  
  7. 	//必须修改Python路径，否则会找不到Python模块
  8.     PyRun_SimpleString("import sys");
  9. 	PyRun_SimpleString("sys.path.append('./')");
  10.  
  11. 	PyObject* pModule2 = NULL;
  12. 	PyObject* pFunc2 = NULL;
  13. 	PyObject* pClass = NULL;
  14. 	PyObject* pInstance = NULL;
  15. 	PyObject* args2 = NULL;
  16.  
  17. 	pModule2 = PyImport_ImportModule("helloClass");//这里是要调用的文件名helloClass.py
  18. 	if (pModule2 == NULL)
  19. 	{
  20. 		PyErr_Print();
  21. 		Py_Finalize();
  22. 		return 0;
  23. 	}
  24.  
  25. 	// 模块的字典列表
  26. 	PyObject* pDict = PyModule_GetDict(pModule2);
  27. 	if (!pDict) {
  28. 		PyErr_Print();
  29. 		Py_Finalize();
  30. 		return 0;
  31. 	}
  32.  
  33. 	//从字典中获取myClass类
  34. 	PyObject* pClassCalc = PyDict_GetItemString(pDict, "myClass");
  35. 	if (!pClassCalc) {
  36. 		PyErr_Print();
  37. 		Py_Finalize();
  38. 		return 0;
  39. 	}
  40.  
  41. 	//构造实例
  42. 	PyObject* pInstanceCalc = PyInstanceMethod_New(pClassCalc);
  43. 	if (!pInstanceCalc) {
  44. 		PyErr_Print();
  45. 		Py_Finalize();
  46. 		return 0;
  47. 	}
  48.  
  49.     //获取pInstanceCalc实例的属性，转换成字符串并输出
  50. 	PyObject* obj2 = PyObject_GetAttrString(pInstanceCalc, "welcome");
  51. 	PyObject* str = PyUnicode_AsEncodedString(obj2, "utf-8", "strict");
  52. 	char* result = PyBytes_AsString(str);
  53.     printf("%s\n", result);
  54.  
  55.     //如果属性是int型，可用下面这句转换属性：
  56.     //int qwq;
  57.     //PyArg_Parse(obj2, "i", &qwq);
  58.  
  59.     //调用无参数Python方法，s和pInstanceCalc对应Python中的self
  60. 	PyObject_CallMethod(pClassCalc, "hello", "s", pInstanceCalc);
  61. 	
  62.     //调用多参数Python方法，(s,i,i)和pInstanceCalc、12、22 分别对应Python方法中的 self、a、b
  63.     pRet = PyObject_CallMethod(pClassCalc, "minus","(s,i,i)",pInstanceCalc, 12, 22);
  64. 	if (!pRet)
  65. 	{
  66. 		PyErr_Print();
  67. 		Py_Finalize();
  68. 		return 0;
  69. 	}
  70.  
  71. 	int res = 0;
  72. 	PyArg_Parse(pRet, "i", &res);//转换返回类型
  73.  
  74. 	printf("Return C++: ans = %d\n", res);
  75.  
  76.  
  77. 	Py_Finalize(); 
  78.  
  79. 	return 0;
  80. }

（2）Python3.9以上可用：

 

  1. PyObject* getClass(const char* fileName, const char* className) {
  2. 	//必须修改Python路径，否则会找不到Python模块
  3. 	PyRun_SimpleString("import sys");
  4. 	PyRun_SimpleString("sys.path.append('./')");
  5.  
  6. 	PyObject* pModule = NULL;
  7. 	PyObject* pClass = NULL;
  8. 	PyObject* pInstance = NULL;
  9.  
  10.  
  11. 	pModule = PyImport_ImportModule(fileName);
  12. 	if (pModule == NULL)
  13. 	{
  14. 		PyErr_Print();
  15. 		Py_Finalize();
  16. 		return NULL;
  17. 		//return 0;
  18. 	}
  19.  
  20. 	// 模块的字典列表
  21. 	PyObject* pDict = PyModule_GetDict(pModule);
  22. 	if (!pDict) {
  23. 		PyErr_Print();
  24. 		Py_Finalize();
  25. 		return NULL;
  26. 		//return 0;
  27. 	}
  28.  
  29. 	//从字典中获取myClass类
  30. 	pClass = PyDict_GetItemString(pDict, className);
  31. 	if (!pClass) {
  32. 		PyErr_Print();
  33. 		Py_Finalize();
  34. 		return NULL;
  35. 		//return 0;
  36. 	}
  37. 	//实例化
  38. 	pInstance = PyObject_CallObject(pClass, NULL);
  39. 	
  40. 	return pInstance;
  41. }
  42.  
  43.  
  44. int main(){
  45.     Py_Initialize();
  46.  
  47.     PyObject* pInstance = getClass("sarsaScript", "RL");
  48.  
  49. 	//调用多参数Python类方法
  50.     //cjoose_action是方法名
  51. 	PyObject* pAction = PyUnicode_FromString("choose_action");
  52.     std::string state = "state1";
  53. 	PyObject* pState = PyUnicode_FromString(state.c_str());
  54.     
  55. //参数以NULL结尾
  56. 	PyObject* pRet = PyObject_CallMethodObjArgs(pInstance, pAction, pState, NULL);
  57. 	if (!pRet)
  58. 	{
  59. 		PyErr_Print();
  60. 		Py_Finalize();
  61. 		return -1;
  62. 	}
  63.  
  64. 	int res = 0;
  65. 	PyArg_Parse(pRet, "i", &res);//转换返回类型为int
  66.  
  67.     //调用无参数Python类方法
  68.     //qwq是方法名
  69.     PyObject* pQWQ = PyUnicode_FromString("qwq");
  70.     PyObject_CallMethodNoArgs(pInstance, pQWQ);
  71.  
  72. 	Py_Finalize();
  73. 	return 0;
  74. }

把上面的四段代码整合到一起运行，控制台输出为：

参考资料

文档：

  1. 官方API文档：The Very High Level Layer — Python 3.10.11 documentation
  2. API文档中文版本：C++调用Python浅析_pyeval_callobject_magictong的博客-CSDN博客
  3. 官方使用教程：1. 在其它应用程序嵌入 Python — Python 3.7.13 文档
  4. 官方API手册：Python 中文文档 - Python/C API 参考手册 | Docs4dev

博客：

  1. 精炼：[Python]C用API与Python交互_cpython api_西北丰的博客-CSDN博客
  2. 初学：
    1. C++调用python脚本 - 知乎 (zhihu.com)
    2. [C++/Python] 如何在C++中使用一个Python类? (Use Python-defined class in C++) - Lancelod_Liu - 博客园 (cnblogs.com)
    3. c++调用python的代码、函数、类 - 简书 (jianshu.com)
  3. 细致：C语言扩展Python模块 - 随笔分类 - 建木 - 博客园 (cnblogs.com)
  4. 踩坑经验：这里要隆重的写一下C++调用python遇到的各种坑，搞了好久，终于成功了！_c++调用python initfsencoding: unable to load the fil_Darling100的博客-CSDN博客

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/花生_TL007/article/detail/401111
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号