python日志如何输出到控制台

Python日志输出到控制台的方法包括使用标准库logging、配置日志记录器、设置日志级别等。 其中，最常用的方法是使用Python的标准库logging模块来实现日志的输出。logging模块提供了强大的日志功能，可以根据需求进行灵活配置。下面将详细介绍如何在Python中使用logging模块将日志输出到控制台。

一、安装与导入logging模块

Python的logging模块是标准库的一部分，因此无需额外安装，只需要在代码中导入即可。

import logging

二、配置日志记录器

要将日志输出到控制台，需要首先创建并配置一个日志记录器。日志记录器是logging模块中的一个核心组件，用于管理日志的创建、格式化和输出。

logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)

在上面的代码中，我们创建了一个名为logger的日志记录器，并将其日志级别设置为DEBUG。这样，所有级别大于或等于DEBUG的日志消息都会被记录。

三、创建和配置控制台处理器

控制台处理器（StreamHandler）负责将日志消息输出到控制台。我们需要创建一个控制台处理器，并将其添加到日志记录器中。

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

四、设置日志格式

为了让日志消息更加易读，我们可以设置日志格式。可以使用Formatter类来定义日志消息的格式，并将其应用到控制台处理器。

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')

七、完整示例代码

将上述步骤整合起来，一个完整的示例代码如下：

import logging
创建日志记录器
logger = logging.getLogger(__name__)
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')

八、进阶配置

1、配置文件配置日志

除了在代码中直接配置日志，还可以使用配置文件来管理日志配置。Python的logging模块支持通过配置文件来配置日志记录器、处理器和格式器。

可以使用YAML、JSON或INI格式的配置文件。以下是一个使用INI格式的配置文件示例：

[loggers]
keys=root,sampleLogger
[handlers]
keys=consoleHandler
[formatters]
keys=sampleFormatter
[logger_root]
level=DEBUG
handlers=consoleHandler
[logger_sampleLogger]
level=DEBUG
handlers=consoleHandler
qualname=sampleLogger
propagate=0
[handler_consoleHandler]
class=StreamHandler
level=DEBUG
formatter=sampleFormatter
args=(sys.stdout,)
[formatter_sampleFormatter]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s

在代码中加载配置文件：

import logging.config
logging.config.fileConfig('logging.conf')
logger = logging.getLogger('sampleLogger')
logger.debug('This is a debug message')

2、使用字典配置

也可以使用字典来配置日志：

import logging.config
log_config = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'default': {
            'format': '%(asctime)s - %(name)s - %(levelname)s - %(message)s',
        },
    },
    'handlers': {
        'console': {
            'class': 'logging.StreamHandler',
            'level': 'DEBUG',
            'formatter': 'default',
        },
    },
    'root': {
        'level': 'DEBUG',
        'handlers': ['console'],
    },
}
logging.config.dictConfig(log_config)
logger = logging.getLogger(__name__)
logger.debug('This is a debug message')

九、日志级别

Python的logging模块提供了多个日志级别，用于控制日志消息的输出。常用的日志级别包括：

DEBUG：详细的信息，通常用于诊断问题。
INFO：确认程序按预期运行的信息。
WARNING：表示可能存在的问题或需要注意的情况。
ERROR：表示程序中的错误。
CRITICAL：表示严重的错误，程序可能无法继续运行。

通过设置日志记录器或处理器的日志级别，可以控制哪些日志消息会被记录和输出。

十、多处理器配置

在实际应用中，可能需要将日志输出到多个目标，例如控制台和文件。可以为日志记录器添加多个处理器，分别配置不同的输出目标。

import logging
创建日志记录器
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)
创建控制台处理器
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.DEBUG)
创建文件处理器
file_handler = logging.FileHandler('app.log')
file_handler.setLevel(logging.INFO)
创建日志格式
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
console_handler.setFormatter(formatter)
file_handler.setFormatter(formatter)
将处理器添加到记录器
logger.addHandler(console_handler)
logger.addHandler(file_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')

在这个示例中，日志消息会同时输出到控制台和文件app.log中。控制台处理器记录所有级别大于或等于DEBUG的日志消息，文件处理器记录所有级别大于或等于INFO的日志消息。

十一、异步日志

在某些情况下，日志记录可能会影响应用程序的性能，特别是当日志记录频繁时。可以使用异步日志记录来提高性能。例如，可以使用concurrent.futures模块中的ThreadPoolExecutor来实现异步日志记录。

import logging
from concurrent.futures import ThreadPoolExecutor
创建日志记录器
logger = logging.getLogger(__name__)
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)
创建线程池执行器
executor = ThreadPoolExecutor(max_workers=2)
异步记录日志的函数
def log_message(level, message):
    if level == 'debug':
        logger.debug(message)
    elif level == 'info':
        logger.info(message)
    elif level == 'warning':
        logger.warning(message)
    elif level == 'error':
        logger.error(message)
    elif level == 'critical':
        logger.critical(message)
提交异步日志任务
executor.submit(log_message, 'debug', 'This is an async debug message')
executor.submit(log_message, 'info', 'This is an async info message')
executor.submit(log_message, 'warning', 'This is an async warning message')
executor.submit(log_message, 'error', 'This is an async error message')
executor.submit(log_message, 'critical', 'This is an async critical message')
关闭线程池执行器
executor.shutdown()