瞎比比
這篇文章其實早在一個月之前就寫好了。奈何，加班猛如虎，真的怕了。直至今天才幸運地有了個雙休，趕緊排版一下文章發(fā)布了。以下為正文。
源碼地址：
https://github.com/zonezoen/blog/tree/master/Python/ target=_blank class=infotextkey>Python/logging_model
在初學(xué) Python 的時候，我們使用
print("hello world")
輸出了我們的第一行代碼。在之后的日子里，便一直使用 print 進行調(diào)試（當(dāng)然，還有 IDE 的 debug 模式）。但是，當(dāng)你在線上運行 Python 腳本的時候，你并不可能一直守著你的運行終端?？墒侨绻皇刂脑?，每當(dāng)出現(xiàn) bug ，錯誤又無從查起。這個時候，你需要對你的調(diào)試工具進行更新?lián)Q代了，這里我推薦一個優(yōu)雅的調(diào)試工具 logging。
與 print 相比 logging 有什么優(yōu)勢？
那既然我推薦這個工具，它憑什么要被推薦呢？且來看看它有什么優(yōu)勢：
- 可以輸出到多處，例如：在輸出到控制臺的同時，可以保存日志到日志文件里面，或者保存到其他遠程服務(wù)器
- 可以設(shè)置日志等級，DEBUG、INFO、ERROR等，在不同的環(huán)境（調(diào)試環(huán)境、線上環(huán)境）使用不同的等級來過濾日志，使用起來很方便
- 配置靈活，可保存到配置文件，格式化輸出
基礎(chǔ)用法
下面涉及到的代碼我都省略了導(dǎo)包部分，詳見源碼(后臺回復(fù) logging 獲取源碼)
base_usage.py
logging.basicConfig(level=log_level, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
logger = logging.getLogger(__name__)
logger.info("Log level info")
logger.debug("Log level debug")
logger.warning("Log level warning")
# 捕獲異常，并打印出出錯行數(shù)
try:
raise Exception("my exception")
except (SystemExit, KeyboardInterrupt):
raise
except Exception:
logger.error("there is an error =>", exc_info=True)
level 為日志等級，分為：
FATAL：致命錯誤 CRITICAL：特別糟糕的事情，如內(nèi)存耗盡、磁盤空間為空，一般很少使用 ERROR：發(fā)生錯誤時，如IO操作失敗或者連接問題 WARNING：發(fā)生很重要的事件，但是并不是錯誤時，如用戶登錄密碼錯誤 INFO：處理請求或者狀態(tài)變化等日常事務(wù) DEBUG：調(diào)試過程中使用DEBUG等級，如算法中每個循環(huán)的中間狀態(tài)
foamat 可以格式化輸出，其參數(shù)有如下：
%(levelno)s：打印日志級別的數(shù)值 %(levelname)s：打印日志級別的名稱 %(pathname)s：打印當(dāng)前執(zhí)行程序的路徑，其實就是sys.argv[0] %(filename)s：打印當(dāng)前執(zhí)行程序名 %(funcName)s：打印日志的當(dāng)前函數(shù) %(lineno)d：打印日志的當(dāng)前行號 %(asctime)s：打印日志的時間 %(thread)d：打印線程ID %(threadName)s：打印線程名稱 %(process)d：打印進程ID %(message)s：打印日志信息
捕獲異常,以下兩行代碼都具有相同的作用
logger.exception(msg,_args) logger.error(msg,exc_info = True,_args)
保存到文件，并輸出到命令行
這個用法直接 copy 使用就行
import logging
# 寫入文件
import logging
logger = logging.getLogger(__name__)
logger.setLevel(level=logging.INFO)
handler = logging.FileHandler("info.log")
handler.setLevel(logging.INFO)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)
logger.addHandler(handler)
logger.info("Log level info")
logger.debug("Log level debug")
logger.warning("Log level warning")
# 寫入文件，同時輸出到屏幕
import logging
logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO)
handler = logging.FileHandler("info.log")
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("Log level info")
logger.debug("Log level debug")
logger.warning("Log level warning")
多模塊使用 logging
被調(diào)用者的日志格式會與調(diào)用者的日志格式一樣
main.py
# -*- coding: utf-8 -*-
__auth__ = 'zone'
__date__ = '2019/6/17 下午11:46'
'''
公眾號：zone7
小程序：編程面試題庫
'''
import os
import logging
from python.logging_model.code import sub_of_main
logger = logging.getLogger("zone7Model")
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)
sub = sub_of_main.SubOfMain()
logger.info("main module log")
sub.print_some_log()
sub_of_main.py
# -*- coding: utf-8 -*-
__auth__ = 'zone'
__date__ = '2019/6/17 下午11:47'
'''
公眾號：zone7
小程序：編程面試題庫
'''
import logging
module_logger = logging.getLogger("zone7Model.sub.module")
class SubOfMain(object):
def __init__(self):
self.logger = logging.getLogger("zone7Model.sub.module")
self.logger.info("init sub class")
def print_some_log(self):
self.logger.info("sub class log is printed")
def som_function():
module_logger.info("call function some_function")
使用配置文件配置 logging
這里分別給出了兩種配置文件的使用案例，都分別使用了三種輸出，輸出到命令行、輸出到文件、將錯誤信息獨立輸出到一個文件
log_cfg.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_handler2"],
"propagate":"no"
}
},
"root":{
"level":"INFO",
"handlers":["console","info_file_handler","error_file_handler"]
}
}
通過 json 文件讀取配置：
import json
import logging.config
import os
def set_log_cfg(default_path="log_cfg.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 record_some_thing():
logging.info("Log level info")
logging.debug("Log level debug")
logging.warning("Log level warning")
if __name__ == "__main__":
set_log_cfg(default_path="log_cfg.json")
record_some_thing()
log_cfg.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 文件讀取配置：
import yaml
import logging.config
import os
def set_log_cfg(default_path="log_cfg.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 record_some_thing():
logging.info("Log level info")
logging.debug("Log level debug")
logging.warning("Log level warning")
if __name__ == "__main__":
set_log_cfg(default_path="log_cfg.yaml")
record_some_thing()
