Question

由于某些其他原因，我使用的c ++共享库将一些文本输出到标准输出。在python中，我想捕获输出并保存到变量。关于重定向标准输出有许多类似的问题，但在我的代码中不起作用。

示例：Suppressing output of module calling outside library

1 import sys
2 import cStringIO
3 save_stdout = sys.stdout
4 sys.stdout = cStringIO.StringIO()
5 func()
6 sys.stdout = save_stdout

在第5行， func（）将调用共享库，共享库生成的文本仍然输出到控制台！如果改变 func（）打印“你好”，它就可以了！

我的问题是：

如何将c ++共享库的stdout捕获到变量？
为什么使用StringIO，无法捕获共享库的输出？

Answer 1

Python的sys.stdout对象只是通常的stdout文件描述符之上的Python包装器 - 更改它只会影响Python进程，而不会影响底层文件描述符。任何非Python代码，无论是exec编辑的另一个可执行文件，还是加载的C共享库，都不会理解这一点，并将继续使用I / O的普通文件描述符。

因此，为了使共享库输出到不同的位置，您需要通过打开新的文件描述符然后使用os.dup2()替换stdout来更改基础文件描述符。您可以使用临时文件进行输出，但最好使用使用os.pipe()创建的管道。但是，如果没有任何东西正在读取管道，这就有死锁的危险，所以为了防止我们可以使用另一个线程来排空管道。

下面是一个完整的工作示例，它不使用临时文件，并且不容易出现死锁（在Mac OS X上测试过）。

C共享库代码：

// test.c
#include <stdio.h>

void hello(void)
{
  printf("Hello, world!\n");
}

编译为：

$ clang test.c -shared -fPIC -o libtest.dylib

Python驱动程序：

import ctypes
import os
import sys
import threading

print 'Start'

liba = ctypes.cdll.LoadLibrary('libtest.dylib')

# Create pipe and dup2() the write end of it on top of stdout, saving a copy
# of the old stdout
stdout_fileno = sys.stdout.fileno()
stdout_save = os.dup(stdout_fileno)
stdout_pipe = os.pipe()
os.dup2(stdout_pipe[1], stdout_fileno)
os.close(stdout_pipe[1])

captured_stdout = ''
def drain_pipe():
    global captured_stdout
    while True:
        data = os.read(stdout_pipe[0], 1024)
        if not data:
            break
        captured_stdout += data

t = threading.Thread(target=drain_pipe)
t.start()

liba.hello()  # Call into the shared library

# Close the write end of the pipe to unblock the reader thread and trigger it
# to exit
os.close(stdout_fileno)
t.join()

# Clean up the pipe and restore the original stdout
os.close(stdout_pipe[0])
os.dup2(stdout_save, stdout_fileno)
os.close(stdout_save)

print 'Captured stdout:\n%s' % captured_stdout

Answer 2

感谢nice answer Adam，我得到了这个功能。他的解决方案并不适合我的情况，因为我需要多次捕获文本，恢复和捕获文本，所以我不得不做一些相当大的改动。此外，我想让它也适用于sys.stderr（具有其他流的潜力）。

所以，这是我最终使用的解决方案（有或没有线程）：

代码

import os
import sys
import threading
import time


class OutputGrabber(object):
    """
    Class used to grab standard output or another stream.
    """
    escape_char = "\b"

    def __init__(self, stream=None, threaded=False):
        self.origstream = stream
        self.threaded = threaded
        if self.origstream is None:
            self.origstream = sys.stdout
        self.origstreamfd = self.origstream.fileno()
        self.capturedtext = ""
        # Create a pipe so the stream can be captured:
        self.pipe_out, self.pipe_in = os.pipe()

    def __enter__(self):
        self.start()
        return self

    def __exit__(self, type, value, traceback):
        self.stop()

    def start(self):
        """
        Start capturing the stream data.
        """
        self.capturedtext = ""
        # Save a copy of the stream:
        self.streamfd = os.dup(self.origstreamfd)
        # Replace the original stream with our write pipe:
        os.dup2(self.pipe_in, self.origstreamfd)
        if self.threaded:
            # Start thread that will read the stream:
            self.workerThread = threading.Thread(target=self.readOutput)
            self.workerThread.start()
            # Make sure that the thread is running and os.read() has executed:
            time.sleep(0.01)

    def stop(self):
        """
        Stop capturing the stream data and save the text in `capturedtext`.
        """
        # Print the escape character to make the readOutput method stop:
        self.origstream.write(self.escape_char)
        # Flush the stream to make sure all our data goes in before
        # the escape character:
        self.origstream.flush()
        if self.threaded:
            # wait until the thread finishes so we are sure that
            # we have until the last character:
            self.workerThread.join()
        else:
            self.readOutput()
        # Close the pipe:
        os.close(self.pipe_in)
        os.close(self.pipe_out)
        # Restore the original stream:
        os.dup2(self.streamfd, self.origstreamfd)
        # Close the duplicate stream:
        os.close(self.streamfd)

    def readOutput(self):
        """
        Read the stream data (one byte at a time)
        and save the text in `capturedtext`.
        """
        while True:
            char = os.read(self.pipe_out, 1)
            if not char or self.escape_char in char:
                break
            self.capturedtext += char

用法

使用sys.stdout，默认值为：

out = OutputGrabber()
out.start()
library.method(*args) # Call your code here
out.stop()
# Compare the output to the expected value:
# comparisonMethod(out.capturedtext, expectedtext)

使用sys.stderr：

out = OutputGrabber(sys.stderr)
out.start()
library.method(*args) # Call your code here
out.stop()
# Compare the output to the expected value:
# comparisonMethod(out.capturedtext, expectedtext)

在with块中：

out = OutputGrabber()
with out:
    library.method(*args) # Call your code here
# Compare the output to the expected value:
# comparisonMethod(out.capturedtext, expectedtext)

使用Python 2.7.6在Windows 7上进行测试，在Python 2.7.6上使用Ubuntu 12.04进行测试。

要在Python 3中工作，请更改char = os.read(self.pipe_out,1)
到char = os.read(self.pipe_out,1).decode(self.origstream.encoding)。

Answer 3

谢谢Devan！

你的代码帮助了我很多，但我在使用它时遇到了一些问题，我想在这里分享一下：

出于任何原因，您要强制停止捕获的行

self.origstream.write(self.escape_char)

不起作用。我评论了它并确保我的stdout捕获字符串包含转义字符，否则行

data = os.read(self.pipe_out, 1)  # Read One Byte Only

while循环中的

永远等待。

另一件事是用法。确保OutputGrabber类的对象是局部变量。如果使用全局对象或类属性（例如self.out = OutputGrabber（）），则在重新创建时会遇到麻烦。

这就是全部。再次谢谢你！

Answer 4

使用管道，即os.pipe。在调用您的库之前，您需要os.dup2

Answer 5

对于从Google来到这里的任何人来说，如何找到抑制共享库（dll）中的stderr / stdout输出的方法，就像我一样，我根据Adam的回答发布了下一个简单的上下文管理器：

class SuppressStream(object): 

    def __init__(self, stream=sys.stderr):
        self.orig_stream_fileno = stream.fileno()

    def __enter__(self):
        self.orig_stream_dup = os.dup(self.orig_stream_fileno)
        self.devnull = open(os.devnull, 'w')
        os.dup2(self.devnull.fileno(), self.orig_stream_fileno)

    def __exit__(self, type, value, traceback):
        os.close(self.orig_stream_fileno)
        os.dup2(self.orig_stream_dup, self.orig_stream_fileno)
        os.close(self.orig_stream_dup)
        self.devnull.close()

用法（适应亚当的示例）：

import ctypes
import sys
print('Start')

liba = ctypes.cdll.LoadLibrary('libtest.so')

with SuppressStream(sys.stdout) as guard:
    liba.hello()  # Call into the shared library

print('End')

Answer 6

从库代码中捕获stdout基本上是站不住脚的，因为这取决于你在一个环境中运行的代码。）你是在shell上而b。）没有别的内容进入你的标准。虽然您可能使在这些约束条件下工作，但如果您打算在任何意义上部署此代码，那么就无法合理地保证一致的良好行为。实际上，这个库代码以无法控制的方式打印到stdout是非常值得怀疑的。

这就是你无法做到的。你可以做的是将任何打印调用包装到你可以在子进程中执行的内容中。使用Python的subprocess.check_output，您可以在程序中从该子流程中获取stdout。缓慢，凌乱，有点生气，但另一方面，你使用的图书馆会向stdout输出有用的信息而不会将它返回......

Answer 7

更简单地说，Py library有一个StdCaptureFD可以捕获流文件描述符，从而可以捕获C / C ++扩展模块的输出（与其他答案的机制类似）。请注意，据说该库仅在维护中。

>>> import py, sys
>>> capture = py.io.StdCaptureFD(out=False, in_=False)
>>> sys.stderr.write("world")
>>> out,err = capture.reset()
>>> err
'world'

另一个值得注意的解决方案是，如果您使用的是pytest测试夹具，则可以直接使用capfd，请参见these docs。

虽然其他答案也可能很好用，但是当我在PyCharm IDE（io.UnsupportedOperation: fileno）中使用它们的代码时，却遇到了一个错误，而StdCaptureFD却很好。

在python中，如何将stdout从c ++共享库捕获到变量

7 个答案:

代码

用法