Python中的logging入门

约定不等于承诺〃 2024-03-27 18:42 99阅读 0赞

**目录**

Python中的logging入门

什么是logging模块

使用logging模块记录日志

配置日志记录的其他选项

总结

示例代码：应用场景

logging的缺点

类似的日志模块

--------------------

### Python中的logging入门 ###

在软件开发中，日志记录是一项非常重要的任务。它可以帮助我们在应用程序运行时收集并保存有用的信息，用于调试、错误跟踪和性能分析等目的。Python中的logging模块提供了强大且灵活的日志记录功能，本文将介绍如何使用logging模块进行日志记录。

### 什么是logging模块 ###

logging是Python标准库中的一个模块，用于记录日志信息。它提供了一组函数和类，可以方便地向不同输出目标（如控制台、文件等）输出日志信息，并可以按照不同的级别（如DEBUG、INFO、WARNING等）进行过滤和记录。

### 使用logging模块记录日志 ###

以下是使用logging模块记录日志的基本步骤：

1.  导入logging模块：

pythonCopy codeimport logging

1.  配置日志记录：

pythonCopy codelogging.basicConfig(level=logging.DEBUG, 
                        format='%(asctime)s %(levelname)s %(message)s', 
                        filename='app.log', 
                        filemode='w')

*  `level`：设置日志级别，可选值有DEBUG、INFO、WARNING、ERROR、CRITICAL，默认为WARNING。
 *  `format`：设置日志输出格式，可以使用不同的占位符来表示时间、级别、信息等。
 *  `filename`：设置日志输出文件的文件名。
 *  `filemode`：设置日志输出文件的打开模式，默认为追加模式，这里我们使用覆盖模式。

1.  记录日志：

pythonCopy codelogging.debug('This is a debug log')
    logging.info('This is an info log')
    logging.warning('This is a warning log')
    logging.error('This is an error log')
    logging.critical('This is a critical log')

1.  运行程序后，你将看到日志信息被记录在app.log文件中：

plaintextCopy code2021-10-01 18:20:12,186 DEBUG This is a debug log
    2021-10-01 18:20:12,187 INFO This is an info log
    2021-10-01 18:20:12,188 WARNING This is a warning log
    2021-10-01 18:20:12,189 ERROR This is an error log
    2021-10-01 18:20:12,189 CRITICAL This is a critical log

### 配置日志记录的其他选项 ###

除了上述基本的日志记录配置，logging模块还提供了许多其他选项，以满足不同的需求。下面是一些常用的配置选项：

*  **输出到控制台** 将日志同时输出到控制台和文件是很常见的需求。我们可以通过添加一个StreamHandler来实现输出到控制台的功能：

pythonCopy codeconsole = logging.StreamHandler()
    console.setLevel(logging.INFO)
    formatter = logging.Formatter('%(asctime)s %(levelname)s %(message)s')
    console.setFormatter(formatter)
    logging.getLogger('').addHandler(console)

*  **日志文件按时间切割** 对于长时间运行的应用程序，日志文件可能会变得很大。可以通过使用`TimedRotatingFileHandler`来定期切割日志文件：

pythonCopy codefrom logging.handlers import TimedRotatingFileHandler
    
    file_handler = TimedRotatingFileHandler('app.log', when='midnight', backupCount=7)
    file_handler.setLevel(logging.INFO)
    file_handler.setFormatter(formatter)
    logging.getLogger('').addHandler(file_handler)

*  **日志记录器命名空间** 在大型应用程序中，可能存在多个模块需要独立配置和记录日志。可以使用不同的日志记录器来管理不同模块的日志：

pythonCopy codelogger1 = logging.getLogger('module1')
    logger2 = logging.getLogger('module2')
    
    logger1.debug('This is a debug log for module1')
    logger2.debug('This is a debug log for module2')

### 总结 ###

logging模块是Python中强大且灵活的日志记录工具。通过简单的配置，我们可以方便地将日志信息输出到控制台或文件中，按照不同的级别进行记录和过滤。除了基本的配置选项，logging模块还提供了许多其他的功能和选项，可以满足不同的需求。希望本文对你理解和使用Python中的logging模块有所帮助。

### 示例代码：应用场景 ###

以下是一个示例代码，演示了在一个网络爬虫程序中如何使用logging模块进行日志记录。

pythonCopy codeimport logging
    import requests
    # 配置日志记录
    logging.basicConfig(level=logging.INFO, format='%(asctime)s %(levelname)s %(message)s', filename='spider.log', filemode='w')
    def fetch_data(url):
        try:
            # 发送网络请求
            response = requests.get(url)
            response.raise_for_status()
            
            # 记录成功的日志
            logging.info('Successfully fetched data from {}'.format(url))
            
            # 处理响应数据...
            
        except requests.exceptions.RequestException as e:
            # 记录错误的日志
            logging.error('Failed to fetch data from {}: {}'.format(url, str(e)))
    # 程序入口
    if __name__ == '__main__':
        urls = ['https://example.com', 'https://example.net', 'https://example.org']
        
        for url in urls:
            fetch_data(url)

以上代码片段展示了一个网络爬虫程序，通过requests库发送网络请求获取数据，并根据请求结果记录相应的日志。在`fetch_data`函数中，我们使用`logging.info`记录成功的日志，使用`logging.error`记录出错的日志。日志级别被设置为`logging.INFO`，因此只有`logging.error`会被记录到日志文件中。 通过这样的日志记录，我们可以在程序运行过程中实时了解请求是否成功，以及错误信息的原因，帮助我们调试和分析程序。

#### logging的缺点 ####

1.  学习成本较高：logging模块的使用相对复杂，需要学习不同的日志级别、日志格式化、日志输出等方面的知识。
2.  配置繁琐：logging模块的配置相对繁琐，需要手动设置日志级别、日志输出格式、日志保存位置等参数，有时候需要编写大量的配置代码。
3.  可读性差：logging模块的日志输出格式默认不容易阅读，需要手动设置日志格式化字符串才能满足需求。
4.  不支持分布式架构：logging模块本身不支持分布式架构，如果在分布式环境中使用，可能需要额外处理日志的同步和收集。

#### 类似的日志模块 ####

除了logging模块，还有一些其他的日志模块可以作为logging的替代品，如:

1.  Log4j: Log4j是Java语言中广泛使用的一个日志工具，拥有丰富的功能和灵活的配置选项。
2.  loguru: loguru是Python中的一个新兴日志模块，它具有简单易用的API接口和友好的日志输出格式，能够大大简化日志的使用和设置。
3.  Apache Log4net: Log4net是.NET平台中广泛使用的一个日志组件，与Log4j类似，拥有丰富的功能和灵活的配置选项。
4.  Winston: Winston是Node.js中非常受欢迎的日志模块，具有简单易用的API接口和强大的功能。 这些日志模块在功能和易用性方面可能会有所不同，选择使用时需要根据具体需求和个人喜好进行评估和选择。