作為開發(fā)者,我們可以通過以下3種方式來配置logging:
創(chuàng)新互聯(lián)建站主營新建網站建設的網絡公司,主營網站建設方案,重慶APP軟件開發(fā),新建h5小程序設計搭建,新建網站營銷推廣歡迎新建等地區(qū)企業(yè)咨詢
1)使用Python代碼顯式的創(chuàng)建loggers, handlers和formatters并分別調用它們的配置函數(shù);
2)創(chuàng)建一個日志配置文件,然后使用fileConfig()函數(shù)來讀取該文件的內容;
3)創(chuàng)建一個包含配置信息的dict,然后把它傳遞個dictConfig()函數(shù);
需要說明的是,logging.basicConfig()也屬于第一種方式,它只是對loggers, handlers和formatters的配置函數(shù)進行了封裝。另外,第二種配置方式相對于第一種配置方式的優(yōu)點在于,它將配置信息和代碼進行了分離,這一方面降低了日志的維護成本,同時還使得非開發(fā)人員也能夠去很容易地修改日志配置。
代碼如下:
# 創(chuàng)建一個日志器logger并設置其日志級別為DEBUG
logger = logging.getLogger('simple_logger')
logger.setLevel(logging.DEBUG)
# 創(chuàng)建一個流處理器handler并設置其日志級別為DEBUG
handler = logging.StreamHandler(sys.stdout)
handler.setLevel(logging.DEBUG)
# 創(chuàng)建一個格式器formatter并將其添加到處理器handler
formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
handler.setFormatter(formatter)
# 為日志器logger添加上面創(chuàng)建的處理器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
現(xiàn)在我們通過配置文件的方式來實現(xiàn)與上面同樣的功能:
# 讀取日志配置文件內容
logging.config.fileConfig('logging.conf')
# 創(chuàng)建一個日志器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
該函數(shù)實際上是對configparser模塊的封裝,關于configparser模塊的介紹請參考<。
函數(shù)定義:
該函數(shù)定義在loging.config模塊下:
logging.config.fileConfig(fname, defaults=None, disable_existing_loggers=True)
參數(shù):
上面提到過,fileConfig()函數(shù)是對ConfigParser/configparser模塊的封裝,也就是說fileConfig()函數(shù)是基于ConfigParser/configparser模塊來理解日志配置文件的。換句話說,fileConfig()函數(shù)所能理解的配置文件基礎格式是與ConfigParser/configparser模塊一致的,只是在此基礎上對文件中包含的section和option做了一下規(guī)定和限制,比如:
1)配置文件中一定要包含loggers、handlers、formatters這些section,它們通過keys這個option來指定該配置文件中已經定義好的loggers、handlers和formatters,多個值之間用逗號分隔;另外loggers這個section中的keys一定要包含root這個值;
2)loggers、handlers、formatters中所指定的日志器、處理器和格式器都需要在下面以單獨的section進行定義。seciton的命名規(guī)則為[logger_loggerName]、[formatter_formatterName]、[handler_handlerName]
3)定義logger的section必須指定level和handlers這兩個option,level的可取值為DEBUG、INFO、WARNING、ERROR、CRITICAL、NOTSET,其中NOTSET表示所有級別的日志消息都要記錄,包括用戶定義級別;handlers的值是以逗號分隔的handler名字列表,這里出現(xiàn)的handler必須出現(xiàn)在[handlers]這個section中,并且相應的handler必須在配置文件中有對應的section定義;
4)對于非root logger來說,除了level和handlers這兩個option之外,還需要一些額外的option,其中qualname是必須提供的option,它表示在logger層級中的名字,在應用代碼中通過這個名字得到logger;propagate是可選項,其默認是為1,表示消息將會傳遞給高層次logger的handler,通常我們需要指定其值為0,這個可以看下下面的例子;另外,對于非root logger的level如果設置為NOTSET,系統(tǒng)將會查找高層次的logger來決定此logger的有效level。
5)定義handler的section中必須指定class和args這兩個option,level和formatter為可選option;class表示用于創(chuàng)建handler的類名,args表示傳遞給class所指定的handler類初始化方法參數(shù),它必須是一個元組(tuple)的形式,即便只有一個參數(shù)值也需要是一個元組的形式;level與logger中的level一樣,而formatter指定的是該處理器所使用的格式器,這里指定的格式器名稱必須出現(xiàn)在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。
實例1:
我們把logging.conf中simpleExample這個handler定義中的propagate屬性值改為1,或者刪除這個option(默認值就是1):
[logger_simpleExample]
level=DEBUG
handlers=consoleHandler
qualname=simpleExample
propagate=1
現(xiàn)在來執(zhí)行同樣的代碼:
# 讀取日志配置文件內容
logging.config.fileConfig('logging.conf')
# 創(chuàng)建一個日志器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')
我們會發(fā)現(xiàn),除了在控制臺有輸出信息時候,在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:
現(xiàn)在,我們試著用一個沒有在配置文件中定義的logger名稱來獲取logger:
# 讀取日志配置文件內容
logging.config.fileConfig('logging.conf')
# 用一個沒有在配置文件中定義的logger名稱來創(chuàng)建一個日志器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')
運行程序后,我們會發(fā)現(xiàn)控制臺沒有任何輸出,而logging.log文件中又多了兩行輸出:
2017-05-15 16:13:16,810 - simpleExample1 - ERROR - error message
2017-05-15 16:13:16,810 - simpleExample1 - CRITICAL - critical message
這是因為,當一個日志器沒有被設置任何處理器是,系統(tǒng)會去查找該日志器的上層日志器上所設置的日志處理器來處理日志記錄。
simpleExample1在配置文件中沒有被定義,因此logging.getLogger(simpleExample1)這行代碼這是獲取了一個logger實例,并沒有給它設置任何處理器,但是它的上級日志器--root logger在配置文件中有定義且設置了一個FileHandler處理器,simpleExample1處理器最終通過這個FileHandler處理器將日志記錄輸出到logging.log文件中了。
Python 3.2中引入的一種新的配置日志記錄的方法--用字典來保存logging配置信息。這相對于上面所講的基于配置文件來保存logging配置信息的方式來說,功能更加強大,也更加靈活,因為我們可把很多的數(shù)據轉換成字典。比如,我們可以使用JSON格式的配置文件、YAML格式的配置文件,然后將它們填充到一個配置字典中;或者,我們也可以用Python代碼構建這個配置字典,或者通過socket接收pickled序列化后的配置信息??傊?,你可以使用你的應用程序可以操作的任何方法來構建這個配置字典。
這個例子中,我們將使用YAML格式來完成與上面同樣的日志配置。
首先需要安裝PyYAML模塊:
pip install PyYAML
Python代碼:
'''
學習中遇到問題沒人解答?小編創(chuàng)建了一個Python學習交流群:
尋找有志同道合的小伙伴,互幫互助,群里還有不錯的視頻學習教程和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
該函數(shù)實際上是對configparser模塊的封裝,關于configparser模塊的介紹請參考<。
函數(shù)定義:
該函數(shù)定義在loging.config模塊下:
logging.config.dictConfig(config)
該函數(shù)可以從一個字典對象中獲取日志配置信息,config參數(shù)就是這個字典對象。關于這個字典對象的內容規(guī)則會在下面進行描述。
無論是上面提到的配置文件,還是這里的配置字典,它們都要描述出日志配置所需要創(chuàng)建的各種對象以及這些對象之間的關聯(lián)關系。比如,可以先創(chuàng)建一個名額為“simple”的格式器formatter;然后創(chuàng)建一個名為“console”的處理器handler,并指定該handler輸出日志所使用的格式器為"simple";然后再創(chuàng)建一個日志器logger,并指定它所使用的處理器為"console"。
傳遞給dictConfig()函數(shù)的字典對象只能包含下面這些keys,其中version是必須指定的key,其它key都是可選項: