Python學習：配置日誌的幾種方式

摘要：串列流比較簡單，對於parallelStream，站在它背後的是ForkJoin框架。本文分享自華為雲社區《深入理解Stream之foreach源碼解析》，作者：李哥技術。前言 Stream中的操作可以分為兩大類：中間操作與結束操作。今天要說的foreach是屬於結束操作。 Strea ...

作為開發者，我們可以通過以下3種方式來配置logging:

1）使用Python代碼顯式的創建loggers, handlers和formatters並分別調用它們的配置函數；
2）創建一個日誌配置文件，然後使用fileConfig()函數來讀取該文件的內容；
3）創建一個包含配置信息的dict，然後把它傳遞個dictConfig()函數；

需要說明的是，logging.basicConfig()也屬於第一種方式，它只是對loggers, handlers和formatters的配置函數進行了封裝。另外，第二種配置方式相對於第一種配置方式的優點在於，它將配置信息和代碼進行了分離，這一方面降低了日誌的維護成本，同時還使得非開發人員也能夠去很容易地修改日誌配置。

一、使用Python代碼實現日誌配置

代碼如下：

# 創建一個日誌器logger並設置其日誌級別為DEBUG
logger = logging.getLogger('simple_logger')
logger.setLevel(logging.DEBUG)

# 創建一個流處理器handler並設置其日誌級別為DEBUG
handler = logging.StreamHandler(sys.stdout)
handler.setLevel(logging.DEBUG)

# 創建一個格式器formatter並將其添加到處理器handler
formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
handler.setFormatter(formatter)

# 為日誌器logger添加上面創建的處理器handler
logger.addHandler(handler)

# 日誌輸出
logger.debug('debug message')
logger.info('info message')
logger.warn('warn message')
logger.error('error message')
logger.critical('critical message')

運行輸出：

2017-05-15 11:30:50,955 - simple_logger - DEBUG - debug message
2017-05-15 11:30:50,955 - simple_logger - INFO - info message
2017-05-15 11:30:50,955 - simple_logger - WARNING - warn message
2017-05-15 11:30:50,955 - simple_logger - ERROR - error message
2017-05-15 11:30:50,955 - simple_logger - CRITICAL - critical message

二、使用配置文件和fileConfig()函數實現日誌配置

現在我們通過配置文件的方式來實現與上面同樣的功能：

# 讀取日誌配置文件內容
logging.config.fileConfig('logging.conf')

# 創建一個日誌器logger
logger = logging.getLogger('simpleExample')

# 日誌輸出
logger.debug('debug message')
logger.info('info message')
logger.warn('warn message')
logger.error('error message')
logger.critical('critical message')

配置文件logging.conf內容如下：

[loggers]
keys=root,simpleExample

[handlers]
keys=fileHandler,consoleHandler

[formatters]
keys=simpleFormatter

[logger_root]
level=DEBUG
handlers=fileHandler

[logger_simpleExample]
level=DEBUG
handlers=consoleHandler
qualname=simpleExample
propagate=0

[handler_consoleHandler]
class=StreamHandler
args=(sys.stdout,)
level=DEBUG
formatter=simpleFormatter

[handler_fileHandler]
class=FileHandler
args=('logging.log', 'a')
level=ERROR
formatter=simpleFormatter

[formatter_simpleFormatter]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
datefmt=

運行輸出：

2017-05-15 11:32:16,539 - simpleExample - DEBUG - debug message
2017-05-15 11:32:16,555 - simpleExample - INFO - info message
2017-05-15 11:32:16,555 - simpleExample - WARNING - warn message
2017-05-15 11:32:16,555 - simpleExample - ERROR - error message
2017-05-15 11:32:16,555 - simpleExample - CRITICAL - critical message

1. 關於fileConfig()函數的說明：

該函數實際上是對configparser模塊的封裝，關於configparser模塊的介紹請參考<。
函數定義：

該函數定義在loging.config模塊下：

logging.config.fileConfig(fname, defaults=None, disable_existing_loggers=True)

參數：

fname：表示配置文件的文件名或文件對象
defaults：指定傳給ConfigParser的預設值
disable_existing_loggers：這是一個布爾型值，預設值為True（為了向後相容）表示禁用已經存在的logger，除非它們或者它們的祖先明確的出現在日誌配置中；如果值為False則對已存在的loggers保持啟動狀態。

2. 配置文件格式說明：

上面提到過，fileConfig()函數是對ConfigParser/configparser模塊的封裝，也就是說fileConfig()函數是基於ConfigParser/configparser模塊來理解日誌配置文件的。換句話說，fileConfig()函數所能理解的配置文件基礎格式是與ConfigParser/configparser模塊一致的，只是在此基礎上對文件中包含的section和option做了一下規定和限制，比如：

1）配置文件中一定要包含loggers、handlers、formatters這些section，它們通過keys這個option來指定該配置文件中已經定義好的loggers、handlers和formatters，多個值之間用逗號分隔；另外loggers這個section中的keys一定要包含root這個值；

2）loggers、handlers、formatters中所指定的日誌器、處理器和格式器都需要在下麵以單獨的section進行定義。seciton的命名規則為[logger_loggerName]、[formatter_formatterName]、[handler_handlerName]

3）定義logger的section必須指定level和handlers這兩個option，level的可取值為DEBUG、INFO、WARNING、ERROR、CRITICAL、NOTSET，其中NOTSET表示所有級別的日誌消息都要記錄，包括用戶定義級別；handlers的值是以逗號分隔的handler名字列表，這裡出現的handler必須出現在[handlers]這個section中，並且相應的handler必須在配置文件中有對應的section定義；

4）對於非root logger來說，除了level和handlers這兩個option之外，還需要一些額外的option，其中qualname是必須提供的option，它表示在logger層級中的名字，在應用代碼中通過這個名字得到logger；propagate是可選項，其預設是為1，表示消息將會傳遞給高層次logger的handler，通常我們需要指定其值為0，這個可以看下下麵的例子；另外，對於非root logger的level如果設置為NOTSET，系統將會查找高層次的logger來決定此logger的有效level。

5）定義handler的section中必須指定class和args這兩個option，level和formatter為可選option；class表示用於創建handler的類名，args表示傳遞給class所指定的handler類初始化方法參數，它必須是一個元組（tuple）的形式，即便只有一個參數值也需要是一個元組的形式；level與logger中的level一樣，而formatter指定的是該處理器所使用的格式器，這裡指定的格式器名稱必須出現在formatters這個section中，且在配置文件中必須要有這個formatter的section定義；如果不指定formatter則該handler將會以消息本身作為日誌消息進行記錄，而不添加額外的時間、日誌器名稱等信息；

6）定義formatter的sectioin中的option都是可選的，其中包括format用於指定格式字元串，預設為消息字元串本身；datefmt用於指定asctime的時間格式，預設為'%Y-%m-%d %H:%M:%S'；class用於指定格式器類名，預設為logging.Formatter；

說明：

配置文件中的class指定類名時，該類名可以是相對於logging模塊的相對值，如：FileHandler、handlers.TimeRotatingFileHandler；也可以是一個絕對路徑值，通過普通的import機制來解析，如自定義的handler類mypackage.mymodule.MyHandler，但是mypackage需要在Python可用的導入路徑中--sys.path。

3. 對於propagate屬性的說明

實例1：

我們把logging.conf中simpleExample這個handler定義中的propagate屬性值改為1，或者刪除這個option（預設值就是1）：

[logger_simpleExample]
level=DEBUG
handlers=consoleHandler
qualname=simpleExample
propagate=1

現在來執行同樣的代碼：

# 讀取日誌配置文件內容
logging.config.fileConfig('logging.conf')

# 創建一個日誌器logger
logger = logging.getLogger('simpleExample')

# 日誌輸出
logger.debug('debug message')
logger.info('info message')
logger.warn('warn message')
logger.error('error message')
logger.critical('critical message')

我們會發現，除了在控制台有輸出信息時候，在logging.log文件中也有內容輸出:

2017-05-15 16:06:25,366 - simpleExample - ERROR - error message
2017-05-15 16:06:25,367 - simpleExample - CRITICAL - critical message

這說明simpleExample這個logger在處理完日誌記錄後，把日誌記錄傳遞給了上級的root logger再次做處理，所有才會有兩個地方都有日誌記錄的輸出。通常，我們都需要顯示的指定propagate的值為0，防止日誌記錄向上層logger傳遞。

實例2：

現在，我們試著用一個沒有在配置文件中定義的logger名稱來獲取logger：

# 讀取日誌配置文件內容
logging.config.fileConfig('logging.conf')

# 用一個沒有在配置文件中定義的logger名稱來創建一個日誌器logger
logger = logging.getLogger('simpleExample1')

# 日誌輸出
logger.debug('debug message')
logger.info('info message')
logger.warn('warn message')
logger.error('error message')
logger.critical('critical message')

運行程式後，我們會發現控制台沒有任何輸出，而logging.log文件中又多了兩行輸出：

2017-05-15 16:13:16,810 - simpleExample1 - ERROR - error message
2017-05-15 16:13:16,810 - simpleExample1 - CRITICAL - critical message

這是因為，當一個日誌器沒有被設置任何處理器是，系統會去查找該日誌器的上層日誌器上所設置的日誌處理器來處理日誌記錄。

simpleExample1在配置文件中沒有被定義，因此logging.getLogger(simpleExample1)這行代碼這是獲取了一個logger實例，並沒有給它設置任何處理器，但是它的上級日誌器--root logger在配置文件中有定義且設置了一個FileHandler處理器，simpleExample1處理器最終通過這個FileHandler處理器將日誌記錄輸出到logging.log文件中了。

三、使用字典配置信息和dictConfig()函數實現日誌配置

Python 3.2中引入的一種新的配置日誌記錄的方法--用字典來保存logging配置信息。這相對於上面所講的基於配置文件來保存logging配置信息的方式來說，功能更加強大，也更加靈活，因為我們可把很多的數據轉換成字典。比如，我們可以使用JSON格式的配置文件、YAML格式的配置文件，然後將它們填充到一個配置字典中；或者，我們也可以用Python代碼構建這個配置字典，或者通過socket接收pickled序列化後的配置信息。總之，你可以使用你的應用程式可以操作的任何方法來構建這個配置字典。

這個例子中，我們將使用YAML格式來完成與上面同樣的日誌配置。

首先需要安裝PyYAML模塊：

pip install PyYAML

Python代碼：

'''
學習中遇到問題沒人解答？小編創建了一個Python學習交流群：711312441
尋找有志同道合的小伙伴，互幫互助,群里還有不錯的視頻學習教程和PDF電子書！
'''
import logging
import logging.config
import yaml

with open('logging.yml', 'r') as f_conf:
    dict_conf = yaml.load(f_conf)
logging.config.dictConfig(dict_conf)

logger = logging.getLogger('simpleExample')
logger.debug('debug message')
logger.info('info message')
logger.warn('warn message')
logger.error('error message')
logger.critical('critical message')

logging.yml配置文件的內容：

version: 1
formatters:
  simple:
    format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
handlers:
  console:
    class: logging.StreamHandler
    level: DEBUG
    formatter: simple
    stream: ext://sys.stdout
  console_err:
    class: logging.StreamHandler
    level: ERROR
    formatter: simple
    stream: ext://sys.stderr
loggers:
  simpleExample:
    level: DEBUG
    handlers: [console]
    propagate: yes
root:
  level: DEBUG
  handlers: [console_err]

輸出結果：

2017-05-21 14:19:31,089 - simpleExample - DEBUG - debug message
2017-05-21 14:19:31,089 - simpleExample - INFO - info message
2017-05-21 14:19:31,089 - simpleExample - WARNING - warn message
2017-05-21 14:19:31,089 - simpleExample - ERROR - error message
2017-05-21 14:19:31,090 - simpleExample - CRITICAL - critical message

1. 關於dictConfig()函數的說明：

該函數實際上是對configparser模塊的封裝，關於configparser模塊的介紹請參考<。
函數定義：

該函數定義在loging.config模塊下：

logging.config.dictConfig(config)

該函數可以從一個字典對象中獲取日誌配置信息，config參數就是這個字典對象。關於這個字典對象的內容規則會在下麵進行描述。

2. 配置字典說明

無論是上面提到的配置文件，還是這裡的配置字典，它們都要描述出日誌配置所需要創建的各種對象以及這些對象之間的關聯關係。比如，可以先創建一個名額為“simple”的格式器formatter；然後創建一個名為“console”的處理器handler，並指定該handler輸出日誌所使用的格式器為"simple"；然後再創建一個日誌器logger，並指定它所使用的處理器為"console"。

傳遞給dictConfig()函數的字典對象只能包含下麵這些keys，其中version是必須指定的key，其它key都是可選項：