Python中sys.stdout作为默认函数参数的风险与最佳实践

sys.stdout作为默认参数的风险

假设我们有一个虚拟函数示例，其定义如下所示。

import sys

def writeline(text, stream=sys.stdout):
 stream.write(text + '
')

with open('/path/to/file', 'w') as f:
 # writes to /path/to/file
 writeline('foo', f)

# writes to standard output
writeline('bar')

考虑到Python在函数定义阶段就会评估默认参数的值，将sys.stdout直接设置为默认参数是否安全？这是否会产生意想不到的副作用？

以下是经过分析的最佳实践建议。

这里存在一个潜在问题：在某些场景下，你可能需要将sys.stdout重定向到文件、管道或其他设备。

例如，你的主程序逻辑可能类似于以下结构：

if __name__ == '__main__':
 if len(sys.argv) > 1:
  sys.stdout = open(sys.argv[1],'w')
 try:
  # ... run the program
 finally:
  if len(sys.argv) > 1:
   sys.stdout.close()

如果希望程序在接收到日志文件名参数时（如执行python3 file.py logfile.log）将输出写入该文件，这种机制非常有用。然而，如果你在函数定义时固定了sys.stdout，那么后续对sys.stdout的修改将不会生效，因为默认参数捕获的是定义时的引用。

因此，更安全的写法是避免直接使用sys.stdout作为默认值，而是采用以下模式：

def writeline(text, stream = None):
 if stream is None:
  stream = sys.stdout
 stream.write(text + '
')

通常，将不可变对象（如None、False、元组(1)等）设置为默认参数是更好的选择。在Python中，只有在极少数情况下才建议使用可变对象或可能更改引用的变量作为默认参数。

当然，如果你确定程序中永远不会将sys.stdout重定向到文件、管道等设备，那么直接使用sys.stdout作为默认参数也是安全的。

还原sys.stdout默认值的方法

补充拓展：如何在Python中将sys.stdout还原为默认值

我想将程序输出写入文件，因此执行了以下操作：

sys.stdout = open(outfile, 'w+')

但在写入文件后，我希望重新将输出打印回控制台。

sys.stdout.close() sys.stdout = None

此时程序报错：

AttributeError: 'NoneType' object has no attribute 'write'

显然，默认输出流不能设置为None。因此，我需要告诉Python使用原始的默认输出流：

sys.stdout = use_the_default_one()

解决方案

将sys.stdout重新分配给sys.__stdout__。

参考官方文档说明：

sys.__stdin__、sys.__stderr__和sys.__stdout__保存了程序启动时stdin、stderr和stdout的原始值。它们在程序运行过程中使用，无论sys.std*对象是否已被重定向，将它们打印到实际的标准流都非常有用。

或者，你可以采用另一种方式：

print(output, file=myoutputfile)

这样可以避免上述问题，无需手动管理sys.stdout的重定向与恢复。

以上关于Python中sys.stdout作为默认函数参数的实现细节就是全部内容，希望能为大家提供参考，也希望大家多多支持本站。