python中logging库使用记录

1、基本使用

import logging

logging.info("info")
logging.warning("warning")
logging.error('error')

上述代码仅会在控制台输出：

WARNING:root:warning
ERROR:root:error

因为默认仅输出WARNING及以上级别的日志。常用的级别由高到低有：CRITICAL、ERROR、WARNING、INFO、DEBUG；

输出的格式默认为：

%(levelname)s:%(name)s:%(message)s
-levelname：级别名称；
-name：日志收集器的名称，默认为root；
-message：日志内容；

要想输出其他等级的日志，需要改变输出级别，如下介绍两种方法；

 

2、改变输出的级别

2.1 使用basicConfig()方法

如果logger没有指定处理器，则会默认使用basicConfig，在里面可以对日志进行一些设置。该方法传关键字参数，看下常用的参数：

• filename：文件名;新建一个文件处理器FileHandler。并且把日志输出到该文件，此时日志不再在控制台输出;
• filemode：打开文件的方式;如果指定了filename，则可以指定该参数;默认a，表示追加;w，表示覆盖;
• format：指定日志输出的字符串格式;例如：format='%(levelname)s-%(name)s-%(asctime)s: %(message)s'
• datefmt：指定输出的时间格式;例如：datefmt='%Y-%m-%d'
• level：指定最低输出日志的等级；例如：level='INFO' 则INFO及以上级别的日志均能被输出
• stream：用例初始化一个StreamHandler；如果filename存在，则程序忽略stream;
• encoding：指定filname时，可以通过该参数设置编码;

使用示例：

logging.basicConfig(filename='logout.txt',
                    filemode='a',
                    format='%(levelname)s-%(name)s-%(asctime)s: %(message)s',
                    level='INFO',
                    datefmt='%Y-%m-%d')
# 在logout.txt文件输出结果：
# INFO-root-2022-06-09: info
# WARNING-root-2022-06-09: warning
# ERROR-root-2022-06-09: error

 2.2 创建日志收集器和设置输出渠道

（一）创建日志收集器

logging.getLogger('py')   py即收集器的名称，会在文件/控制台输出；如果不传名称，则默认使用RootLogger；

（二）设置输出渠道

• FileHandler：文件输出；

1. 需要指定filename；模式默认是a(追加)，模式同open函数；
2. setLevel指定输出的等级；

• StreamHandler：控制台输出；

1. setLevel指定输出的等级；

#1、创建日志收集器
my_log = logging.getLogger('py')
my_log.setLevel('DEBUG') #设置采集等级
#2、 设置输出渠道
# 2-1 可以同时设置两个输出渠道
sh = logging.StreamHandler() #2-1-1控制台输出,设置输出等级
sh.setLevel('DEBUG')
fh = logging.FileHandler("logout.txt") #2-1-2文件输入
fh.setLevel('DEBUG')
# 2-2 设置日志字符串格式
format = logging.Formatter("%(levelname)s-%(name)s-%(asctime)s: %(message)s")
# 2-2-1 两种输出渠道都设置format格式
sh.setFormatter(format)
fh.setFormatter(format)
# 2-3 给日志收集器设置输出渠道
my_log.addHandler(sh)
my_log.addHandler(fh)

#使用日志收集器采集日志
my_log.debug('debug')
my_log.info('info')
my_log.warning('warning')
my_log.error('error')

 

3、封装成类

最后，把logger封装成一个类方便调用：

import logging


class MyLog():

    def __init__(self,filepath=None):#测试用例中setup中初始化一个实例
    #1、创建日志收集器
        self.my_log = logging.getLogger('py')
        self.my_log.setLevel('DEBUG') #设置采集等级
        #2、 设置输出渠道
        # 2-1 可以同时设置两个输出渠道
        self.sh = logging.StreamHandler() #2-1-1控制台输出,设置输出等级
        self.sh.setLevel('DEBUG')
        self.fh = logging.FileHandler("logout.txt") #2-1-2文件输入
        self.fh.setLevel('DEBUG')
        # 2-2 设置日志字符串格式
        format = logging.Formatter("%(levelname)s-%(name)s-%(asctime)s: %(message)s")
        # 2-2-1 两种输出渠道都设置format格式
        self.sh.setFormatter(format)
        self.fh.setFormatter(format)
        # 2-3 给日志收集器设置输出渠道
        self.my_log.addHandler(self.sh)
        self.my_log.addHandler(self.fh)

        # self.sh.close()  #把输出渠道写在构造函数里暂时没找到合适的位置关闭处理器
        # self.fh.close()  #把输出渠道写在构造函数里暂时没找到合适的位置关闭处理器

    def info(self,msg):
        self.my_log.info(msg)

    def warning(self,msg):
        self.my_log.warning(msg)

    def error(self,msg):
        self.my_log.error(msg)
        
    def close(self): #测试用例中teardown中调用，否则会出现重复日志
        self.sh.close()
        self.fh.close()
        self.my_log.removeHandler(self.sh)
        self.my_log.removeHandler(self.fh)

# 使用
log = MyLog()
log.info('info')
log.warning('warning')
log.error('error')

注意：一定要removehandler，否则会产生重复日志！（因为每次实例化都会去添加一个handler）

End.