Click Documentation Release 6.7

• 语言: 英语
• 格式: .pdf
• 来源: click.palletsprojects.com

摘要

文档详细介绍了Click库的发行版本及其更新内容，涵盖了从6.7到更早版本的多个更新日志。每个版本都列出了修复的bug和新增的功能，包括对命令行工具的改进、对不同操作系统的兼容性优化、对参数处理的增强以及对错误处理的完善。文档还提到了Click库在Python 2和Python 3之间的兼容性问题，并提供了解决方案和使用建议。

AI总结

### Click Documentation Release 6.7 总结

#### 1. 核心功能与特性
Click 是一个用于开发命令行工具的 Python 库，支持快速构建 CLI 应用程序。其核心功能包括：
- **命令与组**：支持任意嵌套的命令行工具，通过命令和组（MultiCommand）实现。
- **参数与选项**：支持多种参数类型（如文件路径、数字等），以及自定义参数验证。
- **Bash 补全**：提供交互式的命令补全功能。
- **异常处理**：支持自定义错误处理和 Unicode 处理。
- **测试支持**：提供测试运行器和 utilities。
- **跨平台支持**：支持 Windows 和 Unix 系统，包括对 Unicode 的处理。

#### 2. 版本更新
- **版本 6.7**（2020年6月23日）：
- 修复链式命令中的Bash补全问题。
- 修复选项命名规则与文档不一致的问题。
- 修复 Unicode 错误消息在不同 Python 版本中的行为。

- **版本 6.6**（2016年4月4日）：
- 修复 `click.Path` 在传递 `-` 时的崩溃问题。

- **版本 6.5**（未明确）：
- 修复Bash补全丢弃尾随参数的问题。

- **版本 6.4**（2016年3月24日）：
- 修复Bash补全丢弃尾随参数的问题。

- **版本 6.3**（2016年2月22日）：
- 修复 Windows 环境下 `interpreter invoke` 的参数检查问题。
- 修复 Python 3 的 locale 检测问题。

- **版本 6.2**（2015年11月27日）：
- 修复隐藏进度条的问题。

- **版本 6.1**（2015年11月27日）：
- 修复不可见进度条不显示的问题。
- 禁止链式命令与子命令（因固有缺陷）。
- 修复 `MissingParameter` 在未传递参数时的问题。

#### 3. 重要更新与改进
- **上下文与结果回调**：
- 引入 `Context.scope` 和 `get_current_context`。
- 支持在上下文中共享元数据。

- **Echo 函数**：
- Echo 函数变为线程安全，仅调用底层对象的写方法一次。

- **Prompt 功能**：
- `prompt(hide_input=True)` 在 `^C` 时输出换行符。

- **Windows 支持**：
- 提升 Windows 环境下的 Unicode 处理能力。
- 支持通过 `click.get_text_stream` 使用全 Unicode 功能。

- **其他改进**：
- 支持自定义子类选项和参数。
- 支持将提示写入标准错误流。
- 改进对非 ASCII 字符和破折号的 Bash 补全支持。

#### 4. 快速入门示例

import click

@click.command()
def hello():
    click.echo('Hello World!')

if __name__ == '__main__':
    hello()

运行：

$ python hello.py
Hello World!

#### 5. 兼容性与升级
- **参数回调签名变化**：
- 从 Click 2.0 开始，回调函数签名从 `(ctx, value)` 改为 `(ctx, param, value)`。
- 提供兼容性装饰器 `compatcallback` 支持旧版本回调。

- **升级建议**：
- Click 3.0 开始会警告未更新的旧回调。
- 使用 `compatcallback` 装饰器可同时支持 Click 1.0 和 2.0。

#### 6. 许可证
Click 采用三条款 BSD 许可证：
- 允许自由修改和分发。
- 需保留版权声明和免责声明。
- 不能使用 Click 开发者的名称进行商业推广，除非获得书面许可。

---

### 总结
Click 是一个强大且灵活的命令行工具开发库，支持快速构建跨平台 CLI 应用。6.7 版本修复了多个关键问题，提升了兼容性和稳定性，同时增加了对 Windows 环境和 Unicode 的更好支持。文档详细介绍了核心功能、API 参考和使用案例，适合开发者快速上手和深入使用。