Quick-Logger-Colorful：轻量无依赖的 Python 彩色日志库，同步异步双支持

2. 异步日志（asynclog 模块，适用于 FastAPI/Sanic）

import asyncio
from quick_logger import asynclog

async def async_test_func():
    # 初始化异步日志器
    logger = asynclog.Logger()
    await logger.log("This is an async INFO message", typ=1)
    await logger.log("This is an async FATAL message", typ=4)
    
    # 模拟异步任务（无阻塞）
    await asyncio.sleep(1)

# 异步函数异常捕获装饰器
@asynclog.start_logger(fatals=[ImportError])
async def wrapped_async_func():
    await async_test_func()
    raise ImportError("Async fatal error")

if __name__ == "__main__":
    asyncio.run(wrapped_async_func())

3. 模式切换（调试/生产模式）

生产模式：隐藏 DEBUG 级别，仅输出 INFO/WARN/ERROR/FATAL

python your_script.py -O

调试模式（默认）：输出所有级别日志（DEBUG/INFO/WARN/ERROR/FATAL）

python your_script.py

配置说明

自动生成配置文件

首次运行后，会在项目目录下创建配置文件：./Logger/.config/Config.json，默认配置如下：

{"pattern":"[{time}][{func}][{level}]:{msg}","file":"./Logger/{date}.log.txt","enable_color":true}

配置参数说明

• pattern：日志格式模板，支持 4 个占位符
  • {time}：日志输出时间（默认格式：HH:MM:SS）
  • {func}：日志所在函数名
  • {level}：日志级别（DEBUG/INFO/WARN/ERROR/FATAL）
  • {msg}：日志内容
• file：日志文件路径，{date}自动替换为当前日期（默认格式：YYYY-MM-DD）
• enable_color：是否启用终端彩色输出（默认：true）

自定义配置示例

1. 修改日志格式：

{"pattern":"[{time}] [{level}] [{func}] - {msg}","file":"./Logger/{date}.log.txt","enable_color":true}

2. 禁用彩色输出（适用于非交互式终端）：

{"pattern":"[{time}][{func}][{level}]:{msg}","file":"./Logger/{date}.log.txt","enable_color":false}

3. 自定义日志日期格式：

{"pattern":"[{time}][{func}][{level}]:{msg}","file":"./Logger/{date:%Y%m%d}.log.txt"}

4. 修改默认日志目录（支持绝对路径）：

// Linux/macOS
{"pattern":"[{time}][{func}][{level}]:{msg}","file":"/var/log/my_project/{date}.log.txt"}
// Windows
{"pattern":"[{time}][{func}][{level}]:{msg}","file":"D:\\Logs\\my_project\\{date}.log.txt"}

兼容性说明

• Python 版本：支持 3.7 及以上所有 3.x 版本
• 运行平台：Windows、macOS、Linux、Android（支持 Pydroid 等 Python 编译器）
• 框架适配：
  • FastAPI（异步）：使用 asynclog.Logger，日志调用前加 await，装饰器用 @asynclog.start_logger()
  • Django/Flask（同步）：直接使用核心 Logger 类，装饰器用 @start_logger()，建议全局初始化一次（如在 settings.py 中）

常见问题（FAQ）

1. FATAL 日志未输出到文件/终端？
   • 确认 typ=4 参数传递正确（FATAL 级别唯一对应值为 4）；
   • 检查是否误启用 -O 生产模式（生产模式仅隐藏 DEBUG，不影响 FATAL）；
   • 验证 ./Logger/ 目录的读写权限（库不会主动抛出权限异常）。
2. 如何禁用终端彩色输出？
   • 手动创建/修改 ./Logger/.config/Config.json，添加 "enable_color": false 字段，重启脚本即可生效。
3. 异步日志阻塞事件循环？
   • 异步函数中必须使用 quick_logger.asynclog.Logger，不可使用同步版 Logger；
   • 异步日志调用必须加 await 关键字（如 await logger.log(...)），缺失会导致同步阻塞。
4. 如何避免框架中日志重复输出？
   • 不要重复初始化 Logger，建议在项目全局（如 settings.py/init.py）初始化一次，其他文件导入使用。
5. 如何自定义 FATAL 异常？

在装饰器的参数中加上 fatals=[...]并在列表里面写上你要自定义的异常，如：

@quick_logger.start_logger(fatals=[ImportError, IndexError])
def func():
    a = [0, 1, 2]
    return a[3]  # 抛出 IndexError，命中 FATAL 条件

开源协议

本项目基于 MIT 开源协议，可自由使用、修改、商用，详见项目根目录下的 LICENSE 文件。

• GitHub 仓库：https://github.com/huyuenshen/quick-logger
• PyPI 地址：https://pypi.org/project/quick-logger-colorful/