Logging HOWTO
今天分享的内容是如何在程序中写我们的log
logging概述
首先写日志意味着我们要记录程序运行时发生的一些事件。软件开发者在代码中添加日志去指示一些具体的事件已经发生了，一个事件可以由一些描述性的数据组成（数据可能会因为不同事件的发生而产生不同数据），事件同时还具有开发者定义好的重要性，重要性也就是常说的日志等级，或者严重性。
那么何时应该去使用logging呢？
Logging 模块提供了一系列方便的方法满足一些简单的应用场景，他们分别是debug(),info(),warning(),error(),critical()，要确定何时去使用logging可以看python doc.给我们的这张表格，提供了各种应该使用logging的应用场景。
| Task you want to perform | the best tool for the task |
|---|---|
| 显示控制台输出，用于命令行脚本或者程序的普通使用 | print() |
| 报告程序正常运行期间发生的事件（如状态监视或故障调查） | logging.info(),logging.debug() |
| 发出关于特定事件时的警告 | logging.warning |
| 报告关于特定运行时事件的错误 | 抛出异常 Raise an exception |
| 在不引发异常的情况下报告错误（例如长时间运行的服务器进程中的错误处理程序） | logging.error(),logging.exception(),logging.critical |
日志功能根据其用于跟踪的事件的级别或严重程度命名。标准等级及其适用性如下(按严重程度递增):
这张表格更加明确了什么时候去使用
| Level | When it's used |
|---|---|
| DEBUG | 详细信息，常用于诊断问题 |
| INFO | 确认时间按照预期运行 |
| WARNING | 表示发生了意想不到的事情，或者表示在不久的将来可能会出现的问题（比如磁盘空间不足），该软件仍然按照预期运行。 |
| ERROR | 由于一个严重的问题，软件某些功能已经不能使用 |
| CRITICAL | 严重错误，程序本身无法继续运行 |
默认的日志等级是WARNING，这意味着只有高于该等级的日志才会被追踪，除非我们做了一些设置。
处理跟踪事件的最简单方法就是将他们打印到控制台，另一种常用的方法就是将他们写入文件。
A simple example
import logging
logging.warning('Watch out!') # will print a message to the console
logging.info('I told you so') # will not print anything
此时终端只会打印出
WARNING:root:Watch out!
还记得为什么吗，因为默认的日志等级是WARNING
将logging写入文件
一个非常常见的情况就是我们会把日志写入文件。
import logging
logging.basicConfig(filename='example.log', encoding='utf-8', level=logging.DEBUG)
logging.debug('This message should go to the log file')
logging.info('So should this')
logging.warning('And this, too')
logging.error('And non-ASCII stuff, too, like Øresund and Malmö')
在python3.9版本，basicConfig()方法中新添加了encoding参数，这里不多介绍了
这是一个example.log的文件将会被创建在代码执行的相同目录中，如果我们打开他就会看到
DEBUG:root:This message should go to the log file
INFO:root:So should this
WARNING:root:And this, too
ERROR:root:And non-ASCII stuff, too, like Øresund and Malmö
该例子还展示了我们可以设置日志等级，由于我们设置等级为DEBUG所有全部的日志都被正常打印了
调用basicConfig()因该在调用debug，info()之前，因为它是一种一次性的简单配置工具，只有第一个调用才会真正的执行，后续的调用实际上是误操作的。
这句话比较重要，如果我们将上面的脚本跑了很多次之后，每次打印的log将会追加在example.log中
如果希望每次都重新开始，不保持之前的消息，我们可以指定filemode参数
logging.basicConfig(filename='example.log', filemode='w', level=logging.DEBUG)
这样配置后，输出将会和之前一样，但是日志文件内容将不会追加，早前的日志内容将会丢失。
下一期内容
下一期内容还会分享
- 从多个模块进行日志记录
- 日志记录结合变量数据
- 更改显示消息的格式
- 在消息中显示日期和时间
直到我把整个logging模块的内容分享完，如果喜欢就点个赞吧，我真是求求了
