python logging模块如何使用

Python logging模块的使用方法：创建日志记录器、配置日志记录级别、添加日志处理器、格式化日志消息。下面将详细介绍如何通过这几个方面来使用Python的logging模块。

Python的logging模块是一个非常强大的工具，能够帮助开发者记录程序运行时的各种信息，从而便于调试和维护。创建日志记录器是使用logging模块的第一步，接下来需要配置日志记录级别，以确定记录哪些级别的信息。添加日志处理器可以将日志信息输出到不同的目的地，如控制台、文件等。而格式化日志消息则可以使日志信息更加易读和有用。

一、创建日志记录器

创建日志记录器是使用logging模块的第一步。日志记录器是logging模块的核心组件，用于生成日志消息。

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

在这段代码中，logging.getLogger('example_logger')创建了一个名为example_logger的日志记录器。使用特定名称可以方便地在不同模块中引用同一个日志记录器。

二、配置日志记录级别

日志记录级别决定了日志记录器将记录哪些级别的日志消息。logging模块提供了几个常见的日志级别：DEBUG、INFO、WARNING、ERROR和CRITICAL。

logger.setLevel(logging.DEBUG)

在这段代码中，logger.setLevel(logging.DEBUG)设置了日志记录器的级别为DEBUG，这意味着所有级别的日志消息（DEBUG、INFO、WARNING、ERROR和CRITICAL）都会被记录下来。

三、添加日志处理器

日志处理器用于将日志消息输出到不同的目的地，如控制台、文件等。logging模块提供了几种常见的处理器，如StreamHandler、FileHandler等。

控制台处理器

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

这段代码创建了一个控制台处理器console_handler，并将其添加到日志记录器logger中。这样，日志消息将会输出到控制台。

文件处理器

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

这段代码创建了一个文件处理器file_handler，并将其添加到日志记录器logger中。这样，日志消息将会被写入到文件example.log中。

四、格式化日志消息

格式化日志消息可以使日志信息更加易读和有用。logging模块提供了Formatter类用于定义日志消息的格式。

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

在这段代码中，logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')创建了一个格式化器formatter，定义了日志消息的格式为“时间 – 日志器名称 – 日志级别 – 日志消息”。接着，使用console_handler.setFormatter(formatter)和file_handler.setFormatter(formatter)将格式化器添加到控制台处理器和文件处理器中。

五、记录日志消息

配置完日志记录器后，就可以开始记录日志消息了。logging模块提供了几个方法用于记录不同级别的日志消息：debug()、info()、warning()、error()和critical()。

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模块。logging模块提供了fileConfig()函数用于从配置文件中读取配置。

配置文件示例（logging.conf）

[loggers]
keys=root,example_logger
[handlers]
keys=consoleHandler,fileHandler
[formatters]
keys=exampleFormatter
[logger_root]
level=DEBUG
handlers=consoleHandler
[logger_example_logger]
level=DEBUG
handlers=consoleHandler,fileHandler
qualname=example_logger
propagate=0
[handler_consoleHandler]
class=StreamHandler
level=DEBUG
formatter=exampleFormatter
args=(sys.stdout,)
[handler_fileHandler]
class=FileHandler
level=DEBUG
formatter=exampleFormatter
args=('example.log', 'a')
[formatter_exampleFormatter]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
datefmt=

从配置文件中读取配置

import logging
import logging.config
logging.config.fileConfig('logging.conf')
logger = logging.getLogger('example_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')

在这段代码中，logging.config.fileConfig('logging.conf')从配置文件logging.conf中读取配置，并创建了日志记录器example_logger。

七、使用字典配置

除了使用配置文件，还可以使用字典来配置logging模块。logging模块提供了dictConfig()函数用于从字典中读取配置。

字典配置示例

import logging
import logging.config
log_config = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'exampleFormatter': {
            'format': '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
        },
    },
    'handlers': {
        'consoleHandler': {
            'class': 'logging.StreamHandler',
            'level': 'DEBUG',
            'formatter': 'exampleFormatter',
            'stream': 'ext://sys.stdout',
        },
        'fileHandler': {
            'class': 'logging.FileHandler',
            'level': 'DEBUG',
            'formatter': 'exampleFormatter',
            'filename': 'example.log',
            'mode': 'a',
        },
    },
    'loggers': {
        'example_logger': {
            'level': 'DEBUG',
            'handlers': ['consoleHandler', 'fileHandler'],
            'propagate': False,
        },
    }
}
logging.config.dictConfig(log_config)
logger = logging.getLogger('example_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')

在这段代码中，logging.config.dictConfig(log_config)从字典log_config中读取配置，并创建了日志记录器example_logger。

八、高级用法

1、捕获异常

logging模块允许捕获并记录异常信息，这对于调试和错误分析非常有用。

try:
    1 / 0
except ZeroDivisionError as e:
    logger.error('Exception occurred', exc_info=True)

在这段代码中，exc_info=True将异常信息包含在日志消息中。

2、使用自定义日志级别

除了使用logging模块提供的标准日志级别，还可以创建自定义日志级别。

VERBOSE = 5
logging.addLevelName(VERBOSE, 'VERBOSE')
def verbose(self, message, *args, kwargs):
    if self.isEnabledFor(VERBOSE):
        self._log(VERBOSE, message, args, kwargs)
logging.Logger.verbose = verbose
logger.verbose('This is a verbose message')

在这段代码中，创建了一个名为VERBOSE的自定义日志级别，并定义了一个verbose方法用于记录VERBOSE级别的日志消息。

3、使用过滤器

过滤器可以用于更细粒度地控制哪些日志消息应该被记录下来。logging模块提供了Filter类用于创建过滤器。

class NoDebugFilter(logging.Filter):
    def filter(self, record):
        return record.levelno != logging.DEBUG
no_debug_filter = NoDebugFilter()
console_handler.addFilter(no_debug_filter)

在这段代码中，创建了一个名为NoDebugFilter的过滤器，用于过滤掉DEBUG级别的日志消息，并将其添加到控制台处理器中。

4、使用上下文信息

有时在日志消息中包含上下文信息是非常有用的。logging模块允许在日志消息中包含额外的信息。

extra = {'user': 'John Doe'}
logger = logging.getLogger('example_logger')
logger = logging.LoggerAdapter(logger, extra)
logger.info('User logged in')

在这段代码中，创建了一个包含上下文信息的日志记录器，并在日志消息中包含了用户信息。

九、项目管理系统推荐

在进行软件开发时，使用合适的项目管理系统可以显著提高团队的效率和协作能力。对于研发项目管理，可以考虑使用PingCode，而对于通用项目管理，可以考虑使用Worktile。

PingCode

PingCode是一个专为研发团队设计的项目管理系统，提供了丰富的功能，如需求管理、缺陷跟踪、迭代管理等。它能够帮助团队更好地规划和执行项目，提高开发效率和质量。

Worktile

Worktile是一个通用的项目管理软件，适用于各种类型的团队和项目。它提供了任务管理、时间跟踪、文件共享等功能，帮助团队更好地协作和管理项目。

总结

Python的logging模块是一个非常强大的工具，能够帮助开发者记录程序运行时的各种信息，从而便于调试和维护。通过创建日志记录器、配置日志记录级别、添加日志处理器和格式化日志消息，可以方便地记录和管理日志信息。此外，还可以使用配置文件或字典配置logging模块，并利用高级用法如捕获异常、使用自定义日志级别、使用过滤器和上下文信息来进一步增强日志记录功能。在进行软件开发时，使用合适的项目管理系统如PingCode和Worktile可以显著提高团队的效率和协作能力。