一、PYTHON工程使用LOGGING的基本步骤
在Python工程中使用logging模块可以使调试、运行和维护程序更加方便。通过配置日志记录器、设置日志级别、选择合适的处理器、格式化日志消息，我们可以有效地跟踪和记录程序的执行过程。这有助于快速定位问题，分析程序行为并进行性能优化。特别是在大型项目中，合理使用日志系统是必不可少的。以下将详细介绍如何配置日志记录器。
首先，我们需要导入Python的logging模块，然后创建一个日志记录器对象。可以使用logging.getLogger()来创建或获取一个日志记录器对象。接下来，需要设置日志级别，决定哪些级别的日志消息会被记录。常见的日志级别有DEBUG、INFO、WARNING、ERROR和CRITICAL。此外，还可以通过添加处理器（Handler）来控制日志的输出位置，比如输出到控制台、文件或远程服务器。通过格式化器（Formatter），我们可以定义日志消息的格式，以便更好地阅读和分析。
import logging
创建一个日志记录器
logger = logging.getLogger(__name__)
设置日志级别
logger.setLevel(logging.DEBUG)
创建一个控制台处理器
console_handler = logging.StreamHandler()
创建一个文件处理器
file_handler = logging.FileHandler('app.log')
定义日志格式
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('这是一个调试信息')
logger.info('这是一个信息')
logger.warning('这是一个警告')
logger.error('这是一个错误')
logger.critical('这是一个严重错误')
二、LOGGING模块的配置
在Python中，logging模块提供了多种配置方式，包括直接在代码中配置、使用配置文件（如INI、YAML、JSON等）和使用字典配置。合理的配置可以使日志系统更加灵活和易于维护。
- 直接在代码中配置
直接在代码中配置是最简单的方式，但对于大型项目，可能不够灵活和易于维护。我们可以通过创建日志记录器、处理器和格式化器来完成。
- 使用配置文件
使用配置文件可以将日志配置与代码分离，提高可维护性。Python的logging模块支持从INI格式的配置文件中读取配置。可以通过logging.config.fileConfig()函数加载配置文件。
# logging.conf
[loggers]
keys=root,sampleLogger
[handlers]
keys=consoleHandler,fileHandler
[formatters]
keys=sampleFormatter
[logger_root]
level=DEBUG
handlers=consoleHandler
[logger_sampleLogger]
level=DEBUG
handlers=consoleHandler,fileHandler
qualname=sampleLogger
[handler_consoleHandler]
class=StreamHandler
level=DEBUG
formatter=sampleFormatter
args=(sys.stdout,)
[handler_fileHandler]
class=FileHandler
level=DEBUG
formatter=sampleFormatter
args=('app.log', 'a')
[formatter_sampleFormatter]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
加载配置文件：
import logging
import logging.config
logging.config.fileConfig('logging.conf')
创建一个日志记录器
logger = logging.getLogger('sampleLogger')
输出日志
logger.debug('这是一个调试信息')
logger.info('这是一个信息')
- 使用字典配置
字典配置方式是通过字典来定义日志配置，并使用logging.config.dictConfig()函数来加载配置。这种方式在需要动态生成配置时特别有用。
import logging
import logging.config
定义字典配置
LOGGING_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',
'formatter': 'default',
'filename': 'app.log',
},
},
'loggers': {
'': {
'handlers': ['console', 'file'],
'level': 'DEBUG',
},
},
}
加载字典配置
logging.config.dictConfig(LOGGING_CONFIG)
创建一个日志记录器
logger = logging.getLogger(__name__)
输出日志
logger.debug('这是一个调试信息')
logger.info('这是一个信息')
三、日志处理器（HANDLER）
Handler是logging模块中用于定义日志输出目标的组件。通过不同类型的Handler，可以将日志输出到不同的位置，如控制台、文件、网络等。
- StreamHandler
StreamHandler用于将日志输出到流中，通常是控制台。默认情况下，日志会输出到标准错误输出（stderr）。
console_handler = logging.StreamHandler()
logger.addHandler(console_handler)
- FileHandler
FileHandler用于将日志输出到文件中。可以指定文件名、模式（如写入、追加）等参数。
file_handler = logging.FileHandler('app.log', mode='a')
logger.addHandler(file_handler)
- RotatingFileHandler
RotatingFileHandler用于将日志输出到文件中，并在文件达到一定大小后进行轮换。可以设置文件的最大字节数和备份文件的个数。
from logging.handlers import RotatingFileHandler
rotating_file_handler = RotatingFileHandler('app.log', maxBytes=1024*1024, backupCount=5)
logger.addHandler(rotating_file_handler)
- TimedRotatingFileHandler
TimedRotatingFileHandler用于将日志输出到文件中，并在指定时间间隔后进行轮换。可以设置时间间隔和备份文件的个数。
from logging.handlers import TimedRotatingFileHandler
timed_rotating_file_handler = TimedRotatingFileHandler('app.log', when='midnight', interval=1, backupCount=7)
logger.addHandler(timed_rotating_file_handler)
- HTTPHandler
HTTPHandler用于通过HTTP将日志发送到远程服务器。需要指定目标服务器的地址和路径。
from logging.handlers import HTTPHandler
http_handler = HTTPHandler(
host='localhost:8080',
url='/log',
method='POST',
)
logger.addHandler(http_handler)
四、日志格式化器（FORMATTER）
Formatter是用于定义日志消息格式的组件。通过格式化器，我们可以指定日志消息的显示内容和格式。
- 基本格式
基本格式包括时间、日志记录器名称、日志级别、消息等。
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
- 自定义格式
可以自定义日志格式，以满足特定需求。
formatter = logging.Formatter('%(levelname)s:%(name)s:%(message)s')
- 日期格式
可以指定日志消息中时间的显示格式。
formatter = logging.Formatter('%(asctime)s - %(message)s', datefmt='%Y-%m-%d %H:%M:%S')
五、日志级别（LEVEL）
日志级别用于控制哪些日志消息会被记录。Python的logging模块定义了以下标准的日志级别：
- DEBUG
DEBUG级别用于输出详细的调试信息，通常用于诊断问题。
logger.debug('这是一个调试信息')
- INFO
INFO级别用于输出一般信息，如程序开始、结束、状态变化等。
logger.info('这是一个信息')
- WARNING
WARNING级别用于输出警告信息，表示程序可能出现问题。
logger.warning('这是一个警告')
- ERROR
ERROR级别用于输出错误信息，表示程序发生错误。
logger.error('这是一个错误')
- CRITICAL
CRITICAL级别用于输出严重错误信息，表示程序可能无法继续运行。
logger.critical('这是一个严重错误')
通过合理使用这些日志级别，可以更好地控制日志的输出和过滤，提高日志系统的效率和可读性。
相关问答FAQs：
如何在Python工程中配置logging模块？
在Python中配置logging模块可以通过创建一个logger对象来实现。通常，可以使用logging.basicConfig()方法来设置日志的基本配置，包括日志的级别、输出格式和输出位置。例如，可以设置日志级别为DEBUG，输出到控制台或文件，设置日志格式为时间戳、日志级别和消息内容等。通过这种方式，您可以快速开始记录日志，并在需要时进行调整。
如何选择合适的日志级别？
在使用logging模块时，选择合适的日志级别非常重要。Python的logging模块提供了几个内置的日志级别，分别为DEBUG、INFO、WARNING、ERROR和CRITICAL。建议在开发阶段使用DEBUG级别来捕获详细的信息，而在生产环境中使用WARNING或ERROR级别来记录重要的警告和错误信息。根据实际需求选择合适的级别，可以帮助您更有效地管理日志。
如何将日志输出到文件而非控制台？
将日志输出到文件而非控制台可以通过在logging.basicConfig()中指定filename参数来实现。例如，设置logging.basicConfig(filename='app.log', level=logging.DEBUG)可以将所有的日志信息写入名为app.log的文件中。这样，您可以方便地存储和查看历史日志记录，特别是在调试和分析应用程序时。
如何在Python中自定义日志格式？
自定义日志格式可以通过设置format参数来实现。在logging.basicConfig()中，您可以指定格式化字符串，例如format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'。这样可以控制日志输出的内容，包括时间、日志名称、日志级别和实际消息。自定义格式可以帮助您更好地理解和分析日志信息。
