Python常用库 - logging日志库

时间:2020-02-18 小菠萝测试笔记人气:0

logging的简单介绍

用作记录日志，默认分为六种日志级别（括号为级别对应的数值）

NOTSET（0）
DEBUG（10）
INFO（20）
WARNING（30）
ERROR（40）
CRITICAL（50）

special

在自定义日志级别时注意不要和默认的日志级别数值相同
logging 执行时输出大于等于设置的日志级别的日志信息，如设置日志级别是 INFO，则 INFO、WARNING、ERROR、CRITICAL 级别的日志都会输出。

logging常见对象

Logger：日志，暴露函数给应用程序，基于日志记录器和过滤器级别决定哪些日志有效。
LogRecord ：日志记录器，将日志传到相应的处理器处理。
Handler ：处理器, 将(日志记录器产生的)日志记录发送至合适的目的地。
Filter ：过滤器, 提供了更好的粒度控制,它可以决定输出哪些日志记录。
Formatter：格式化器, 指明了最终输出中日志记录的格式。

logging基本使用

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

参数名称	参数描述
filename	日志输出到文件的文件名
filemode	文件模式，r[+]、w[+]、a[+]
format	日志输出的格式
datefat	日志附带日期时间的格式
style	格式占位符，默认为 "%" 和 “{}”
level	设置日志输出级别
stream	定义输出流，用来初始化 StreamHandler 对象，不能 filename 参数一起使用，否则会ValueError 异常
handles	定义处理器，用来创建 Handler 对象，不能和 filename 、stream 参数一起使用，否则也会抛出 ValueError 异常

logging代码

1 logging.debug("debug")
2 logging.info("info")
3 logging.warning("warning")
4 logging.error("error")5 logging.critical("critical")

测试结果

1 WARNING:root:warning
2 ERROR:root:error
3 CRITICAL:root:critical

但是当发生异常时，直接使用无参数的 debug() 、 info() 、 warning() 、 error() 、 critical() 方法并不能记录异常信息，需要设置 exc_info=True 才可以，或者使用 exception() 方法，还可以使用 log() 方法，但还要设置日志级别和 exc_info 参数

1 a = 5
2 b = 0
3 try:
4     c = a / b
5 except Exception as e:
6     # 下面三种方式三选一，推荐使用第一种
7     logging.exception("Exception occurred")
8     logging.error("Exception occurred", exc_info=True)
9     logging.log(level=logging.ERROR, msg="Exception occurred", exc_info=True)

logging之Formatter对象

Formatter 对象用来设置具体的输出格式，常用格式如下表所示

格式	变量描述
%(asctime)s	将日志的时间构造成可读的形式，默认情况下是精确到毫秒，如 2018-10-13 23:24:57,832，可以额外指定 datefmt 参数来指定该变量的格式
%(name)	日志对象的名称
%(filename)s	不包含路径的文件名
%(pathname)s	包含路径的文件名
%(funcName)s	日志记录所在的函数名
%(levelname)s	日志的级别名称
%(message)s	具体的日志信息
%(lineno)d	日志记录所在的行号
%(pathname)s	完整路径
%(process)d	当前进程ID
%(processName)s	当前进程名称
%(thread)d	当前线程ID
%threadName)s	当前线程名称

logging封装类

 1 #!/usr/bin/env python
 2 # -*- coding: utf-8 -*-
 3 
 4 """
 5 __title__  = logging工具类
 6 __Time__   = 2019/8/8 19:26
 7 """
 8 import logging
 9 from logging import handlers
10 
11 
12 class Loggers:
13     __instance = None
14 
15     def __new__(cls, *args, **kwargs):
16         if not cls.__instance:
17             cls.__instance = object.__new__(cls, *args, **kwargs)
18         return cls.__instance
19 
20     def __init__(self):
21         # 设置输出格式
22         formater = logging.Formatter(
23             '[%(asctime)s]-[%(levelname)s]-[%(filename)s]-[%(funcName)s:%(lineno)d] : %(message)s')
24         # 定义一个日志收集器
25         self.logger = logging.getLogger('log')
26         # 设定级别
27         self.logger.setLevel(logging.DEBUG)
28         # 输出渠道一 - 文件形式
29         self.fileLogger = handlers.RotatingFileHandler("./test.log", maxBytes=5242880, backupCount=3)
30 
31         # 输出渠道二 - 控制台
32         self.console = logging.StreamHandler()
33         # 控制台输出级别
34         self.console.setLevel(logging.DEBUG)
35         # 输出渠道对接输出格式
36         self.console.setFormatter(formater)
37         self.fileLogger.setFormatter(formater)
38         # 日志收集器对接输出渠道
39         self.logger.addHandler(self.fileLogger)
40         self.logger.addHandler(self.console)
41 
42     def debug(self, msg):
43         self.logger.debug(msg=msg)
44 
45     def info(self, msg):
46         self.logger.info(msg=msg)
47 
48     def warn(self, msg):
49         self.logger.warning(msg=msg)
50 
51     def error(self, msg):
52         self.logger.error(msg=msg)
53 
54     def excepiton(self, msg):
55         self.logger.exception(msg=msg)
56 
57 
58 loggers = Loggers()
59 
60 if __name__ == '__main__':
61     loggers.debug('debug')
62     loggers.info('info')

logzero封装类

 1 #!/usr/bin/env python
 2 # -*- coding: utf-8 -*-
 3 
 4 """
 5 __title__  = logzero日志封装类
 6 __Time__   = 2019/8/8 19:26
 7 """
 8 import logging
 9 
10 import logzero
11 from logzero import logger
12 
13 
14 class Logzero(object):
15     __instance = None
16 
17     def __new__(cls, *args, **kwargs):
18         if not cls.__instance:
19             cls.__instance = object.__new__(cls, *args, **kwargs)
20         return cls.__instance
21 
22     def __init__(self):
23         self.logger = logger
24         # console控制台输入日志格式 - 带颜色
25         self.console_format = '%(color)s' \
26                               '[%(asctime)s]-[%(levelname)1.1s]-[%(filename)s]-[%(funcName)s:%(lineno)d] 日志信息: %(message)s ' \
27                               '%(end_color)s '
28         # 创建一个Formatter对象
29         self.formatter = logzero.LogFormatter(fmt=self.console_format)
30         # 将formatter提供给setup_default_logger方法的formatter参数
31         logzero.setup_default_logger(formatter=self.formatter)
32 
33         # 设置日志文件输出格式
34         self.formater = logging.Formatter(
35             '[%(asctime)s]-[%(levelname)s]-[%(filename)s]-[%(funcName)s:%(lineno)d] 日志信息: %(message)s')
36         # 设置日志文件等级
37         logzero.loglevel(logging.DEBUG)
38         # 输出日志文件路径和格式
39         logzero.logfile("F:\\imocInterface\\log/tests.log", formatter=self.formater)
40 
41     def debug(self, msg):
42         self.logger.debug(msg=msg)
43 
44     def info(self, msg):
45         self.logger.info(msg=msg)
46 
47     def warning(self, msg):
48         self.logger.warning(msg=msg)
49 
50     def error(self, msg):
51         self.logger.error(msg=msg)
52 
53     def exception(self, msg):
54         self.logger.exception(msg=msg)
55 
56 
57 logzeros = Logzero()
58 
59 if __name__ == '__main__':
60     logzeros.debug("debug")
61     logzeros.info("info")
62     logzeros.warning("warning")
63     logzeros.error("error")
64     a = 5
65     b = 0
66     try:
67         c = a / b
68     except Exception as e:
69         logzeros.exception("Exception occurred")

变量	格式	变量描述
asctime	%(asctime)s	将日志的时间构造成可读的形式，默认情况下是精确到毫秒，如 2018-10-13 23:24:57,832，可以额外指定 datefmt 参数来指定该变量的格式
name	%(name)	日志对象的名称
filename	%(filename)s	不包含路径的文件名
pathname	%(pathname)s	包含路径的文件名
funcName	%(funcName)s	日志记录所在的函数名
levelname	%(levelname)s	日志的级别名称
message	%(message)s	具体的日志信息
lineno	%(lineno)d	日志记录所在的行号
pathname	%(pathname)s	完整路径
process	%(process)d	当前进程ID
processName	%(processName)s	当前进程名称
thread	%(thread)d	当前线程ID
threadName	%threadName)s	当前线程名称

加载全部内容