Python3 日志模塊

Python3 日志模塊

python3 日志模塊官網(wǎng)說明
python中日志等級從高到低依次為：CRITICAL > ERROR > WARNING > INFO > DEBUG > NOTSET
默認的日志等級為：WARNING，即在顯示日志時，低于WARNING的日志不顯示
示例代碼：

#!/usr/bin/python3
import logging
logging.info('this is the info message')
logging.debug('this is the debug message')
logging.warning('this is the warning message')
logging.error('this is the error message')
logging.critical('this is the critical message')

輸出：
WARNING:root:this is warning message
ERROR:root:this is error message
CRITICAL:root:this is critical message

日志配置

logging.basicConfig()函數(shù)來配置日志等級、日志顯示格式、日志顯示的消息等
相關參數(shù)及含義為：

示例代碼：

#!/usr/bin/python3
import logging
logging.basicConfig(filename='test.log',level=logging.DEBUG,format='%(asctime)s %(filename)s[line:%(lineno)d] %(message)s',datefmt='%Y-%m-%d %X')
logging.info(' info logging')
logging.debug('debug logging')
logging.warning('warning logging')
logging.error('error logging')
logging.critical('critical logging')

輸出：
WARNING:root:warning logging
ERROR:root:error logging
CRITICAL:root:critical logging

format 輸出格式參數(shù)

Logger，Handler，F(xiàn)ormatter，F(xiàn)ilter的概念

• logger提供了應用程序可以直接使用的接口；

• handler將(logger創(chuàng)建的)日志記錄發(fā)送到合適的目的輸出；

• filter提供了細度設備來決定輸出哪條日志記錄；

• formatter決定日志記錄的最終輸出格式。

logger

每個程序在輸出日志之前都要獲得一個Logger。Logger通常對應了程序的模塊名，比如聊天工具的圖形界面模塊可以這樣獲得它的Logger：
LOG=logging.getLogger(”chat.gui”)
而核心模塊可以這樣：
LOG=logging.getLogger(”chat.kernel”)

Logger.setLevel(lel):指定最低的日志級別，低于lel的級別將被忽略。debug是最低的內置級別，critical為最高
Logger.addFilter(filt)、Logger.removeFilter(filt):添加或刪除指定的filter
Logger.addHandler(hdlr)、Logger.removeHandler(hdlr)：增加或刪除指定的handler
Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical()：可以設置的日志級別

handler

handler對象負責發(fā)送相關的信息到指定目的地。
Python的日志系統(tǒng)有多種Handler可以使用。
有些Handler可以把信息輸出到控制臺。
有些Logger可以把信息輸出到文件。
還有些 Handler可以把信息發(fā)送到網(wǎng)絡上。
如果覺得不夠用，還可以編寫自己的Handler。
可以通過addHandler()方法添加多個多handler
Handler.setLevel(lel):指定被處理的信息級別，低于lel級別的信息將被忽略
Handler.setFormatter()：給這個handler選擇一個格式
Handler.addFilter(filt)、Handler.removeFilter(filt)：新增或刪除一個filter對象

每個Logger可以附加多個Handler。
接下來我們就來介紹一些常用的Handler：
1) logging.StreamHandler
使用這個Handler可以向類似與sys.stdout或者sys.stderr的任何文件對象(file object)輸出信息。它的構造函數(shù)是：
StreamHandler([strm])
其中strm參數(shù)是一個文件對象。默認是sys.stderr

2) logging.FileHandler
和StreamHandler類似，用于向一個文件輸出日志信息。
不過FileHandler會幫你打開這個文件。它的構造函數(shù)是：
FileHandler(filename[,mode])
filename是文件名，必須指定一個文件名。
mode是文件的打開方式。參見Python內置函數(shù)open()的用法。默認是’a'，即追加。

3) logging.handlers.RotatingFileHandler
這個Handler類似于上面的FileHandler，但是它可以管理文件大小。
當文件達到一定大小之后，它會自動將當前日志文件改名，然后創(chuàng)建 一個新的同名日志文件繼續(xù)輸出。
比如日志文件是chat.log。當chat.log達到指定的大小之后，RotatingFileHandler自動把 文件改名為chat.log.1。
不過，如果chat.log.1已經(jīng)存在，會先把chat.log.1重命名為chat.log.2。。。最后重新創(chuàng)建 chat.log，繼續(xù)輸出日志信息。
它的構造函數(shù)是：
RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]])
其中filename和mode兩個參數(shù)和FileHandler一樣。
maxBytes用于指定日志文件的最大文件大小。
如果maxBytes為0，意味著日志文件可以無限大，這時上面描述的重命名過程就不會發(fā)生。
backupCount用于指定保留的備份文件的個數(shù)。
比如，如果指定為2，當上面描述的重命名過程發(fā)生時，原有的chat.log.2并不會被更名，而是被刪除。

4) logging.handlers.TimedRotatingFileHandler
這個Handler和RotatingFileHandler類似，不過，它沒有通過判斷文件大小來決定何時重新創(chuàng)建日志文件，而是間隔一定時間就 自動創(chuàng)建新的日志文件。
重命名的過程與RotatingFileHandler類似，不過新的文件不是附加數(shù)字，而是當前時間。
它的構造函數(shù)是：
TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])
其中filename參數(shù)和backupCount參數(shù)和RotatingFileHandler具有相同的意義。
interval是時間間隔。
when參數(shù)是一個字符串。表示時間間隔的單位，不區(qū)分大小寫。它有以下取值：
S 秒
M 分
H 小時
D 天
W 每星期（interval==0時代表星期一）
midnight 每天凌晨

封裝的日志函數(shù)

示例代碼：

#!/usr/bin/python
import logging
import os
import sys

BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
sys.path.append(BASE_DIR)

"""
工程使用需求：
1-不同日志名稱
2-打印同時在控制臺，也有文件
3-錄活控制等級
"""

# logging.disable(logging.CRITICAL)   # 禁止輸出日志

def public_log(logger_name='default-log', log_file=os.path.join(BASE_DIR, 'log', 'dataoperate.log'), level=logging.DEBUG):
    logger = logging.getLogger(logger_name)
    logger.setLevel(level)   # 添加日志等級

    # 創(chuàng)建控制臺 console handler
    ch = logging.StreamHandler()
        # 設置控制臺輸出時的日志等級
    ch.setLevel(logging.WARNING) 

    # 創(chuàng)建文件 handler
    fh = logging.FileHandler(filename=log_file, encoding='utf-8')
        # 設置寫入文件的日志等級
    fh.setLevel(logging.DEBUG)
    # 創(chuàng)建 formatter
    formatter = logging.Formatter('%(asctime)s %(filename)s [line:%(lineno)d] %(name)s %(levelname)s %(message)s')

    # 添加formatter
    ch.setFormatter(formatter)
    fh.setFormatter(formatter)

    # 把ch fh 添加到logger
    logger.addHandler(ch)
    logger.addHandler(fh)

    return logger