原文:http://www.cnblogs.com/dahu-daqing/p/7040764.html 1 logging模塊簡介logging模塊是Python內(nèi)置的標準模塊,主要用于輸出運行日志,可以設置輸出日志的等級、日志保存路徑、日志文件回滾等;相比print,具備如下優(yōu)點:
2 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 print log") logger.debug("Do something") logger.warning("Something maybe fail.") logger.info("Finish") 運行時,控制臺輸出,
logging中可以選擇很多消息級別,如debug、info、warning、error以及critical。通過賦予logger或者handler不同的級別,開發(fā)者就可以只輸出錯誤信息到特定的記錄文件,或者在調(diào)試時只記錄調(diào)試信息。 例如,我們將logger的級別改為DEBUG,再觀察一下輸出結(jié)果, logging.basicConfig(level = logging.DEBUG,format = '%(asctime)s - %(name)s - %(levelname)s - %(message)s') 控制臺輸出,可以發(fā)現(xiàn),輸出了debug的信息。
logging.basicConfig函數(shù)各參數(shù): filename:指定日志文件名; filemode:和file函數(shù)意義相同,指定日志文件的打開模式,'w'或者'a'; format:指定輸出的格式和內(nèi)容,format可以輸出很多有用的信息,
datefmt:指定時間格式,同time.strftime(); level:設置日志級別,默認為logging.WARNNING; stream:指定將日志的輸出流,可以指定輸出到sys.stderr,sys.stdout或者文件,默認輸出到sys.stderr,當stream和filename同時指定時,stream被忽略; 2.2 將日志寫入到文件2.2.1 將日志寫入到文件 設置logging,創(chuàng)建一個FileHandler,并對輸出消息的格式進行設置,將其添加到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ù)為,
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) 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文件和控制臺中看到,
可以發(fā)現(xiàn),logging有一個日志處理的主對象,其他處理方式都是通過addHandler添加進去,logging中包含的handler主要有如下幾種,
2.2.3 日志回滾 使用RotatingFileHandler,可以實現(xiàn)日志回滾, import logging from logging.handlers import RotatingFileHandler logger = logging.getLogger(__name__) logger.setLevel(level = logging.INFO) #定義一個RotatingFileHandler,最多備份3個日志文件,每個日志文件最大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") 可以在工程目錄中看到,備份的日志文件,
2.3 設置消息的等級可以設置不同的日志等級,用于控制日志的輸出,
2.4 捕獲tracebackPython中的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") 控制臺和日志文件log.txt中輸出,
也可以使用logger.exception(msg,_args),它等價于logger.error(msg,exc_info = True,_args), 將
替換為,
控制臺和日志文件log.txt中輸出,
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") 執(zhí)行之后,在控制和日志文件log.txt中輸出,
首先在主模塊定義了logger'mainModule',并對它進行了配置,就可以在解釋器進程里面的其他地方通過getLogger('mainModule')得到的對象都是一樣的,不需要重新配置,可以直接使用。定義的該logger的子logger,都可以共享父logger的定義和配置,所謂的父子logger是通過命名來識別,任意以'mainModule'開頭的logger都是它的子logger,例如'mainModule.sub'。 實際開發(fā)一個application,首先可以通過logging配置文件編寫好這個application所對應的配置,可以生成一個根logger,如'PythonAPP',然后在主函數(shù)中通過fileConfig加載logging配置,接著在application的其他地方、不同的模塊中,可以使用根logger的子logger,如'PythonAPP.Core','PythonAPP.Web'來進行l(wèi)og,而不需要反復的定義和配置各個模塊的logger。 3 通過JSON或者YAML文件配置logging模塊盡管可以在Python代碼中配置logging,但是這樣并不夠靈活,最好的方法是使用一個配置文件來配置。在Python 2.7及以后的版本中,可以從字典中加載logging配置,也就意味著可以通過JSON或者YAML文件加載日志的配置。 3.1 通過JSON文件配置JSON配置文件,
通過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文件配置通過YAML文件進行配置,比JSON看起來更加簡介明了,
通過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() |
|