Python标准输出重定向
本文内容纲要：
-Python标准输出重定向
-声明
-一.背景知识
-二.重定向方式
-2.1控制台重定向
-2.2print>>重定向
-2.3sys.stdout重定向
-2.4上下文管理器(ContextManager)
-2.5logging模块重定向
-三.参考资料
Python标准输出重定向
标签：Pythonstdout重定向
目录
-
Python标准输出重定向
-
声明
-
一.背景知识
-
二.重定向方式
- 2.1控制台重定向
- 2.2print>>重定向
- 2.3sys.stdout重定向
- 2.4上下文管理器(ContextManager)
- 2.5logging模块重定向
-
三.参考资料
声明
本文基于Python2.7版本，介绍常见的几种标准输出(stdout)重定向方式。显然，这些方式也适用于标准错误重定向。
本文同时也发布于作业部落，视觉效果略有不同。
一.背景知识
在Python中，文件对象sys.stdin、sys.stdout和sys.stderr分别对应解释器的标准输入、标准输出和标准出错流。在程序启动时，这些对象的初值由sys.__stdin__、sys.__stdout__和sys.__stderr__保存，以便用于收尾(finalization)时恢复标准流对象。
Windows系统中IDLE(PythonGUI)由pythonw.exe，该GUI没有控制台。因此，IDLE将标准输出句柄替换为特殊的PseudoOutputFile对象，以便脚本输出重定向到IDLE终端窗口(Shell)。这可能导致一些奇怪的问题，例如：
Python2.7.11(v2.7.11:6d1b6a68f775,Dec52015,20:32:19)[MSCv.150032bit(Intel)]onwin32
Type"copyright","credits"or"license()"formoreinformation.
>>>importsys
>>>forfdin(sys.stdin,sys.stdout,sys.stderr):printfd
<idlelib.PyShell.PseudoInputFileobjectat0x0177C910>
<idlelib.PyShell.PseudoOutputFileobjectat0x0177C970>
<idlelib.PyShell.PseudoOutputFileobjectat0x017852B0>
>>>forfdin(sys.__stdin__,sys.__stdout__,sys.__stderr__):printfd
<openfile'<stdin>',mode'r'at0x00FED020>
<openfile'<stdout>',mode'w'at0x00FED078>
<openfile'<stderr>',mode'w'at0x00FED0D0>
>>>
可以发现，sys.__stdout__与sys.stdout取值并不相同。而在普通的Python解释器下(如通过Windows控制台)运行上述代码时，两者取值相同。
print语句(statement)不以逗号结尾时，会在输出字符串尾部自动附加一个换行符(linefeed)；否则将一个空格代替附加的换行符。print语句默认写入标准输出流，也可重定向至文件或其他可写对象(所有提供write方法的对象)。这样，就可以使用简洁的print语句代替笨拙的object.write('hello'+'\n')写法。
由上可知，在Python中调用printobj打印对象时，缺省情况下等效于调用sys.stdout.write(obj+'\n')。示例如下：
>>>importsys
>>>print'HelloWorld'
HelloWorld
>>>sys.stdout.write('HelloWorld')
HelloWorld
二.重定向方式
本节介绍常用的Python标准输出重定向方式。这些方法各有优劣之处，适用于不同的场景。
2.1控制台重定向
最简单常用的输出重定向方式是利用控制台命令。这种重定向由控制台完成，而与Python本身无关。
Windows命令提示符(cmd.exe)和LinuxShell(bash等)均通过">"或">>"将输出重定向。其中，">"表示覆盖内容，">>"表示追加内容。类似地，"2>"可重定向标准错误。重定向到"nul"(Windows)或"/dev/null"(Linux)会抑制输出，既不屏显也不存盘。
以Windows命令提示符为例，将Python脚本输出重定向到文件(为缩短篇幅已删除命令间空行)：
E:\>echoprint'hello'>test.py
E:\>test.py>out.txt
E:\>typeout.txt
hello
E:\>test.py>>out.txt
E:\>typeout.txt
hello
hello
E:\>test.py>nul
注意，在Windows命令提示符中执行Python脚本时，命令行无需以"python"开头，系统会根据脚本后缀自动调用Python解释器。此外，type命令可直接显示文本文件的内容，类似Linux系统的cat命令。
LinuxShell中执行Python脚本时，命令行应以"python"开头。除">"或">>"重定向外，还可使用tee命令。该命令可将内容同时输出到终端屏幕和(多个)文件中，"-a"选项表示追加写入，否则覆盖写入。示例如下(echo$SHELL或echo$0显示当前所使用的Shell)：
[wangxiaoyuan_@localhost~]$echo$SHELL
/bin/bash
[wangxiaoyuan_@localhost~]$python-c"print'hello'"
hello
[wangxiaoyuan_@localhost~]$python-c"print'hello'">out.txt
[wangxiaoyuan_@localhost~]$catout.txt
hello
[wangxiaoyuan_@localhost~]$python-c"print'world'">>out.txt
[wangxiaoyuan_@localhost~]$catout.txt
hello
world
[wangxiaoyuan_@localhost~]$python-c"print'Iam'"|teeout.txt
Iam
[wangxiaoyuan_@localhost~]$python-c"print'xywang'"|tee-aout.txt
xywang
[wangxiaoyuan_@localhost~]$catout.txt
Iam
xywang
[wangxiaoyuan_@localhost~]$python-c"print'hello'">/dev/null
[wangxiaoyuan_@localhost~]$
若仅仅想要将脚本输出保存到文件中，也可直接借助会话窗口的日志抓取功能。
注意，控制台重定向的影响是全局性的，仅适用于比较简单的输出任务。
2.2print>>重定向
这种方式基于print语句的扩展形式，即"printobj>>expr"。其中，obj为一个file-like(尤其是提供write方法的)对象，为None时对应标准输出(sys.stdout)。expr将被输出到该文件对象中。示例如下：
memo=cStringIO.StringIO();serr=sys.stderr;file=open('out.txt','w+')
print>>memo,'StringIO';print>>serr,'stderr';print>>file,'file'
print>>None,memo.getvalue()
上述代码执行后，屏显为"serr"和"StringIO"(两行，注意顺序)，out.txt文件内写入"file"。
可见，这种方式非常灵活和方便。缺点是不适用于输出语句较多的场景。
2.3sys.stdout重定向
将一个可写对象(如file-like对象)赋给sys.stdout，可使随后的print语句输出至该对象。重定向结束后，应将sys.stdout恢复最初的缺省值，即标准输出。
简单示例如下：
importsys
savedStdout=sys.stdout#保存标准输出流
withopen('out.txt','w+')asfile:
sys.stdout=file#标准输出重定向至文件
print'Thismessageisforfile!'
sys.stdout=savedStdout#恢复标准输出流
print'Thismessageisforscreen!'
注意，IDLE中sys.stdout初值为PseudoOutputFile对象，与sys.__stdout__并不相同。为求通用，本例另行定义变量(savedStdout)保存sys.stdout，下文也将作此处理。此外，本例不适用于经由fromsysimportstdout导入的stdout对象。
以下将自定义多种具有write()方法的file-like对象，以满足不同需求：
classRedirectStdout:#importos,sys,cStringIO
def__init__(self):
self.content=''
self.savedStdout=sys.stdout
self.memObj,self.fileObj,self.nulObj=None,None,None
#外部的print语句将执行本write()方法，并由当前sys.stdout输出
defwrite(self,outStr):
#self.content.append(outStr)
self.content+=outStr
deftoCons(self):#标准输出重定向至控制台
sys.stdout=self.savedStdout#sys.__stdout__
deftoMemo(self):#标准输出重定向至内存
self.memObj=cStringIO.StringIO()
sys.stdout=self.memObj
deftoFile(self,file='out.txt'):#标准输出重定向至文件
self.fileObj=open(file,'a+',1)#改为行缓冲
sys.stdout=self.fileObj
deftoMute(self):#抑制输出
self.nulObj=open(os.devnull,'w')
sys.stdout=self.nulObj
defrestore(self):
self.content=''
ifself.memObj.closed!=True:
self.memObj.close()
ifself.fileObj.closed!=True:
self.fileObj.close()
ifself.nulObj.closed!=True:
self.nulObj.close()
sys.stdout=self.savedStdout#sys.__stdout__
注意，toFile()方法中，open(name[,mode[,buffering]])调用选择行缓冲(无缓冲会影响性能)。这是为了观察中间写入过程，否则只有调用close()或flush()后输出才会写入文件。内部调用open()方法的缺点是不便于用户定制写文件规则，如模式(覆盖或追加)和缓冲(行或全缓冲)。
重定向效果如下：
redirObj=RedirectStdout()
sys.stdout=redirObj#本句会抑制"Let'sbegin!"输出
print"Let'sbegin!"
#屏显'HelloWorld!'和'Iamxywang.'(两行)
redirObj.toCons();print'HelloWorld!';print'Iamxywang.'
#写入'Howareyou?'和"Can'tcomplain."(两行)
redirObj.toFile();print'Howareyou?';print"Can'tcomplain."
redirObj.toCons();print"What'up?"#屏显
redirObj.toMute();print'<Silence>'#无屏显或写入
os.system('echoNeverredirectme!')#控制台屏显'Neverredirectme!'
redirObj.toMemo();print'Whatapity!'#无屏显或写入
redirObj.toCons();print'Hello?'#屏显
redirObj.toFile();print"Oh,xywangcan'thearme"#该串写入文件
redirObj.restore()
print'Popup'#屏显
可见，执行toXXXX()语句后，标准输出流将被重定向到XXXX。此外，toMute()和toMemo()的效果类似，均可抑制输出。
使用某对象替换sys.stdout时，尽量确保该对象接近文件对象，尤其是涉及第三方库时(该库可能使用sys.stdout的其他方法)。此外，本节替换sys.stdout的代码实现并不影响由os.popen()、os.system()或os.exec*()系列方法所创建进程的标准I/O流。这些涉及底层控制，其重定向方式可参考"RedirectingallkindsofstdoutinPython"一文。
2.4上下文管理器(ContextManager)
本节严格意义上并非新的重定向方式，而是利用Pyhton上下文管理器优化上节的代码实现。借助于上下文管理器语法，可不必向重定向使用者暴露sys.stdout。
首先考虑输出抑制，基于上下文管理器语法实现如下：
importsys,cStringIO,contextlib
classDummyFile:
defwrite(self,outStr):pass
@contextlib.contextmanager
defMuteStdout():
savedStdout=sys.stdout
sys.stdout=cStringIO.StringIO()#DummyFile()
try:
yield
exceptException:#捕获到错误时，屏显被抑制的输出(该处理并非必需)
content,sys.stdout=sys.stdout,savedStdout
printcontent.getvalue()#;raise
#finally:
sys.stdout=savedStdout
使用示例如下：
withMuteStdout():
print"I'llshowupwhen<raise>isexecuted!"#不屏显不写入
raise#屏显上句
print"I'mhidingmyselfsomewhere:)"#不屏显
再考虑更通用的输出重定向：
importos,sys
fromcontextlibimportcontextmanager
@contextmanager
defRedirectStdout(newStdout):
savedStdout,sys.stdout=sys.stdout,newStdout
try:
yield
finally:
sys.stdout=savedStdout
使用示例如下：
defGreeting():print'Hello,boss!'
withopen('out.txt',"w+")asfile:
print"I'mwritingtoyou..."#屏显
withRedirectStdout(file):
print'Ihopethisletterfindsyouwell!'#写入文件
print'Checkyourmailbox.'#屏显
withopen(os.devnull,"w+")asfile,RedirectStdout(file):
Greeting()#不屏显不写入
print'Ideserveapayraise:)'#不屏显不写入
print'DidyouhearwhatIsaid?'#屏显
可见，with内嵌块里的函数和print语句输出均被重定向。注意，上述示例不是线程安全的，主要适用于单线程。
当函数被频繁调用时，建议使用装饰器包装该函数。这样，仅需修改该函数定义，而无需在每次调用该函数时使用with语句包裹。示例如下：
importsys,cStringIO,functools
defMuteStdout(retCache=False):
defdecorator(func):
@functools.wraps(func)
defwrapper(*args,**kwargs):
savedStdout=sys.stdout
sys.stdout=cStringIO.StringIO()
try:
ret=func(*args,**kwargs)
ifretCache==True:
ret=sys.stdout.getvalue().strip()
finally:
sys.stdout=savedStdout
returnret
returnwrapper
returndecorator
若装饰器MuteStdout的参数retCache为真，外部调用func()函数时将返回该函数内部print输出的内容(可供屏显)；若retCache为假，外部调用func()函数时将返回该函数的返回值(抑制输出)。
MuteStdout装饰器使用示例如下：
@MuteStdout(True)
defExclaim():print'Iamproudofmyself!'
@MuteStdout()
defMumble():print'Ilackconfidence...';return'sad'
printExclaim(),Exclaim.__name__#屏显'Iamproudofmyself!Exclaim'
printMumble(),Mumble.__name__#屏显'sadMumble'
在所有线程中，被装饰函数执行期间，sys.stdout都会被MuteStdout装饰器劫持。而且，函数一经装饰便无法移除装饰。因此，使用该装饰器时应慎重考虑场景。
接着，考虑创建RedirectStdout装饰器：
defRedirectStdout(newStdout=sys.stdout):
defdecorator(func):
defwrapper(*args,**kwargs):
savedStdout,sys.stdout=sys.stdout,newStdout
try:
returnfunc(*args,**kwargs)
finally:
sys.stdout=savedStdout
returnwrapper
returndecorator
使用示例如下：
file=open('out.txt',"w+")
@RedirectStdout(file)
defFunNoArg():print'Noargument.'
@RedirectStdout(file)
defFunOneArg(a):print'Oneargument:',a
defFunTwoArg(a,b):print'Twoarguments:%s,%s'%(a,b)
FunNoArg()#写文件'Noargument.'
FunOneArg(1984)#写文件'Oneargument:1984'
RedirectStdout()(FunTwoArg)(10,29)#屏显'Twoarguments:10,29'
printFunNoArg.__name__#屏显'wrapper'(应显示'FunNoArg')
file.close()
注意FunTwoArg()函数的定义和调用与其他函数的不同，这是两种等效的语法。此外，RedirectStdout装饰器的最内层函数wrapper()未使用"functools.wraps(func)"修饰，会丢失被装饰函数原有的特殊属性(如函数名、文档字符串等)。
2.5logging模块重定向
对于代码量较大的工程，建议使用logging模块进行输出。该模块是线程安全的，可将日志信息输出到控制台、写入文件、使用TCP/UDP协议发送到网络等等。
默认情况下logging模块将日志输出到控制台(标准出错)，且只显示大于或等于设置的日志级别的日志。日志级别由高到低为CRITICAL>ERROR>WARNING>INFO>DEBUG>NOTSET，默认级别为WARNING。
以下示例将日志信息分别输出到控制台和写入文件：
importlogging
logging.basicConfig(level=logging.DEBUG,
format='%(asctime)s[%(levelname)s]at%(filename)s,%(lineno)d:%(message)s',
datefmt='%Y-%m-%d(%a)%H:%M:%S',
filename='out.txt',
filemode='w')
#将大于或等于INFO级别的日志信息输出到StreamHandler(默认为标准错误)
console=logging.StreamHandler()
console.setLevel(logging.INFO)
formatter=logging.Formatter('[%(levelname)-8s]%(message)s')#屏显实时查看，无需时间
console.setFormatter(formatter)
logging.getLogger().addHandler(console)
logging.debug('gubed');logging.info('ofni');logging.critical('lacitirc')
通过对多个handler设置不同的level参数，可将不同的日志内容输入到不同的地方。本例使用在logging模块内置的StreamHandler(和FileHandler)，运行后屏幕上显示:
[INFO]ofni
[CRITICAL]lacitirc
out.txt文件内容则为:
2016-05-13(Fri)17:10:53[DEBUG]attest.py,25:gubed
2016-05-13(Fri)17:10:53[INFO]attest.py,25:ofni
2016-05-13(Fri)17:10:53[CRITICAL]attest.py,25:lacitirc
除直接在程序中设置Logger、Handler、Formatter等外，还可将这些信息写入配置文件。示例如下：
#logger.conf
###############Logger###############
[loggers]
keys=root,Logger2F,Logger2CF
[logger_root]
level=DEBUG
handlers=hWholeConsole
[logger_Logger2F]
handlers=hWholeFile
qualname=Logger2F
propagate=0
[logger_Logger2CF]
handlers=hPartialConsole,hPartialFile
qualname=Logger2CF
propagate=0
###############Handler###############
[handlers]
keys=hWholeConsole,hPartialConsole,hWholeFile,hPartialFile
[handler_hWholeConsole]
class=StreamHandler
level=DEBUG
formatter=simpFormatter
args=(sys.stdout,)
[handler_hPartialConsole]
class=StreamHandler
level=INFO
formatter=simpFormatter
args=(sys.stderr,)
[handler_hWholeFile]
class=FileHandler
level=DEBUG
formatter=timeFormatter
args=('out.txt','a')
[handler_hPartialFile]
class=FileHandler
level=WARNING
formatter=timeFormatter
args=('out.txt','w')
###############Formatter###############
[formatters]
keys=simpFormatter,timeFormatter
[formatter_simpFormatter]
format=[%(levelname)s]at%(filename)s,%(lineno)d:%(message)s
[formatter_timeFormatter]
format=%(asctime)s[%(levelname)s]at%(filename)s,%(lineno)d:%(message)s
datefmt=%Y-%m-%d(%a)%H:%M:%S
此处共创建三个Logger：root，将所有日志输出至控制台；Logger2F，将所有日志写入文件；Logger2CF，将级别大于或等于INFO的日志输出至控制台，将级别大于或等于WARNING的日志写入文件。
程序以如下方式解析配置文件和重定向输出：
importlogging,logging.config
logging.config.fileConfig("logger.conf")
logger=logging.getLogger("Logger2CF")
logger.debug('gubed');logger.info('ofni');logger.warn('nraw')
logger.error('rorre');logger.critical('lacitirc')
logger1=logging.getLogger("Logger2F")
logger1.debug('GUBED');logger1.critical('LACITIRC')
logger2=logging.getLogger()
logger2.debug('gUbEd');logger2.critical('lAcItIrC')
运行后屏幕上显示:
[INFO]attest.py,7:ofni
[WARNING]attest.py,7:nraw
[ERROR]attest.py,8:rorre
[CRITICAL]attest.py,8:lacitirc
[DEBUG]attest.py,14:gUbEd
[CRITICAL]attest.py,14:lAcItIrC
out.txt文件内容则为:
2016-05-13(Fri)20:31:21[WARNING]attest.py,7:nraw
2016-05-13(Fri)20:31:21[ERROR]attest.py,8:rorre
2016-05-13(Fri)20:31:21[CRITICAL]attest.py,8:lacitirc
2016-05-13(Fri)20:31:21[DEBUG]attest.py,11:GUBED
2016-05-13(Fri)20:31:21[CRITICAL]attest.py,11:LACITIRC
三.参考资料
本文主要参考以下资料(包括但不限于)：
- RedirectingallkindsofstdoutinPython
- RedirectstdouttoafileinPython?
- SilencethestdoutofafunctioninPythonwithouttrashingsys.stdoutandrestoringeachfunctioncall
本文内容总结：Python标准输出重定向，声明，一.背景知识，二.重定向方式，2.1控制台重定向，2.2print>>重定向，2.3sys.stdout重定向，2.4上下文管理器(ContextManager)，2.5logging模块重定向，三.参考资料，
原文链接：https://www.cnblogs.com/clover-toeic/p/5491073.html