2019-03-04 Python標(biāo)準(zhǔn)模塊logging的使用

logging模塊簡(jiǎn)介

logging模塊是Python內(nèi)置的標(biāo)準(zhǔn)模塊食听，主要用于輸出運(yùn)行日志娘纷，可以設(shè)置輸出日志的等級(jí)植阴、日志保存路徑酷愧、日志文件回滾等烈拒；相比print滓侍，具備如下優(yōu)點(diǎn)：

可以通過設(shè)置不同的日志等級(jí)绍傲，在release版本中只輸出重要信息憾儒，而不必顯示大量的調(diào)試信息
print將所有信息都輸出到標(biāo)準(zhǔn)輸出中规哲，嚴(yán)重影響開發(fā)者從標(biāo)準(zhǔn)輸出中查看其它數(shù)據(jù)跟啤；logging則可以由開發(fā)者決定將信息輸出到什么地方，以及怎么輸出媳叨；

logging模塊使用

1. 基本使用

配置logging基本的設(shè)置腥光，然后在控制臺(tái)輸出日志，

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

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

運(yùn)行輸出

2016-10-09 19:11:19,434 - main - INFO - Start print log
2016-10-09 19:11:19,434 - main - WARNING - Something maybe fail.
2016-10-09 19:11:19,434 - main - INFO - Finish

logging中可以選擇很多消息級(jí)別糊秆，如debug武福、info、warning痘番、error以及critical捉片。通過賦予logger或者h(yuǎn)andler不同的級(jí)別，開發(fā)者就可以只輸出錯(cuò)誤信息到特定的記錄文件汞舱，或者在調(diào)試時(shí)只記錄調(diào)試信息伍纫。
例如，我們將logger的級(jí)別改為DEBUG昂芜，再觀察一下輸出結(jié)果莹规，

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

從輸出可以看出，多了debug級(jí)別的消息

2016-10-09 19:12:08,289 - main - INFO - Start print log
2016-10-09 19:12:08,289 - main - DEBUG - Do something
2016-10-09 19:12:08,289 - main - WARNING - Something maybe fail.
2016-10-09 19:12:08,289 - main - INFO - Finish

logging.basicConfig函數(shù)各參數(shù)：

filename：指定日志文件名泌神；
filemode：和file函數(shù)意義相同良漱，指定日志文件的打開模式舞虱，'w'或者'a'；
format：指定輸出的格式和內(nèi)容母市，format可以輸出很多有用的信息矾兜，

format 參數(shù)
%(levelno)s：打印日志級(jí)別的數(shù)值
%(levelname)s：打印日志級(jí)別的名稱
%(pathname)s：打印當(dāng)前執(zhí)行程序的路徑，其實(shí)就是sys.argv[0]
%(filename)s：打印當(dāng)前執(zhí)行程序名
%(funcName)s：打印日志的當(dāng)前函數(shù)
%(lineno)d：打印日志的當(dāng)前行號(hào)
%(asctime)s：打印日志的時(shí)間
%(thread)d：打印線程ID
%(threadName)s：打印線程名稱
%(process)d：打印進(jìn)程ID
%(message)s：打印日志信息

datefmt：指定時(shí)間格式患久，同time.strftime()椅寺；
level：設(shè)置日志級(jí)別，默認(rèn)為logging.WARNNING蒋失；
stream：指定將日志的輸出流返帕，可以指定輸出到sys.stderr，sys.stdout或者文件篙挽，默認(rèn)輸出到sys.stderr溉旋，7. 當(dāng)stream和filename同時(shí)指定時(shí)，stream被忽略嫉髓；

2. 將日志寫入到文件

2.1 將日志寫入到文件

設(shè)置logging观腊，創(chuàng)建一個(gè)FileHandler，并對(duì)輸出消息的格式進(jìn)行設(shè)置算行，將其添加到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中日志數(shù)據(jù)為州邢，

2016-10-09 19:01:13,263 - main - INFO - Start print log
2016-10-09 19:01:13,263 - main - WARNING - Something maybe fail.
2016-10-09 19:01:13,263 - main - INFO - Finish

2.2 將日志同時(shí)輸出到屏幕和日志文件

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)

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文件和控制臺(tái)中同時(shí)看到.
logging有一個(gè)日志處理的主對(duì)象量淌，其他處理方式都是通過addHandler添加進(jìn)去骗村，logging中包含的handler主要有如下幾種，

handler名稱：位置呀枢；作用
StreamHandler：logging.StreamHandler胚股；日志輸出到流，可以是sys.stderr裙秋，sys.stdout或者文件
FileHandler：logging.FileHandler琅拌；日志輸出到文件
BaseRotatingHandler：logging.handlers.BaseRotatingHandler；基本的日志回滾方式
RotatingHandler：logging.handlers.RotatingHandler摘刑；日志回滾方式进宝，支持日志文件最大數(shù)量和日志文件回滾
TimeRotatingHandler：logging.handlers.TimeRotatingHandler；日志回滾方式枷恕，在一定時(shí)間區(qū)域內(nèi)回滾日志文件
SocketHandler：logging.handlers.SocketHandler党晋；遠(yuǎn)程輸出日志到TCP/IP sockets
DatagramHandler：logging.handlers.DatagramHandler；遠(yuǎn)程輸出日志到UDP sockets
SMTPHandler：logging.handlers.SMTPHandler；遠(yuǎn)程輸出日志到郵件地址
SysLogHandler：logging.handlers.SysLogHandler未玻；日志輸出到syslog
NTEventLogHandler：logging.handlers.NTEventLogHandler漏益；遠(yuǎn)程輸出日志到Windows NT/2000/XP的事件日志
MemoryHandler：logging.handlers.MemoryHandler；日志輸出到內(nèi)存中的指定buffer
HTTPHandler：logging.handlers.HTTPHandler深胳；通過"GET"或者"POST"遠(yuǎn)程輸出到HTTP服務(wù)器

2.3 日志回滾

使用RotatingFileHandler，可以實(shí)現(xiàn)日志回滾铜犬，

import logging
from logging.handlers import RotatingFileHandler
logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO)
#定義一個(gè)RotatingFileHandler舞终，最多備份3個(gè)日志文件，每個(gè)日志文件最大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")

可以在工程目錄中看到癣猾，備份的日志文件敛劝，

2016/10/09 19:36 732 log.txt
2016/10/09 19:36 967 log.txt.1
2016/10/09 19:36 985 log.txt.2
2016/10/09 19:36 976 log.txt.3

2.4 設(shè)置消息的等級(jí)

可以設(shè)置不同的日志等級(jí)，用于控制日志的輸出纷宇，

日志等級(jí)：使用范圍
FATAL：致命錯(cuò)誤
CRITICAL：特別糟糕的事情夸盟，如內(nèi)存耗盡、磁盤空間為空像捶，一般很少使用
ERROR：發(fā)生錯(cuò)誤時(shí)上陕，如IO操作失敗或者連接問題
WARNING：發(fā)生很重要的事件，但是并不是錯(cuò)誤時(shí)拓春，如用戶登錄密碼錯(cuò)誤
INFO：處理請(qǐng)求或者狀態(tài)變化等日常事務(wù)
DEBUG：調(diào)試過程中使用DEBUG等級(jí)释簿，如算法中每個(gè)循環(huán)的中間狀態(tài)

2.5 捕獲traceback

Python中的traceback模塊被用于跟蹤異常返回信息，可以在logging中記錄下traceback硼莽，

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)

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("Faild to open sklearn.txt from logger.error",exc_info = True)

logger.info("Finish")

控制臺(tái)和日志文件log.txt中輸出庶溶，

Something maybe fail.
Faild to open sklearn.txt from logger.error
Traceback (most recent call last):
  File "G:\zhb7627\Code\Eclipse WorkSpace\PythonTest\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)，它等價(jià)于logger.error(msg,exc_info = True,_args)懂鸵，

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

2.6 多模塊使用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")

執(zhí)行之后匆光，在控制和日志文件log.txt中輸出套像，

2016-10-09 20:25:42,276 - mainModule - INFO - creating an instance of subModule.subModuleClass
2016-10-09 20:25:42,279 - mainModule.sub.module - INFO - creating an instance in SubModuleClass
2016-10-09 20:25:42,279 - mainModule - INFO - calling subModule.subModuleClass.doSomething
2016-10-09 20:25:42,279 - mainModule.sub.module - INFO - do something in SubModule
2016-10-09 20:25:42,279 - mainModule.sub.module - INFO - finish something in SubModuleClass
2016-10-09 20:25:42,279 - mainModule - INFO - done with subModule.subModuleClass.doSomething
2016-10-09 20:25:42,279 - mainModule - INFO - calling subModule.some_function
2016-10-09 20:25:42,279 - mainModule.sub - INFO - call function some_function
2016-10-09 20:25:42,279 - mainModule - INFO - done with subModule.some_function

首先在主模塊定義了logger'mainModule'，并對(duì)它進(jìn)行了配置终息，就可以在解釋器進(jìn)程里面的其他地方通過getLogger('mainModule')得到的對(duì)象都是一樣的凉夯，不需要重新配置，可以直接使用采幌。定義的該logger的子logger劲够，都可以共享父logger的定義和配置，所謂的父子logger是通過命名來識(shí)別休傍，任意以'mainModule'開頭的logger都是它的子logger征绎，例如'mainModule.sub'。

實(shí)際開發(fā)一個(gè)application，首先可以通過logging配置文件編寫好這個(gè)application所對(duì)應(yīng)的配置人柿，可以生成一個(gè)根logger柴墩，如'PythonAPP'，然后在主函數(shù)中通過fileConfig加載logging配置凫岖，接著在application的其他地方江咳、不同的模塊中，可以使用根logger的子logger哥放，如'PythonAPP.Core'歼指，'PythonAPP.Web'來進(jìn)行l(wèi)og，而不需要反復(fù)的定義和配置各個(gè)模塊的logger甥雕。

通過JSON或者YAML文件配置logging模塊

盡管可以在Python代碼中配置logging踩身，但是這樣并不夠靈活，最好的方法是使用一個(gè)配置文件來配置社露。在Python 2.7及以后的版本中挟阻，可以從字典中加載logging配置，也就意味著可以通過JSON或者YAML文件加載日志的配置峭弟。

3.1 通過JSON文件配置

{
    "version":1,
    "disable_existing_loggers":false,
    "formatters":{
        "simple":{
            "format":"%(asctime)s - %(name)s - %(levelname)s - %(message)s"
        }
    },
    "handlers":{
        "console":{
            "class":"logging.StreamHandler",
            "level":"DEBUG",
            "formatter":"simple",
            "stream":"ext://sys.stdout"
        },
        "info_file_handler":{
            "class":"logging.handlers.RotatingFileHandler",
            "level":"INFO",
            "formatter":"simple",
            "filename":"info.log",
            "maxBytes":"10485760",
            "backupCount":20,
            "encoding":"utf8"
        },
        "error_file_handler":{
            "class":"logging.handlers.RotatingFileHandler",
            "level":"ERROR",
            "formatter":"simple",
            "filename":"errors.log",
            "maxBytes":10485760,
            "backupCount":20,
            "encoding":"utf8"
        }
    },
    "loggers":{
        "my_module":{
            "level":"ERROR",
            "handlers":["info_file_handler"],
            "propagate":"no"
        }
    },
    "root":{
        "level":"INFO",
        "handlers":["console","info_file_handler","error_file_handler"]
    }
}

通過JSON加載配置文件附鸽，然后通過logging.dictConfig配置logging，

import json
import logging.config
import os

def setup_logging(default_path = "logging.json",default_level = logging.INFO,env_key = "LOG_CFG"):
    path = default_path
    value = os.getenv(env_key,None)
    if value:
        path = value
    if os.path.exists(path):
        with open(path,"r") as f:
            config = json.load(f)
            logging.config.dictConfig(config)
    else:
        logging.basicConfig(level = default_level)

def func():
    logging.info("start func")

    logging.info("exec func")

    logging.info("end func")

if __name__ == "__main__":
    setup_logging(default_path = "logging.json")
    func()

3.2 通過YAML文件配置

version: 1
disable_existing_loggers: False
formatters:
        simple:
            format: "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
handlers:
    console:
            class: logging.StreamHandler
            level: DEBUG
            formatter: simple
            stream: ext://sys.stdout
    info_file_handler:
            class: logging.handlers.RotatingFileHandler
            level: INFO
            formatter: simple
            filename: info.log
            maxBytes: 10485760
            backupCount: 20
            encoding: utf8
    error_file_handler:
            class: logging.handlers.RotatingFileHandler
            level: ERROR
            formatter: simple
            filename: errors.log
            maxBytes: 10485760
            backupCount: 20
            encoding: utf8
loggers:
    my_module:
            level: ERROR
            handlers: [info_file_handler]
            propagate: no
root:
    level: INFO
    handlers: [console,info_file_handler,error_file_handler]

通過YAML加載配置文件瞒瘸，然后通過logging.dictConfig配置logging拒炎，

import yaml
import logging.config
import os

def setup_logging(default_path = "logging.yaml",default_level = logging.INFO,env_key = "LOG_CFG"):
    path = default_path
    value = os.getenv(env_key,None)
    if value:
        path = value
    if os.path.exists(path):
        with open(path,"r") as f:
            config = yaml.load(f)
            logging.config.dictConfig(config)
    else:
        logging.basicConfig(level = default_level)

def func():
    logging.info("start func")

    logging.info("exec func")

    logging.info("end func")

if __name__ == "__main__":
    setup_logging(default_path = "logging.yaml")
    func()

Reference
http://www.cnblogs.com/zhbzz2007/p/5943685.html

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者

人面猴
序言：七十年代末，一起剝皮案震驚了整個(gè)濱河市挨务，隨后出現(xiàn)的幾起案子击你，更是在濱河造成了極大的恐慌，老刑警劉巖谎柄，帶你破解...
沈念sama閱讀 206,013評(píng)論 6贊 481
死咒
序言：濱河連續(xù)發(fā)生了三起死亡事件丁侄，死亡現(xiàn)場(chǎng)離奇詭異，居然都是意外死亡朝巫，警方通過查閱死者的電腦和手機(jī)鸿摇，發(fā)現(xiàn)死者居然都...
沈念sama閱讀 88,205評(píng)論 2贊 382
救了他兩次的神仙讓他今天三更去死
文/潘曉璐我一進(jìn)店門，熙熙樓的掌柜王于貴愁眉苦臉地迎上來劈猿，“玉大人拙吉，你說我怎么就攤上這事【救伲” “怎么了筷黔？”我有些...
開封第一講書人閱讀 152,370評(píng)論 0贊 342
道士緝兇錄：失蹤的賣姜人
文/不壞的土叔我叫張陵，是天一觀的道長(zhǎng)仗颈。經(jīng)常有香客問我佛舱，道長(zhǎng)，這世上最難降的妖魔是什么？我笑而不...
開封第一講書人閱讀 55,168評(píng)論 1贊 278
?港島之戀（遺憾婚禮）
正文為了忘掉前任请祖，我火速辦了婚禮订歪，結(jié)果婚禮上，老公的妹妹穿的比我還像新娘肆捕。我一直安慰自己刷晋，他們只是感情好，可當(dāng)我...
茶點(diǎn)故事閱讀 64,153評(píng)論 5贊 371
惡毒庶女頂嫁案：這布局不是一般人想出來的
文/花漫我一把揭開白布慎陵。她就那樣靜靜地躺著眼虱，像睡著了一般。火紅的嫁衣襯著肌膚如雪荆姆。梳的紋絲不亂的頭發(fā)上，一...
開封第一講書人閱讀 48,954評(píng)論 1贊 283
城市分裂傳說
那天映凳，我揣著相機(jī)與錄音胆筒，去河邊找鬼。笑死诈豌，一個(gè)胖子當(dāng)著我的面吹牛仆救，可吹牛的內(nèi)容都是我干的。我是一名探鬼主播矫渔，決...
沈念sama閱讀 38,271評(píng)論 3贊 399
雙鴛鴦連環(huán)套：你想象不到人心有多黑
文/蒼蘭香墨我猛地睜開眼彤蔽，長(zhǎng)吁一口氣：“原來是場(chǎng)噩夢(mèng)啊……” “哼！你這毒婦竟也來了庙洼？” 一聲冷哼從身側(cè)響起顿痪，我...
開封第一講書人閱讀 36,916評(píng)論 0贊 259
萬榮殺人案實(shí)錄
序言：老撾萬榮一對(duì)情侶失蹤，失蹤者是張志新（化名）和其女友劉穎油够，沒想到半個(gè)月后蚁袭，有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體，經(jīng)...
沈念sama閱讀 43,382評(píng)論 1贊 300
?護(hù)林員之死
正文獨(dú)居荒郊野嶺守林人離奇死亡石咬，尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛以下內(nèi)容為張勛視角年9月15日...
茶點(diǎn)故事閱讀 35,877評(píng)論 2贊 323
?白月光啟示錄
正文我和宋清朗相戀三年揩悄，在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片鬼悠。...
茶點(diǎn)故事閱讀 37,989評(píng)論 1贊 333
活死人
序言：一個(gè)原本活蹦亂跳的男人離奇死亡删性，死狀恐怖，靈堂內(nèi)的尸體忽然破棺而出焕窝，到底是詐尸還是另有隱情蹬挺，我是刑警寧澤，帶...
沈念sama閱讀 33,624評(píng)論 4贊 322
?日本核電站爆炸內(nèi)幕
正文年R本政府宣布它掂，位于F島的核電站汗侵，受9級(jí)特大地震影響，放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜晰韵，卻給世界環(huán)境...
茶點(diǎn)故事閱讀 39,209評(píng)論 3贊 307
男人毒藥：我在死后第九天來索命
文/蒙蒙一发乔、第九天我趴在偏房一處隱蔽的房頂上張望。院中可真熱鬧雪猪，春花似錦栏尚、人聲如沸。這莊子的主人今日做“春日...
開封第一講書人閱讀 30,199評(píng)論 0贊 19
一樁弒父案译仗，背后竟有這般陰謀
文/蒼蘭香墨我抬頭看了看天上的太陽。三九已至官觅，卻和暖如春纵菌，著一層夾襖步出監(jiān)牢的瞬間，已是汗流浹背休涤。一陣腳步聲響...
開封第一講書人閱讀 31,418評(píng)論 1贊 260
情欲美人皮
我被黑心中介騙來泰國(guó)打工咱圆，沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留，地道東北人功氨。一個(gè)月前我還...
沈念sama閱讀 45,401評(píng)論 2贊 352
代替公主和親
正文我出身青樓序苏，卻偏偏與公主長(zhǎng)得像，于是被迫代替她去往敵國(guó)和親捷凄。傳聞我的和親對(duì)象是個(gè)殘疾皇子忱详，可洞房花燭夜當(dāng)晚...
茶點(diǎn)故事閱讀 42,700評(píng)論 2贊 345