单击更改日志 — 单击文档

来自菜鸟教程
Click/docs/6.x/changelog
跳转至:导航、​搜索

单击更改日志

这包含 Click 版本之间的所有主要版本更改。

版本 6.8

(错误修复发布;尚未发布)

  • 在不支持它的 Python 解释器上禁用 sys._getframes()。 见#728。
  • 修复了使用 None 调用 sys.exit 时测试运行器中的错误。 见#739。
  • 修复 Windows 控制台上的崩溃,请参阅 #744。
  • 修复链式命令上的 bashcompletion。 见#754。
  • 修复选项命名例程以匹配文档。 见#793
  • 分别修复了 2.x 和 3.x 上有关 unicode 的单击错误消息的行为。 消息现在总是 unicode 并且 str 和 unicode 特殊方法在该平台上按您的预期工作。


版本 6.7

(错误修复版本;2017 年 1 月 6 日发布)

  • 使 click.progressbar 与 codecs.open 文件一起使用。 见#637。
  • 使用嵌套子命令修复 bash 完成中的错误。 见#639。
  • 修复测试运行器没有正确保存调用者环境。 见#644。
  • 修复 SIGPIPE 的处理。 见#626
  • 处理损坏的 Windows 环境,例如 Google App Engine。 见#711。


版本 6.6

(错误修复版本;2016 年 4 月 4 日发布)

  • 修复 click.Path 中的错误,当通过 - 时它会崩溃。 见#551。


版本 6.4

(错误修复版本;2016 年 3 月 24 日发布)

  • 修复 bash 完成中的错误,其中单击会丢弃一个或多个尾随参数。 见#471。


版本 6.3

(错误修复版本;2016 年 2 月 22 日发布)

  • 在 Windows 上使用 -m 和 -c 修复解释器调用的参数检查。
  • 修复了在 Python 3 上导致区域设置检测出错的错误。


版本 6.2

(错误修复版本,于 2015 年 11 月 27 日发布)

  • 正确修复隐藏的进度条。


版本 6.1

(错误修复版本,于 2015 年 11 月 27 日发布)

  • 解决了不可见进度条不再呈现的问题。
  • 禁用带有子命令的链命令,因为它们本身就已损坏。
  • 修复 MissingParameter 在没有传递参数的情况下不起作用。


版本 6.0

(代号“pow pow”,2015 年 11 月 24 日发布)

  • 优化进度条渲染,当它没有实际改变时不渲染。
  • 明确禁止 nargs=-1 设置默认值。
  • 上下文现在在从堆栈中弹出之前关闭。
  • 添加了对切换时 false 标志的短别名的支持。
  • Click 现在将尝试通过在操作系统的帮助下列出可用的语言环境来帮助您更好地调试语言环境错误。
  • 单击用于在某些单元测试情况下返回 Python 2 上的字节字符串。 这已被修复,现在可以正确返回 unicode 字符串。
  • 对于使用 Python 2 的 Windows 用户,Click 现在可以更正确地处理来自系统的 Unicode。 这也有一个令人失望的副作用,即默认情况下,Path 类型中的文件名现在将始终为 unicode,这意味着这可能会为不知道这一点的代码引入小错误。
  • 将 type 参数添加到 Path 以对值强制使用特定的字符串类型。
  • 对于在 Windows 上运行 Python 的用户,echo) 和 prompt 函数现在通过模拟输出流在 Python windows 控制台中使用完整的 unicode 功能。 这也适用于通过 click.get_text_stream(…) 获取虚拟输出和输入流。
  • 单元测试现在总是强制一定的虚拟终端宽度。
  • 添加了允许破折号将标准流指示为 Path 类型的支持。
  • 链模式下的多命令不再将解析剩下的参数传播到回调。 如果启用链模式,当可选参数附加到多命令时,现在也不允许通过异常。
  • 放宽限制,不允许链式命令将其他链式命令作为子命令。
  • 现在可以实现具有正 nargs 的参数的默认值。 以前,此配置通常会导致返回稍微意外的值。


版本 5.1

(错误修复版本,于 2015 年 8 月 17 日发布)

  • 修复 pass_obj 中会意外传递上下文的错误。


5.0 版

(代号“tok tok”,2015 年 8 月 16 日发布)

  • 删除了各种已弃用的功能。
  • 原子文件现在只接受 w 模式。
  • 对于很长的命令,更改帮助输出的使用部分,将它们的参数包装到下一行,缩进 4 个空格。
  • 修复使用 CliRunner 时返回代码和错误消息不正确的错误。
  • 添加了 get_current_context。
  • 向上下文中添加了 meta 字典,该字典在上下文链接列表中共享,以允许单击实用程序将状态放置在那里。
  • 引入了 Context.scope。
  • echo 函数现在是线程安全的:它只调用底层对象的 write 方法一次。
  • prompt(hide_input=True) 现在在 ^C 上打印一个换行符。
  • 如果用户正在使用 unicode_literals,单击现在将发出警告。
  • 如果 PAGER 环境变量为空或仅包含空格,则 Click 现在将忽略该环境变量。
  • click-contrib GitHub 组织已创建。


版本 4.1

(错误修复版本,于 2015 年 7 月 14 日发布)

  • 修复错误消息将包含尾随 None 字符串的错误。
  • 修复了一个错误,即 Click 会在带有尾随换行符的文档字符串上崩溃。
  • 支持在 Python 3 上将编码设置为 None 的流,因为它会出现更好的错误。
  • 在 less-pager 中正确处理 ^C。
  • 处理来自 sys.getfilesystemencoding 的 None 的返回值
  • 修复使用 click.echo 写入 unicode 文件时崩溃的问题。
  • 使用多个选项修复类型推断。


版本 4.0

(代号“zoom zoom”,2015年3月31日发布)

  • 为大量直接或间接调用回显的接口添加了 color 参数。 这以前总是自动检测(echo_via_pager 函数除外)。 现在您可以强制启用或禁用它,覆盖 Click 的自动检测。
  • 添加了 UNPROCESSED 类型,该类型不执行任何类型更改,从而在某些特殊的高级用例中简化了 2.x / 3.x 上的文本处理。
  • 添加了 NoSuchOption 和 BadOptionUsage 异常,用于更通用的错误处理。
  • 添加了对处理未处理选项的支持,这在参数被转发到底层工具的情况下很有用。
  • 在上下文中添加了 max_content_width 参数,可用于更改帮助输出的最大宽度。 默认情况下,Click 不会格式化超过 80 个字符宽度的内容。
  • 添加了对向 stderr 写入提示的支持。
  • 修复显示多个参数的默认值时的错误。
  • 为 option 和 argument 添加了对自定义子类的支持。
  • 修复安装 colorama 时 Windows 上 clear() 中的错误。
  • 正确拒绝nargs=-1选项。 选项不能是可变参数。
  • 修复了 bash 补全对于非 ASCII 字符或破折号的命令无法正常工作的问题。
  • 添加了一种手动更新进度条的方法。
  • 更改了缺失参数的格式。 以前内部参数名称显示在错误消息中,现在如果传递则显示元变量。 如果选择了自动元变量,首先会去除额外的格式。


版本 3.3

(错误修复版本,于 2014 年 9 月 8 日发布)

  • 修复了在 Python 3 上报告无效命令转发错误的问题。


版本 3.2

(错误修复版本,于 2014 年 8 月 22 日发布)

  • 添加了缺少的 err 参数转发到 secho 函数。
  • 修复了上下文调用方法未正确处理的默认参数。 如果函数使用不当,这是向后不兼容的更改。 有关详细信息,请参阅 升级到 3.2
  • 很大程度上删除了 invoked_subcommands 属性。 由于解析的工作方式,无法使其无错误地工作,因此该 API 已被弃用。 有关详细信息,请参阅 升级到 3.2
  • 恢复了 invoked_subcommand 的功能,该功能在 3.1 中作为回归被破坏。


版本 3.1

(错误修复版本,于 2014 年 8 月 13 日发布)

  • 修复了导致在调用父命令之前创建子命令上下文的回归,这是早期 Click 版本的回归。


版本 3.0

(代号“clonk clonk”,2014 年 8 月 12 日发布)

  • 格式化程序现在不再尝试适应小于 50 个字符的终端。 如果发生这种情况,它只是假设一个最小的宽度。
  • 添加了一种不会在测试系统中吞下异常的方法。
  • 添加了对带有寻呼机的颜色的更好支持以及覆盖自动检测的方法。
  • CLI 运行器的结果对象现在附加了回溯。
  • 改进了自动简短帮助检测,以更好地处理不终止句子的点。
  • 现在在定义没有实际有效选项字符串的选项时,Click 将给出错误消息而不是静默传递。 这应该会捕获用户想要创建参数而不是选项的情况。
  • 内部重组 Click 以支持销售。
  • 添加了对多命令链接的支持。
  • 添加了对 multiple 选项和 nargs != 1 选项和参数的默认支持。
  • 传递给 progressbar 的标签不再呈现为去除空白。
  • 添加了一种在 Click 命令上禁用 main 方法的独立模式的方法,以便能够更好地处理错误。
  • 添加了对从命令回调返回值的支持。
  • 添加了从 echo 打印到 stderr 的简化。
  • 为组添加了结果回调。
  • 多次进入上下文会推迟清理,直到最后一次退出。
  • 添加了 open_file。


版本 2.6

(错误修复版本,于 2014 年 8 月 11 日发布)

  • 修复了 Python 3 上的包装流会报告不正确的可查找值的问题。


版本 2.5

(错误修复版本,于 2014 年 7 月 28 日发布)

  • 修复了 Python 3 上文本换行的错误。


版本 2.4

(错误修复版本,于 2014 年 7 月 4 日发布)

  • 更正了 2.3 中帮助选项更改中的错误。


版本 2.3

(错误修复版本,于 2014 年 7 月 3 日发布)

  • 修复了计数选项的格式不正确的帮助记录。
  • 如果 colorama 不可用,则在 Windows 上添加对 ansi 代码剥离的支持。
  • 恢复了 Click 1.0 处理某些边缘情况的帮助参数。


版本 2.2

(错误修复版本,于 2014 年 6 月 26 日发布)

  • 修复了 PyPy 上的 tty 检测。
  • 修复了进入上下文管理器时未呈现进度条的问题。


版本 2.1

(错误修复版本,于 2014 年 6 月 14 日发布)

  • 修复了 Windows 上的 launch() 函数。
  • 改进了 Windows 上的 colorama 支持,以便在应用程序中断时尽量不搞砸控制台。
  • 固定的 Windows 终端被错误地报告为 80 个字符宽而不是 79 个字符
  • 如果可用,请使用 colorama win32 绑定来获取 Windows 终端的正确尺寸。
  • 修复了 Python 3 上自定义函数类型的问题。
  • 修复了错误消息中错误报告未知选项的问题。


2.0版

(代号“tap tap tap”,2014 年 6 月 6 日发布)

  • 添加了对以二进制模式在 Windows 上正确打开 stdin/stdout 的支持。
  • 通过临时文件添加了对文件原子写入的支持。
  • 引入了 BadParameter,它可用于轻松执行自定义验证,并使用与类型系统中相同的错误消息。
  • 添加了 进度条(); 显示进度条的功能。
  • 添加了 get_app_dir(); 计算配置的主文件夹的函数。
  • 通过 colorama 将 ANSI 代码的透明处理添加到 echo() 函数中。
  • 添加了 clear() 函数。
  • 重大变化:参数回调现在获取作为第二个参数传递的参数对象。 旧回调有遗留支持,它会发出警告但仍会执行脚本。
  • 为 ANSI 样式添加了 style()unstyle()secho()
  • 添加了调用默认编辑器的 edit() 函数。
  • 添加了启动浏览器和应用程序的 launch() 函数。
  • 现在可以通过 required 标志将参数的 -1 的 nargs 强制为单个项目。 它默认为不需要。
  • 为参数设置默认值现在隐式使其不再需要。
  • 在确认提示中将“yN”/“Yn”更改为“y/N”和“Y/n”。
  • 添加了对 bash 完成的基本支持。
  • 添加 getchar() 以从终端获取单个字符。
  • 错误现在按预期转到 stderr。
  • 修复了更奇特的参数格式(如 DOS/Windows 样式参数)的各种问题。
  • 添加了 pause(),它的工作原理类似于内置的 Windows pause cmd,但如果应用程序不是通过终端运行的,则会变成自动 noop。
  • 添加了一些关于缺少选择参数的额外信息。
  • 更改了帮助功能的实现方式,以允许全局覆盖帮助选项。
  • 添加了对令牌规范化的支持以实现不区分大小写的处理。
  • 添加了对为上下文设置提供默认值的支持。


版本 1.1

(错误修复版本,于 2014 年 5 月 23 日发布)

  • 修复了导致 Python 2 中的文本文件不接受本机字符串的错误。


版本 1.0

(无代号,2014 年 5 月 21 日发布)

  • 初始版本。