python--使用logging庫自定義日志輸出

前言

1. 現在要求將錯誤日志寫入日志文件,通過查詢日志文件的方式,可以查看最新用例的執行情況,並快速定位問題
2. 使用print能夠將一些錯誤信息輸出在屏幕上,但是無法寫入在文件中
3. 本篇博客介紹如何使用logging庫實現日志輸出

logging庫

logging日志級別

debug info warning error critical

logging簡單示例

1. loggin默認只輸出 級別為warning error critical的日志
2. logging.basicConfig(**kwargs) 控制着logging的行為,其中level=[]控制日志輸出等級

import logging
logging.basicConfig(level=logging.DEBUG)
logging.debug('這是一個debug級別的信息,一般用來打印一些調試信息,級別最低')
logging.info('這是一個info級別的信息,一般用來打印一些正常的操作信息')
logging.warning('這是一個warning級別的信息')
logging.error('這是一個error級別的信息')
logging.critical('這是一個critical級別的信息,一般用來打印一些致命的錯誤信息，等級最高')

logging.basicConfig(**kwargs)參數

• filename：指定日志文件名
• filemode：和file函數意義相同，指定日志文件的打開模式，'w'或者'a'
• format：指定輸出的格式和內容，format可以輸出很多有用的信息

'''
formatter = logging.Formatter('%(asctime)s-%(levelname)s-%(filename)s-日志信息:%(message)s')

%(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         字符串形式的當前時間，默認格式‘2000-01-01 10:00:00,100’
%(thread)d          線程ID，可能沒有
%(threadName)s      線程名，可能沒有
%(process)d         進程ID，可能沒有
%(message)s         用戶輸出的消息（常用）
'''

• datefmt：指定時間格式，同time.strftime()
• level：設置日志級別，默認為logging.WARNNING
• stream：指定將日志的輸出流，可以指定輸出到sys.stderr，sys.stdout或者文件，默認輸出到sys.stderr，當stream和filename同時指定時，stream被忽略

haddler種類

logging是通過addHandler添加主處理對象,haddler種類有:

'''
handler名稱：位置；作用

StreamHandler：logging.StreamHandler     日志輸出到流，可以是sys.stderr，sys.stdout或者文件
FileHandler：logging.FileHandler     日志輸出到文件
BaseRotatingHandler：logging.handlers.BaseRotatingHandler    基本的日志回滾方式
RotatingHandler：logging.handlers.RotatingHandler    日志回滾方式，支持日志文件最大數量和日志文件回滾
TimeRotatingHandler：logging.handlers.TimeRotatingHandler    日志回滾方式，在一定時間區域內回滾日志文件
SocketHandler：logging.handlers.SocketHandler    遠程輸出日志到TCP/IP sockets
DatagramHandler：logging.handlers.DatagramHandler    遠程輸出日志到UDP sockets
SMTPHandler：logging.handlers.SMTPHandler    遠程輸出日志到郵件地址
SysLogHandler：logging.handlers.SysLogHandler    日志輸出到syslog
NTEventLogHandler：logging.handlers.NTEventLogHandler    遠程輸出日志到Windows NT/2000/XP的事件日志
MemoryHandler：logging.handlers.MemoryHandler    日志輸出到內存中的指定buffer
HTTPHandler：logging.handlers.HTTPHandler    通過"GET"或者"POST"遠程輸出到HTTP服務器
'''

輸出日志在控制台和文本中示例

# File  : test.py
# IDE   : PyCharm

import sys
import logging

logger = logging.getLogger(__name__)
logger.setLevel(level = logging.DEBUG)   # 輸出等級
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')   # 輸出格式

handler = logging.FileHandler("log.txt")    # 文本輸出
handler.setFormatter(formatter)
console = logging.StreamHandler(sys.stdout)   # 控制台輸出
console.setFormatter(formatter)

logger.addHandler(handler)
logger.addHandler(console)

if __name__ == '__main__':
    logger.info("這是一條info級別信息")
    logger.debug("這是一條debug級別信息")
    logger.warning("這是一條warning級別信息")

執行結果

封裝日志處理

# File  : logger_operation.py
# IDE   : PyCharm

import os
import sys
import logging
from time import strftime

class Logger():
    def __init__(self):
        # 日志格式
        custom_format = '%(asctime)s %(filename)s [line:%(lineno)d] %(levelname)s: %(message)s'
        # 日期格式
        date_format = '%a, %d %b %Y %H:%M:%S'
        # 日志路徑
        log_path = os.path.abspath('.') + '/logs/'

        self._logger = logging.getLogger()  # 實例化
        self.filename = '{0}{1}.log'.format(log_path, strftime("%Y-%m-%d")) # 日志文件名
        self.formatter = logging.Formatter(fmt=custom_format, datefmt=date_format)
        self._logger.addHandler(self._get_file_handler(self.filename))
        self._logger.addHandler(self._get_console_handler())
        self._logger.setLevel(logging.INFO)  # 默認等級

    def _get_file_handler(self, filename):
        '''輸出到日志文件'''
        filehandler = logging.FileHandler(filename, encoding="utf-8")
        filehandler.setFormatter(self.formatter)
        return filehandler

    def _get_console_handler(self):
        '''輸出到控制台'''
        console_handler = logging.StreamHandler(sys.stdout)
        console_handler.setFormatter(self.formatter)
        return console_handler

    @property
    def logger(self):
        return self._logger

if __name__ == '__main__':
    import datetime
    logging=Logger().logger
    logging.info(u"{}:執行xxx用例".format(datetime.datetime.now()))

總結

1. 本篇博客只實現了logging庫的基本使用,調用起來可能會不夠靈活,可以通過讀取配置文件的方式去配置日志
2. 日志是為了方便調試和查錯,在必要的函數內,都需要加上日志