如何在C++代码中捕获Python标准输出
我有一个程序，在运行过程中有时需要调用Python来执行一些任务。我需要一个函数来调用Python，并且捕获Python的输出，然后把这些输出放到一个文件里。这是这个函数的声明。
pythonCallBackFunc(const char* pythonInput)
我遇到的问题是如何捕获给定命令的所有Python输出（pythonInput）。我对Python的API没有经验，不知道该用什么方法来做到这一点。我尝试的第一件事是使用Py_run_SimpleString来重定向Python的标准输出和错误输出，这是我写的一些代码示例。
#include "boost\python.hpp"
#include <iostream>
void pythonCallBackFunc(const char* inputStr){
PyRun_SimpleString(inputStr);
}
int main () {
...
//S0me outside functions does this
Py_Initialize();
PyRun_SimpleString("import sys");
PyRun_SimpleString("old_stdout = sys.stdout");
PyRun_SimpleString("fsock = open('python_out.log','a')");
PyRun_SimpleString("sys.stdout = fsock");
...
//my func
pythonCallBackFunc("print 'HAHAHAHAHA'");
pythonCallBackFunc("result = 5");
pythonCallBackFunc("print result");
pythonCallBackFunc("result = 'Hello '+'World!'");
pythonCallBackFunc("print result");
pythonCallBackFunc("'KUKU '+'KAKA'");
pythonCallBackFunc("5**3");
pythonCallBackFunc("prinhghult");
pythonCallBackFunc("execfile('stdout_close.py')");
...
//Again anothers function code
PyRun_SimpleString("sys.stdout = old_stdout");
PyRun_SimpleString("fsock.close()");
Py_Finalize();
return 0;
}
有没有更好的方法来实现这个呢？另外，由于某种原因，当PyRun_SimpleString接收到一些数学表达式时，它似乎没有任何反应，比如PyRun_SimpleString("5**3")什么都不打印（而在Python控制台上会打印出结果：125）。
也许这很重要，我正在使用Visual Studio 2008。谢谢，
Alex
根据Mark的建议，我做了一些修改：
#include <python.h>
#include <string>
using namespace std;
void PythonPrinting(string inputStr){
string stdOutErr =
"import sys\n\
class CatchOut:\n\
def __init__(self):\n\
self.value = ''\n\
def write(self, txt):\n\
self.value += txt\n\
catchOut = CatchOut()\n\
sys.stdout = catchOut\n\
sys.stderr = catchOut\n\
"; //this is python code to redirect stdouts/stderr
PyObject *pModule = PyImport_AddModule("__main__"); //create main module
PyRun_SimpleString(stdOutErr.c_str()); //invoke code to redirect
PyRun_SimpleString(inputStr.c_str());
PyObject *catcher = PyObject_GetAttrString(pModule,"catchOut");
PyObject *output = PyObject_GetAttrString(catcher,"value");
printf("Here's the output: %s\n", PyString_AsString(output));
}
int main(int argc, char** argv){
Py_Initialize();
PythonPrinting("print 123");
PythonPrinting("1+5");
PythonPrinting("result = 2");
PythonPrinting("print result");
Py_Finalize();
return 0;
}
我在运行主程序后得到的输出是：
Here's the output: 123
Here's the output:
Here's the output:
Here's the output: 2
这对我来说很好，但只有一个问题，它应该是
Here's the output: 123
Here's the output: 6
Here's the output:
Here's the output: 2
我不知道为什么，但在运行这个命令：PythonPrinting("1+5")后，PyString_AsString(output)命令返回的是一个空字符串（char*），而不是6... :( 有没有什么办法可以不丢失这个输出呢？
谢谢，
Alex
3 个回答
5
我知道这个问题已经很久了，但其中有一部分问题还没有得到解答：
“如何捕获那些不直接写入Python标准输出的命令的输出，比如：1+1？”
以下是步骤（适用于Python 3.4）：
使用Mark的解决方案，将标准输出和标准错误重定向到一个Python变量中：https://stackoverflow.com/a/4307737/1046299
从Python源代码中复制函数
PyRun_InteractiveOneObject(FILE *fp, PyObject *filename, PyCompilerFlags *flags)。这个函数在文件pythonrun.c中。修改
PyRun_InteractiveOneObject的函数名和参数，使得新函数的第一个参数变为const char*（你的命令），而不是FILE*。然后在函数实现中，你需要使用PyParser_ASTFromStringObject，而不是PyParser_ASTFromFileObject。注意，你需要从Python中直接复制函数run_mod，因为它在这个函数中被调用。用你的命令调用新函数，比如
1+1。此时，标准输出应该会显示结果2。
33
这是我最近开发的一个适合C++的解决方案。
我在我的博客上解释了一些细节：在C++中重定向Python的sys.stdout，在那儿我还指向了我的GitHub仓库，里面有最新版本的代码。
以下是一个完整的例子，基于我在回答这个问题时的当前代码：
#include <functional>
#include <iostream>
#include <string>
#include <Python.h>
namespace emb
{
typedef std::function<void(std::string)> stdout_write_type;
struct Stdout
{
PyObject_HEAD
stdout_write_type write;
};
PyObject* Stdout_write(PyObject* self, PyObject* args)
{
std::size_t written(0);
Stdout* selfimpl = reinterpret_cast<Stdout*>(self);
if (selfimpl->write)
{
char* data;
if (!PyArg_ParseTuple(args, "s", &data))
return 0;
std::string str(data);
selfimpl->write(str);
written = str.size();
}
return PyLong_FromSize_t(written);
}
PyObject* Stdout_flush(PyObject* self, PyObject* args)
{
// no-op
return Py_BuildValue("");
}
PyMethodDef Stdout_methods[] =
{
{"write", Stdout_write, METH_VARARGS, "sys.stdout.write"},
{"flush", Stdout_flush, METH_VARARGS, "sys.stdout.flush"},
{0, 0, 0, 0} // sentinel
};
PyTypeObject StdoutType =
{
PyVarObject_HEAD_INIT(0, 0)
"emb.StdoutType", /* tp_name */
sizeof(Stdout), /* tp_basicsize */
0, /* tp_itemsize */
0, /* tp_dealloc */
0, /* tp_print */
0, /* tp_getattr */
0, /* tp_setattr */
0, /* tp_reserved */
0, /* tp_repr */
0, /* tp_as_number */
0, /* tp_as_sequence */
0, /* tp_as_mapping */
0, /* tp_hash */
0, /* tp_call */
0, /* tp_str */
0, /* tp_getattro */
0, /* tp_setattro */
0, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT, /* tp_flags */
"emb.Stdout objects", /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
0, /* tp_weaklistoffset */
0, /* tp_iter */
0, /* tp_iternext */
Stdout_methods, /* tp_methods */
0, /* tp_members */
0, /* tp_getset */
0, /* tp_base */
0, /* tp_dict */
0, /* tp_descr_get */
0, /* tp_descr_set */
0, /* tp_dictoffset */
0, /* tp_init */
0, /* tp_alloc */
0, /* tp_new */
};
PyModuleDef embmodule =
{
PyModuleDef_HEAD_INIT,
"emb", 0, -1, 0,
};
// Internal state
PyObject* g_stdout;
PyObject* g_stdout_saved;
PyMODINIT_FUNC PyInit_emb(void)
{
g_stdout = 0;
g_stdout_saved = 0;
StdoutType.tp_new = PyType_GenericNew;
if (PyType_Ready(&StdoutType) < 0)
return 0;
PyObject* m = PyModule_Create(&embmodule);
if (m)
{
Py_INCREF(&StdoutType);
PyModule_AddObject(m, "Stdout", reinterpret_cast<PyObject*>(&StdoutType));
}
return m;
}
void set_stdout(stdout_write_type write)
{
if (!g_stdout)
{
g_stdout_saved = PySys_GetObject("stdout"); // borrowed
g_stdout = StdoutType.tp_new(&StdoutType, 0, 0);
}
Stdout* impl = reinterpret_cast<Stdout*>(g_stdout);
impl->write = write;
PySys_SetObject("stdout", g_stdout);
}
void reset_stdout()
{
if (g_stdout_saved)
PySys_SetObject("stdout", g_stdout_saved);
Py_XDECREF(g_stdout);
g_stdout = 0;
}
} // namespace emb
int main()
{
PyImport_AppendInittab("emb", emb::PyInit_emb);
Py_Initialize();
PyImport_ImportModule("emb");
PyRun_SimpleString("print(\'hello to console\')");
// here comes the ***magic***
std::string buffer;
{
// switch sys.stdout to custom handler
emb::stdout_write_type write = [&buffer] (std::string s) { buffer += s; };
emb::set_stdout(write);
PyRun_SimpleString("print(\'hello to buffer\')");
PyRun_SimpleString("print(3.14)");
PyRun_SimpleString("print(\'still talking to buffer\')");
emb::reset_stdout();
}
PyRun_SimpleString("print(\'hello to console again\')");
Py_Finalize();
// output what was written to buffer object
std::clog << buffer << std::endl;
}
这个方法可以让你用任何可以调用的C++实体来拦截sys.stdout.write的输出，比如自由函数、类的成员函数、命名的函数对象，甚至是像上面例子中使用的C++11的lambda表达式。
需要注意的是，这只是一个最简单的例子，用来展示基本概念。在实际的生产代码中，肯定需要更多的关注，比如对PyObject的引用计数、消除全局状态等等。
24
如果我理解你的问题没错的话，你是想把程序输出的内容（标准输出和错误输出）存到一个变量里，对吧？你可以通过把这些输出重定向到一个Python变量中，然后再把这个变量的内容引入到你的C++程序里。请注意，我下面的代码没有做正确的引用计数：
#include <Python.h>
#include <string>
int main(int argc, char** argv)
{
std::string stdOutErr =
"import sys\n\
class CatchOutErr:\n\
def __init__(self):\n\
self.value = ''\n\
def write(self, txt):\n\
self.value += txt\n\
catchOutErr = CatchOutErr()\n\
sys.stdout = catchOutErr\n\
sys.stderr = catchOutErr\n\
"; //this is python code to redirect stdouts/stderr
Py_Initialize();
PyObject *pModule = PyImport_AddModule("__main__"); //create main module
PyRun_SimpleString(stdOutErr.c_str()); //invoke code to redirect
PyRun_SimpleString("print(1+1)"); //this is ok stdout
PyRun_SimpleString("1+a"); //this creates an error
PyObject *catcher = PyObject_GetAttrString(pModule,"catchOutErr"); //get our catchOutErr created above
PyErr_Print(); //make python print any errors
PyObject *output = PyObject_GetAttrString(catcher,"value"); //get the stdout and stderr from our catchOutErr object
printf("Here's the output:\n %s", PyString_AsString(output)); //it's not in our C++ portion
Py_Finalize();
return 0;
}