Python日志模塊logging用法
一、概述
步驟
- 創建logger對象
- 創建handler對象
- 創建formatter對象
- 把formatter綁定到handler對象上
- 把handler對象綁定到logger對象上
- 設置級別
- 測試
二、低配logging
日志總共分為以下五個級別，這個五個級別自下而上進行匹配 debug–>info–>warning–>error–>critical，默認最低級別為warning級別。
critical=50、error =40 、arning =30、info = 20、debug =10
v1:屏幕輸出
v1版本無法指定日志的級別；無法指定日志的格式；隻能往屏幕打印，無法寫入文件。
import logging
logging.debug('調試信息')
logging.info('正常信息')
logging.warning('警告信息') # WARNING:root:警告信息
logging.error('報錯信息') # ERROR:root:報錯信息
logging.critical('嚴重錯誤信息') # CRITICAL:root:嚴重錯誤信息
v2：輸出到文件
v2版本不能指定字符編碼；隻能往文件中打印。
可在logging.basicConfig()函數中可通過具體參數來更改logging模塊默認行為，可用參數有:
- filename：用指定的文件名創建FiledHandler（後邊會具體講解handler的概念），這樣日志會被存儲在指定的文件中。
- filemode：文件打開方式，在指定瞭filename時使用這個參數，默認值為“a”還可指定為“w”。
- format：指定handler使用的日志顯示格式。
- datefmt：指定日期時間格式。
- level：設置rootlogger（後邊會講解具體概念）的日志級別
- stream：用指定的stream創建StreamHandler。可以指定輸出到sys.stderr,sys.stdout或者文件，默認為sys.stderr。若同時列出瞭filename和stream兩個參數，則stream參數會被忽略。
import logging
# 日志的基本配置
logging.basicConfig(filename='access.log',
format='%(asctime)s - %(name)s - %(levelname)s -%(module)s: %(message)s',
datefmt='%Y-%m-%d %H:%M:%S %p',
level=10)
logging.debug('調試信息') # 2019-11-28 18:25:26 PM - root - DEBUG -run: 調試信息
logging.info('正常信息') # 2019-11-28 18:25:26 PM - root - INFO -run: 正常信息
logging.warning('警告信息') # 2019-11-28 18:25:26 PM - root - WARNING -run: 警告信息
logging.error('報錯信息') # 2019-11-28 18:25:26 PM - root - ERROR -run: 報錯信息
logging.critical('嚴重錯誤信息') # 2019-11-28 18:25:26 PM - root - CRITICAL -run: 嚴重錯誤信息
format參數中可能用到的格式化串：
- %(name)s ：Logger的名字
- %(levelno)s ：數字形式的日志級別
- %(levelname)s ：文本形式的日志級別
- %(pathname)s 調：用日志輸出函數的模塊的完整路徑名，可能沒有
- %(filename)s ：調用日志輸出函數的模塊的文件名
- %(module)s ：調用日志輸出函數的模塊名
- %(funcName)s ：調用日志輸出函數的函數名
- %(lineno)d ：調用日志輸出函數的語句所在的代碼行
- %(created)f ：當前時間，用UNIX標準的表示時間的浮 點數表示
- %(relativeCreated)d ：輸出日志信息時的，自Logger創建以 來的毫秒數
- %(asctime)s ：字符串形式的當前時間。默認格式是 “2003-07-08 16:49:45,896”。逗號後面的是毫秒
- %(thread)d ：線程ID。可能沒有
- %(threadName)s ：線程名。可能沒有
- %(process)d ：進程ID。可能沒有
- %(message)s：用戶輸出的消息
v3：使用內置各種對象
logging模塊包含四種角色：logger、Filter、Formatter、Handler對象
- logger：產生日志的對象
- Filter：過濾日志的對象
- Formatter：可以定制不同的日志格式對象，然後綁定給不同的Handler對象使用，以此來控制不同的Handler的日志格式
- Handler：接收日志然後控制打印到不同的地方，FileHandler用來打印到文件中，StreamHandler用來打印到終端
import logging
# 1、logger對象：負責產生日志，然後交給Filter過濾，然後交給不同的Handler輸出
logger = logging.getLogger(__file__)
# 2、Filter對象：不常用，略
# 3、Handler對象：接收logger傳來的日志，然後控制輸出
h1 = logging.FileHandler('t1.log') # 打印到文件
h2 = logging.FileHandler('t2.log') # 打印到文件
sm = logging.StreamHandler() # 打印到終端
# 4、Formatter對象：日志格式
formmater1 = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s -%(module)s: %(message)s',
datefmt='%Y-%m-%d %H:%M:%S %p', )
formmater2 = logging.Formatter('%(asctime)s : %(message)s',
datefmt='%Y-%m-%d %H:%M:%S %p', )
formmater3 = logging.Formatter('%(name)s %(message)s', )
# 5、為Handler對象綁定格式
h1.setFormatter(formmater1)
h2.setFormatter(formmater2)
sm.setFormatter(formmater3)
# 6、將Handler添加給logger並設置日志級別
logger.addHandler(h1)
logger.addHandler(h2)
logger.addHandler(sm)
# 設置日志級別，可以在兩個關卡進行設置logger與handler
# logger是第一級過濾，然後才能到handler
logger.setLevel(30)
h1.setLevel(10)
h2.setLevel(10)
sm.setLevel(10)
# 7、測試
logger.debug('debug')
logger.info('info')
logger.warning('warning')
logger.error('error')
logger.critical('critical')
三、高配logging
1、 配置日志文件
以上三個版本的日志隻是為瞭引出我們下面的日志配置文件
import os
import logging.config
# 定義三種日志輸出格式 開始
standard_format = '[%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d]' \
'[%(levelname)s][%(message)s]' # 其中name為getLogger()指定的名字；lineno為調用日志輸出函數的語句所在的代碼行
simple_format = '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'
id_simple_format = '[%(levelname)s][%(asctime)s] %(message)s'
# 定義日志輸出格式 結束
logfile_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # log文件的目錄，需要自定義文件路徑 # atm
logfile_dir = os.path.join(logfile_dir, 'log') # C:\Users\oldboy\Desktop\atm\log
logfile_name = 'log.log' # log文件名，需要自定義路徑名
# 如果不存在定義的日志目錄就創建一個
if not os.path.isdir(logfile_dir): # C:\Users\oldboy\Desktop\atm\log
os.mkdir(logfile_dir)
# log文件的全路徑
logfile_path = os.path.join(logfile_dir, logfile_name) # C:\Users\oldboy\Desktop\atm\log\log.log
# 定義日志路徑 結束
# log配置字典
LOGGING_DIC = {
'version': 1,
'disable_existing_loggers': False,
'formatters': {
'standard': {
'format': standard_format
},
'simple': {
'format': simple_format
},
},
'filters': {}, # filter可以不定義
'handlers': {
# 打印到終端的日志
'console': {
'level': 'DEBUG',
'class': 'logging.StreamHandler', # 打印到屏幕
'formatter': 'simple'
},
# 打印到文件的日志,收集info及以上的日志
'default': {
'level': 'INFO',
'class': 'logging.handlers.RotatingFileHandler', # 保存到文件
'formatter': 'standard',
'filename': logfile_path, # 日志文件
'maxBytes': 1024 * 1024 * 5, # 日志大小 5M (*****)
'backupCount': 5,
'encoding': 'utf-8', # 日志文件的編碼，再也不用擔心中文log亂碼瞭
},
},
'loggers': {
# logging.getLogger(__name__)拿到的logger配置。如果''設置為固定值logger1，則下次導入必須設置成logging.getLogger('logger1')
'': {
# 這裡把上面定義的兩個handler都加上，即log數據既寫入文件又打印到屏幕
'handlers': ['default', 'console'],
'level': 'DEBUG',
'propagate': False, # 向上（更高level的logger）傳遞
},
},
}
def load_my_logging_cfg():
logging.config.dictConfig(LOGGING_DIC) # 導入上面定義的logging配置
logger = logging.getLogger(__name__) # 生成一個log實例
logger.info('It works!') # 記錄該文件的運行狀態
return logger
if __name__ == '__main__':
load_my_logging_cfg()
2、 使用日志
import time
import logging
import my_logging # 導入自定義的logging配置
logger = logging.getLogger(__name__) # 生成logger實例
def demo():
logger.debug("start range... time:{}".format(time.time()))
logger.info("中文測試開始。。。")
for i in range(10):
logger.debug("i:{}".format(i))
time.sleep(0.2)
else:
logger.debug("over range... time:{}".format(time.time()))
logger.info("中文測試結束。。。")
if __name__ == "__main__":
my_logging.load_my_logging_cfg() # 在你程序文件的入口加載自定義logging配置
demo()
四、Django日志配置文件
Django(發音：[`dʒæŋɡəʊ])是一個開放源代碼的Web應用框架，由Python寫成。采用瞭MTV的框架模式，即模型M，視圖V和模版T。
# logging_config.py
LOGGING = {
'version': 1,
'disable_existing_loggers': False,
'formatters': {
'standard': {
'format': '[%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d]'
'[%(levelname)s][%(message)s]'
},
'simple': {
'format': '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'
},
'collect': {
'format': '%(message)s'
}
},
'filters': {
'require_debug_true': {
'()': 'django.utils.log.RequireDebugTrue',
},
},
'handlers': {
# 打印到終端的日志
'console': {
'level': 'DEBUG',
'filters': ['require_debug_true'],
'class': 'logging.StreamHandler',
'formatter': 'simple'
},
# 打印到文件的日志,收集info及以上的日志
'default': {
'level': 'INFO',
'class': 'logging.handlers.RotatingFileHandler', # 保存到文件，自動切
'filename': os.path.join(BASE_LOG_DIR, "xxx_info.log"), # 日志文件
'maxBytes': 1024 * 1024 * 5, # 日志大小 5M
'backupCount': 3,
'formatter': 'standard',
'encoding': 'utf-8',
},
# 打印到文件的日志:收集錯誤及以上的日志
'error': {
'level': 'ERROR',
'class': 'logging.handlers.RotatingFileHandler', # 保存到文件，自動切
'filename': os.path.join(BASE_LOG_DIR, "xxx_err.log"), # 日志文件
'maxBytes': 1024 * 1024 * 5, # 日志大小 5M
'backupCount': 5,
'formatter': 'standard',
'encoding': 'utf-8',
},
# 打印到文件的日志
'collect': {
'level': 'INFO',
'class': 'logging.handlers.RotatingFileHandler', # 保存到文件，自動切
'filename': os.path.join(BASE_LOG_DIR, "xxx_collect.log"),
'maxBytes': 1024 * 1024 * 5, # 日志大小 5M
'backupCount': 5,
'formatter': 'collect',
'encoding': "utf-8"
}
},
'loggers': {
# logging.getLogger(__name__)拿到的logger配置
'': {
'handlers': ['default', 'console', 'error'],
'level': 'DEBUG',
'propagate': True,
},
# logging.getLogger('collect')拿到的logger配置
'collect': {
'handlers': ['console', 'collect'],
'level': 'INFO',
}
},
}
# -----------
# 用法:拿到倆個logger
logger = logging.getLogger(__name__) # 線上正常的日志
collect_logger = logging.getLogger("collect") # 領導說,需要為領導們單獨定制領導們看的日志
到此這篇關於Python日志模塊的文章就介紹到這瞭。希望對大傢的學習有所幫助，也希望大傢多多支持WalkonNet。
推薦閱讀：
- Python logging簡介詳解
- python 日志模塊logging的使用場景及示例
- python自動化測試通過日志3分鐘定位bug
- 如何理解python接口自動化之logging日志模塊
- Python 內置logging 使用詳細介紹