Python日志模块logbook使用方法详解

青禾

发布时间：2026-10-13| 6人浏览过

原创

本文详细介绍Python中logbook模块的安装及配置方法。通过示例代码展示如何定义日志格式logFormate，以及在initLogger中设置文件输出fileLogFlag和终端输出stdOutFlag。同时讲解如何通过globalConf.py共享Logger实例，并在test.py中调用不同日志等级进行记录，帮助开发者高效管理程序日志。

logbook模块简介

Python内置了logging模块用于记录程序运行时的日志信息。此外，logbook模块作为logging的替代方案，在许多项目中被广泛使用。本文将详细介绍Python logbook模块的具体使用方法。

安装与配置

1. 安装

pip install logbook

官方使用文档详见此处。

2. 使用方法如下：

日志格式与初始化

文件logconf.py用于初始化日志并设置日志格式等参数：


import sys
import os
import logbook
import logbook.more
def logFormate(record,handler):
  formate = "[{date}] [{level}] [{filename}] [{func_name}] [{lineno}] {msg}".format(
    date = record.time,               # 日志时间
    level = record.level_name,            # 日志等级
    filename = os.path.split(record.filename)[-1],  # 文件名
    func_name = record.func_name,          # 函数名
    lineno = record.lineno,             # 行号
    msg = record.message               # 日志内容
  )
  return formate
def initLogger(filename,fileLogFlag=True,stdOutFlag=False):
  LOG_DIR = os.path.join('log')
  if not os.path.exists(LOG_DIR):
    os.makedirs(LOG_DIR)
  logbook.set_datetime_format('local')
  logger = logbook.Logger(filename)
  logger.handlers = []
  if fileLogFlag:#日志输出到文件
    logFile = logbook.TimedRotatingFileHandler(os.path.join(LOG_DIR, '%s.log' % 'log'),date_format='%Y-%m-%d', bubble=True, encoding='utf-8')
    logFile.formatter = logFormate
    logger.handlers.append(logFile)
  if stdOutFlag:#日志打印到屏幕
    logStd = logbook.more.ColorizedStderrHandler(bubble=True)
    logStd.formatter = logFormate
    logger.handlers.append(logStd)
  return logger

1. 该文件中的logFormate函数用于设置日志的输出格式。

2. 在initLogger函数中，fileLogFlag参数用于标识是否将日志写入文件。

3. 在initLogger函数中，stdOutFlag参数用于标识是否将日志打印到终端。

上述参数可根据实际情况进行设置。

全局Logger共享

文件globalConf.py将logger定义为一个供所有其他模块使用的全局公共变量，因此单独设置该文件以便其他文件引用。


import logconf
class ShareLogger:
 logger = logconf.initLogger('log.txt',True,True)
 
def getShareLogger():
 return ShareLogger.logger
def setShareLogger(logger):
 ShareLogger.logger = logger

日志调用示例

文件test.py为日志具体使用的示例文件：


import sys
import os
import globalConf
global logger
logger = globalConf.getShareLogger()
if __name__ == "__main__":
 logger.info("this is info")
 logger.warning("this iswarning")
 logger.debug("this is debug")
 logger.critical("this is critical")

该文件中调用globalConf.py获取logger日志变量，并根据不同的日志等级进行记录。logbook模块的日志等级说明见此处。


logbook.CRITICAL     严重错误信息
logbook.ERROR       一般错误信息
logbook.WARNING     警告信息
logbook.INFO   正常的记录信息
logbook.DEBUG  调试程序输出的信息
logbook.NOTSET      正常的记录信息

在程序运行后，可以查看存储的日志文件，所有记录均按照上述日志格式进行保存。

总结

以上所述是小编给大家介绍的python日志模块logbook使用方法，希望对大家有所帮助。如果大家有任何疑问请留言，小编会及时回复。在此也非常感谢大家对本站网站的支持！如果你觉得本文对你有帮助，欢迎转载，烦请注明出处，谢谢！