• 分类

  • 重置

Python logging模块handlers用法详解

    一、handlers是什么?

    logging模块中包含的类

    用来自定义日志对象的规则(比如:设置日志输出格式、等级等)

    常用3个子类:StreamHandler、FileHandler、TimedRotatingFileHandler

    二、handlers基础应用

    2.1 StreamHandler 控制台输出日志

    
    import logging
    
    #创建一个logger日志对象
    logger = logging.getLogger('test_logger')
    logger.setLevel(logging.DEBUG)  #设置默认的日志级别
    
    #创建日志格式对象
    formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
    
    #创建StreamHandler对象
    sh = logging.StreamHandler()
    #StreamHandler对象自定义日志级别
    sh.setLevel(logging.DEBUG)
    #StreamHandler对象自定义日志格式
    sh.setFormatter(formatter)
    
    logger.addHandler(sh)  #logger日志对象加载StreamHandler对象
    #日志输出
    logger.info('newdream')

    上面代码执行后,会在控制台输出日志信息。

    2.2 FileHandler 日志输出到文件

    
    import logging
    
    #创建一个logger日志对象
    logger = logging.getLogger('test_logger')
    logger.setLevel(logging.DEBUG)  #设置默认的日志级别
    
    #创建日志格式对象
    formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
    
    #创建FileHandler对象
    fh = logging.FileHandler('test.log')
    #FileHandler对象自定义日志级别
    fh.setLevel(logging.DEBUG)
    #FileHandler对象自定义日志格式
    fh.setFormatter(formatter)
    
    logger.addHandler(fh)  #logger日志对象加载FileHandler对象
    #日志输出
    logger.info('newdream')

    上面代码执行后,控制台不会输出日志信息,而会在当前文件夹新建一个test.log日志文件进行日志记录。

    2.3 TimedRotatingFileHandler 日志分割

    
    import logging
    from logging import handlers
    
    #创建一个logger日志对象
    logger = logging.getLogger('test_logger')
    logger.setLevel(logging.DEBUG)  #设置默认的日志级别
    
    #创建日志格式对象
    formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
    
    #创建TimedRotatingFileHandler对象
    rh = handlers.TimedRotatingFileHandler("test.log", when='S', interval=1, backupCount=5)
    #TimedRotatingFileHandler对象自定义日志级别
    rh.setLevel(logging.DEBUG)
    #TimedRotatingFileHandler对象自定义日志级别
    rh.suffix = "%Y_%m_%d_%H_%M_%S.log"
    #TimedRotatingFileHandler对象自定义日志格式
    rh.setFormatter(formatter)
    
    logger.addHandler(rh)  #logger日志对象加载TimedRotatingFileHandler对象
    #日志输出
    logger.info('newdream')

    上面代码执行后,控制台不会输出日志信息,而会在当前文件夹新建一个 test_年_月_日_时_分_秒.log 日志文件进行日志记录。

    在使用TimedRotatingFileHandler创建对象时,它的构造函数定义如下:

    • TimedRotatingFileHandler(filename [,when [,interval [,backupCount]]])
    • filename:是输出日志文件名的前缀,比如log/myapp.log
    • when:按什么日期格式切分,接收指定字符串参数,接收的值如下:

    “S”: Seconds
    “M”: Minutes
    “H”: Hours
    “D”: Days
    “W”: Week day (0=Monday)
    “midnight”: Roll over at midnight

    interval 是指等待多少个单位when的时间后,Logger会自动重建文件,这个文件的创建取决于filename+suffix,若这个文件跟之前的文件有重名,则会自动覆盖掉以前的文件,所以有些情况suffix要定义不能因为when而重复。
    backupCount 是保留日志个数。默认的0是不会自动删除掉日志。若设为5,则在文件的创建过程中库会判断是否有超过这个5,若超过,则会从最先创建的开始删除。

    三、小结

    以上的日志实例为了让读者更清晰的操作和理解,分开代码单独实现

    在 2.3 中 如果想实现看是否达到5个日志就删除的效果,可以把日志用循环输出,如下:

    while True:
    logger.info(‘newdream’)

    三种handlers日志可以共同使用,都是独立的handler对象,但一般 FileHandler 和 TimedRotatingFileHandler 不会同时使用。

    以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持lingkb。