用途:为 Python 库构建命令行界面(CLI),提供框架选择、常用模式与检查清单。
框架选择:Click(推荐,成熟、功能丰富)、Typer(现代、以类型提示为中心)、argparse(零依赖、标准库)。
主要能力:命令组与版本选项;参数与选项处理(如 click.argument、click.option);文件 I/O 支持 stdin/stdout(click.File,默认 '-');进度条(click.progressbar);彩色输出(click.secho);错误处理(click.BadParameter);Shell 补全脚本生成;使用 CliRunner 进行测试。
使用方式:在 pyproject.toml 中配置入口点,例如 [project.scripts] 下 mycli = "my_package.cli:cli",可选依赖 cli = ["click>=8.0"]。补全脚本生成示例:_MYCLI_COMPLETE=bash_source mycli > ~/.mycli-complete.bash,zsh 同理。测试示例:runner = CliRunner(); runner.invoke(cli, ['process', 'input.txt'])。
适用场景:需要为 Python 库提供命令行工具、需要命令组、参数校验、进度反馈、Shell 补全与可测试性的项目。
限制:资料未提供具体版本兼容范围、性能数据、收费信息或平台限制;详细模式见 CLICK_PATTERNS.md 与 TYPER_GUIDE.md。