Python基础-----logging模块

Posted 2021-01-10 Meanwey

python中logging日志模块功能及用法

#!/usr/bin/env python
#-*- coding:utf-8 -*-

################################################################################################################
########################################灵活配置日志级别，日志格式，输出位置#######################################
################################################################################################################

\'\'\'
默认情况下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=\'test.log\',  
#                     filemode=\'w\')  
  
# logging.debug(\'debug message\')  
# logging.info(\'info message\')  
# logging.warning(\'warning message\')  
# logging.error(\'error message\')  
# logging.critical(\'critical message\')


\'\'\'
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(显示到屏幕，通过print打印)。若同时列出了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）
http://www.cnblogs.com/yuanchenqi/articles/5732581.html
\'\'\'

# import logging

# def logger(log_user = \'root\',log_level = logging.DEBUG):     #定义logger对象函数，参数1为looger用户名，参数2为日志级别
#  logger = logging.getLogger(log_user)  #通过getLogger()方法获取一个logger对象，默认为根用户root
#  logger.setLevel(log_level) #设置日志的级别或logger.setLevel(\'DEBUG\')

#  fh = logging.FileHandler(\'logger.log\')   #通过FileHandler(文件路径\\文件名)方法创建一个handler，用于写入日志文件
#  ch = logging.StreamHandler()          #通过StreamHandler()方法，再创建一个handler，用于输入日志信息到控制台

#  #通过Foramtter(格式信息)方法传入格式信息，则日志文件会按照此格式进行生成与打印
#  formatter = logging.Formatter(\'%(asctime)s - %(name)s - %(levelname)s - %(message)s   [%(lineno)d]\')

#  #通过hanler的setFormatter(formatter)方法传入设置好的格式信息formatter，对logger对象进行输出日志格式设置
#  fh.setFormatter(formatter)
#  ch.setFormatter(formatter)

#  #通过logger的addHandler(fh)方法，将为logger对象添加handler对象
#  logger.addHandler(fh)
#  logger.addHandler(ch)

#  return logger    #返回logger对象借口，可供调用

# try_logger = logger(\'test_loger\',logging.WARNING)    #调用上述定义好格式等信息的logger对象

# #写入相关信息
# try_logger.debug(\'debug message\')
# try_logger.info(\'info message\')
# try_logger.warning(\'warning message\')
# try_logger.error(\'error message\')
# try_logger.critical(\'critical message\')

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


   Logger是一个树形层级结构，输出信息之前都要获得一个Logger（如果没有显示的获取则自动创建并使用root Logger，如第一个例子所示）。
   logger = logging.getLogger()返回一个默认的Logger也即root Logger，并应用默认的日志级别、Handler和Formatter设置。
   当然也可以通过Logger.setLevel(lel)指定最低的日志级别，可用的日志级别有logging.DEBUG、logging.INFO、logging.WARNING、
logging.ERROR、logging.CRITICAL。
   Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical()输出不同级别的日志，只有日志等级
大于或等于设置的日志级别的日志才会被输出。 
\'\'\'

##################################################
# import logging
# logger1 = logging.getLogger(\'mylogger\')
# logger1.setLevel(logging.DEBUG)

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

# fh = logging.FileHandler(\'logger.log\')
# ch = logging.StreamHandler() 

# 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\')
\'\'\'
   <1>我们明明通过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的输出遵从了后来设置的日志级别。

   <2>为什么logger1、logger2对应的每个输出分别显示两次?
   这是因为我们通过logger = logging.getLogger()显示的创建了root Logger，而logger1 = logging.getLogger(\'mylogger\')
   创建了root Logger的孩子(root.)mylogger,logger2同样。而孩子,孙子，重孙……既会将消息分发给他的handler进行处理也会传递
   给所有的祖先Logger处理。


上述出现的问题可以通过Filter来进行过滤
   比如我们定义了filter = logging.Filter(\'a.b.c\'),并将这个Filter添加到了一个Handler上，则使用该Handler的Logger中只有名字带
a.b.c前缀的Logger才能输出其日志。

    filter = logging.Filter(\'mylogger\') 

    logger.addFilter(filter)

    这是只对logger这个对象进行筛选

    如果想对所有的对象进行筛选，则：

    filter = logging.Filter(\'mylogger\') 

    fh.addFilter(filter)

    ch.addFilter(filter)

    这样，所有添加fh或者ch的logger对象都会进行筛选。
\'\'\'

                           ##################################################
                           ###################      示例代码 ##################
                           ##################################################

import logging

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

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

formatter = logging.Formatter(\'%(asctime)s - %(name)s - %(levelname)s - %(message)s\')

fh.setFormatter(formatter)
ch.setFormatter(formatter)

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

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

logger.setLevel(logging.DEBUG)

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 = 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\')


                           ##################################################
                           ###################      示例应用 ##################
                           ##################################################

import os
import time
import logging
from config import settings

def get_logger(card_num, struct_time):

    if struct_time.tm_mday < 23:
        file_name = "%s_%s_%d" %(struct_time.tm_year, struct_time.tm_mon, 22)
    else:
        file_name = "%s_%s_%d" %(struct_time.tm_year, struct_time.tm_mon+1, 22)

    file_handler = logging.FileHandler(
        os.path.join(settings.USER_DIR_FOLDER, card_num, \'record\', file_name),
        encoding=\'utf-8\'
    )
    fmt = logging.Formatter(fmt="%(asctime)s :  %(message)s")
    file_handler.setFormatter(fmt)

    logger1 = logging.Logger(\'user_logger\', level=logging.INFO)
    logger1.addHandler(file_handler)
    return logger1