Python日志模块Loguru的基本用法和封装技巧

示例

from loguru import logger

# 添加一个文件输出目标
logger.add('my_file_log.log')
# 记录一条日志，它将同时输出到控制台和文件
logger.info('这是一条info级别日志')
logger.warning('这是一条warning级别日志')
logger.error('这是一条error级别日志')
logger.critical('这是一条critical级别日志')
logger.debug('这是一条debug级别日志')

说明

源码

class Logger:
 @overload
 def add(
     self,
     sink: Union[TextIO, Writable, Callable[[Message], None], Handler],
     *,
     level: Union[str, int] = ...,
     format: Union[str, FormatFunction] = ...,
     filter: Optional[Union[str, FilterFunction, FilterDict]] = ...,
     colorize: Optional[bool] = ...,
     serialize: bool = ...,
     backtrace: bool = ...,
     diagnose: bool = ...,
     enqueue: bool = ...,
     context: Optional[Union[str, BaseContext]] = ...,
     catch: bool = ...

sink:

这是指定日志输出的地方，可以是一个文件名、文件对象、标准输出（例如 sys.stderr 或 sys.stdout）、一个URL（如向Slack发送消息）等。

logger.add("my_file_log.log")  # 输出到my_file_log.log文件  
logger.add(sys.stdout)  # 输出到标准输出

level:

用于指定日志级别。如果指定了级别，则只有该级别及以上的日志才会被输出到该sink。如果不指定，则使用全局级别

logger.add("my_file_log.log", level="INFO")  # 只记录INFO级别及以上的日志

format:

用于定义日志的格式。这是一个字符串，可以使用各种占位符来自定义输出格式。

logger.add("my_file_log.log", format="{time} {level} {message}")

可填参数

import logging  
  
logging.basicConfig(format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')  
logger = logging.getLogger(__name__)  
logger.info('This is an info message.')

如何指定时间格式

日志内容信息只保留年月日信息，十分秒不要

from loguru import logger  
  
# 自定义时间格式，仅包含年、月、日  
format_string = "{time:YYYY-MM-DD} | {level} | {message}"  
  
# 添加一个日志输出配置，指定时间格式  
logger.add(sink="my_file_log.log", format=format_string)  
  
logger.info("这是一条日志消息")

日志文件名字带有时间，带有年月日

from loguru import logger

# 添加一个文件输出目标
logger.add('my_file_log{time:YYYY-MM-DD}.log')
# 记录一条日志，它将同时输出到控制台和文件
logger.info('这是一条info级别日志')xxxxxxxxxx from loguru import logger# 添加一个文件输出目标logger.add('my_file_log{time:YYYY-MM-DD}.log')# 记录一条日志，它将同时输出到控制台和文件logger.info('这是一条info级别日志')

filter:

可选的函数或条件表达式，用于决定是否输出日志。如果提供了 filter，则只有满足该 filter 条件的日志才会被输出到该sink。

def filter_fn(record):  
    # 返回布尔值，记录的级别不是DEBUG就返回True
    return record["level"].name != "DEBUG"  
 
logger.add("my_file_log.log", filter=filter_fn)  # 不记录DEBUG级别的日志

colorize:

用于指定是否对日志消息进行颜色编码（布尔值）。默认为True，控制台输出是颜色编码的，但文件输出不是。

logger.add("my_file_log.log", colorize=True) 

serialize:

默认为False，如果为True，则日志消息会被序列化为JSON格式。这对于非文本输出（如发送到Elasticsearch）很有用。

logger.add("my_file_log.log", serialize=True）

enqueue:

默认为False，如果为True，则日志调用是异步的，并通过内部队列进行处理。这可以提高性能，特别是在高负载下。

logger.add("my_file_log.log", enqueue=True)

rotation:

用于文件输出的日志轮转设置。可以基于文件大小（如 "5 MB"）或时间间隔（如 "1 week"）进行轮转。

logger.add("my_file_log.log", rotation="1 week")  # 每周轮转一次
logger.add("my_file_log.log", rotation="5MB")  # 每到5MB就轮转一次

retention:

指定日志文件的保留时长，超过这个时长的日志文件将被自动删除。

logger.add("my_file_log.log", retention="10 days")  # 保留10天的日志文件

compression:

用于指定日志文件的压缩格式，如 "zip"。

logger.add("my_file_log", compression="zip")

backtrace:

默认为False，如果为True，则在记录错误级别的日志时自动添加回溯信息。

logger.add("with_backtrace.log", backtrace=True, level="ERROR")

再装饰器可以使用记录日志功能，这样只使用了该装饰器，那么就可以自动记录日志

示例

from loguru import logger
from functools import wraps
import time


def timed_function(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        start_time = time.time()
        result = func(*args, **kwargs)
        end_time = time.time()
        duration = end_time - start_time
        logger.info(f"Function {func.__name__} took {duration:.2f}s to execute.")
        return result

    return wrapper


@timed_function
def add_func(x, y):
    import time
    time.sleep(1)
    return x + y


add_func(1, 2)