SuperAPI AI 工具集

rich-terminal-output

编程与开发

查看项目

更新于 10-15 18:28

技能介绍

用途:为 Python 命令行应用生成更美观、易读的终端输出,包括表格、面板、进度条、语法高亮、树形展示与日志美化。激活场景涵盖构建 CLI 应用、展示结构化数据、显示长任务进度、创建错误/状态面板、调试时美化打印对象以及增强日志输出。

主要能力:Console 对象支持带样式输出与标记语法(粗体、斜体、颜色、背景、链接等);rich.print 可替代内置 print 并自动美化字典等对象;Table 支持列样式与对齐;Panel 用于成功或错误状态展示;track 与 Progress 提供单任务或多任务进度条;Syntax 支持带行号与主题的代码高亮;Tree 展示层级结构;RichHandler 集成 logging,install 可美化异常回溯。

使用方式:安装命令为 uv add rich;快速验证可用 python -c "from rich import print; print('[bold green]Rich working![/]')"。建议复用同一个 Console 实例,用户输入经 rich.markup.escape 转义以避免方括号破坏标记,必要时用 Console(force_terminal=sys.stdout.isatty()) 处理非 TTY 环境。可与 click 等 CLI 框架配合,如用 console.status 显示执行中状态。

适用场景:交互式 CLI、开发调试、任务进度展示、日志与回溯美化。

限制:非交互脚本(输出被管道处理)、服务端日志、性能敏感循环以及要求极少依赖的场景不建议使用。更多高级内容可参考 AgentUsage/rich_formatting.md。