如何用python写日志函数

在Python中写日志函数可以通过多种方式实现，logging模块、手动写入文件、第三方库如loguru都是常用的方法。其中，logging模块是Python内置的日志模块，功能强大且易于使用，是最推荐的方法之一。接下来我们将详细介绍如何使用logging模块来实现日志功能。

一、使用 logging 模块

Python的logging模块提供了一个灵活的框架，用于在应用程序中记录调试、信息、警告、错误和关键日志。下面是一个基本的例子，展示了如何使用logging模块来记录日志：

import logging
配置日志
logging.basicConfig(filename='app.log', filemode='w', 
                    format='%(name)s - %(levelname)s - %(message)s', 
                    level=logging.DEBUG)
创建日志器
logger = logging.getLogger(__name__)
记录日志
logger.debug('这是一个调试信息')
logger.info('这是一个普通信息')
logger.warning('这是一个警告信息')
logger.error('这是一个错误信息')
logger.critical('这是一个严重错误信息')

二、配置日志

1、配置日志格式

日志格式可以通过format参数进行配置，常见的格式符有：

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

例如，以下是一个格式化日志输出的例子：

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

2、日志级别

日志级别决定了哪些日志消息将会被输出，常见的日志级别有：

DEBUG: 调试信息，细粒度信息事件，对调试应用程序非常有帮助。
INFO: 普通信息，确认程序按预期运行。
WARNING: 警告信息，表示有些事情出乎意料，或者在将来可能会出现问题。
ERROR: 错误信息，表示更严重的问题，软件已经不能执行某些功能了。
CRITICAL: 严重错误信息，表示非常严重的问题，可能导致程序无法继续运行。

可以通过level参数配置日志级别。例如：

logging.basicConfig(level=logging.INFO)

三、日志处理器和格式器

1、日志处理器

日志处理器（Handler）是将日志记录发送到合适输出位置的类。常用的处理器有：

StreamHandler: 输出日志到控制台
FileHandler: 输出日志到文件
RotatingFileHandler: 输出日志到文件，并在文件达到一定大小后进行轮转
TimedRotatingFileHandler: 输出日志到文件，并在特定时间间隔后进行轮转

例如，使用FileHandler将日志输出到文件：

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

2、日志格式器

日志格式器（Formatter）用于定义日志消息的最终输出格式。可以通过设置格式器来定制日志消息的格式：

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

四、日志过滤器

日志过滤器（Filter）用于精细控制哪些日志记录可以输出。可以通过自定义过滤器来实现特定的日志记录策略：

class CustomFilter(logging.Filter):
    def filter(self, record):
        return 'special' in record.msg
logger.addFilter(CustomFilter())

五、完整示例

下面是一个完整的日志配置示例，展示了如何使用多种日志处理器和格式器：

import logging
from logging.handlers import RotatingFileHandler, TimedRotatingFileHandler
创建日志器
logger = logging.getLogger('my_logger')
logger.setLevel(logging.DEBUG)
创建控制台处理器并设置级别为DEBUG
console_handler = logging.StreamHandler()
console_handler.setLevel(logging.DEBUG)
创建文件处理器并设置级别为INFO
file_handler = RotatingFileHandler('app.log', maxBytes=2000, backupCount=5)
file_handler.setLevel(logging.INFO)
创建定时轮转文件处理器并设置级别为WARNING
timed_file_handler = TimedRotatingFileHandler('timed_app.log', when='midnight', interval=1, backupCount=7)
timed_file_handler.setLevel(logging.WARNING)
创建格式器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
为处理器设置格式器
console_handler.setFormatter(formatter)
file_handler.setFormatter(formatter)
timed_file_handler.setFormatter(formatter)
为日志器添加处理器
logger.addHandler(console_handler)
logger.addHandler(file_handler)
logger.addHandler(timed_file_handler)
记录日志
logger.debug('这是一个调试信息')
logger.info('这是一个普通信息')
logger.warning('这是一个警告信息')
logger.error('这是一个错误信息')
logger.critical('这是一个严重错误信息')

六、使用第三方库 loguru

除了Python内置的logging模块外，loguru也是一个非常流行且易于使用的第三方日志库。它提供了更为简洁的接口和更多的功能。以下是一个简单的loguru使用示例：

from loguru import logger
配置日志
logger.add("file_{time}.log", rotation="500 MB")  # 自动轮转日志文件
记录日志
logger.debug("这是一个调试信息")
logger.info("这是一个普通信息")
logger.warning("这是一个警告信息")
logger.error("这是一个错误信息")
logger.critical("这是一个严重错误信息")

loguru的优势在于其简洁性和强大的功能，例如自动轮转日志、异步日志记录等。

七、总结

在Python中写日志函数可以通过多种方式实现，最常用的是logging模块，它提供了一个灵活且功能强大的框架，用于记录应用程序的日志。通过配置日志格式、日志级别、日志处理器和格式器，可以实现对日志记录的精细控制。对于更为简洁和功能丰富的日志记录需求，可以考虑使用第三方库如loguru。无论使用哪种方法，记录日志都是一个非常重要的实践，有助于调试和维护应用程序。