一、logging模塊簡介

logging模塊是Python內置的標準模塊，主要用於輸出運行日誌，可以設置輸出日誌的等級、日誌保存路徑、日誌文件回滾等；相比print，具備如下優點：

• 可以通過設置不同的日誌等級，在release版本中只輸出重要信息，而不必顯示大量的調試信息；
• print將所有信息都輸出到標準輸出中，嚴重影響開發者從標準輸出中查看其它數據；logging則可以由開發者決定將信息輸出到什麽地方，以及怎麽輸出

二、logging模塊使用

2.1 基本使用

配置logging的基本配置，到控制臺輸出日誌：

import logging
logging.basicConfig(level 
 
= logging.INFO, format = ‘%(asctime)s - %(name)s - %(levelname)s - %(message)s‘)
logger = logging.getLogger(__name__)

logger.info("Start pribnt log")
logger.debug("Do something")
logger.warning("Something  maybe fail")
logger.info("Finish")

運行時控制臺輸出：

2018-09-26 14:19:27,895 - __main__ - INFO - Start print
 
 log
2018-09-26 14:19:27,895 - __main__ - WARNING - Something maybe fail
2018-09-26 14:19:27,895 - __main__ - INFO - Finish

logging中可以選擇很多消息級別，如debug、info、warning、error以及critical。通過賦予logger或者handler不同級別，開發者就可以輸出錯誤信息到特定的記錄文件，或者在調試時只記錄調試信息。

例如，我們將logger的級別修改為DEBUG，看輸出結果。

logging.basicConfig(level = logging.DEBUG,format = ‘
 
%(asctime)s - %(name)s - %(levelname)s - %(message)s‘)

控制臺輸出，可以發現輸出了debug的信息。

2018-09-26 14:23:38,786 - __main__ - INFO - Start print log
2018-09-26 14:23:38,786 - __main__ - DEBUG - Do something
2018-09-26 14:23:38,786 - __main__ - WARNING - Something maybe fail
2018-09-26 14:23:38,786 - __main__ - INFO - Finish

logging.basicConfig函數的各個參數：

filename：指定日誌文件名；
filemode：和file函數意義相同，指定日誌文件的打開模式，‘w’或者‘a’；
format：指定輸出的格式和內容，format可以輸出很多有用的信息。
datefmt：指定時間格式，同strftime()；
level：設置日誌級別，默認為logging.WARNNING；
stream：指定日誌的輸出流，可以指定輸出到sys.stderr，sys.stdout或者文件，默認輸出到sys.stderr，當stream和filename同時指定時，sreaam被忽略。

format參數：作用

%(levelno)s：打印日誌級別的數值
%(levelname)s：打印日誌級別的名稱
%(pathname)s：打印當前執行程序的路徑，其實就是sys.argv[0]
%(filename)s：打印當前執行程序名
%(funcName)s：打印日誌的當前函數
%(lineno)d：打印日誌的當前行號
%(asctime)s：打印日誌的時間
%(thread)d：打印線程ID
%(threadName)s：打印線程名稱
%(process)d：打印進程ID
%(message)s：打印日誌信息

2.2 將日誌寫到文件

2.2.1 將日誌寫入到文件

設置logging，創建一個FileHendle，並對輸出消息的格式進行設置，將其添加到logger，然後將日誌寫入到指定的文件中。

import logging 
logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO)
handler = logging.FileHandler("log.txt")
handler.setLevel(logging.INFO)
formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
handler.setFormatter(formatter)
logger.addHandler(handler)

logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail")
logger.info("Finish")

log.txt中的日誌數據為：

2018-09-26 15:01:14,201 - __main__ - INFO - Start print log
2018-09-26 15:01:14,203 - __main__ - WARNING - Something maybe fail
2018-09-26 15:01:14,203 - __main__ - INFO - Finish

2.2.2 將日誌同時輸出到控制臺和日誌文件

logger中添加StreamHandler，可將日誌輸出到控制臺

import logging
logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO)
handler = logging.FileHandler("log.txt")
handler.setLevel(logging.INFO)
formatter = logging.Formatter(‘%(asctime)s - %(name)s - %(levelname)s - %(message)s‘)
handler.setFormatter(formatter)

console = logging.StreamHandler()
console.setLevel(logging.INFO)
console.setFormatter(formatter)

logger.addHandler(handler)
logger.addHandler(console)

logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
logger.info("Finish")

這樣在log.txt和控制臺都可以看到：

2018-09-26 15:20:17,000 - __main__ - INFO - Start print log
2018-09-26 15:20:17,002 - __main__ - WARNING - Something maybe fail.
2018-09-26 15:20:17,002 - __main__ - INFO - Finish

可以發現，logging有一個日誌處理的主對象，其他方式都是通過addHandler添加進去，logging中包含handler主要有以下幾種：

handler名稱：位置；作用

StreamHandler：logging.StreamHandler；日誌輸出到流，可以是sys.stderr，sys.stdout或者文件
FileHandler：logging.FileHandler；日誌輸出到文件
BaseRotatingHandler：logging.handlers.BaseRotatingHandler；基本的日誌回滾方式
RotatingHandler：logging.handlers.RotatingHandler；日誌回滾方式，支持日誌文件最大數量和日誌文件回滾
TimeRotatingHandler：logging.handlers.TimeRotatingHandler；日誌回滾方式，在一定時間區域內回滾日誌文件
SocketHandler：logging.handlers.SocketHandler；遠程輸出日誌到TCP/IP sockets
DatagramHandler：logging.handlers.DatagramHandler；遠程輸出日誌到UDP sockets
SMTPHandler：logging.handlers.SMTPHandler；遠程輸出日誌到郵件地址
SysLogHandler：logging.handlers.SysLogHandler；日誌輸出到syslog
NTEventLogHandler：logging.handlers.NTEventLogHandler；遠程輸出日誌到Windows NT/2000/XP的事件日誌
MemoryHandler：logging.handlers.MemoryHandler；日誌輸出到內存中的指定buffer
HTTPHandler：logging.handlers.HTTPHandler；通過"GET"或者"POST"遠程輸出到HTTP服務器

2.2.3 日誌回滾

使用RotatingFileHandler，可以實現日誌回滾：

# -*- coding:utf-8 -*-
import logging
from logging.handlers import RotatingFileHandler

logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO)
# 定義一個RotatingFileHandler，最多備份三個日誌文件, 每個日誌文件最大1k
rHandler = RotatingFileHandler("log.txt",maxBytes = 1*1024,backupCount = 3)

rHandler.setLevel(logging.INFO)
formatter = logging.Formatter(‘%(asctime)s - %(name)s - %(levelname)s - %(message)s‘)
rHandler.setFormatter(formatter)

console = logging.StreamHandler()
console.setLevel(logging.INFO)
console.setFormatter(formatter)

logger.addHandler(rHandler)
logger.addHandler(console)

logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
logger.info("Finish")

可以在工程目錄中看到，備份的日誌文件：

log.txt
log.txt.1
log.txt.2
log.txt.3

2.3 設置消息的等級

可以設置不同的日誌等級，用於控制日誌的輸出：

日誌等級：使用範圍

FATAL：致命錯誤
CRITICAL：特別糟糕的事情，如內存耗盡、磁盤空間為空，一般很少使用
ERROR：發生錯誤時，如IO操作失敗或者連接問題
WARNING：發生很重要的事件，但是並不是錯誤時，如用戶登錄密碼錯誤
INFO：處理請求或者狀態變化等日常事務
DEBUG：調試過程中使用DEBUG等級，如算法中每個循環的中間狀態

2.4 捕獲traceback

python中的traceback模塊被用於跟蹤用於異常返回信息，可以在logging中記錄traceback

# -*- coding:utf-8 -*-
import logging
from logging.handlers import RotatingFileHandler

logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO)
handler = logging.FileHandler("log.txt")
handler.setLevel(logging.INFO)
formatter = logging.Formatter(‘%(asctime)s - %(name)s - %(levelname)s - %(message)s‘)
handler.setFormatter(formatter)

console = logging.StreamHandler()
console.setLevel(logging.INFO)


logger.addHandler(handler)
logger.addHandler(console)

logger.info("Start print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
try:
    open("sklearn.txt", "rb")
except (SystemExit, KeyboardInterrupt):
    raise
except Exception:
    logger.error("Falid to open sklearn.txt from logger.error", exc_info = True)

logger.info("Finish")

控制臺和日誌文件log.txt中輸出：

Start print log
Something maybe fail.
Falid to open sklearn.txt from logger.error
Traceback (most recent call last):
  File "D:/myproject/test.py", line 23, in <module>
    open("sklearn.txt", "rb")
IOError: [Errno 2] No such file or directory: ‘sklearn.txt‘
Finish

也可以使用logger.exception(msg,_args)，它等價於logger.error(msg,exc_info=True,_args)

將

logger.error("Faild to open sklearn.txt from logger.error",exc_info = True)

更改為：

logger.exception("Faild to open sklearn.txt from logger.exception")

控制臺和日誌文件log.txt輸出：

Start print log
Something maybe fail.
Faild to open sklearn.txt from logger.exception
Traceback (most recent call last):
  File "D:/myproject/test.py", line 23, in <module>
    open("sklearn.txt", "rb")
IOError: [Errno 2] No such file or directory: ‘sklearn.txt‘
Finish

2.5 多模塊使用logging

主模塊mainModule.py

import logging
import subModule
logger = logging.getLogger("mainModule")
logger.setLevel(level = logging.INFO)
handler = logging.FileHandler("log.txt")
handler.setLevel(logging.INFO)
formatter = logging.Formatter(‘%(asctime)s - %(name)s - %(levelname)s - %(message)s‘)
handler.setFormatter(formatter)

console = logging.StreamHandler()
console.setLevel(logging.INFO)
console.setFormatter(formatter)

logger.addHandler(handler)
logger.addHandler(console)


logger.info("creating an instance of subModule.subModuleClass")
a = subModule.SubModuleClass()
logger.info("calling subModule.subModuleClass.doSomething")
a.doSomething()
logger.info("done with  subModule.subModuleClass.doSomething")
logger.info("calling subModule.some_function")
subModule.som_function()
logger.info("done with subModule.some_function")

子模塊subModule.py

import logging

module_logger = logging.getLogger("mainModule.sub")
class SubModuleClass(object):
    def __init__(self):
        self.logger = logging.getLogger("mainModule.sub.module")
        self.logger.info("creating an instance in SubModuleClass")
    def doSomething(self):
        self.logger.info("do something in SubModule")
        a = []
        a.append(1)
        self.logger.debug("list a = " + str(a))
        self.logger.info("finish something in SubModuleClass")

def som_function():
    module_logger.info("call function some_function")

輸出：

2018-09-26 16:23:13,884 - mainModule - INFO - creating an instance of subModule.subModuleClass
2018-09-26 16:23:13,885 - mainModule.sub.module - INFO - creating an instance in SubModuleClass
2018-09-26 16:23:13,885 - mainModule - INFO - calling subModule.subModuleClass.doSomething
2018-09-26 16:23:13,885 - mainModule.sub.module - INFO - do something in SubModule
2018-09-26 16:23:13,885 - mainModule.sub.module - INFO - finish something in SubModuleClass
2018-09-26 16:23:13,885 - mainModule - INFO - done with  subModule.subModuleClass.doSomething
2018-09-26 16:23:13,885 - mainModule - INFO - calling subModule.some_function
2018-09-26 16:23:13,885 - mainModule.sub - INFO - call function some_function
2018-09-26 16:23:13,885 - mainModule - INFO - done with subModule.some_function

首先在主模塊定義了logger‘mainModule‘，並對它進行了配置，就可以在解釋器進程裏面的其他地方通過getLogger(‘mainModule‘)得到的對象都是一樣的，不需要重新配置，可以直接使用。定義的該logger的子logger，都可以共享父logger的定義和配置，所謂的父子logger是通過命名來識別，任意以‘mainModule‘開頭的logger都是它的子logger，例如‘mainModule.sub‘。

實際開發一個application，首先可以通過logging配置文件編寫好這個application所對應的配置，可以生成一個根logger，如‘PythonAPP‘，然後在主函數中通過fileConfig加載logging配置，接著在application的其他地方、不同的模塊中，可以使用根logger的子logger，如‘PythonAPP.Core‘，‘PythonAPP.Web‘來進行log，而不需要反復的定義和配置各個模塊的logger。

logging日誌模塊