SuperAPI AI 工具集

python-cli-patterns

编程与开发

查看项目

更新于 10-13 17:00

技能介绍

用途

python-cli-patterns 用于指导 Python 命令行应用(CLI)的开发,重点演示 Typer 与 Rich 两个库的常见写法,帮助开发者快速搭建带参数解析、子命令、彩色输出与进度提示的终端工具。触发场景包括 cli、command line、typer、click、argparse、terminal、rich、console、terminal ui 等关键词。

主要能力

资料中展示的能力包括:

  • 基础 Typer 应用:创建 typer.Typer 实例,设置 name、help、add_completion,并通过 @app.command() 定义命令与参数。示例中使用 typer.Argument 定义必填参数 name,使用 typer.Option 定义 count、loud 等选项,并用 typer.echo 输出。
  • 命令组:通过 typer.Typer 创建子应用(如 users_app),再用 app.add_typer 挂载,实现类似 users list、users create 的多级命令结构。
  • Rich 输出:使用 rich.console.Console 打印、rich.table.Table 构建带列样式(如 cyan、green)的表格、rich.progress.track 显示进度条。
  • 错误处理:定义 error 函数,使用 console.print 输出红色错误文本,并通过 raise typer.Exit(code) 退出。
  • 快速参考:以表格形式汇总必需参数、可选参数、Option、Argument、布尔标志、枚举选项等 Typer 语法,以及 Table、Progress、Colors、Panel 等 Rich 功能用法。

使用方式

资料给出的示例均为 Python 代码片段,开发者需自行在项目中安装并导入 typer 与 rich(资料未提供具体安装命令)。示例入口形式为 if name == "main": app()。进阶参考指向 ./references/typer-patterns.md、./references/rich-output.md、./references/configuration.md,模板位于 ./assets/cli-template.py。

适用场景

适合需要构建命令行工具、终端界面、带子命令的 CLI、需要彩色输出或进度提示的 Python 项目。

限制

资料未提供具体的安装命令、依赖版本、兼容平台、性能数据或收费信息。相关技能(python-typing-patterns、python-observability-patterns、python-env)的具体内容也未在资料中展开,仅以“See Also”形式列出。