我可以将标准输出重定向到某种字符串缓冲区吗？
Posted
技术标签:
【中文标题】我可以将标准输出重定向到某种字符串缓冲区吗？【英文标题】：Can I redirect the stdout into some sort of string buffer? 【发布时间】：2010-11-16 04:16:06 【问题描述】：我正在使用python的ftplib写一个小的FTP客户端，但是包中的一些函数不返回字符串输出，而是打印到stdout。我想将stdout 重定向到一个我可以从中读取输出的对象。
我知道stdout 可以重定向到任何常规文件：
stdout = open("file", "a")
但我更喜欢不使用本地驱动器的方法。
我正在寻找类似于 Java 中的 BufferedReader 的东西，它可用于将缓冲区包装到流中。
【问题讨论】：
我认为stdout = open("file", "a") 本身不会重定向任何东西。
【参考方案1】：
from cStringIO import StringIO # Python3 use: from io import StringIO
import sys
old_stdout = sys.stdout
sys.stdout = mystdout = StringIO()
# blah blah lots of code ...
sys.stdout = old_stdout
# examine mystdout.getvalue()
【讨论】：
+1，您不需要保留对原始stdout 对象的引用，因为它始终在sys.__stdout__ 可用。见docs.python.org/library/sys.html#sys.__stdout__。
嗯，这是一场有趣的辩论。绝对原始的标准输出是可用的，但是当像这样替换时，最好像我所做的那样使用显式保存，因为其他人可能已经替换了标准输出，如果你使用 stdout，你会破坏他们的替代品。
一个线程中的这个操作会改变其他线程的行为吗？我的意思是它是线程安全的吗？
我强烈建议在 finally: 块中重新分配旧的标准输出，因此如果在两者之间出现异常，也会重新分配它。 try: bkp = sys.stdout ... ... finally: sys.stdout = bkp
如果你想在 Python 3 中使用它，请将 cStringIO 替换为 io 。【参考方案2】：
在 Python 3.4+ 中有一个contextlib.redirect_stdout() function：
import io
from contextlib import redirect_stdout
with io.StringIO() as buf, redirect_stdout(buf):
print('redirected')
output = buf.getvalue()
这是code example that shows how to implement it on older Python versions。
【讨论】：
最新的 Python 上也有redirect_stderr！
我认为没有必要为此解决方案添加 try/finally 块。【参考方案3】：
只是为了补充上面 Ned 的答案：您可以使用它来将输出重定向到 任何实现 write(str) 方法的对象。
这可以很好地用于在 GUI 应用程序中“捕获”标准输出。
这是 PyQt 中的一个愚蠢的例子：
import sys
from PyQt4 import QtGui
class OutputWindow(QtGui.QPlainTextEdit):
def write(self, txt):
self.appendPlainText(str(txt))
app = QtGui.QApplication(sys.argv)
out = OutputWindow()
sys.stdout=out
out.show()
print "hello world !"
【讨论】：
适用于我的 python 2.6 和 PyQT4。当您不知道为什么它不起作用时，对工作代码进行投票似乎很奇怪！ 别忘了加上flush()！【参考方案4】：python3 的上下文管理器：
import sys
from io import StringIO
class RedirectedStdout:
def __init__(self):
self._stdout = None
self._string_io = None
def __enter__(self):
self._stdout = sys.stdout
sys.stdout = self._string_io = StringIO()
return self
def __exit__(self, type, value, traceback):
sys.stdout = self._stdout
def __str__(self):
return self._string_io.getvalue()
这样使用：
>>> with RedirectedStdout() as out:
>>> print('asdf')
>>> s = str(out)
>>> print('bsdf')
>>> print(s, out)
'asdf\n' 'asdf\nbsdf\n'
【讨论】：
【参考方案5】：从 Python 2.6 开始，您可以使用任何实现 io 模块中的 TextIOBase API 的东西作为替代。
此解决方案还使您能够在 Python 3 中使用sys.stdout.buffer.write() 将（已经）编码的字节字符串写入标准输出（请参阅stdout in Python 3）。
那时使用StringIO 将不起作用，因为sys.stdout.encoding 和sys.stdout.buffer 都不可用。
使用 TextIOWrapper 的解决方案：
import sys
from io import TextIOWrapper, BytesIO
# setup the environment
old_stdout = sys.stdout
sys.stdout = TextIOWrapper(BytesIO(), sys.stdout.encoding)
# do something that writes to stdout or stdout.buffer
# get output
sys.stdout.seek(0) # jump to the start
out = sys.stdout.read() # read output
# restore stdout
sys.stdout.close()
sys.stdout = old_stdout
此解决方案适用于 Python 2 >= 2.6 和 Python 3。
请注意，我们的新 sys.stdout.write() 只接受 unicode 字符串，sys.stdout.buffer.write() 只接受字节字符串。
旧代码可能不是这种情况，但通常是为在 Python 2 和 3 上运行而无需更改而构建的代码的情况，这又经常使用sys.stdout.buffer。
您可以为write() 构建一个接受 unicode 和字节字符串的轻微变体：
class StdoutBuffer(TextIOWrapper):
def write(self, string):
try:
return super(StdoutBuffer, self).write(string)
except TypeError:
# redirect encoded byte strings directly to buffer
return super(StdoutBuffer, self).buffer.write(string)
您不必将缓冲区的编码设置为 sys.stdout.encoding，但这有助于使用此方法测试/比较脚本输出。
【讨论】：
这个答案在设置环境对象的标准输出参数以与 Httpie 的 core.py 一起使用时帮助了我。【参考方案6】：即使出现异常，此方法也会恢复 sys.stdout。它还在异常之前获得任何输出。
import io
import sys
real_stdout = sys.stdout
fake_stdout = io.BytesIO() # or perhaps io.StringIO()
try:
sys.stdout = fake_stdout
# do what you have to do to create some output
finally:
sys.stdout = real_stdout
output_string = fake_stdout.getvalue()
fake_stdout.close()
# do what you want with the output_string
使用io.BytesIO()在 Python 2.7.10 中测试
使用io.StringIO()在 Python 3.6.4 中测试
Bob，如果您觉得修改/扩展代码实验中的任何内容可能会在任何意义上变得有趣，则添加一个案例，否则请随意删除它
Ad informandum ... 在寻找一些可行的机制以“获取”输出时扩展实验的一些评论，由
numexpr.print_versions()直接指向<stdout>（需要清理 GUI 并将详细信息收集到调试报告）
# THIS WORKS AS HELL: as Bob Stein proposed years ago:
# py2 SURPRISEDaBIT:
#
import io
import sys
#
real_stdout = sys.stdout # PUSH <stdout> ( store to REAL_ )
fake_stdout = io.BytesIO() # .DEF FAKE_
try: # FUSED .TRY:
sys.stdout.flush() # .flush() before
sys.stdout = fake_stdout # .SET <stdout> to use FAKE_
# ----------------------------------------- # + do what you gotta do to create some output
print 123456789 # +
import numexpr # +
QuantFX.numexpr.__version__ # + [3] via fake_stdout re-assignment, as was bufferred + "late" deferred .get_value()-read into print, to finally reach -> real_stdout
QuantFX.numexpr.print_versions() # + [4] via fake_stdout re-assignment, as was bufferred + "late" deferred .get_value()-read into print, to finally reach -> real_stdout
_ = os.system( 'echo os.system() redir-ed' )# + [1] via real_stdout + "late" deferred .get_value()-read into print, to finally reach -> real_stdout, if not ( _ = )-caught from RET-d "byteswritten" / avoided from being injected int fake_stdout
_ = os.write( sys.stderr.fileno(), # + [2] via stderr + "late" deferred .get_value()-read into print, to finally reach -> real_stdout, if not ( _ = )-caught from RET-d "byteswritten" / avoided from being injected int fake_stdout
b'os.write() redir-ed' )# *OTHERWISE, if via fake_stdout, EXC <_io.BytesIO object at 0x02C0BB10> Traceback (most recent call last):
# ----------------------------------------- # ? io.UnsupportedOperation: fileno
#''' ? YET: <_io.BytesIO object at 0x02C0BB10> has a .fileno() method listed
#>>> 'fileno' in dir( sys.stdout ) -> True ? HAS IT ADVERTISED,
#>>> pass; sys.stdout.fileno -> <built-in method fileno of _io.BytesIO object at 0x02C0BB10>
#>>> pass; sys.stdout.fileno()-> Traceback (most recent call last):
# File "<stdin>", line 1, in <module>
# io.UnsupportedOperation: fileno
# ? BUT REFUSES TO USE IT
#'''
finally: # == FINALLY:
sys.stdout.flush() # .flush() before ret'd back REAL_
sys.stdout = real_stdout # .SET <stdout> to use POP'd REAL_
sys.stdout.flush() # .flush() after ret'd back REAL_
out_string = fake_stdout.getvalue() # .GET string from FAKE_
fake_stdout.close() # <FD>.close()
# +++++++++++++++++++++++++++++++++++++ # do what you want with the out_string
#
print "\n0:\n1:0:".format( 60 * "/\\",# "LATE" deferred print the out_string at the very end reached -> real_stdout
out_string #
)
'''
PASS'd:::::
...
os.system() redir-ed
os.write() redir-ed
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
123456789
'2.5'
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
Numexpr version: 2.5
NumPy version: 1.10.4
Python version: 2.7.13 |Anaconda 4.0.0 (32-bit)| (default, May 11 2017, 14:07:41) [MSC v.1500 32 bit (Intel)]
AMD/Intel CPU? True
VML available? True
VML/MKL version: Intel(R) Math Kernel Library Version 11.3.1 Product Build 20151021 for 32-bit applications
Number of threads used by default: 4 (out of 4 detected cores)
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
>>>
EXC'd :::::
...
os.system() redir-ed
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
123456789
'2.5'
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
Numexpr version: 2.5
NumPy version: 1.10.4
Python version: 2.7.13 |Anaconda 4.0.0 (32-bit)| (default, May 11 2017, 14:07:41) [MSC v.1500 32 bit (Intel)]
AMD/Intel CPU? True
VML available? True
VML/MKL version: Intel(R) Math Kernel Library Version 11.3.1 Product Build 20151021 for 32-bit applications
Number of threads used by default: 4 (out of 4 detected cores)
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
Traceback (most recent call last):
File "<stdin>", line 9, in <module>
io.UnsupportedOperation: fileno
'''
【讨论】：
【参考方案7】：在 Python3.6 中，StringIO 和 cStringIO 模块不见了，你应该改用io.StringIO。所以你应该像第一个答案一样这样做：
import sys
from io import StringIO
old_stdout = sys.stdout
old_stderr = sys.stderr
my_stdout = sys.stdout = StringIO()
my_stderr = sys.stderr = StringIO()
# blah blah lots of code ...
sys.stdout = self.old_stdout
sys.stderr = self.old_stderr
// if you want to see the value of redirect output, be sure the std output is turn back
print(my_stdout.getvalue())
print(my_stderr.getvalue())
my_stdout.close()
my_stderr.close()
【讨论】：
您可以通过解释上述代码的工作原理以及这如何改善提问者的情况来提高您的回答质量。【参考方案8】：使用pipe() 并写入适当的文件描述符。
https://docs.python.org/library/os.html#file-descriptor-operations
【讨论】：
【参考方案9】：这是另一种看法。 contextlib.redirect_stdout 和 io.StringIO() 作为 documented 很棒，但对于日常使用来说还是有点冗长。以下是如何通过子类化contextlib.redirect_stdout 使其成为单线：
import sys
import io
from contextlib import redirect_stdout
class capture(redirect_stdout):
def __init__(self):
self.f = io.StringIO()
self._new_target = self.f
self._old_targets = [] # verbatim from parent class
def __enter__(self):
self._old_targets.append(getattr(sys, self._stream)) # verbatim from parent class
setattr(sys, self._stream, self._new_target) # verbatim from parent class
return self # instead of self._new_target in the parent class
def __repr__(self):
return self.f.getvalue()
由于 __enter__ 返回 self，在 with 块退出后，您可以使用上下文管理器对象。此外，由于 __repr__ 方法，上下文管理器对象的字符串表示实际上是标准输出。所以现在你有了，
with capture() as message:
print('Hello World!')
print(str(message)=='Hello World!\n') # returns True
【讨论】：
以上是关于我可以将标准输出重定向到某种字符串缓冲区吗？的主要内容，如果未能解决你的问题，请参考以下文章