小C和小派的缠绵爱情——C语言调用Python代码

我妒忌你的开源，你眼红我的速度，不如我们就在一起吧！ --------SJ2050

2019.4.9号更新：实现在未安装python环境的机子上运行调用了python程序的C语言代码！

文章目录

• 环境搭建
• 代码讲解
• 引用计数
• 特别说明
• 参考资料

 
 

---

环境搭建

       这篇教程基于的实验环境为VS2017+python3.5.0，所以我们首先来进行一些前期准备使得小C能认识小派（做个媒婆），说白了就是VS中第三方库的配置过程，我在这篇文章中已有详细图文介绍?两分钟搞定VS下第三方库的配置?。这里我们只强调一下不同点：

---

代码讲解

       虽然网上已有不少的C语言调用python代码的实例了，但大多是抄来抄去，比较难以理解，而且前期铺垫了很多，代码部分就被带过了，让读者很苦恼，这也是我写这篇文章的缘由。我们首先来看一下我们将要调用的python的代码，很简单的一个函数：

# -*- coding: utf-8 -*-
# this function will return "I Love you,***"

def express_love(name):
	return 'I Love you,%s!'%name,

我相信，既然你在找到了这篇文章，你一定是对C和python有一定的了解，上面的python函数不过是传入一个参数，然后打印出一句肉麻的话来。接下来我们着重看一下C的代码：

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

int main()
{
	// variable declarations of PyObject type
	PyObject *pModule, *pFunc;
	PyObject *pArgs, *pValue;
	char* saying;

	// initialize the running environment
	Py_Initialize();

	//import python scripts
	pModule = PyImport_ImportModule("iloveyou");

	// error checking of pModule left out
	if (pModule){
		// get the specific function in python scripts
		pFunc = PyObject_GetAttrString(pModule, "express_love"); 

		if (pFunc && PyCallable_Check(pFunc)) {
			// create a tuple variable of python
			pArgs = PyTuple_New(1);
			PyTuple_SetItem(pArgs, 0, Py_BuildValue("s","小 C"));
			
			if (pArgs) {
				pValue = PyObject_CallObject(pFunc,pArgs);
				
				if (!pValue) {
					// pValue error
					PyErr_Print();
					return -1;
				}

				// convert python variables to C variables
				if (PyArg_ParseTuple(pValue, "s", &saying)) {
					printf("小派对小C说：%s
", saying);
					Py_XDECREF(pValue);
				}
				else {
					// convertion fails
					PyErr_Print();
					return -1;
				}
				Py_XDECREF(pArgs);
			}
			else {
				// pArgs error
				PyErr_Print();
				return -1;
			}
			Py_XDECREF(pFunc);		
		}
		else {
			// pFunc error
			PyErr_Print();
			return -1;
		}
		Py_XDECREF(pModule);
	}
	else {
		// pModule error
		PyErr_Print();
		return -1;
	}

	// end the environment
	Py_Finalize();
	
	system("pause");
	return 0;
}

C的代码乍一眼看起来很长，很吓人的样子，只不过是注释比较多，还有很多错误检测的代码罢了，实际工作的代码少的可怜，接下来我们逐部分分析这段代码：

0. 标准的C语言的框架，唯一要提醒的是这里我们要导入Python的头文件，这样我们才能使用python给我们准备的一些函数和数据结构呀！

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

int main()
{
	//....
	system("pause");
	return 0;
}

1. PyObject是个结构体，是所有python变量的基类，可以简单当作个智能类型，其内部会自动转换。这里声明的变量都使用了指针类型，无指针不C呀！

// variable declarations of PyObject type
   PyObject *pModule, *pFunc;
   PyObject *pArgs, *pValue;
   char* saying

2. 因为要调用python代码，所以得初始化运行环境（原生态的小C不认识小派呀）。

// initialize the running environment
   Py_Initialize();

3. PyImport_ImportModule()函数是导入我们要调用的python代码，其传入参数是python文件名，然后我们 把该文件名的python代码放在和可执行文件(.exe)同一个文件夹下

//import python scripts
   pModule = PyImport_ImportModule("iloveyou");

4. 这个选择语句检查导入python文件是否成功，若不成功，其会返回NULL，即执行else中的语句，PyErr_Print()函数会把错误信息打印出来。

// error checking of pModule left out
	if (pModule){
		//...
	}
	else {
		// pModule error
		PyErr_Print();
		return -1;
	}

5. PyObject_GetAttrString()函数可以获得导入python模块的指定属性和方法，这里我们导入python代码中的函数express_love。

	// get the specific function in python scripts
		pFunc = PyObject_GetAttrString(pModule, "express_love"); 

6. 检查导入python属性是否成功，且能否调用（即是否为函数），else部分中的语句之前已提到过。

		if (pFunc && PyCallable_Check(pFunc)) {
			//...
		}
		else {
			// pFunc error
			PyErr_Print();
			return -1;
		}

7. PyTuple_New()函数可以创建一个python中的元组类型，传入的参数可以指定这个元组的大小。接下来的PyTuple_SetItem()函数可以为元组赋值，其第一个参数是元组类型的变量，第二个参数是要赋值的下标，第三个参数是python的变量，可以是任何python的变量类型。所以，我们需要Py_BuildVaule()这个函数可以创建python变量，这个函数的用法很类似C中的printf，第一个参数是格式化参数，第二个是C字符串，这里的s表示我们要创建一个python中的字符串。

    pArgs = PyTuple_New(1);
    PyTuple_SetItem(pArgs, 0, Py_BuildValue("s","小 C"));

8. 检查创建python中的变量是否成功。<./font>

				if (pArgs) {
					//...
				}
				else {
					// convertion fails
					PyErr_Print();
					return -1;
				}

9. PyObject_CallObject()是调用python代码中的函数，第二个参数是传给函数的参数，注意，这个参数一定得为python的元组类型，这个参数一定得为python的元组类型，这个参数一定得为python的元组类型。执行后，这个函数会返回指向return结果的PyObject指针。

pValue = PyObject_CallObject(pFunc,pArgs);

10. 检查调用python代码中的函数是否出错。

	if (!pValue) {
					// pValue error
					PyErr_Print();
					return -1;
				}

11. PyArg_ParseTuple()函数会将python变量转化为C变量，用法和fprintf()比较类似，如果转化不成功，这个函数会返回NULL，这里我们也得注意，其第一个参数得为python的元组类型，第一个参数得为python的元组类型，第一个参数得为python的元组类型。

   			 // convert python variables to C variables
   			if (PyArg_ParseTuple(pValue, "s", &saying)) {
   				printf("小派对小C说：%s
", saying);
   			}
   			else {
   				// convertion fails
   				PyErr_Print();
   				return -1;
   			}

12. 最后我们结束并清理python的运行环境。

	// end the environment
   Py_Finalize();

这样子，我相信你对这段代码应该是没有疑惑了。

---

引用计数

       细心的小朋友可能会发现，在讲解代码过程中，有个函数一直被漏掉了——Py_XDECREF()。这个是干嘛的呢，这还得从python的引用计数的机制说起。众所周知，python很智能，即使我们打开文件后未显示调用close，但python的解释器也会适时去关闭它，这若是搁C这，就引发内存泄露了。那么python是怎么知道哪些变量是可以销毁，哪些不是呢？这就用到了引用计数机制，python对象中记录了其被引用了多少次，当引用次数为0时，也就是其不备任何python变量引用，则python解释器就会将其销毁。PyObject结构体中的有一个变量就记录了引用的次数（好期的朋友可以在VS中查看其定义）。一般情况下，引用的增加和减少在我们调用函数过程中会自动完成，但有时候我们也可以显性地来增加和减少引用，例如Py_XINCREF()，Py_XDECREF()(有人问为啥不用Py_INCREF()和Py_DECREF()，因为加个X可以不管参数是否为NULL)。
       如何正确且合理地应用好引用计数是项高难度地技术活，这里我们不详细展开了，我找了一篇我认为比较好的相关文章?Python基础30-面向对象(内存管理机制-引用计数/垃圾回收/循环引用/弱引用)?。

---

特别说明

       上面这段代码在VS运行中会在return部分报错，请教了几位大神，尚不清楚问题所在，如果你知道的话，麻烦告诉我一下。但我们直接去运行编译生成的可执行的文件(.exe)的话，倒是一切正常。我将这段代码在codeblocks编译后运行也一切正常，VS太强大，我也搞不清楚他在想啥。
       **如果想让可执行文件运行在别人的电脑上装X的话，那么务必请确保别人的电脑也安装了python，且版本和你电脑上的python相同，不然的话就会报找不到相应dll的错误。最后，我们来看一下最终这个可执行文件运行的效果： **

       如果想在不安装python环境的机子上运行该程序，就得将python35.dll(根据版本选择)以及整个Lib库拷贝到与exe同级目录下（整个Lib文件夹显得有点大，如果你知道这个程序中具体调用了哪些库，完全可以复制那几个库，但我强烈建议不要自找麻烦），上张图便能说明一切：

 
 
 
 
 
 
 
 
 
 

参考资料

1、《python3.5.0帮助文档》
2、《python高级编程（第二版）》