lesson 039 —— logging 模块

最新推荐文章于 2024-07-24 23:49:50 发布

weixin_30690833

最新推荐文章于 2024-07-24 23:49:50 发布

阅读量68

点赞数

文章标签： python

原文链接：http://www.cnblogs.com/arelive/p/python-39.html

版权

lesson 039 —— logging 模块

关于 logging 模块的简单介绍。

简单使用

>>> import logging
>>> logging.debug('debug messaage')
>>> logging.info('info message')
>>> logging.warning('warning message')
WARNING:root:warning message
>>> logging.error('error message')
ERROR:root:error message
>>> logging.critical('critical message')
CRITICAL:root:critical message

可见，在默认情况下 python 的 logging 模块将日志打印到标准输出中，且只显示了大于等于 WARNING 级别的日志，这说明默认日志级别设置为 WARNING （日志级别等级 CRITICAL > ERROR > WARNING > INFO > DEBUG > NOTSET），默认日志格式为：Logger 名称：用户输出信息。

高级配置

import logging

logging.basicConfig(
    level=logging.DEBUG,
    format='%(asctime)s   %(filename)s[line:%(lineno)d]   %(levelname)s   %(message)s',
    datefmt='%a, %d %b %Y %H:%M:%S',
    filename='logger.log',
    filemode='w',
    )

logging.debug('debug message')  
logging.info('info message')  
logging.warning('warning message')  
logging.error('error message')  
logging.critical('critical message')

输出结果 logger.log

Sun, 27 Jan 2019 20:04:24   test.py[line:11]   DEBUG   debug message
Sun, 27 Jan 2019 20:04:24   test.py[line:12]   INFO   info message
Sun, 27 Jan 2019 20:04:24   test.py[line:13]   WARNING   warning message
Sun, 27 Jan 2019 20:04:24   test.py[line:14]   ERROR   error message
Sun, 27 Jan 2019 20:04:24   test.py[line:15]   CRITICAL   critical message

logging 中默认的是以追加(a)的方式打开文件。可见在 logging.basicConfig() 函数中可通过具体参数来更改 logging 模块默认行为，可用参数有:

filename：用指定的文件名创建 FiledHandler（后边会具体讲解handler的概念），这样日志会被存储在指定的文件中。
filemode：文件打开方式，在指定了filename时使用这个参数，默认值为 a 还可指定为 w。
format：指定 handler 使用的日志显示格式。
datefmt：指定日期时间格式。
level：设置 rootlogger（后边会讲解具体概念）的日志级别
stream：用指定的 stream 创建 StreamHandler。可以指定输出到 sys.stderr, sys.stdout 或者文件(f=open('test.log','w'))，默认为 sys.stderr。若同时列出了 filename 和 stream 两个参数，则 stream 参数会被忽略。

format 参数中可能用到的格式化串：

%(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：用户输出的消息

logger 对象

我们了解到了logging.debug()、logging.info()、logging.warning()、logging.error()、logging.critical()（分别用以记录不同级别的日志信息），logging.basicConfig()（用默认日志格式（Formatter）为日志系统建立一个默认的流处理器（StreamHandler），设置基础配置（如日志级别等）并加到 root logger（根Logger）中）这几个logging模块级别的函数，另外还有一个模块级别的函数是logging.getLogger([name])（返回一个logger对象，如果没有指定名字将返回root logger）

import logging

# 将设置部分封装成一个函数
def create_logger():
    ### 设置部分

    logger = logging.getLogger()

    # 创建一个handler，用于写入日志文件
    fh = logging.FileHandler('test.log')
    # 再创建一个handler，用于输出到控制台
    ch = logging.StreamHandler()
    # 设置输出日志格式
    fm = logging.Formatter('%(asctime)s   %(filename)s[%(lineno)d]   %(levelname)s   %(message)s')

    # 分别添加格式
    fh.setFormatter(fm)
    ch.setFormatter(fm)

    # 定义一个 Filter
    filt = logging.Filter('mylogger')
    fh.addFilter(filt)
    ch.addFilter(filt)

    # 设置显示级别
    logger.setLevel('DEBUG')   # logger.setLevel(logging.DEBUG)
    # 添加对象；logger 对象可以添加多个 fh 和 ch 对象
    logger.addHandler(fh)
    logger.addHandler(ch)   # 可以不用添加，就不会显示到输出台

    return logger


### 输出部分

# 将设置部分成函数再使用
logger = create_logger()
# 这里输出的时候不仅会在控制台输出信息，还会同时创建一个
# test.log 文件将信息同步写到文件里
logger.debug('logger debug message')
logger.info('logger info message')
logger.warning('logger warning message')
logger.error('logger error message')
logger.critical('logger critical message')

logging库提供了多个组件：Logger、Handler、Filter、Formatter。Logger对象提供应用程序可直接使用的接口，Handler发送日志到适当的目的地，Filter提供了过滤日志信息的方法，Formatter指定日志显示格式。

Filter：限制只有满足过滤规则的日志才会输出。比如我们定义了filter = logging.Filter('mylogger'),并将这个Filter添加到了一个Handler上，则使用该Handler的Logger中只有名字是 mylogger 的Logger才能输出其日志。

filter = logging.Filter('mylogger'); logger.addFilter(filter) 这是只对logger这个对象进行筛选如果想对所有的对象进行筛选，则：filter = logging.Filter('mylogger'); fh.addFilter(filter); ch.addFilter(filter)，这样，所有添加fh或者ch的logger对象都会进行筛选。

Logger是一个树形层级结构，输出信息之前都要获得一个Logger（如果没有显式的获取则自动创建并使用root Logger，如上例所示）。、

logger = logging.getLogger()返回一个默认的Logger也即root Logger，并应用默认的日志级别、Handler和Formatter设置。即logger = logging.getLogger() 返回的Logger名为root，日志默认输出的名称为 root。
当然也可以通过Logger.setLevel(lel)指定最低的日志级别，可用的日志级别有logging.DEBUG、logging.INFO、logging.WARNING、logging.ERROR、logging.CRITICAL。

Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical()输出不同级别的日志，只有日志等级大于或等于设置的日志级别的日志才会被输出。

尝试创建两个 logger 对象：

import logging

fh = logging.FileHandler('test.log')
ch = logging.StreamHandler()
fm = logging.Formatter('%(asctime)s   %(filename)s[%(lineno)d]   %(levelname)s   %(message)s')
fh.setFormatter(fm)
ch.setFormatter(fm)

logger1 = logging.getLogger('mylogger')
logger1.setLevel(logging.DEBUG)

logger2 = logging.getLogger('mylogger')
logger2.setLevel(logging.INFO)

logger1.addHandler(fh)
logger1.addHandler(ch)

logger2.addHandler(fh)
logger2.addHandler(ch)

logger1.debug('logger1 debug message')
logger1.info('logger1 info message')
logger1.warning('logger1 warning message')
logger1.error('logger1 error message')
logger1.critical('logger1 critical message')

logger2.debug('logger2 debug message')
logger2.info('logger2 info message')
logger2.warning('logger2 warning message')
logger2.error('logger2 error message')
logger2.critical('logger2 critical message')

输出结果：

2019-01-27 22:27:35,210   test.py[22]   INFO   logger1 info message
2019-01-27 22:27:35,228   test.py[23]   WARNING   logger1 warning message
2019-01-27 22:27:35,236   test.py[24]   ERROR   logger1 error message
2019-01-27 22:27:35,246   test.py[25]   CRITICAL   logger1 critical message
2019-01-27 22:27:35,256   test.py[28]   INFO   logger2 info message
2019-01-27 22:27:35,266   test.py[29]   WARNING   logger2 warning message
2019-01-27 22:27:35,277   test.py[30]   ERROR   logger2 error message
2019-01-27 22:27:35,287   test.py[31]   CRITICAL   logger2 critical message

明明通过logger1.setLevel(logging.DEBUG)将logger1的日志级别设置为了DEBUG，为何显示的时候没有显示出DEBUG级别的日志信息，而是从INFO级别的日志开始显示呢？

原来logger1和logger2对应的是同一个Logger实例，只要logging.getLogger（name）中名称参数name相同则返回的Logger实例就是同一个，且仅有一个，也即name与Logger实例一一对应。在logger2实例中通过logger2.setLevel(logging.INFO)设置mylogger的日志级别为logging.INFO，所以最后logger1的输出遵从了后来设置的日志级别。

我们再创建一个 logger 试一试

import logging  

# 创建一个logger    
logger = logging.getLogger()  

logger1 = logging.getLogger('mylogger')  
logger1.setLevel(logging.DEBUG)  

logger2 = logging.getLogger('mylogger')  
logger2.setLevel(logging.INFO)  

logger3 = logging.getLogger('mylogger.child1')  
logger3.setLevel(logging.WARNING)  

logger4 = logging.getLogger('mylogger.child1.child2')  
logger4.setLevel(logging.DEBUG)  

logger5 = logging.getLogger('mylogger.child1.child2.child3')  
logger5.setLevel(logging.DEBUG)  

# 创建一个handler，用于写入日志文件    
fh = logging.FileHandler('test_xxx.log')  

# 再创建一个handler，用于输出到控制台    
ch = logging.StreamHandler()  

# 定义handler的输出格式formatter    
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')  
fh.setFormatter(formatter)  
ch.setFormatter(formatter)     

# 给logger添加handler     
logger.addHandler(fh)  
logger.addHandler(ch)  

logger1.addHandler(fh)  
logger1.addHandler(ch)  

logger2.addHandler(fh)  
logger2.addHandler(ch)  

logger3.addHandler(fh)  
logger3.addHandler(ch)  

logger4.addHandler(fh)  
logger4.addHandler(ch)  

logger5.addHandler(fh)  
logger5.addHandler(ch)  

# 记录一条日志    
##logger.debug('logger debug message')  
##logger.info('logger info message')  
##logger.warning('logger warning message')  
##logger.error('logger error message')  
##logger.critical('logger critical message')  
##  
##logger1.debug('logger1 debug message')  
##logger1.info('logger1 info message')  
##logger1.warning('logger1 warning message')  
##logger1.error('logger1 error message')  
##logger1.critical('logger1 critical message')  
##  
##logger2.debug('logger2 debug message')  
##logger2.info('logger2 info message')  
##logger2.warning('logger2 warning message')  
##logger2.error('logger2 error message')  
##logger2.critical('logger2 critical message')  
##  
##logger3.debug('logger3 debug message')  
##logger3.info('logger3 info message')  
##logger3.warning('logger3 warning message')  
##logger3.error('logger3 error message')  
##logger3.critical('logger3 critical message')  
##  
##logger4.debug('logger4 debug message')  
##logger4.info('logger4 info message')  
##logger4.warning('logger4 warning message')  
##logger4.error('logger4 error message')  
##logger4.critical('logger4 critical message')  

logger5.debug('logger5 debug message')  
logger5.info('logger5 info message')  
logger5.warning('logger5 warning message')  
logger5.error('logger5 error message')  
logger5.critical('logger5 critical message')

运行结果：

2019-01-27 22:39:20,120 - mylogger.child1.child2.child3 - DEBUG - logger5 debug message
2019-01-27 22:39:20,120 - mylogger.child1.child2.child3 - DEBUG - logger5 debug message
2019-01-27 22:39:20,120 - mylogger.child1.child2.child3 - DEBUG - logger5 debug message
2019-01-27 22:39:20,120 - mylogger.child1.child2.child3 - DEBUG - logger5 debug message
2019-01-27 22:39:20,120 - mylogger.child1.child2.child3 - DEBUG - logger5 debug message
2019-01-27 22:39:20,204 - mylogger.child1.child2.child3 - INFO - logger5 info message
2019-01-27 22:39:20,204 - mylogger.child1.child2.child3 - INFO - logger5 info message
2019-01-27 22:39:20,204 - mylogger.child1.child2.child3 - INFO - logger5 info message
2019-01-27 22:39:20,204 - mylogger.child1.child2.child3 - INFO - logger5 info message
2019-01-27 22:39:20,204 - mylogger.child1.child2.child3 - INFO - logger5 info message
2019-01-27 22:39:20,252 - mylogger.child1.child2.child3 - WARNING - logger5 warning message
2019-01-27 22:39:20,252 - mylogger.child1.child2.child3 - WARNING - logger5 warning message
2019-01-27 22:39:20,252 - mylogger.child1.child2.child3 - WARNING - logger5 warning message
2019-01-27 22:39:20,252 - mylogger.child1.child2.child3 - WARNING - logger5 warning message
2019-01-27 22:39:20,252 - mylogger.child1.child2.child3 - WARNING - logger5 warning message
2019-01-27 22:39:20,310 - mylogger.child1.child2.child3 - ERROR - logger5 error message
2019-01-27 22:39:20,310 - mylogger.child1.child2.child3 - ERROR - logger5 error message
2019-01-27 22:39:20,310 - mylogger.child1.child2.child3 - ERROR - logger5 error message
2019-01-27 22:39:20,310 - mylogger.child1.child2.child3 - ERROR - logger5 error message
2019-01-27 22:39:20,310 - mylogger.child1.child2.child3 - ERROR - logger5 error message
2019-01-27 22:39:20,377 - mylogger.child1.child2.child3 - CRITICAL - logger5 critical message
2019-01-27 22:39:20,377 - mylogger.child1.child2.child3 - CRITICAL - logger5 critical message
2019-01-27 22:39:20,377 - mylogger.child1.child2.child3 - CRITICAL - logger5 critical message
2019-01-27 22:39:20,377 - mylogger.child1.child2.child3 - CRITICAL - logger5 critical message
2019-01-27 22:39:20,377 - mylogger.child1.child2.child3 - CRITICAL - logger5 critical message

为什么 logger5 对应的每个输出显示了 5 次？

这是因为我们通过logger = logging.getLogger()显示的创建了root Logger，而 logger1 = logging.getLogger('mylogger') 创建了root Logger的孩子(root.)mylogger,logger2同样。而孩子,孙子，重孙……既会将消息分发给他的handler进行处理也会传递给所有的祖先Logger处理。

那么，我们把

##logger.addHandler(fh)  
##logger.addHandler(ch)  

logger1.addHandler(fh)  
logger1.addHandler(ch)  

##logger2.addHandler(fh)  
##logger2.addHandler(ch)  
##
##logger3.addHandler(fh)  
##logger3.addHandler(ch)  
##  
##logger4.addHandler(fh)  
##logger4.addHandler(ch) 

logger5.addHandler(fh)  
logger5.addHandler(ch)

注释掉看一看结果：

2019-01-27 22:44:49,567 - mylogger.child1.child2.child3 - DEBUG - logger5 debug message
2019-01-27 22:44:49,567 - mylogger.child1.child2.child3 - DEBUG - logger5 debug message
2019-01-27 22:44:49,593 - mylogger.child1.child2.child3 - INFO - logger5 info message
2019-01-27 22:44:49,593 - mylogger.child1.child2.child3 - INFO - logger5 info message
2019-01-27 22:44:49,608 - mylogger.child1.child2.child3 - WARNING - logger5 warning message
2019-01-27 22:44:49,608 - mylogger.child1.child2.child3 - WARNING - logger5 warning message
2019-01-27 22:44:49,624 - mylogger.child1.child2.child3 - ERROR - logger5 error message
2019-01-27 22:44:49,624 - mylogger.child1.child2.child3 - ERROR - logger5 error message
2019-01-27 22:44:49,639 - mylogger.child1.child2.child3 - CRITICAL - logger5 critical message
2019-01-27 22:44:49,639 - mylogger.child1.child2.child3 - CRITICAL - logger5 critical message

因为我们注释了 logger 对象显示的位置，所以才用了默认方式，即标准输出方式。因为它的父级只有 logger1 设置文件显示方式，所以在这里只打印了两次。

孩子,孙子，重孙……可逐层继承来自祖先的日志级别、Handler、Filter设置，也可以通过 Logger.setLevel(lel)、Logger.addHandler(hdlr)、Logger.removeHandler(hdlr)、Logger.addFilter(filt)、Logger.removeFilter(filt)。设置自己特别的日志级别、Handler、Filter。若不设置则使用继承来的值。

转载于:https://www.cnblogs.com/arelive/p/python-39.html

weixin_30690833

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
lesson 039 —— logging 模块

lesson 039 —— logging 模块关于 logging 模块的简单介绍。简单使用>>> import logging>>> logging.debug('debug messaage')>>> logging.info('info message')>>> logging.warning('warni...
复制链接

扫一扫