Python的logging模块基本用法-猿码集

1. logging模块介绍

Python中的logging模块是一个强大的日志记录工具，它可以帮助我们记录和跟踪程序运行时的各种信息。通过使用logging模块，我们可以将程序运行时产生的日志信息输出到控制台、文件或者其他目的地，方便我们进行调试和错误追踪。

2. 日志级别

在logging模块中，日志信息被分为不同的级别，不同级别的日志信息可以用来记录不同重要程度的信息。Python中定义了以下几个常用的日志级别：

DEBUG：最详细的日志信息，通常用于调试

INFO：用于确认程序是否按预期工作

WARNING：表示可能出现的问题，但不影响程序运行

ERROR：表示出现了严重的问题，程序可能无法正常工作

CRITICAL：表示严重的错误，可能导致程序崩溃

3. logging模块的基本用法

3.1 创建Logger对象

在使用logging模块进行日志记录之前，我们需要先创建一个Logger对象。Logger对象是logging模块中的主要接口，用于进行日志记录操作。

import logging
logger = logging.getLogger('my_logger')  # 创建Logger对象，指定日志名

上述代码中，我们通过调用logging模块的getLogger()方法，创建了一个名为'my_logger'的Logger对象，并将其赋值给变量logger。

3.2 设置日志级别

在创建Logger对象之后，我们可以通过调用setLevel()方法来设置日志级别。只有当日志级别大于等于Logger对象的日志级别时，才会输出相应级别的日志信息。

logger.setLevel(logging.DEBUG)  # 设置日志级别为DEBUG

上述代码中，我们将Logger对象的日志级别设置为DEBUG。

3.3 添加Handler

Logger对象本身并不会输出日志信息，它需要通过Handler来决定日志信息的输出目标。可通过addHandler()方法向Logger对象添加一个或多个Handler。

console_handler = logging.StreamHandler()  # 创建一个StreamHandler对象，用于输出日志到控制台
logger.addHandler(console_handler)  # 添加控制台Handler

上述代码创建了一个StreamHandler对象console_handler，并通过调用addHandler()方法添加到Logger对象中。这样，Logger对象就会将日志信息输出到控制台上。

3.4 格式化日志信息

日志信息可以通过Formatter对象进行格式化，以便更好地展示和记录。我们可以通过调用Formatter对象的format()方法，将日志信息转换为指定格式。

formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')  # 创建一个Formatter对象
console_handler.setFormatter(formatter)  # 设置控制台Handler的格式化对象

上述代码创建了一个Formatter对象formatter，其中的'%(asctime)s'、'%(levelname)s'和'%(message)s'分别表示日志发生时间、日志级别和日志内容。然后，我们通过调用setFormatter()方法，将Formatter对象设置给控制台Handler。

3.5 输出日志信息

现在，我们已经完成了Logger对象的初始化配置，可以开始输出日志信息了。调用Logger对象的相应方法，就可以输出不同级别的日志信息。

logger.debug('This is a debug message.')
logger.info('This is an info message.')
logger.warning('This is a warning message.')
logger.error('This is an error message.')
logger.critical('This is a critical message.')

上述代码依次输出了DEBUG、INFO、WARNING、ERROR和CRITICAL级别的日志信息。

4. 修改日志级别

在实际应用中，我们可能需要根据不同的情况来调整日志级别。对于logging模块而言，我们可以通过修改Logger对象或Handler对象的日志级别来达到这一目的。

4.1 修改Logger对象的日志级别

我们可以通过调用Logger对象的setLevel()方法，直接修改Logger对象的日志级别。

logger.setLevel(logging.ERROR)  # 修改Logger对象的日志级别为ERROR

4.2 修改Handler对象的日志级别

我们也可以通过调用Handler对象的setLevel()方法，修改Handler对象的日志级别。

console_handler.setLevel(logging.INFO)  # 修改控制台Handler的日志级别为INFO

上述代码将Logger对象的日志级别修改为ERROR，只有级别高于或等于ERROR的日志信息才会被输出。同时，将控制台Handler的日志级别修改为INFO，只有级别高于或等于INFO的日志信息才会被输出。

5. 总结

通过本文的介绍，我们了解了Python的logging模块的基本用法。我们学习了如何创建Logger对象、设置日志级别、添加Handler、格式化日志信息以及输出日志信息。此外，我们还了解了如何修改Logger对象和Handler对象的日志级别，以满足实际需求。

使用logging模块可以帮助我们记录和追踪程序运行时的各种信息，方便进行调试和错误追踪。合理设置日志级别和格式化日志信息，可以更好地展示和记录日志信息，帮助我们定位问题所在。

Python的logging模块基本用法