如何解决Python 记录器 - 将 STDOUT 重定向到日志文件以及任何调试消息
我正在尝试使用 Python 中的日志记录模块,因此当我运行我的程序时,我最终会得到一个日志文件 debug.log
,其中包含:
- 每条日志消息(logging.DEBUG、logging.WARNING 等)
- 每次我的代码向 STDOUT 打印一些东西
当我运行程序时,我只希望调试消息出现在日志文件中,而不是打印在终端上。
基于 this answer,这是我的示例代码,test.py
:
import logging
import sys
root = logging.getLogger()
root.setLevel(logging.DEBUG)
fh = logging.FileHandler('debug.log')
fh.setLevel(logging.DEBUG)
sh = logging.StreamHandler(sys.stdout)
sh.setLevel(logging.DEBUG)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
sh.setFormatter(formatter)
fh.setFormatter(formatter)
root.addHandler(sh)
root.addHandler(fh)
x = 4
y = 5
logging.debug("X: %s",x)
logging.debug("Y: %s",y)
print("x is",x)
print("y is",y)
print("x * y =",x*y)
print("x^y =",x**y)
这就是我想要的 debug.log
的内容:
2021-02-01 12:10:48,263 - root - DEBUG - X: 4
2021-02-01 12:10:48,264 - root - DEBUG - Y: 5
x is 4
y is 5
x * y = 20
x^y = 1024
相反,debug.log
的内容只是前两行:
2021-02-01 12:10:48,264 - root - DEBUG - Y: 5
当我运行 test.py
时,我得到以下输出:
2021-02-01 12:17:04,201 - root - DEBUG - X: 4
2021-02-01 12:17:04,201 - root - DEBUG - Y: 5
x is 4
y is 5
x * y = 20
x^y = 1024
所以我实际上得到了与我想要的相反的结果:日志文件不包括 STDOUT 打印我希望它们包含的地方,程序输出包括我希望它们排除的调试消息。
我该如何解决这个问题,以便运行 test.py
只输出 print
语句中的行,并且生成的 debug.log
文件包含 DEBUG 日志和打印行?>
解决方法
嗯,我可以让它工作,但我还不知道是否有任何影响。也许其他人能够指出任何潜在的缺陷,例如多线程。
您可以将 sys.stdout
设置为您喜欢的任何类似文件的对象。这将包括您的 logging.FileHandler()
正在写入的文件。试试这个:
fh = logging.FileHandler('debug.log')
fh.setLevel(logging.DEBUG)
old_stdout = sys.stdout # in case you want to restore later
sys.stdout = fh.stream # the file to which fh writes
并且您可以删除处理连接到标准输出的 sh
的代码。
我认为您不希望所有 stdout
输出都进入日志文件。
您可以做的是将控制台处理程序的日志记录级别设置为 logging.INFO
,将文件处理程序的日志记录级别设置为 logging.DEBUG
。然后将您的 print
语句替换为对 logging.info
的调用。这样只会将信息消息及以上信息输出到控制台。
像这样:
import logging
import sys
logger = logging.getLogger(__name__)
console_handler = logging.StreamHandler(sys.stdout)
file_handler = logging.FileHandler("debug.log")
console_handler.setLevel(logging.INFO)
file_handler.setLevel(logging.DEBUG)
console_formatter = logging.Formatter('%(message)s')
file_formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
console_handler.setFormatter(console_formatter)
file_handler.setFormatter(file_formatter)
logger.addHandler(console_handler)
logger.addHandler(file_handler)
logger.setLevel(logging.DEBUG) #set root logging level to DEBUG
if __name__ == "__main__":
x = 4
y = 5
logger.debug("X: %s",x)
logger.debug("Y: %s",y)
logger.info("x is {}".format(x))
logger.info("y is {}".format(y))
logger.info("x * y = {}".format(x * y))
logger.info("x^y = {}".format(x ** y))
,
如果您真的希望 all 输出到 stdout
以最终出现在日志文件中,请参见例如mhawke's answer,以及链接的问题和答案。
但是,如果您真的只是对自己的 print()
调用的输出感兴趣,那么我会使用自定义日志记录级别将所有这些替换为 Logger.log()
调用。这让您可以对发生的事情进行细粒度的控制。
下面,我定义了一个值高于 logging.CRITICAL
的自定义日志级别,所以我们的控制台输出总是被打印出来,即使记录器的级别是 CRITICAL
。见docs。
以下是基于 OP 示例的最小实现:
import sys
import logging
# define a custom log level with a value higher than CRITICAL
CUSTOM_LEVEL = 100
# dedicated formatter that just prints the unformatted message
# (actually this is the default behavior,but we make it explicit here)
# See docs: https://docs.python.org/3/library/logging.html#logging.Formatter
console_formatter = logging.Formatter('%(message)s')
# your basic console stream handler
console_handler = logging.StreamHandler(sys.stdout)
console_handler.setFormatter(console_formatter)
# only use this handler for our custom level messages (highest level)
console_handler.setLevel(CUSTOM_LEVEL)
# your basic file formatter and file handler
file_formatter = logging.Formatter(
'%(asctime)s - %(name)s - %(levelname)s - %(message)s')
file_handler = logging.FileHandler('debug.log')
file_handler.setFormatter(file_formatter)
file_handler.setLevel(logging.DEBUG)
# use a module logger instead of the root logger
logger = logging.getLogger(__name__)
# add the handlers
logger.addHandler(console_handler)
logger.addHandler(file_handler)
# include messages with level DEBUG and higher
logger.setLevel(logging.DEBUG)
# NOW,instead of using print(),we use logger.log() with our CUSTOM_LEVEL
x = 4
y = 5
logger.debug(f'X: {x}')
logger.debug(f'Y: {y}')
logger.log(CUSTOM_LEVEL,f'x is {x}')
logger.log(CUSTOM_LEVEL,f'y is {y}')
logger.log(CUSTOM_LEVEL,f'x * y = {x*y}')
logger.log(CUSTOM_LEVEL,f'x^y = {x**y}')
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。