Python Logging 模块完全解读

简介: Python Logging 模块完全解读

Python 中的 logging 模块可以让你跟踪代码运行时的事件,当程序崩溃时可以查看日志并且发现是什么引发了错误。Log 信息有内置的层级——调试(debugging)、信息(informational)、警告(warnings)、错误(error)和严重错误(critical)。你也可以在 logging 中包含 traceback 信息。不管是小项目还是大项目,都推荐在 Python 程序中使用 logging。本文将简单清晰地介绍如何使用 logging 模块。


为什么使用 logging?



当你运行一个 Python 脚本时,你可能想要知道脚本的哪个部分在执行,并且检视变量的当前值。


通常,可以只使用 print() 打印出你想要的信息。在小程序中,可能靠这个就足够了。


但问题是,当你处理有很多个模块的大项目时,就需要一个更加灵活的方法。

为什么?


因为代码需要经历开发、调试、审查、测试或者上线等不同阶段。在开发时你想要打印的信息类型可能和上线后你想看到的信息类型完全不同。


也就是说,在“测试”时,你可能只想看警告和错误信息,然而在“调试”时,你可能还想看到跟调试相关的信息。


如果你还想打印出使用的模块以及代码运行的时间,那么你的代码很容易变得混乱。

使用 logging 模块,这些问题就能很容易地解决。


logging 模块可以:


  1. 控制信息层级,仅记录需要的信息。
  2. 控制显示或者保存日志的时机。
  3. 使用内置信息模板控制日志格式。
  4. 知晓信息来自于哪个模块。


基本 logging 例子



logging 模块是 Python 的标准库,要使用 logging,只需要使用 logging.basicConfig() 进行基本设置。事实上,这也是可选的。


然后就可以调用 logging.{level}(message) 在控制台中显示信息。


import logging
logging.basicConfig(level=logging.INFO)
def hypotenuse(a, b):
    """计算三角形斜边"""
    return (a**2 + b**2)**0.5
logging.info("{a}, {b} 的斜边是 {c}".format(a=3, b=4, c=hypotenuse(a=3, b=4)))
#> INFO:root:3, 4 的斜边是 5.0


打印出的日志信息遵循默认格式: {LEVEL}:{LOGGER}:{MESSAGE}。


上面的例子中, LEVEL 就是 INFO,因为调用的是 logging.info()。


LOGGER 为 root,因为这是默认 logger。


logger(日志记录器)类似于一个实体,你可以创建并配置它来记录不同类型和格式的消息。


你可以配置一个输出到控制台的 logger 和另一个将日志发送到文件的 logger,它们具有不同的日志记录级别,并且特定于给定模块。


最后,输出的信息就是我传递给 logging.info() 的字符串。


那么如果不设置 logging.basicConfig(level=logging.INFO) 会怎么样?


答案是 日志信息不会被打印出来。


为什么?要知道这个需要先了解 logging 的级别。


logging 的 5 个级别



logging 有 5 个不同层次的日志级别,可以将给定的 logger 配置为这些级别:


  1. DEBUG:详细信息,用于诊断问题。Value=10。
  2. INFO:确认代码运行正常。Value=20。
  3. WARNING:意想不到的事情发生了,或预示着某个问题。但软件仍按预期运行。Value=30。
  4. ERROR:出现更严重的问题,软件无法执行某些功能。Value=40。
  5. CRITICAL:严重错误,程序本身可能无法继续运行。Value=50。


现在,让我们回答之前提出的问题。默认 logger 是 root,其默认的 basicConfig 级别是 WARNING。也就是说,只有来自 logging.warning或者更高级别的信息才会被记录下来。


因此,logging.info() 中的信息不会被打印出来。这也是为什么 basicConfig 被设为 INFO。


如果级别使用 logging.ERROR 代替,只有来自 logging.error 和 logging.critical 的信息会被记录。


import logging
logging.basicConfig(level=logging.ERROR)
def hypotenuse(a, b):
    """计算三角形斜边"""
    return (a**2 + b**2)**0.5
kwargs = {'a':3, 'b':4, 'c':hypotenuse(3, 4)}
logging.debug("a = {a}, b = {b}".format(**kwargs))
logging.info("{a}, {b} 的斜边是 {c}".format(**kwargs))
logging.warning("a={a} 和 b={b} 相等".format(**kwargs))
logging.error("a={a} 和 b={b} 不能为负".format(**kwargs))
logging.critical("{a}, {b} 的斜边是 {c}".format(**kwargs))
#> ERROR:root:a=3 和 b=4 不能为负
#> CRITICAL:root:3, 4 的斜边是 5.0


将日志记入文件



要从 root logger 将日志消息发送到文件,需要在 logging.basicConfig() 中设置 file 参数:


import logging
logging.basicConfig(level=logging.INFO, filename='sample.log')


现在,所有后续日志消息都将直接记录到当前工作目录中的“sample.log“文件。如果要将其记录到另一个目录中的文件,请给出完整的文件路径。


如何更改 logging 格式



logging 模块提供了向日志消息添加各种详细信息的速记表。


微信图片_20220429121541.jpg


fig


让我们更改日志信息格式以显示 TIME、LEVEL 和 MESSAGE。


import logging
logging.basicConfig(level=logging.INFO, format='%(asctime)s :: %(levelname)s :: %(message)s')
logging.info("当当当!")
#> 2019-03-10 19:41:09,057 :: INFO :: 当当当!


不要对所有模块使用 root logger


让我们看下面的代码:


# 1. myprojectmodule.py
import logging
logging.basicConfig(filename='module.log')
#-----------------------------
# 2. main.py (从 myprojectmodule.py 导入代码)
import logging
import myprojectmodule  # 运行 myprojectmodule.py 中的代码,将生成 `module.log` 文件
logging.basicConfig(filename='main.log')  # 无效!


如果项目中有一个或多个模块。这些模块使用基本根模块。然后,当导入模块 myprojectmodule.py 时,将运行该模块的所有代码并配置 logger。


一旦配置好,main 文件中的 root logger 将不能再更改 root logger 设置。因为,一旦设置好 logging.basicConfig(),就不能再更改它。


如果想在不同文件中使用不同 logger,就需要创建一个新的 logger。


如何创建一个新的 logger?



可以使用 logger.getLogger(name) 方法创建一个新的 logger。


如果存在同名的 logger,则将使用该 logger。


可以给 logger 取任何名字,但是通常使用 __name__ 变量。

相关实践学习
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
相关文章
|
SQL 关系型数据库 数据库
Python SQLAlchemy模块:从入门到实战的数据库操作指南
免费提供Python+PyCharm编程环境,结合SQLAlchemy ORM框架详解数据库开发。涵盖连接配置、模型定义、CRUD操作、事务控制及Alembic迁移工具,以电商订单系统为例,深入讲解高并发场景下的性能优化与最佳实践,助你高效构建数据驱动应用。
1242 7
|
监控 安全 程序员
Python日志模块配置:从print到logging的优雅升级指南
从 `print` 到 `logging` 是 Python 开发的必经之路。`print` 调试简单却难维护,日志混乱、无法分级、缺乏上下文;而 `logging` 支持级别控制、多输出、结构化记录,助力项目可维护性升级。本文详解痛点、优势、迁移方案与最佳实践,助你构建专业日志系统,让程序“有记忆”。
1034 0
|
JSON 算法 API
Python中的json模块:从基础到进阶的实用指南
本文深入解析Python内置json模块的使用,涵盖序列化与反序列化核心函数、参数配置、中文处理、自定义对象转换及异常处理,并介绍性能优化与第三方库扩展,助你高效实现JSON数据交互。(238字)
887 4
|
安全 大数据 程序员
Python operator模块的methodcaller:一行代码搞定对象方法调用的黑科技
`operator.methodcaller`是Python中处理对象方法调用的高效工具,替代冗长Lambda,提升代码可读性与性能。适用于数据过滤、排序、转换等场景,支持参数传递与链式调用,是函数式编程的隐藏利器。
358 4
|
Java 调度 数据库
Python threading模块:多线程编程的实战指南
本文深入讲解Python多线程编程,涵盖threading模块的核心用法:线程创建、生命周期、同步机制(锁、信号量、条件变量)、线程通信(队列)、守护线程与线程池应用。结合实战案例,如多线程下载器,帮助开发者提升程序并发性能,适用于I/O密集型任务处理。
1015 0
|
XML JSON 数据处理
超越JSON:Python结构化数据处理模块全解析
本文深入解析Python中12个核心数据处理模块,涵盖csv、pandas、pickle、shelve、struct、configparser、xml、numpy、array、sqlite3和msgpack,覆盖表格处理、序列化、配置管理、科学计算等六大场景,结合真实案例与决策树,助你高效应对各类数据挑战。(238字)
1487 0
|
存储 数据库 开发者
Python SQLite模块:轻量级数据库的实战指南
本文深入讲解Python内置sqlite3模块的实战应用,涵盖数据库连接、CRUD操作、事务管理、性能优化及高级特性,结合完整案例,助你快速掌握SQLite在小型项目中的高效使用,是Python开发者必备的轻量级数据库指南。
1023 0
|
Python
Python Internet 模块
Python Internet 模块。
424 74
|
存储 安全 数据处理
Python 内置模块 collections 详解
`collections` 是 Python 内置模块,提供多种高效数据类型,如 `namedtuple`、`deque`、`Counter` 等,帮助开发者优化数据处理流程,提升代码可读性与性能,适用于复杂数据结构管理与高效操作场景。
718 0

推荐镜像

更多