Python線上環(huán)境使用日志的及配置文件

更新時(shí)間：2019年07月28日 09:00:09 作者：zone

這篇文章主要介紹了Python線上環(huán)境如何優(yōu)雅地使用日志，本文通過(guò)示例給大家分析對(duì)比了與 print 相比 logging 有什么優(yōu)勢(shì),需要的朋友可以參考下

瞎比比
與 print 相比 logging 有什么優(yōu)勢(shì)？
基礎(chǔ)用法
保存到文件
多模塊使用 logging
使用配置文件配置 logging

瞎比比

這篇文章其實(shí)早在一個(gè)月之前就寫(xiě)好了。奈何，加班猛如虎，真的怕了。直至今天才幸運(yùn)地有了個(gè)雙休，趕緊排版一下文章發(fā)布了。以下為正文。在初學(xué) Python 的時(shí)候，我們使用

print("hello world")

輸出了我們的第一行代碼。在之后的日子里，便一直使用 print 進(jìn)行調(diào)試（當(dāng)然，還有 IDE 的 debug 模式）。但是，當(dāng)你在線上運(yùn)行 Python 腳本的時(shí)候，你并不可能一直守著你的運(yùn)行終端?？墒侨绻皇刂脑?，每當(dāng)出現(xiàn) bug ，錯(cuò)誤又無(wú)從查起。這個(gè)時(shí)候，你需要對(duì)你的調(diào)試工具進(jìn)行更新?lián)Q代了，這里我推薦一個(gè)優(yōu)雅的調(diào)試工具 logging。

與 print 相比 logging 有什么優(yōu)勢(shì)？

那既然我推薦這個(gè)工具，它憑什么要被推薦呢？且來(lái)看看它有什么優(yōu)勢(shì)：

可以輸出到多處，例如：在輸出到控制臺(tái)的同時(shí)，可以保存日志到日志文件里面，或者保存到其他遠(yuǎn)程服務(wù)器
可以設(shè)置日志等級(jí)，DEBUG、INFO、ERROR等，在不同的環(huán)境（調(diào)試環(huán)境、線上環(huán)境）使用不同的等級(jí)來(lái)過(guò)濾日志，使用起來(lái)很方便
配置靈活，可保存到配置文件，格式化輸出

基礎(chǔ)用法

下面涉及到的代碼我都省略了導(dǎo)包部分，詳見(jiàn)源碼(后臺(tái)回復(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")
# 捕獲異常，并打印出出錯(cuò)行數(shù)
try:
  raise Exception("my exception")
except (SystemExit, KeyboardInterrupt):
  raise
except Exception:
  logger.error("there is an error =>", exc_info=True)

level為日志等級(jí)，分為：

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

foamat可以格式化輸出，其參數(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：打印日志信息

捕獲異常,以下兩行代碼都具有相同的作用

logger.exception(msg,_args)
logger.error(msg,exc_info = True,_args)

保存到文件，并輸出到命令行

這個(gè)用法直接 copy 使用就行

import logging
# 寫(xiě)入文件
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")
# 寫(xiě)入文件，同時(shí)輸出到屏幕
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)用者的日志格式會(huì)與調(diào)用者的日志格式一樣 main.py

# -*- coding: utf-8 -*-
__auth__ = 'zone'
__date__ = '2019/6/17 下午11:46'
'''
公眾號(hào)：zone7

小程序：編程面試題庫(kù)

'''
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'
'''

公眾號(hào)：zone7

小程序：編程面試題庫(kù)

'''
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

這里分別給出了兩種配置文件的使用案例，都分別使用了三種輸出，輸出到命令行、輸出到文件、將錯(cuò)誤信息獨(dú)立輸出到一個(gè)文件

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"]
  }
}

通過(guò) 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]

通過(guò) 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()

總結(jié)

以上所述是小編給大家介紹的Python線上環(huán)境使用日志的及配置文件,希望對(duì)大家有所幫助，如果大家有任何疑問(wèn)請(qǐng)給我留言，小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)腳本之家網(wǎng)站的支持！
如果你覺(jué)得本文對(duì)你有幫助，歡迎轉(zhuǎn)載，煩請(qǐng)注明出處，謝謝！

您可能感興趣的文章: