logging模块

logging模块
日志级别
logging的简单使用
logging模块的四种对象
logging的进阶使用
参考文档:

logging模块

Python内置的日志模块，日志是对软件执行时所发生事件的一种追踪方式。软件开发人员对他们的代码添加日志调用，借此来指示某事件的发生。一个事件通过一些包含变量数据的描述信息来描述（比如：每个事件发生时的数据都是不同的）。开发者还会区分事件的重要性，重要性也被称为等级或 严重性。

正常的项目想看程序状态变化，尽量不要用print（断点调试/日志）。任何语言、任何程序都要记录日志。

Python中的日志要么输出至控制台，要么保存至文件。

日志级别

CRITICAL = 50  # 危险/紧急
ERROR = 40  # 错误
WARNING = 30  # 警告
INFO = 20  # 正常信息，用来替代print
DEBUG = 10  # 调试
NOTSET = 0  # 不设置

默认会将日志信息打印到终端，默认的级别为WARNING，表示会输出WARNING及以上级别的日志。

logging的简单使用

1、导入模块

import logging

2、定义基本配置

Python3.9中可以配置编码，在此之前只能使用默认系统编码。

logging.basicConfig(
            # filename='access.log',          # 日志名字 (不指定默认输出到终端)
            format='%(asctime)s - %(name)s - %(levelname)s - %(module)s: %(message)s', # 日志格式
            datefmt='%Y-%m-%d %H:%M:%S %p',   # 时间格式
            level=30,                         # 日志等级
            )

3、在程序运行中使用。

logging.debug('自定义的调试信息。')
logging.info('自定义的正常信息。')
logging.warning('自定义的警告信息。')
logging.error('自定义的报错信息。')
logging.critical('自定义的紧急信息。')

执行结果。

>>> logging.debug('自定义的调试信息。')
>>> logging.info('自定义的正常信息。')
>>> logging.warning('自定义的警告信息。')
2020-12-20 10:54:49 AM - root - WARNING - <stdin>: 自定义的警告信息。
>>> logging.error('自定义的报错信息。')
2020-12-20 10:54:49 AM - root - ERROR - <stdin>: 自定义的报错信息。
>>> logging.critical('自定义的紧急信息。')
2020-12-20 10:54:59 AM - root - CRITICAL - <stdin>: 自定义的紧急信息。

logging.basicConfig（）所做的配置为全局配置，针对所以logger有效。

在logging.basicConfig（）中通过具体参数来更改logging模块的默认行为，可用参数有：

filename：指定文件名创建FileHandler，这样日志会被存储到指定的文件中。
filemode：文件打开方式，默认为 “ a ”可指定为 “ w ”。
format：指定handler使用的日志格式。
datefmt：指定日期时间格式。
level：设置rootlogger的日志级别。
stream：用指定的stream创建StreamHandler。可以指定输出到sys.stderr,sys.stdout或者文件，默认为sys.stderr。若同时列出了filename和stream两个参数，则stream参数会被忽略。

可指定格式有：

格式	含义
%(name)s	Logger的名字，并非用户名，详细查看
%(levelno)s	数字形式的日志级别
%(levelname)s	文本形式的日志级别
%(pathname)s	调用日志输出函数的模块的完整路径名，可能没有
%(filename)s	调用日志输出函数的模块的文件名
%(module)s	调用日志输出函数的模块名
%(funcName)s	调用日志输出函数的函数名
%(lineno)d	调用日志输出函数的语句所在的代码行
%(created)f	当前时间，用UNIX标准的表示时间的浮点数表示
%(relativeCreated)d	输出日志信息时的，自Logger创建以来的毫秒数
%(asctime)s	字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”。逗号后面的是毫秒
%(thread)d	线程ID。可能没有
%(threadName)s	线程名。可能没有
%(process)d	进程ID。可能没有
%(message)s	用户输出的消息

logging模块的四种对象

logger：产生日志的对象。1个logger对象可以绑定多个Handler，用以输出至不同位置。
filter：过滤日志的对象，不常用。
handler：控制日志输入位置，FileHandler用来输出至文件中，StreamHandler用来输出至终端。
Formatter：格式化输出，定制不同的日志格式对象，然后绑定给不同的Handler对象使用，以此来控制不同的Handler的日志格式。

import logging

# 1、logger对象：负责产生日志，交给Filter过滤，然后交给不同的Handler输出。
logger = logging.getLogger(__file__)  # 传入的参数为logger对象的名字。

# 2、Handler对象:接收logger传来的日志,输出至不同位置。
h1 = logging.FileHandler('f1.log')  # 定义一个输出至当前目录文件f1.log的Handler对象.
h2 = logging.FileHandler('f2.log')  # 定义一个输出至当前目录文件f2.log的Handler对象.
h3 = logging.StreamHandler()  # 定义一个输出至终端的Handler对象.

# 3、Formatter对象：定义日志格式
formater1=logging.Formatter('%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s',
                    datefmt='%Y-%m-%d %H:%M:%S %p',)

formater2=logging.Formatter('%(asctime)s :  %(message)s',
                    datefmt='%Y-%m-%d %H:%M:%S %p',)

formater3=logging.Formatter('%(name)s %(message)s',)

# 4、为Handler对象绑定格式
h1.setFormatter(formater1)
h2.setFormatter(formater2)
h3.setFormatter(formater3)

# 5、将Handler添加给logger并设置日志级别。1个logger对象可以绑定多个Handler，用以输出至不同位置。
logger.addHandler(h1)
logger.addHandler(h2)
logger.addHandler(h3)
logger.setLevel(10)  # debug级别及以上的日志都会输出至两个日志文件和终端。

# 6、测试
logger.debug('debug')
logger.info('info')
logger.warning('warning')
logger.error('error')
logger.critical('critical')
由于级别为debug，所有日志都会输出至f1.log、f2.log和终端，只是日志格式不同。

logger是第一级过滤，然后才到handler，可以给logger和handler都设置level，如果将logger等级设为debug，handler设为info，那么handler对象的输出不会包含debug级别的日志，因为debug < info

# 验证
import logging

# 定义一个Formatter对象
fmt = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s',
                    datefmt='%Y-%m-%d %H:%M:%S %p',)

# 定义一个标准输出的Handler对象
std = logging.StreamHandler()

# 将Formatter绑定给Handler,设定日志等级为20
std.setFormatter(fmt)
std.setLevel(20)

# 定义一个Logger名字为root,设定日志等级为10
log1 = logging.getLogger('root')
log1.setLevel(10)

# 将Handler对象绑定给Logger
log1.addHandler(std)

# 产生日志.
log1.debug('debug信息')
log1.info('info信息')

结果：

2020-12-20 12:39:38 PM - root - INFO -code:  info信息

可以看到debug信息并没有输出，因为Handler对象的等级为20，只有info及以上级别的信息会输出，debug会被过滤掉。

Formatter、Handler和Logger对象的使用顺序为：

1、先产生Formatter对象，定义不同日志格式。
2、产生Handler对象，定义不同的输出位置，定义Handler对象过滤日志的等级。
3、将Formatter对象绑定给Handler对象，通常输出至终端的日志格式要比输出至文件的日志格式要精简。
4、产生Logger对象，在括号内定义对象的名称，也就是%(name)s所输出的内容。
5、将Handler对象绑定给Logger，一个Logger对象可以绑定多个Handler。

logging的进阶使用

通常我们会使用一个配置字典来定义日志。实例：

1、导入logging模块。

import os
import logging
import logging.config

2、定义三种日志输出格式。

standard_format = '[%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d][%(levelname)s][%(message)s]'  # 其中name为getlogger指定的名字

simple_format = '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'

id_simple_format = '[%(levelname)s][%(asctime)s] %(message)s'

3、定义日志文件位置。

# 动态获取目录
logfile_dir = os.path.dirname(os.path.dirname(__file__))
logfile_name = 'f1.log'  # 日志文件名

# 如果不存在定义的日志目录就创建一个
if not os.path.isdir(logfile_dir):
    os.mkdir(logfile_dir)
    
# log文件的完整路径
logfile_path = os.path.join(logfile_dir, logfile_name)

4、定义配置字典。通常会放在配置文件中，比如项目conf目录下settings文件中。

LOGGING_DIC = {
    'version': 1,						# 配置字典的版本.
    'disable_existing_loggers': False,	  # 是否关闭已存在的日志,默认False.
    'formatters': {      				# 先定义的多个Formatter对象。
        'standard': {    				#  Formatter对象standard,格式为上述变量内的值.
            'format': standard_format
        },
        'simple': {     				# Formatter对象simple,格式为上述变量内的值.
            'format': simple_format  
        },
    },
    'filters': {},						# Filter对象,不常用.
    'handlers': {  						# 里面是定义的多个Handler对象。
        'console': {					# 打印到终端的Handler对象console
            'level': 'DEBUG',  			# 级别为DEBUG
            'class': 'logging.StreamHandler',  	# 打印到屏幕
            'formatter': 'simple',			# 绑定Formatter对象为simple
        },
        'default': {					# 打印到文件的Handler对象default。
            'level': 'DEBUG',  			 # 级别为DEBUG
            'class': 'logging.handlers.RotatingFileHandler',    # 保存到文件
            'formatter': 'standard',		# 绑定Formatter对象为standard
            'filename': logfile_path,  		# 指定日志文件路径
            # 指定文件大小,单位为字节.
            'maxBytes': 1024*1024*5,  # 日志大小 5M
            'backupCount': 5,			# 最大保存5个日志文件，多了就会把最旧的那个文件删除。
            'encoding': 'utf-8',  # 日志文件的编码，通常指定为utf-8
        },
    },
    'loggers': {			# 里面是定义的多个logger对象
        # ''所定义的配置就是logging.getLogger(__name__)拿到的logger配置
        '': {
            'handlers': ['default', 'console'],  # 这里把上面定义的两个handler都加上，即log数据既写入文件又打印到屏幕
            'level': 'DEBUG',
            'propagate': False,  # 向上（更高level的logger）传递,通常设置为False即可，否则会一份日志向上层层传递
        },
    },
}

5、在其他文件中导入配置字典，logging模块是个包，要使用里面的方法可以通过如下方式导入。

from logging import config
from logging import getLogger

# 导入配置字典
from conf import settings

6、加载配置。

logging.config.dictConfig(settings.LOGGING_DIC)

7、生成logger对象，输出日志。

logger1 = logging.getLogger('银行操作')
logger1.info('李白提现一个亿')

8、结果为：

# console Handler对象会输出至屏幕。
[INFO][2020-12-20 20:00:11,247][code.py:127]李白提现了一个亿

# default Handler对象会输出至conf的父目录下f1.log文件中。
[2020-12-20 20:00:11,247][MainThread:9032][task_id:银行操作][code.py:127][INFO][李白提现了一个亿]

9、如果要在其他文件中使用该配置，那么也要重复执行导入配置字典操作，所以我们可以将导入字典这步操作写入字典所在文件中，将之放入一个函数，以后再导入该函数即可：

def get_logger(name):
    logging.config.dictConfig(LOGGING_DIC)
    logger = logging.getLogger(name)
    return logger

10、在其他文件中使用。

from conf.settings import get_logger
logger1 = get_logger('银行接口')
logger1.info('李白提现一个亿')

所得到的的结果也相同，并且还能在产生logger对象时，可以在函数中自定义添加其他功能，更加方便使用。

参考文档:

https://docs.python.org/zh-cn/3/library/logging.html?highlight=loggin#module-logging