Click Documentation Release 3.3

《Click Documentation Release 3.3》文档内容总结如下： --- ### Core Information - **Click** 是一个 Python 包，用于以最少的代码创建美观且可组合的命令行界面（CLI），旨在快速、愉快地编写命令行工具，同时避免因命令行接口实现困难带来的挫败感。 - Click 的核心功能包括： -supports arbitrary nesting of commands（支持命令的任意嵌套） - automatic generation of help pages（自动生成帮助页面） - supports lazy loading of subcommands at runtime（支持运行时动态加载子命令） --- ### Key Features - Click 通过装饰器声明命令，内部提供了一个非装饰器接口以供高级用例。 - 支持快速创建命令行工具，例如： ```python import click @click.command() def hello(): click.echo('Hello World!') if __name__ == '__main__': hello() ``` 这将生成一个可执行的脚本，并自动生成帮助页面。 --- ### Version Updates (Changelog) - **Version 3.3 (2024-09-08)**: 修复了 Python 3 上的错误报告问题。 - **Version 3.2 (2024-08-22)**: - Added missing err parameter forwarding to secho. - Fixed context invoke method 的参数处理问题（向后兼容性破坏，需参考升级指南）。 - Removed `invoked_subcommands` 属性，并恢复 `invoked_subcommand` 的功能。 - **Version 3.1 (2024-08-13)**: 修复了子命令上下文创建顺序的回归问题。 - **Version 3.0 (2024-08-12)**: - 重构内部支持以支持 vendoring。 - Added support for multi-command chaining（命令链式调用）。 - Improved error handling, automatic short help detection, and more. - Previous versions (2.6, 2.5, 2.4) 主要是 bug 修复版本，涉及 text wrapping, stream reporting, 和帮助选项的修改。 --- ### Usage and Examples - Click 提供了丰富的示例，包括： - **inout**: 文件输入输出示例。 - **naval**: docopt 风格的端口示例。 - **aliases**: 命令别名示例。 - Click 支持通过装饰器快速定义命令和选项，例如： ```python @click.option('--count', default=1, help='Number of greetings.') @click.option('--name', prompt='Your name', help='The person to greet.') ``` - 支持确认选项（confirmation options）和环境变量参数（environment variables）。 - 支持自定义帮助页面，包括短帮助（short help）和段落重排。 --- ### API Reference - Click 提供了丰富的装饰器和 API，包括： - `@click.command()`：定义一个命令。 - `@click.group()`：定义一个命令组。 - `@click.option()` 和 `@click.argument()`：定义选项和参数。 - `click.echo()` 和 `click.secho()`：用于输出文本，支持颜色和错误输出。 - `click.confirmation_option()`：快速添加确认选项。 - 支持进度条、错误处理、上下文管理等功能。 --- ### Documenting and Help System - Click 自动生成帮助页面，支持自定义帮助内容和格式化。 - 可以通过 `@click.help` 和 `doc` 属性自定义帮助文本。 - 支持元变量（meta variables）和段落重排。 --- 总结：本文档详细介绍了 Click 包的功能、使用方法和版本更新，强调了其简洁性和灵活性，并通过丰富的示例和 API 参考帮助用户快速上手和深入开发。