Python Logger|极客教程

Python Logger

1. 简介

在开发过程中，日志记录是非常重要的。它不仅可以帮助我们追踪代码运行的状态，还可以帮助我们调试和分析错误。Python提供了一个强大的日志记录模块logging，它可以轻松地将日志信息输出到控制台、文件或其他位置。本文将详细介绍Python中的日志记录模块，包括其基本用法、不同日志级别、配置和自定义记录器等内容。

2. 基本用法

在Python中使用日志记录模块非常简单，只需要导入logging模块并创建一个记录器对象，然后可以使用该对象来记录日志信息。下面是一个简单的示例：

import logging

# 创建记录器对象
logger = logging.getLogger('my_logger')
logger.setLevel(logging.DEBUG)

# 创建处理器对象
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.DEBUG)

# 创建格式化对象
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
console_handler.setFormatter(formatter)

# 将处理器添加到记录器
logger.addHandler(console_handler)

# 记录日志
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')

代码解释：

logging.getLogger('my_logger')：创建一个名为my_logger的记录器对象。我们可以给记录器对象命名，以方便在多个模块中使用相同的记录器。
logger.setLevel(logging.DEBUG)：设置日志记录的级别，默认为WARNING。这里将记录级别设置为DEBUG，即所有级别的日志都会被记录下来。
logging.StreamHandler()：创建一个控制台处理器对象。我们可以使用不同的处理器将日志信息记录到文件、数据库等位置，这里选择在控制台输出日志信息。
handler.setLevel(logging.DEBUG)：设置处理器的记录级别。这里将记录级别设置为DEBUG，即所有级别的日志都会被处理器处理。
logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')：创建一个格式化对象，定义日志信息的输出格式。
handler.setFormatter(formatter)：将格式化对象添加到处理器中。
logger.addHandler(handler)：将处理器添加到记录器中。
logger.debug(), logger.info(), logger.warning(), logger.error(), logger.critical(): 分别记录不同级别的日志信息。

以上示例代码将输出如下日志信息：

2022-01-01 00:00:00,000 - my_logger - DEBUG - This is a debug message
2022-01-01 00:00:00,000 - my_logger - INFO - This is an info message
2022-01-01 00:00:00,000 - my_logger - WARNING - This is a warning message
2022-01-01 00:00:00,000 - my_logger - ERROR - This is an error message
2022-01-01 00:00:00,000 - my_logger - CRITICAL - This is a critical message

可以看到，日志信息包括时间、记录器名称、日志级别和日志消息。

3. 不同日志级别

在上述示例中，我们使用了不同级别的日志记录函数，包括debug(), info(), warning(), error(), critical()。下面是这些日志级别的介绍：

DEBUG：详细的调试信息，只有在进行详细的调试时才使用。
INFO：确认系统正常工作的信息。
WARNING：表示系统可能出现问题，但不会影响系统的正常运行。
ERROR：表示出现了错误，但不会影响系统的继续运行。
CRITICAL：表示严重错误，将导致系统无法继续运行。

在实际开发中，我们可以根据需要选择适当的日志级别，以便准确记录和分析代码的状态和问题。

4. 配置日志记录器

除了基本用法之外，我们还可以通过配置文件来配置日志记录器。这样做的好处是，我们可以根据需要轻松地更改日志记录的行为，而不需要修改源代码。下面是一个使用配置文件的示例：

创建一个名为logging.conf的配置文件，内容如下：

[loggers]
keys=root,sampleLogger

[handlers]
keys=consoleHandler

[formatters]
keys=simpleFormatter

[logger_root]
level=NOTSET
handlers=consoleHandler

[logger_sampleLogger]
level=DEBUG
handlers=consoleHandler
qualname=sampleLogger
propagate=0

[handler_consoleHandler]
class=StreamHandler
level=DEBUG
formatter=simpleFormatter
args=(sys.stdout,)

[formatter_simpleFormatter]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
datefmt=

修改示例代码如下：

import logging
import logging.config

# 加载配置文件
logging.config.fileConfig('logging.conf')

# 创建记录器对象
logger = logging.getLogger('sampleLogger')

# 记录日志
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')

以上示例代码将输出相同的日志信息，但这次我们使用了配置文件。通过配置文件，我们可以轻松地更改记录器的级别、处理器和格式化等信息，而不需要修改源代码。

5. 自定义记录器

在某些情况下，我们可能需要自定义记录器来满足特定的需求。例如，我们可以为不同的模块创建不同的记录器，并为它们指定不同的处理器和级别。下面是一个示例：

import logging

def create_logger(name, filename):
    logger = logging.getLogger(name)
    logger.setLevel(logging.DEBUG)

    file_handler = logging.FileHandler(filename)
    file_handler.setLevel(logging.DEBUG)

    console_handler = logging.StreamHandler()
    console_handler.setLevel(logging.INFO)

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

    file_handler.setFormatter(formatter)
    console_handler.setFormatter(formatter)

    logger.addHandler(file_handler)
    logger.addHandler(console_handler)

    return logger

# 创建不同的记录器
logger1 = create_logger('logger1', 'log1.txt')
logger2 = create_logger('logger2', 'log2.txt')

# 记录日志
logger1.debug('This is a debug message')
logger1.info('This is an info message')
logger2.warning('This is a warning message')
logger2.error('This is an error message')

以上示例代码创建了两个自定义的记录器，分别为logger1和logger2。它们分别将日志信息记录到不同的文件和控制台，并使用不同的级别进行记录。