在loguru中显示异步任务名称(taskName)的方法

loguru作为Python中广受欢迎的日志记录库，虽然功能强大，但默认并不直接支持显示异步任务名称(taskName)。本文将介绍如何通过自定义配置在loguru中实现这一功能。

为什么需要显示taskName

在Python 3.12中，标准库的logging模块新增了对异步任务名称(taskName)的支持。这对于调试异步应用程序非常有价值，因为：

1. 可以清晰区分不同异步任务的日志
2. 便于追踪特定任务的执行流程
3. 有助于分析异步任务间的交互关系

实现方案

loguru虽然不原生支持taskName，但提供了灵活的扩展机制。我们可以通过以下方式实现：

import asyncio
from loguru import logger

def add_task_name(record):
    try:
        # 获取当前异步任务名称
        record["extra"]["task_name"] = asyncio.current_task().get_name()
    except Exception:
        # 如果不是异步环境，使用线程名作为替代
        record["extra"]["task_name"] = record['thread'].name

# 配置logger
logger.configure(patcher=add_task_name)
logger.add("file.log", format="{extra[task_name]} {message}")

实现原理

1. patcher函数：loguru允许通过configure方法的patcher参数注册一个处理函数，该函数会在每条日志记录创建时被调用

2. 获取任务名称：在异步上下文中，通过asyncio.current_task().get_name()获取当前任务名称

3. 异常处理：当不在异步环境中时，回退到使用线程名称，确保始终有可显示的标识

高级用法

如果需要更复杂的格式化，可以进一步扩展：

logger.add(
    "file.log",
    format="{time:YYYY-MM-DD HH:mm:ss} | {level} | {extra[task_name]} | {message}"
)

注意事项

1. 此功能需要Python 3.8+版本，因为get_name()方法是在此版本引入的

2. 在同步代码中，asyncio.current_task()会抛出异常，因此必须有异常处理

3. 对于复杂的异步应用，建议结合其他上下文信息(如coroutine名称)一起记录

通过这种扩展方式，loguru可以完美支持异步任务名称的显示，为异步应用的调试和监控提供了有力工具。