python logging模块学习

浅浅的花香味﹌ 2022-07-17 03:50 270阅读 0赞

## 目的： ##

## 1. 简单打印，区分打印消息的级别 ##

可直接使用logging模块如下(默认输出WARNING级别以上),

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

输出：

WARNING:root:warning message
    ERROR:root:error message
    CRITICAL:root:critical message

--------------------

## 2. 需要将日志消息写入到文件中，并打印 ##

### 通过设置logging.basicConfig()来设置 ###

可见在***`logging.basicConfig()`***函数中可通过具体参数来更改logging模块默认行为，可用参数有

filename：用指定的文件名创建FiledHandler（后边会具体讲解handler的概念），这样日志会被存储在指定的文件中。
    filemode：文件打开方式，在指定了filename时使用这个参数，默认值为“a”还可指定为“w”。
    format：指定handler使用的日志显示格式。 
    datefmt：指定日期时间格式。 
    level：设置rootlogger（后边会讲解具体概念）的日志级别 
    stream：用指定的stream创建StreamHandler。可以指定输出到sys.stderr,sys.stdout或者文件，默认为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用户输出的消息

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='/tmp/test.log',  //设置输出文件
                filemode='w'//打开文件方式) 
    
    logging.debug('debug message')  
    logging.info('info message')  
    logging.warning('warning message')  
    logging.error('error message')  
    logging.critical('critical message')

输出：

cat /tmp/test.log 
    Mon, 05 May 2014 16:29:53 test_logging.py[line:9] DEBUG debug message
    Mon, 05 May 2014 16:29:53 test_logging.py[line:10] INFO info message
    Mon, 05 May 2014 16:29:53 test_logging.py[line:11] WARNING warning message
    Mon, 05 May 2014 16:29:53 test_logging.py[line:12] ERROR error message
    Mon, 05 May 2014 16:29:53 test_logging.py[line:13] CRITICAL critical message

--------------------

## 3. 当不同模块需要使用不同的打印方式的时候可以使用logging.getLogger()获取独立的日志模块，以下时logger的用法 ##

１．***`logger = logging.getLogger(logger_name)`***返回一个可操作的单独的logger，logger\_name默认为”root”

import  logging
    logger = logging.getLogger()
    logger.debug("debug")
    logger.info("info")
    logger.warning("waring")
    logger.error("error")
    logger.critical("critical")

输出：

waring
    error
    critical

２．***`logger.setLevel(level)`*** 设置日志的等级，当使用logger.debug(),logger.error()时，若日志等级高于设置等级时，将打印。但是最低等级仍然为WARNING

import  logging
    
    logger = logging.getLogger("Mylogger")
    logger.setLevel(logging.DEBUG)
    logger.debug("debug")
    logger.info("info")
    logger.warning("waring")
    logger.error("error")
    logger.critical("critical")

输出：

waring
    error
    critical

--------------------

### 3.1 当使用logger时，需要设置格式和输出文件时： ###

１．***`fh = FileHandler(filename)`*** 创建一个输出到文件的handler  
２．***`ch = StreamHandler(默认stderr)`*** 创建一个打印到控制台的handler  
３．***`fm = logging.Format(formatstring)`***定义一个日志handler的输出格式  
４．***`fh.setFormatter(fm)`***设置输出到文件中的日志消息的格式  
５．***`ch.setFormatter(fm)`***设置输出到控制台的日志消息的格式  
６．***`logger.addHandler(fh)`***添加一个操作，一个输出到文件中的操作  
７．***`logger.addHandler(ch)`***添加一个操作，一个输出到控制台的操作

使用完logger.addHandler(handler) logger便具备了handler操作，每次输出时，都将调用该handler

代码示例：

import logging
    
    logger = logging.getLogger("Mylogger11")
    logger.setLevel(logging.DEBUG)
    
    fh = logging.FileHandler("./testlog.log")
    ch = logging.StreamHandler()
    
    fm = logging.Formatter("%(name)s - %(message)s")
    
    fh.setFormatter(fm)
    ch.setFormatter(fm)
    
    logger.addHandler(fh)
    logger.addHandler(ch)
    
    logger.debug("debug")
    logger.info("info")
    logger.warning("waring")
    logger.error("error")
    logger.critical("critical")

输出结果

Mylogger11 - debug
    Mylogger11 - info
    Mylogger11 - waring
    Mylogger11 - error
    Mylogger11 - critical

注意：　logger.setlevel(logging.DEBUG)为最低输出等级，若要控制太提高输出等级可使用
        ch.setLevel(logging.WARN)
        同理提高文件日志输出的等级为
        fh.setLevel(logging.WARN)

--------------------

## 4. 当使用logger将日志消息输出到文件中，需要自动重复创建日志文件时使用：TimedRotatingFileHandler和RotatingFileHandler ##

### 4.1 TimedRotatingFileHandler: ###

当文件达到一定大小之后，它会自动将当前日志文件改名，然后创建 一个新的同名日志文件继续输出。比如日志文件是chat.log。当chat.log达到指定的大小之后，RotatingFileHandler自动把 文件改名为chat.log.1。不过，如果chat.log.1已经存在，会先把chat.log.1重命名为chat.log.2。。。最后重新创建 chat.log，继续输出日志信息。它的构造函数是：
    RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]])

\*\*参数说明\*\*

＠filename　和＠mode　两个参数和FileHandler一样。
        ＠maxBytes　用于指定日志文件的最大文件大小。如果maxBytes为0，意味着日志文件可以无限大，这时上面描述的重命名过程就不会发生。
        ＠backupCount　用于指定保留的备份文件的个数。比如，如果指定为2，当上面描述的重命名过程发生时，原有的chat.log.2并不会被更名，而是被删除。

### 4.2 TimedRotatingFileHandler ###

这个Handler和RotatingFileHandler类似，不过，它没有通过判断文件大小来决定何时重新创建日志文件，而是间隔一定时间就 自动创建新的日志文件。重命名的过程与RotatingFileHandler类似，不过新的文件不是附加数字，而是当前时间。它的构造函数是：
    
        TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])

\*\*参数说明：\*\*

filename参数和backupCount参数和RotatingFileHandler具有相同的意义。
        interval是时间间隔。
        when参数是一个字符串。表示时间间隔的单位，不区分大小写。它有以下取值：
        S 秒
        M 分
        H 小时
        D 天
        W 每星期（interval==0时代表星期一）
    midnight 每天凌晨