内置模块-logging

loging模块是python提供的内置模块，用来做日志处理。

日志等级：

logging的执行是多线程的。

1. 基本函数

不推荐使用basicConfig对日志等级进行自我创作，因为会影响代码的移植性，代码在别人那里容易起冲突。

2. 基本使用

logging模块的默认输出级别是warning。

import logging

logging.debug('This is a debug log.')
logging.info('This is a info log.')
logging.warning('This is a warning log.')
logging.error('This is a error log.')
logging.critical('This is a critical log.')

# 默认的日志输出级别是warning，
# 所以以上代码运行时结果是：
# WARNING:root:This is a warning log.
# ERROR:root:This is a error log.
# CRITICAL:root:This is a critical log.

basicConfig常见参数：

• level：设置日志级别
• filename：设置日志输出文件名
• filemode：设置日志输出模式
• format：设置日志格式
• datefmt：设置时间格式（"%Y-%m-%d %H:%M:%S"）

level：设置输出级别：

import logging

logging.basicConfig(level=logging.DEBUG)
# 将日志的输出级别设置为debug

filename：设置日志文件

默认日志的输出是在终端，

可通过指定文件名的方式将日志记录到文件中，默认是追加模式。

import logging

logging.basicConfig(level=logging.DEBUG, filename='demo.log')
# 将日志输出结果记录到文件demo.log中。（不存在则创建）

filemode：设置写入模式

通过filemode参数设置写入方式

import logging

logging.basicConfig(level=logging.DEBUG, filename='demo.log', filemode='w')

format：设置日志格式

logging.basicConfig(
    filename='demo.log',
    level=logging.DEBUG,
    format="%(asctime)s|%(levelname)s|%(message)s|%(filename)s:%(lineno)s",
)

datefmt：设置日期格式

logging.basicConfig(
    filename='demo.log',
    level=logging.DEBUG,
    format="%(asctime)s|%(levelname)s|%(message)s|%(filename)s:%(lineno)s",
    datefmt="%Y-%m-%d %H:%M:%S",
)

3. 高级应用

3.1 相关组件

3.2 loggers

日志对象。

相当于创建一支笔。

import logging

# 创建一个Logger，名称是cn.cccb.applog
logger = logging.getLogger('cn.cccb.applog')

# 设置为日志输出级别
logger.setLevel(logging.WARNING)

3.3 Handlers

Handler是用于将日志分发到不同的目的地。

可以是终端（默认）、文件、邮件、或者通过 socket、http等协议发送到任何地方。

相当于不同的输出媒介。

以下是常见的Handler：

• StreamHandler：标准输出stout分发器

import logging

sh = logging.StreamHandler(stream=None)

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

import logging

fh = logging.FileHandler(filename,mode='a',encoding=None,delay=False)

• BaseRotatingHandler
• RotatingFileHandler：滚动的多日志输出，按照时间or其他方式去生成多个日志
• TimedRotatingFileHandler

以下Handler使用得较少

• SocketHandler
• DataaramHandler
• SmtpHandler
• SyslogHandler
• NteventlogHandler
• HttpHandler
• WatchedFileHandler
• QuteleHandler
• NullHandler

每一个handler都有一个setFormatter()方法，

用于设置当前Handler对象使用Formatter，以指定日志的输出格式。

3.4 Formatters格式

Formatter对象用来设置日志信息的结构和内容。

其构造方法是：

import logging

# 创建formatter，并设置formatter的格式
formatter = logging.Formatter("%(asctime)s|%(levelname)8s|%(filename)10s%(lineno)s|%(message)s")

3.5 案例

# 创建一个Logger，名称是cn.cccb.applog
logger = logging.getLogger('cn.cccb.applog')

# 设置为日志输出级别
logger.setLevel(logging.DEBUG)


# 创建终端Handler，并设置输出级别
consoleHandler = logging.StreamHandler()
consoleHandler.setLevel(logging.DEBUG)


# 创建文件Handler，并设置输出级别
fileHandler = logging.FileHandler(filename='addDemo.log')
fileHandler.setLevel(logging.INFO)


# 创建formatter，并设置formatter的格式
formatter = logging.Formatter("%(asctime)s|%(levelname)8s|%(filename)10s%(lineno)s|%(message)s")
#里面的8，10实现了占位对齐


# 给每个处理器设置格式
consoleHandler.setFormatter(formatter)
fileHandler.setFormatter(formatter)


# 给logger设置handler
logger.addHandler(consoleHandler)
logger.addHandler(fileHandler)


#定义一个过滤器，过滤logger的名称，以cn.cccb开头的才会被处理。
# flt = logging.Filter("cn.cccb")


# 关联过滤器
# logger.addFilter(flt)  # 可以是给logger设置过滤器
# fileHandler.addFilter(flt)  # 可以是给handler设置过滤器

name = 'zibuyu'
age = 18

# 打印日志的代码
# logging.debug()  #不能使用这个了！！！会使用WARNING的版本，不会用之前的记录器
logger.debug("姓名 %s, 年龄%d" % (name, age))
logger.debug("姓名 {}, 年龄{}".format(name, age))
logger.debug(f"姓名{name}, 年龄{age}")

上面的案例中，logger、handler和formatter都可以设置日志的输出级别，它们之间的关系是逐层过滤。

4. 通过配置文件

logging.conf:

# 配置记录器名称：提供应用程序代码直接使用的接口
# 注意：root必须存在！！！
[loggers]
keys=root,applog

# 配置处理器名称，将记录器产生的日志发送至目的地
[handlers]
keys=fileHandler,consoleHandler

# 配置格式化器，设置日志内容的组成结构和消息字段
[formatters]
keys=simpleFormatter

# 设置记录器root的级别与种类
# 节点名称必须是logger_+上面配置的记录器名称
[logger_root]
level=DEBUG
handlers=consoleHandler

# 设置记录器applog的级别与种类
[logger_applog]
level=DEBUG 
handlers=fileHandler,consoleHandler

#起个对外的名字
qualname=applog

#继承关系
propagate=0

#设置
[handler_consoleHandler]
class=StreamHandler
args=(sys.stdout,)
level=DEBUG
formatter=simpleFormatter

[handler_fileHandler]
class=handlers.TimedRotatingFileHandler
# 在午夜1点（3600s）开启下一个log文件，第四个参数0表示保留历史文件
args=('applog.log','midnight',3600,0)
level=DEBUG
formatter=simpleFormatter

[formatter_simpleFormatter]
format=%(asctime)s|%(levelname)8s|%(filename)s[:%(lineno)d]|%(message)s
#设置时间输出格式
datefmt=%Y-%m-%d %H:%M:%S

使用：

import logging
import logging.config

# 通过文件配置创建logger
logging.config.fileConfig('logging.conf')

# 使用字典进行配置
# logging.config.dictConfig({"loggers":"root,applog"})

rootLogger = logging.getLogger()
rootLogger.debug("This is root Logger, debug")

logger = logging.getLogger('applog')
logger.debug("This is applog, debug")

try:
    a = 'qwe'
    int(a)  # 故意出错。
except Exception as e:
    logger.exception(e)

注意：配置文件的默认编码是gbk。

在python 3.10 版本，fileConfig新增了 encoding 形参，可以指定配置文件的编码。