100天精通Python（基础篇）——第32天：日志标准库logging【文末送书两本】_python log库

import logging

1、logging库日志级别

---

问题思考：

• 开发人员在开发一个应用程序时需要什么日志信息？在程序正式上线后需要什么日志信息？

• 运维人员在部署开发环境时需要什么日志信息？在部署生产环境时需要什么日志信息？

根据需求选择不同的日志级别：

| 级别 | 级别数值 | 使用时机 |

| — | — | — |

| DEBUG | 10 （级别最低） | 详细信息，常用于调试。 |

| INFO | 20（重要） | 程序正常运行过程中产生的一些信息。 |

| WARNING | 30 （警告） | 警告用户，虽然程序还在正常工作，但有可能发生错误。 |

| ERROR | 40（错误） | 由于更严重的问题，程序已经不能执行一些功能了。 |

| CRITICAL | 50 （严重） | 严重错误，程序已经不能继续运行。 |

默认情况是日志级别是warning，日志级别从上到下依次升高，即 DEBUG < INFO < WARNING < ERROR < CRITICAL。而日志的信息量是依次减少的。

开发应用程序 或部署开发环境时：应该使用DEBUG 或INFO级别的日志获取尽可能详细的日志信息来进行开发或部署调试；

应用上线 或部署生产环境时：应该使用WARNING或CRITICAL级别的日志来降低机器的I/O压力和提高获取错误日志信息的效率

PS：当为某个应用程序指定一个日志级别后，应用程序会记录所有日志级别大于或等于指定日志级别的日志信息，而不是仅仅记录指定级别的日志信息，只要级别大于或等于该指定日志级别的日志记录才会被输出，小于该级别的日志记录将会被丢弃。

2、logging工作流程

---

Logger：日志，暴露函数给应用程序，基于日志记录器和过滤器级别决定哪些日志有效。

LogRecord ：日志记录器，将日志传到相应的处理器处理。

Handler ：处理器, 将(日志记录器产生的)日志记录发送至合适的目的地。

Filter ：过滤器, 提供了更好的粒度控制,它可以决定输出哪些日志记录。

Formatter：格式化器, 指明了最终输出中日志记录的布局。

流程描述：

• 1、判断日志的等级是否大于 Logger 对象的等级，如果大于，则往下执行，否则，流程结束。

• 2、产生日志：第一步，判断是否有异常，如果有，则添加异常信息。 第二步，处理日志记录方法(如 debug，info 等)中的占位符，即一般的字符串格式化处理。

• 3、使用注册到 Logger 对象中的 Filters 进行过滤。如果有多个过滤器，则依次过滤；只要有一个过滤器返回假，则过滤结束，且该日志信息将丢弃，不再处理，而处理流程也至此结束。否则，处理流程往下执行。

• 4、在当前 Logger 对象中查找 Handlers，如果找不到任何 Handler，则往上到该 Logger 对象的父 Logger 中查找；如果找到一个或多个 Handler，则依次用 Handler 来处理日志信息。但在每个 Handler 处理日志信息过程中，会首先判断日志信息的等级是否大于该 Handler 的等级，如果大于，则往下执行(由 Logger 对象进入 Handler 对象中)，否则，处理流程结束。

• 5、执行 Handler 对象中的 filter 方法，该方法会依次执行注册到该 Handler 对象中的 Filter。如果有一个 Filter 判断该日志信息为假，则此后的所有 Filter 都不再执行，而直接将该日志信息丢弃，处理流程结束。

• 6、使用 Formatter 类格式化最终的输出结果。 注：Formatter 同上述第 2 步的字符串格式化不同，它会添加额外的信息，比如日志产生的时间，产生日志的源代码所在的源文件的路径等等。

• 7、真正地输出日志信息(到网络，文件，终端，邮件等)。至于输出到哪个目的地，由 Handler 的种类来决定。

3、日志输出格式

---

日志的输出格式可以认为设置，默认格式为下图所示：

4、基本使用

---

logging 使用非常简单，使用 basicConfig() 方法就能满足基本的使用需要，如果方法没有传入参数，会根据默认的配置创建Logger 对象，默认的日志级别被设置为 WARNING，默认的日志输出格式如上图，该函数可选的参数如下表所示。

| 参数名称 | 参数描述 |

| — | — |

| filename | 日志输出到文件的文件名 |

| filemode | 文件模式，r[+]、w[+]、a[+] |

| format | 日志输出的格式 |

| datefat | 日志附带日期时间的格式 |

| style | 格式占位符，默认为 “%” 和 “{}” |

| level | 设置日志输出级别 |

| stream | 定义输出流，用来初始化 StreamHandler 对象，不能 filename 参数一起使用，否则会ValueError 异常 |

| handles | 定义处理器，用来创建 Handler 对象，不能和 filename 、stream 参数一起使用，否则也会抛出 ValueError 异常 |

5、代码实战

---

指定日志输出级别

• 默认日志级别输出

import logging

默认的日志输出级别为warning

logging.debug(‘This is debug log’) # 调试级别

logging.info(‘This is info log’) # 信息级别

logging.warning(‘This is warning log’) # 警告级别

logging.error(‘This is error log’) # 错误级别

logging.critical(‘This is critical log’) # 严重错误级别

输出结果如下：

• 使用baseconfig()来指定日志输出级别:

import logging

使用baseconfig()来指定日志输出级别

logging.basicConfig(level=logging.DEBUG)

logging.debug(‘This is debug log’) # 调试级别

logging.info(‘This is info log’) # 信息级别

logging.warning(‘This is warning log’) # 警告级别

logging.error(‘This is error log’) # 错误级别

logging.critical(‘This is critical log’) # 严重错误级别

输出结果如下：

输出日志到文件

import logging

使用baseconfig()来指定日志输出级别，日志信息写入test.log文件中

logging.basicConfig(filename=“test.log”, level=logging.DEBUG)

logging.debug(‘This is debug log’) # 调试级别

logging.info(‘This is info log’) # 信息级别

logging.warning(‘This is warning log’) # 警告级别

logging.error(‘This is error log’) # 错误级别

logging.critical(‘This is critical log’) # 严重错误级别

生成文件test.log，文件内容如下：

注意：默认情况再执行程序会换行追加！如果想要每次执行程序，先清空文件，然后再输出日志到文件中，只需要新增一个属性filemode="w"文件模式（先清空在写入）

logging.basicConfig(filename=“test.log”,filemode=“w”,level=logging.DEBUG)

输出对象

import logging

logging.basicConfig(level=logging.DEBUG)

name = “张三”

age = “10”

logging.debug(“姓名:%s, 年龄:%s”, name, age)

logging.debug(“姓名:%s, 年龄:%s” % (name, age))

logging.debug((“姓名 {}，年龄 {}”.format(name, age)))

logging.debug((f"姓名 {name}，年龄 {age}"))

输出结果如下：

添加重要信息

• asctime：当前时间

• levelname：输出日志级别

• filename：文件名称

• lineno：报错文件行号

• message：输出信息

import logging

使用baseconfig()来指定日志输出级别，日志信息写入test.log文件中

asctime：日期，levelname：级别，message：报错信息，filename：文件名，lineno：报错行数；datefmt：格式化时间字符串；level：修改默认日志级别

logging.basicConfig(filename=“test.log”, filemode=“w”,

format=“%(asctime)s %(name)s:%(levelname)s:%(message)s|%(filename)s:%(lineno)s”,

datefmt=“%Y-%M-%d %H:%M:%S”, level=logging.DEBUG)

logging.debug(‘This is a debug message’)

logging.debug(‘This is debug log’) # 调试级别

logging.info(‘This is info log’) # 信息级别

logging.warning(‘This is warning log’) # 警告级别

logging.error(‘This is error log’) # 错误级别

logging.critical(‘This is critical log’) # 严重错误级别

生成文件test.log，文件内容如下：

三、logging高级应用

===============================================================================

logging模块采用了模块化设计，主要包含四种组件:

| 类名 | 说明 |

| — | — |

| Loggers | 记录器，提供应用程序代码能直接使用的接口。 |

| Handlers | 处理器，将记录器产生的日志发送至目的地 |

| Filters | 过滤器，提供更好的粒度控制，决定那些日志会被输出 |

| Formatters | 格式化器，设置日志内容的组成结构和消息字段 |

logging模块的工作流程：

1、loggers记录器

---

• 1、提供应用程序的调用接口（logger是单例的）

logger = logging.getLogger(name)

• 2、决定日志记录的级别

logger.setLevel()

• 3、将日志内容传递相关联的handlers中

logger.addHandler()和logger.removeHandler()

2、Handlers处理器

---

它们将日志分发到不同的目的地：文件、标准输出、邮件、或者通过socke、http等协议发送到任何地方。

• SreamHandler：标准输出stdout（如显示器）分发器。

创建方法：sh = logging.StreamHandler(stream=None)

• FileHandle：将日志保存到磁盘文件的处理器

创建方法:fh=logging.FileHandler(filename,mode=“a”,encoding=Node,delay=False)

setFormatter()：设置当前handler对象使用的消息格式。

3、Formatters 格式

---

Formatter对象用来最终设置日志信息的顺序、结构和内容。

构造方法：ft = logging.Formatter.__init__(fmt=None,datefmt=None,style='%')

datefmt默认格式为：%Y-%m-%d %H:%M:%S；style参数默认为百分符%,这表示%(<dictionary key>)s格式的字符串

| 属性 | 格式 | 描述 |

| — | — | — |

| asctime | %(asctime)s | 日志产生时间，默认格式为 2021-11-23 10:20:30,123 |

| created | %(created)f | time.time()生成的日志创建时间戳 |

| filename | %(filename)s | 生成日志的程序名 |

| funcName | %(funcName)s | 调用日志的函数名 |

| levelname | %(levelname)s | 日志级别(DEGBU、INFO、WARNING、ERROR、CRITICAL) |

| levelno | %(levelno)s | 日志级别对应的数值 |

| lineno | %(lineno)d | 日志所针对的代码行号（报错代码所在行数） |

| module | %(module)s | 生成日志的模块名 |

| msecs | %(msecs)d | 日志生成时间的毫秒部分 |

| message | %(message)s | 具体的日志信息 |

| name | %(name)s | 日志调用者 |

| pathname | %(pathname)s | 生成日志的完整路径 |

| processName | %(processName)s | 进程名（如果可用） |

| thread | %(thread)d | 生成日志的线程id（如果可用） |

| process | %(process)d | 生成日志的进程id |

| threadName | %(threadName)s | 线程名（如果可用） |

四、高级用法实战

==========================================================================

1、记录器

---

• 默认情况：

import logging

logger = logging.getLogger()

print(logger)

print(type(logger))

输出结果如下：

• 修改为指定级别

import logging

logger = logging.getLogger(“applog”) # 修改的显示名称

logger.setLevel(logging.DEBUG) # 修改日志级别

print(logger)

print(type(logger))

输出结果如下：

2、处理器

---

• 普通处理器定义

consoleHandler = logging.StreamHandler()

consoleHandler.setLevel(logging.DEBUG)

• 写入文件处理器定义

写入文件，没有给handler指定日志级别，将使用logger的级别

fileHandler = logging.FileHandler(filename=“test.log”)

fileHandler.setLevel(logging.INFO)

• 设置formatter格式

给处理器设置formatter格式

formatter = logging.Formatter(“%(asctime)s %(name)s:%(levelname)s:%(message)s|%(filename)s:%(lineno)s”)

• 处理器设置格式

给处理器设置格式

consoleHandler.setFormatter(formatter)

fileHandler.setFormatter(formatter)

• 记录器要设置处理器

logger.addHandler(consoleHandler)

logger.addHandler(fileHandler)

完整代码：

import logging

记录器

logger = logging.getLogger(“applog”) # 修改的显示名称

logger.setLevel(logging.DEBUG) # 修改日志级别

处理器

consoleHandler = logging.StreamHandler()

consoleHandler.setLevel(logging.DEBUG)

写入文件，没有给handler指定日志级别，将使用logger的级别

fileHandler = logging.FileHandler(filename=“test.log”)

fileHandler.setLevel(logging.INFO)

给处理器设置formatter格式; 8s：表示s前面的占8位；-8s：左对齐

formatter = logging.Formatter(“%(asctime)s %(name)s:%(levelname)8s:%(message)s|%(filename)s:%(lineno)s”)

给处理器设置格式

consoleHandler.setFormatter(formatter)

fileHandler.setFormatter(formatter)

记录器要设置处理器

logger.addHandler(consoleHandler)

logger.addHandler(fileHandler)

打印日志的代码

logger.debug(‘This is debug log’) # 调试级别

logger.info(‘This is info log’) # 信息级别

logger.warning(‘This is warning log’) # 警告级别

logger.error(‘This is error log’) # 错误级别

logger.critical(‘This is critical log’) # 严重错误级别

输出结果：

• 控制台

• test.log文件中

3、过滤器

---

#定义过滤器；过滤开头名称为cn.cccb的文件

fit = logging.Filter(“cn.cccb”)

#关联过滤器

logger.addFilter(fit)

输出结果：

• 控制台无数据

• test.log文件中无数据

想要正常显示，需要修改记录器的自定义名称：

logger = logging.getLogger(“cn.cccb.log”)

输出结果如下：

• 控制台

• test.log文件

当然我们在设置过滤器的时候，我们也可以指定给我们的某个handler处理器指定过滤器来过滤，我们修改代码完整如下：

import logging

记录器

logger = logging.getLogger(“apploglog”) # 修改的显示名称

logger.setLevel(logging.DEBUG) # 修改日志级别

处理器

consoleHandler = logging.StreamHandler()

consoleHandler.setLevel(logging.DEBUG)

写入文件，没有给handler指定日志级别，将使用logger的级别

fileHandler = logging.FileHandler(filename=“test.log”)

fileHandler.setLevel(logging.INFO)

给处理器设置formatter格式; 8s：表示s前面的占8位

formatter = logging.Formatter(“%(asctime)s %(name)s:%(levelname)8s:%(message)s|%(filename)s:%(lineno)s”)

给处理器设置格式

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Python工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Python开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上前端开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录大纲截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且后续会持续更新

如果你觉得这些内容对你有帮助，可以扫码获取！！！（备注Python）

e)8s:%(message)s|%(filename)s:%(lineno)s")

给处理器设置格式

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Python工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Python开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

[外链图片转存中…(img-N8I5tY2A-1712445441475)]

[外链图片转存中…(img-puZZVsR1-1712445441476)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上前端开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录大纲截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且后续会持续更新

如果你觉得这些内容对你有帮助，可以扫码获取！！！（备注Python）