首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >学会充分利用Python中的日志,提升你的编程level

学会充分利用Python中的日志,提升你的编程level

作者头像
HuangWeiAI
发布2021-05-07 10:54:37
5990
发布2021-05-07 10:54:37
举报
文章被收录于专栏:浊酒清味浊酒清味浊酒清味

为什么使用日志而不使用print()

日志记录对于程序员来说是一个非常重要的功能。对于调试和显示运行时信息,日志记录同样有用。在本文中,我将介绍为什么以及如何在程序中使用python的日志模块。

打印语句和日志输出之间有一个关键的区别。通常,打印语句写到标准输出(stdout),期望它是有用的信息或程序的输出。但是,日志被写入标准错误(stderr)。我们可以如下演示这个场景。

import logging
logging.basicConfig(level=logging.INFO) #We'll talk about this soon!
logging.warning('Something bad could happen!')
logging.info('You are running the program')
logging.error('Aw snap! Everything failed.')
print("This is the program output")

现在,如果我运行这个程序,我将在命令行中看到以下内容。

$ python log_test.py
WARNING:root:Something bad could happen!
INFO:root:You are running the program
ERROR:root:Aw snap! Everything failed.
This is the program output

然而,对于普通用户来说,这些信息太多了。尽管这实际上是在命令行中一起显示的,但数据被写入两个单独的流中。因此,典型的用户应该执行以下操作。

$ python log_test.py > program_output.txt
WARNING:root:Something bad could happen!
INFO:root:You are running the program
ERROR:root:Aw snap! Everything failed.
$ cat program_output.txt
This is the program output

在这里,通过重定向>,将有用的程序输出写入一个文件。这样我们就可以看到终端上发生了什么,并方便地在文件中获得输出。现在让我们尝试理解日志级别!

日志和日志级别

日志记录可能由于不同的原因而发生。这些原因分为以下严重程度。

  • 调试:为开发人员调试信息,如计算值、估计参数、url、API调用等。
  • 信息:信息,没什么严重的。
  • 警告:对用户的输入、参数等的警告。
  • 错误:报告由用户在程序中所做的事情或发生的事情引起的错误。
  • CRITICAL:最高优先级的日志输出。用于关键问题(取决于用例)。

最常见的日志类型有DEBUG、INFO和ERROR。但是,很容易出现python抛出版本不匹配警告的情况。

配置记录器和日志处理程序

记录器可以在不同的参数下配置。日志记录器可以配置为遵循特定的日志级别、文件名、文件模式和打印日志输出的格式。

配置日志采集器参数

日志记录器可以进行如下配置。

import logging

logging.basicConfig(filename='program.log', filemode='w', level=logging.DEBUG)
logging.warning('You are given a warning!')

上面的设置要求记录器将日志输出到名为program.log的文件中。filemode= ' w '定义了写入文件的性质。例如,'w'打开一个新文件,覆盖在那里的任何东西。默认情况下,这个参数是'a',它将以附加模式打开日志文件。有时,拥有一个日志历史记录是很有用的。level参数定义日志记录的最低级别。例如,如果将其设置为INFO,则不会打印调试日志。您可能见过,程序需要以inverbose=debug模式运行才能查看一些参数。默认级别为INFO。

创建日志处理程序

尽管上面的方法对于一个简单的应用程序来说很简单,但是对于生产就绪的软件或服务,我们需要一个全面的日志记录过程。这是因为很难在数百万的调试日志中找到特定的错误日志。此外,我们需要在整个程序和模块中使用单个日志记录器。这样我们就可以正确地将日志追加到同一个文件中。为此,我们可以为该任务使用具有不同配置的处理程序。

import logging
logger = logging.getLogger("My Logger")
logger.setLevel(logging.DEBUG)
console_handler = logging.StreamHandler()
file_handler = logging.FileHandler('file.log', mode='w')
console_handler.setLevel(logging.INFO)
file_handler.setLevel(logging.DEBUG)
logger.addHandler(console_handler)
logger.addHandler(file_handler)

您可以看到,我们首先得到一个传递名称的记录器。这使我们能够在程序的其他地方重用相同的日志程序。我们将全局日志记录级别设置为DEBUG。这是最低的日志级别,因此允许我们在其他处理程序中使用任何日志级别。

接下来,我们为控制台和文件编写创建两个处理程序。对于每个处理器,我们都提供了一个日志级别。这有助于减少控制台输出的开销,并将它们传输到文件处理程序。使以后处理调试变得容易。

格式化日志输出

日志不仅仅是打印我们自己的消息。有时我们需要打印其他信息,比如时间、日志级别和进程id。对于这个任务,我们可以使用日志格式。让我们看看下面的代码。

console_format = logging.Formatter('%(name)s - %(levelname)s - %(message)s')
file_format = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
console_handler.setFormatter(console_format)
file_handler.setFormatter(file_format)

在向记录器添加处理程序之前,我们可以如上所述对日志输出进行格式化。还有更多的参数可以用于此。你可以在这里找到它们。

重用代码

下面是一个日志代码片段,我将继续在我的许多应用程序中使用它。我想这对作为读者的你可能有用。

import logging

logger = logging.getLogger('Program Name-Version')
logger.setLevel(logging.DEBUG)

formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')

consoleHeader = logging.StreamHandler()
consoleHeader.setFormatter(formatter)
consoleHeader.setLevel(logging.INFO)

fileHandler = logging.FileHandler(f"{output}/metabcc-lr.log")
fileHandler.setLevel(logging.DEBUG)
fileHandler.setFormatter(formatter)

logger.addHandler(fileHandler)
logger.addHandler(consoleHeader)

·END·

本文参与 腾讯云自媒体分享计划,分享自微信公众号。
原始发表:2021-04-24,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 Python学会 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档