Python 项目标准库中的 logging 如何使用

在编写Python项目时，日志记录是一个不可或缺的环节，它能够帮助开发者追踪代码执行过程中的状态，分析和排除错误。Python标准库中的logging模块提供了灵活的日志记录系统，主要通过配置日志级别、日志格式和日志处理器来使用。 其中，日志级别的合理配置尤为重要，它能帮助开发者控制日志的输出内容，确保在不同的运行环境下获取适量的日志信息，既有效地进行问题定位，又不会导致日志文件过大。

一、引入LOGGING模块

在Python项目中使用logging模块前，需要先进行导入。可以直接导入logging模块，也可以从logging模块中导入具体的类和函数。

import logging

接着，通过配置logging模块的基本配置来快速开始日志记录。

二、配置LOGGING基本设置

logging.basicConfig()函数能够快速地对日志系统进行基本配置，包括日志级别、日志文件路径、日志记录格式等。

logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')

这里，level参数指定日志级别，format参数定义了日志的输出格式。

三、定义日志级别

日志级别是日志记录的核心，logging模块预定义了五种日志级别：DEBUG、INFO、WARNING、ERROR、CRITICAL。

• DEBUG：最详细的日志信息，用于调试。
• INFO：用于记录一般的事件，或确认程序按预期运行。
• WARNING：表示某些不期望的事件发生，或指示将来可能出现的问题。
• ERROR：记录错误事件，但应用可能仍能继续运行。
• CRITICAL：记录非常严重的问题，可能会导致应用中断。

配置合适的日志级别能够帮助开发者在适当的情况下记录必要的信息。

四、创建和配置LOG HANDLER

除了基本的日志配置外，logging模块还允许创建多个日志处理器（Handlers），以便将日志输出到不同的位置，如文件、控制台或网络。

文件日志处理器

file_handler = logging.FileHandler('app.log')

file_handler.setLevel(logging.ERROR)
file_handler.setFormatter(logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s'))
logging.getLogger('').addHandler(file_handler)

这样配置后，只有ERROR级别以上的日志会被记录到app.log文件中。

控制台日志处理器

console_handler = logging.StreamHandler()

console_handler.setLevel(logging.DEBUG)
console_handler.setFormatter(logging.Formatter('%(asctime)s - %(levelname)s - %(message)s'))
logging.getLogger('').addHandler(console_handler)

通过这种方式，所有级别的日志会输出到控制台，且输出格式与文件日志有所不同。

五、使用LOGGER记录日志

基于以上配置，可以开始在代码中使用logging模块记录日志了。

logging.debug('This is a debug message')

logging.info('This is an info message')
logging.warning('This is a warning message')
logging.error('This is an error message')
logging.critical('This is a critical message')

每一条日志记录的方式基本相同，只是调用的方法不同，对应不同的日志级别。

六、高级用法

为了更灵活地使用logging模块，可以对日志器（Logger）、过滤器（Filter）、格式器（Formatter）等进行定制，实现复杂的日志需求。

使用Logger对象

在大型项目中，可能需要在多个模块中使用日志记录，此时可通过创建Logger对象来实现。

logger = logging.getLogger('mylogger')

logger.setLevel(logging.DEBUG)

创建Logger对象后，可以为其添加Handler，且只影响该Logger对象。

配置文件

为了避免在代码中直接配置日志，可以将配置信息放在一个配置文件中，然后使用fileConfig或dictConfig函数加载。

logging.config.fileConfig('logging.conf')

将日志配置单独放在logging.conf文件中，更方便管理和修改。

综上所述，logging模块是Python中一个非常强大且灵活的日志记录工具。掌握如何合理地配置和使用logging模块，对于提高程序的健壮性和可维护性具有重要意义。

相关问答FAQs：

1. logging是什么？在Python项目中为什么要使用它？
logging是Python标准库中的一个模块，用于记录应用程序的日志信息。使用logging可以帮助我们在程序运行过程中有效管理和监控日志，以便更好地调试和分析程序的运行状况，提高代码质量和可维护性。

2. logging模块中的几个常用组件有哪些？如何配置logging的日志级别？
logging模块的几个常用组件包括logger、handler和formatter。logger用于创建日志记录器，handler用于定义日志输出的目的地，formatter用于规定日志的输出格式。要配置logging的日志级别，可以通过设置logger对象的level属性来确定，常用的日志级别包括DEBUG、INFO、WARNING、ERROR和CRITICAL。

3. 如何在Python项目中使用logging模块记录日志？可以实现日志的分级和分文件保存吗？
要在Python项目中使用logging模块记录日志，可以先创建一个logger对象，然后设置日期格式、日志级别和日志输出位置，最后通过logger对象调用不同级别的日志记录方法，如logger.debug()、logger.info()等。可以根据需求将日志分级，在配置文件中设置不同级别的日志输出到不同的文件中，以实现更灵活的日志管理。

最后建议，企业在引入信息化系统初期，切记要合理有效地运用好工具，这样一来不仅可以让公司业务高效地运行，还能最大程度保证团队目标的达成。同时还能大幅缩短系统开发和部署的时间成本。特别是有特定需求功能需要定制化的企业，可以采用我们公司自研的企业级低代码平台：织信Informat。 织信平台基于数据模型优先的设计理念，提供大量标准化的组件，内置AI助手、组件设计器、自动化（图形化编程）、脚本、工作流引擎（BPMN2.0）、自定义API、表单设计器、权限、仪表盘等功能，能帮助企业构建高度复杂核心的数字化系统。如ERP、MES、CRM、PLM、SCM、WMS、项目管理、流程管理等多个应用场景，全面助力企业落地国产化/信息化/数字化转型战略目标。