Python logging 模块基础教程

基础内容

简单使用

logging 模块使用与日志级别对应的函数可以直接输出日志

import logging
logging.warning("warn")

输出:

WARNING:root:warn

没有手动配置, logging 模块默认使用 the root logger 发送日志, 这就是为什么输出中包含 root , 日志默认被发送至标准错误输出 sys.stderr(终端一般会显示为红色字体)

日志级别

Level	重要程度
logging.DEBUG	调试
logging.INFO	通知
logging.WARNING	警告
logging.ERROR	一般错误
logging.CRITICAL	严重错误

the root logger 默认有效级别为 WARNING, 低于该级别的日志默认被忽视

logging.info("info") # 没有打印日志

保存日志文件

如果要将日志保存到日志文件, 则要调用logging.basicConfig()修改默认配置, 该函数应在程序开头调用一次

如果在显式配置前直接使用logging.info()之类的日志输出函数,系统使用默认配置隐式调用logging.basicConfig()

# 写入指定文件
logging.basicConfig(filename="/tmp/temp.log", level=logging.INFO)

logging.warning("WARNING")
logging.debug("DEBUG")

如果配置没有生效, 可以新增 force 参数强行覆盖之前的配置logging.basicConfig(...,force=True)(Python3.8 有效)

查看日志内容

$ cat /tmp/temp.log

WARNING:root:WARNING

日志文件默认为追加模式, 可以修改为只写模式

logging.basicConfig(filename="/tmp/temp.log", filemode='w', level=logging.INFO)

这样每次运行代码都会清空之前的日志

日志内容

日志消息中可包含变量数据, 使用 %-style 格式的字符串

name = "Hoss"
age = "100"

logging.info("name: %s age: %s", name, age)

INFO:root:name: Hoss age: 100

日志格式

日志的默认格式为 “%(levelname)s:%(name)s:%(message)s”, 可以使用 logging.BASIC_FORMAT 查看, 其中 %(message)s 是使用 logging.info("") 等函数发出的日志内容, %(levelname)s 为级别名称, %(name)s 为 logger 的名称

常见的格式

格式	作用
%(asctime)s	时间
%(module)s	模块名
%(lineno)d	对应源代码中的行数

示例 base.py

import logging

# 修改日志格式
logging.basicConfig(format="%(asctime)s:%(module)s:%(lineno)d:%(message)s",
                    filemode="w",
                    level=logging.INFO)

logging.warning("WARNING")

2020-09-27 11:34:35,235:base:8:WARNING