Python中打印到标准错误输出（stderr）的方法

技术背景

在Python编程中，有时候我们需要将错误信息或调试信息输出到标准错误输出（stderr），而不是标准输出（stdout）。标准错误输出通常用于显示程序运行过程中的错误信息，这样可以将正常的输出和错误信息分开，便于调试和监控。Python提供了多种方式来实现将信息打印到stderr，不同的方法在语法、兼容性和性能上有所差异。

实现步骤

1. 使用 print >> sys.stderr（Python 2 专用）

import sys
print >> sys.stderr, "spam"

这种方法在Python 2中使用，语法较为简洁，但在Python 3中已被移除。

2. 使用 sys.stderr.write()

import sys
sys.stderr.write("spam\n")

这是一种跨版本兼容的方法，在Python 2和Python 3中都可以使用。需要注意的是，write() 方法不会自动添加换行符，需要手动添加。

3. 使用 os.write()

import os
os.write(2, b"spam\n")

这里的 2 代表标准错误输出的文件描述符。这种方法比较底层，需要传入字节类型的数据。

4. 使用 print() 函数并指定 file=sys.stderr

import sys
print("spam", file=sys.stderr)

这是Python 3中推荐的方法，也可以在Python 2中通过 from __future__ import print_function 来使用。

5. 自定义函数

import sys

def eprint(*args, **kwargs):
    print(*args, file=sys.stderr, **kwargs)

eprint("Test")
eprint("foo", "bar", "baz", sep="---")

自定义函数可以提高代码的复用性，使用方式和标准的 print() 函数类似。

核心代码

以下是一个综合示例，展示了上述几种方法的使用：

import sys
import os

# Python 2 专用
# print >> sys.stderr, "spam"

# 使用 sys.stderr.write()
sys.stderr.write("spam\n")

# 使用 os.write()
os.write(2, b"spam\n")

# 使用 print() 函数并指定 file=sys.stderr
print("spam", file=sys.stderr)

# 自定义函数
def eprint(*args, **kwargs):
    print(*args, file=sys.stderr, **kwargs)

eprint("Test")
eprint("foo", "bar", "baz", sep="---")

最佳实践

• 兼容性：如果需要同时支持Python 2和Python 3，建议使用 sys.stderr.write() 或 print("spam", file=sys.stderr) 方法。
• 代码可读性：使用自定义函数 eprint() 可以提高代码的可读性和复用性，尤其是在需要多次打印到stderr的情况下。
• 性能：如果对性能有较高要求，可以使用 sys.stderr.write() 方法，因为它比 print() 函数稍微快一些。

常见问题

1. sys.stderr.write() 和 print() 的区别

sys.stderr.write() 是一个底层的写入方法，不会自动添加换行符，需要手动添加；而 print() 函数会自动添加换行符，并且可以方便地处理多个参数和格式化输出。

2. Python 2 和 Python 3 语法的兼容性问题

print >> sys.stderr 这种语法在Python 3中已被移除，需要使用 print("spam", file=sys.stderr) 来替代。可以通过 from __future__ import print_function 在Python 2中使用Python 3的 print() 函数语法。

3. 如何避免 TypeError 错误

在使用自定义函数 eprint() 时，如果不小心写成 eprint("error", file=sys.stderr)，会导致 TypeError: print() got multiple values for keyword argument 'file' 错误。可以通过修改 eprint() 函数来避免这个问题：

import sys

def eprint(*args, **kwargs):
    kwargs['file'] = sys.stderr
    print(*args, **kwargs)