python 如何生成运行记录log

使用Python生成运行记录log的方法包括使用logging模块、指定log级别、配置log格式、将log输出到文件等。在本文中，我们将详细讲解如何使用这些方法生成运行记录log。

logging模块：Python内置的logging模块功能强大、易于使用，可以满足大多数的日志需求。
指定log级别：通过设置不同的日志级别（如DEBUG、INFO、WARNING、ERROR、CRITICAL），可以控制日志的详细程度。
配置log格式：可以自定义日志的输出格式，包括时间、日志级别、消息等信息。
将log输出到文件：可以将日志输出到文件中，便于长期保存和分析。

一、logging模块

Python的logging模块是一个标准库模块，提供了功能强大的日志功能。它可以创建日志记录器（logger），处理日志信息，并将其输出到多个目标。

1.1 安装与导入

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

import logging

1.2 创建logger

可以通过调用logging.getLogger(name)方法创建一个logger对象。name参数可以用来标识logger，通常使用模块名。

logger = logging.getLogger(__name__)

1.3 设置日志级别

通过logger.setLevel(level)方法可以设置日志的级别。常用的日志级别有：

DEBUG: 详细的信息，通常只在诊断问题时使用。
INFO: 确认一切按预期工作。
WARNING: 表示某些不期望的事件，或表明某些问题可能会发生。
ERROR: 更严重的问题，软件未能执行某些功能。
CRITICAL: 严重错误，表示程序本身可能无法继续运行。

logger.setLevel(logging.DEBUG)

二、指定log级别

在创建logger后，可以通过设置日志级别来控制输出日志的详细程度。不同的日志级别可以用来记录不同重要性的信息。

2.1 日志级别示例

以下是不同日志级别的示例代码：

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

这些方法分别对应不同的日志级别，设置日志级别后，只有高于或等于该级别的日志信息才会被记录。

三、配置log格式

配置日志格式可以使日志信息更加易读，并包含更多有用的信息。使用logging.Formatter类可以自定义日志的输出格式。

3.1 自定义日志格式

以下是一个自定义日志格式的示例：

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

%(asctime)s: 日志事件发生的时间
%(name)s: logger的名称
%(levelname)s: 日志级别
%(message)s: 日志消息

3.2 应用日志格式

将自定义的日志格式应用到handler上：

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

四、将log输出到文件

将日志输出到文件有助于长期保存和分析日志信息。可以使用logging.FileHandler类将日志记录保存到文件中。

4.1 创建FileHandler

创建一个FileHandler对象，并将其添加到logger中：

file_handler = logging.FileHandler('app.log')
file_handler.setFormatter(formatter)
logger.addHandler(file_handler)

这样，所有的日志信息将会保存到app.log文件中。

五、使用多个handler

有时候，我们需要将日志信息同时输出到多个目标，如控制台和文件。这时，可以使用多个handler来实现。

5.1 添加多个handler

以下示例代码展示了如何同时将日志输出到控制台和文件：

console_handler = logging.StreamHandler()
console_handler.setFormatter(formatter)
logger.addHandler(console_handler)
file_handler = logging.FileHandler('app.log')
file_handler.setFormatter(formatter)
logger.addHandler(file_handler)

这样，日志信息将会同时输出到控制台和文件中。

六、使用配置文件

除了在代码中配置日志外，还可以使用配置文件来管理日志配置。logging模块支持使用配置文件来定义日志配置。

6.1 创建配置文件

以下是一个日志配置文件的示例（logging.conf）：

[loggers]
keys=root
[handlers]
keys=consoleHandler,fileHandler
[formatters]
keys=simpleFormatter
[logger_root]
level=DEBUG
handlers=consoleHandler,fileHandler
[handler_consoleHandler]
class=StreamHandler
level=DEBUG
formatter=simpleFormatter
args=(sys.stdout,)
[handler_fileHandler]
class=FileHandler
level=DEBUG
formatter=simpleFormatter
args=('app.log', 'a')
[formatter_simpleFormatter]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s

6.2 加载配置文件

可以使用logging.config.fileConfig方法加载配置文件：

import logging.config
logging.config.fileConfig('logging.conf')
logger = logging.getLogger(__name__)

七、使用字典配置

除了配置文件外，还可以使用字典来配置日志。logging模块支持使用字典来定义日志配置。

7.1 创建字典配置

以下是一个字典配置的示例：

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',
            'formatter': 'default',
        },
        'file': {
            'class': 'logging.FileHandler',
            'filename': 'app.log',
            'formatter': 'default',
        },
    },
    'root': {
        'level': 'DEBUG',
        'handlers': ['console', 'file'],
    },
}
logging.config.dictConfig(log_config)
logger = logging.getLogger(__name__)

八、捕获异常日志

在实际应用中，捕获和记录异常日志非常重要。可以使用logger.exception方法来记录异常信息。

8.1 捕获异常示例

以下是一个捕获异常并记录日志的示例代码：

try: 1 / 0 except ZeroDivisionError: logger.exception('An exception occurred')

这样，异常信息将会被记录到日志中，包括堆栈追踪信息。

九、总结

通过本文，我们详细讲解了如何使用Python生成运行记录log。包括使用logging模块、指定log级别、配置log格式、将log输出到文件、使用多个handler、使用配置文件和字典配置、以及捕获异常日志等方面的内容。希望这些内容能帮助你更好地管理和记录你的应用日志。

在实际应用中，选择合适的日志级别和格式，合理地输出日志信息，可以帮助你更好地监控和诊断应用程序的问题，提高应用程序的稳定性和可维护性。