Python + logging 輸出到屏幕，將log日志寫入文件

日志

日志是跟蹤軟件運行時所發生的事件的一種方法。軟件開發者在代碼中調用日志函數，表明發生了特定的事件。事件由描述性消息描述，該描述性消息可以可選地包含可變數據（即，對於事件的每次出現都潛在地不同的數據）。事件還具有開發者歸因於事件的重要性；重要性也可以稱為級別或嚴重性。

logging提供了一組便利的函數，用來做簡單的日志。它們是 debug()、 info()、 warning()、 error() 和 critical()。

 

logging函數根據它們用來跟蹤的事件的級別或嚴重程度來命名。標准級別及其適用性描述如下（以嚴重程度遞增排序）：

級別	何時使用
DEBUG	詳細信息，一般只在調試問題時使用。
INFO	證明事情按預期工作。
WARNING	某些沒有預料到的事件的提示，或者在將來可能會出現的問題提示。例如：磁盤空間不足。但是軟件還是會照常運行。
ERROR	由於更嚴重的問題，軟件已不能執行一些功能了。
CRITICAL	嚴重錯誤，表明軟件已不能繼續運行了。

 

級別	數字值
CRITICAL	50
ERROR	40
WARNING	30
INFO	20
DEBUG	10
NOTSET	0

 

默認等級是WARNING，這意味着僅僅這個等級及以上的才會反饋信息，除非logging模塊被用來做其它事情。

被跟蹤的事件能以不同的方式被處理。最簡單的處理方法就是把它們在控制台上打印出來。另一種常見的方法就是寫入磁盤文件。

 

一、打印到控制台

import logging
logging.debug('debug 信息')
logging.warning('只有這個會輸出。。。')
logging.info('info 信息')

由於默認設置的等級是warning，所有只有warning的信息會輸出到控制台。

WARNING:root:只有這個會輸出。。。

 

利用logging.basicConfig()打印信息到控制台

import logging
logging.basicConfig(format='%(asctime)s - %(pathname)s[line:%(lineno)d] - %(levelname)s: %(message)s',
                    level=logging.DEBUG)
logging.debug('debug 信息')
logging.info('info 信息')
logging.warning('warning 信息')
logging.error('error 信息')
logging.critical('critial 信息')

由於在logging.basicConfig()中的level 的值設置為logging.DEBUG, 所有debug, info, warning, error, critical 的log都會打印到控制台。

日志級別： debug < info < warning < error < critical
logging.debug('debug級別，最低級別，一般開發人員用來打印一些調試信息')
logging.info('info級別，正常輸出信息，一般用來打印一些正常的操作')
logging.warning('waring級別，一般用來打印警信息')
logging.error('error級別，一般用來打印一些錯誤信息')
logging.critical('critical 級別，一般用來打印一些致命的錯誤信息,等級最高')

所以如果設置level = logging.info()的話，debug 的信息則不會輸出到控制台。

 

二、利用logging.basicConfig()保存log到文件

logging.basicConfig(level=logging.DEBUG,#控制台打印的日志級別
                    filename='new.log',
                    filemode='a',##模式，有w和a，w就是寫模式，每次都會重新寫日志，覆蓋之前的日志
                    #a是追加模式，默認如果不寫的話，就是追加模式
                    format=
                    '%(asctime)s - %(pathname)s[line:%(lineno)d] - %(levelname)s: %(message)s'
                    #日志格式
                    )

如果在logging.basicConfig()設置filename 和filemode，則只會保存log到文件，不會輸出到控制台。

 

三、既往屏幕輸入，也往文件寫入log

 

logging庫采取了模塊化的設計，提供了許多組件：記錄器、處理器、過濾器和格式化器。

• Logger 暴露了應用程序代碼能直接使用的接口。
• Handler將（記錄器產生的）日志記錄發送至合適的目的地。
• Filter提供了更好的粒度控制，它可以決定輸出哪些日志記錄。
• Formatter 指明了最終輸出中日志記錄的布局。

Loggers:

Logger 對象要做三件事情。首先，它們向應用代碼暴露了許多方法，這樣應用可以在運行時記錄消息。其次，記錄器對象通過嚴重程度（默認的過濾設施）或者過濾器對象來決定哪些日志消息需要記錄下來。第三，記錄器對象將相關的日志消息傳遞給所有感興趣的日志處理器。

常用的記錄器對象的方法分為兩類：配置和發送消息。

這些是最常用的配置方法：

Logger.setLevel()指定logger將會處理的最低的安全等級日志信息, debug是最低的內置安全等級，critical是最高的內建安全等級。例如，如果嚴重程度為INFO，記錄器將只處理INFO，WARNING，ERROR和CRITICAL消息，DEBUG消息被忽略。
Logger.addHandler()和Logger.removeHandler()從記錄器對象中添加和刪除處理程序對象。處理器詳見Handlers。
Logger.addFilter()和Logger.removeFilter()從記錄器對象添加和刪除過濾器對象。

Handlers

處理程序對象負責將適當的日志消息（基於日志消息的嚴重性）分派到處理程序的指定目標。Logger 對象可以通過addHandler()方法增加零個或多個handler對象。舉個例子，一個應用可以將所有的日志消息發送至日志文件，所有的錯誤級別（error）及以上的日志消息發送至標准輸出，所有的嚴重級別（critical）日志消息發送至某個電子郵箱。在這個例子中需要三個獨立的處理器，每一個負責將特定級別的消息發送至特定的位置。

常用的有4種： 

1)    logging.StreamHandler -> 控制台輸出 

使用這個Handler可以向類似與sys.stdout或者sys.stderr的任何文件對象(file object)輸出信息。

它的構造函數是：
StreamHandler([strm])
其中strm參數是一個文件對象。默認是sys.stderr

2)   logging.FileHandler  -> 文件輸出

和StreamHandler類似，用於向一個文件輸出日志信息。不過FileHandler會幫你打開這個文件。它的構造函數是：
FileHandler(filename[,mode])
filename是文件名，必須指定一個文件名。
mode是文件的打開方式。默認是’a'，即添加到文件末尾。

3)   logging.handlers.RotatingFileHandler -> 按照大小自動分割日志文件，一旦達到指定的大小重新生成文件 

這個Handler類似於上面的FileHandler，但是它可以管理文件大小。當文件達到一定大小之后，它會自動將當前日志文件改名，然后創建 一個新的同名日志文件繼續輸出。比如日志文件是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)   logging.handlers.TimedRotatingFileHandler  -> 按照時間自動分割日志文件 

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

配置方法：

• setLevel()方法和日志對象的一樣，指明了將會分發日志的最低級別。為什么會有兩個setLevel()方法？記錄器的級別決定了消息是否要傳遞給處理器。每個處理器的級別決定了消息是否要分發。
• setFormatter()為該處理器選擇一個格式化器。
• addFilter()和removeFilter()分別配置和取消配置處理程序上的過濾器對象。

Formatters

Formatter對象設置日志信息最后的規則、結構和內容，默認的時間格式為%Y-%m-%d %H:%M:%S，下面是Formatter常用的一些信息

%(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	用戶輸出的消息

 

需求：

輸出log到控制台以及將日志寫入log文件。
保存2種類型的log， all.log 保存debug, info, warning, critical 信息， error.log則只保存error信息，同時按照時間自動分割日志文件。

import logging
from logging import handlers

class Logger(object):
    level_relations = {
        'debug':logging.DEBUG,
        'info':logging.INFO,
        'warning':logging.WARNING,
        'error':logging.ERROR,
        'crit':logging.CRITICAL
    }#日志級別關系映射

    def __init__(self,filename,level='info',when='D',backCount=3,fmt='%(asctime)s - %(pathname)s[line:%(lineno)d] - %(levelname)s: %(message)s'):
        self.logger = logging.getLogger(filename)
        format_str = logging.Formatter(fmt)#設置日志格式
        self.logger.setLevel(self.level_relations.get(level))#設置日志級別
        sh = logging.StreamHandler()#往屏幕上輸出
        sh.setFormatter(format_str) #設置屏幕上顯示的格式
        th = handlers.TimedRotatingFileHandler(filename=filename,when=when,backupCount=backCount,encoding='utf-8')#往文件里寫入#指定間隔時間自動生成文件的處理器
        #實例化TimedRotatingFileHandler
        #interval是時間間隔，backupCount是備份文件的個數，如果超過這個個數，就會自動刪除，when是間隔的時間單位，單位有以下幾種：
        # S 秒
        # M 分
        # H 小時、
        # D 天、
        # W 每星期（interval==0時代表星期一）
        # midnight 每天凌晨
        th.setFormatter(format_str)#設置文件里寫入的格式
        self.logger.addHandler(sh) #把對象加到logger里
        self.logger.addHandler(th)
if __name__ == '__main__':
    log = Logger('all.log',level='debug')
    log.logger.debug('debug')
    log.logger.info('info')
    log.logger.warning('警告')
    log.logger.error('報錯')
    log.logger.critical('嚴重')
    Logger('error.log', level='error').logger.error('error')

屏幕上的結果如下：

2018-03-13 21:06:46,092 - D:/write_to_log.py[line:25] - DEBUG: debug
2018-03-13 21:06:46,092 - D:/write_to_log.py[line:26] - INFO: info
2018-03-13 21:06:46,092 - D:/write_to_log.py[line:27] - WARNING: 警告
2018-03-13 21:06:46,099 - D:/write_to_log.py[line:28] - ERROR: 報錯
2018-03-13 21:06:46,099 - D:/write_to_log.py[line:29] - CRITICAL: 嚴重
2018-03-13 21:06:46,100 - D:/write_to_log.py[line:30] - ERROR: error

由於when=D，新生成的文件名上會帶上時間，如下所示。