Python入门之logging模块-猿码集

1. 什么是logging模块

logging是Python官方提供的一个日志操作模块，通过logging模块可以方便地记录应用程序的运行日志，以便后续的运维、调试等工作。logging模块可以输出日志到控制台、文件、邮件等不同的目标，并且可以根据日志的级别进行过滤、格式化等操作。

2. 基本用法

2.1 创建日志记录器

在使用logging模块之前，首先需要创建一个日志记录器（logger）。可以通过调用logging模块的getLogger方法来创建一个指定名称的日志记录器：

import logging
logger = logging.getLogger('my_logger')

2.2 设置日志级别

日志级别是指确定日志的重要程度，logging模块定义了以下几个日志级别，按重要程度递增：

CRITICAL

ERROR

WARNING

INFO

DEBUG

可以通过调用日志记录器的setLevel方法来设置日志级别：

logger.setLevel(logging.DEBUG)

2.3 输出日志到控制台

可以通过添加一个输出到控制台的处理器（handler）来实现日志的输出。可以使用logging模块的StreamHandler类来创建一个输出到控制台的处理器：

console_handler = logging.StreamHandler()
logger.addHandler(console_handler)

2.4 输出日志到文件

除了输出到控制台，还可以通过添加一个输出到文件的处理器来实现日志的输出。可以使用logging模块的FileHandler类来创建一个输出到文件的处理器：

file_handler = logging.FileHandler('log.txt')
logger.addHandler(file_handler)

2.5 指定日志格式

可以使用logging模块的Formatter类来指定日志的格式，然后将其绑定到对应的处理器上：

formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
console_handler.setFormatter(formatter)
file_handler.setFormatter(formatter)

3. logging模块进阶用法

3.1 输出日志到多个目标

除了输出日志到控制台和文件，logging模块还支持输出日志到其他目标，如邮件、数据库等。可以使用对应的处理器来实现，例如使用logging模块的SMTPHandler类来输出日志到邮件：

smtp_handler = logging.handlers.SMTPHandler(mailhost=('smtp.example.com', 25),
                                             fromaddr='sender@example.com',
                                             toaddrs=['receiver@example.com'],
                                             subject='Error log')
logger.addHandler(smtp_handler)

3.2 设置日志的回滚

当日志文件达到一定大小或记录一定数量后，为了避免日志文件过大，可以设置日志的回滚。可以使用logging模块的RotatingFileHandler类来实现日志的回滚：

rotating_handler = logging.handlers.RotatingFileHandler('log.txt', maxBytes=1024, backupCount=5)
logger.addHandler(rotating_handler)

3.3 捕获未处理的异常

可以使用logging模块的excepthook方法来捕获未处理的异常，并将其记录到日志中：

def excepthook(exctype, value, traceback):
    logger.error('Uncaught exception', exc_info=(exctype, value, traceback))
sys.excepthook = excepthook

4. 使用logging模块进行调试

4.1 在代码中添加调试信息

在开发过程中，可以使用logging模块添加调试信息，帮助定位问题。可以使用logging模块的debug方法来输出调试信息：

logger.debug('This is a debug message')

4.2 设置日志级别进行过滤

可以使用setLevel方法设置日志级别，从而过滤掉一些不必要的日志，只保留关键的信息：

logger.setLevel(logging.INFO)

4.3 只输出日志中的关键信息

可以通过设置日志的格式，只输出日志中的关键信息，以便更清晰地查看日志：

formatter = logging.Formatter('%(asctime)s - %(message)s')

5. 结语

logging模块是Python中非常实用的一个模块，可以方便地实现项目的日志管理和调试。通过本文的介绍，你已经初步了解了logging模块的基本用法和一些进阶用法。希望本文能对你掌握logging模块有所帮助。

Python入门之logging模块