prompt-toolkit 的主要优势#

• 跨平台：在 Windows、macOS 和 Linux 上行为完全一致，无需外部依赖。
• 异步输出：更好地支持向终端异步打印，同时不干扰用户的输入行。
• 增强的 UI：支持底部工具栏、浮动菜单等高级 UI 元素。
• 多行编辑：改进了对跨多行命令的编辑支持。

破坏性变更与不兼容之处#

尽管我们努力保持兼容，但仍存在一些差异：

• 键绑定：键绑定现在由 prompt-toolkit 管理。虽然默认仍是 Emacs 风格绑定（与 readline 类似），但自定义方式改为使用 prompt-toolkit 的 KeyBindings API。
• 输入钩子：不再支持 readline 特有的输入钩子。

ansi#

cmd2.ansi 模块中的功能或已被移除，或改为基于 rich 并移动到以下新模块之一：cmd2.colors、cmd2.string_utils 或 cmd2.styles。

为了简化从 cmd2 2.x 到 3.x 的迁移路径，我们以独立包的形式创建了 cmd2-ansi 模块，它是 cmd2 2.7.0 中 cmd2.ansi 模块的向后移植。相关链接：

• PyPI：cmd2-ansi
• GitHub：cmd2-ansi

使用此向后移植包：

1
from cmd2_ansi import ansi

table_creator#

cmd2.table_creator 模块已不复存在。更多信息请参阅 rich 关于 Tables 的文档。rich_tables.py 示例演示了如何在 cmd2 应用中使用 rich 表格。

rich 表格提供了比 cmd2 之前所提供的更强大的能力和灵活性。对于这一向后不兼容我们深表歉意，但两者的 API 根本不同，我们无法设计出一个向后兼容的包装层。

为了简化从 cmd2 2.x 到 3.x 的迁移路径，我们以独立包的形式创建了 cmd2-table 模块，它是 cmd2 2.7.0 中 cmd2.table_creator 模块的向后移植。相关链接：

• PyPI：cmd2-table
• GitHub：cmd2-table

使用此向后移植包：

1
from cmd2_table import table_creator

colors#

新的 cmd2.colors 模块提供了便捷的 cmd2.colors.Color StrEnum 类，用于表示 rich 颜色名称。这让你可以在代码中使用可 Tab 补全的常量，而不是魔法字符串来表示所需的确切颜色。

参阅 getting_started.py 了解使用 Color 类为输出选择颜色的基础示例。或者参阅 color.py 示例，直观查看所有受支持的颜色。

rich_utils#

新的 cmd2.rich_utils 模块提供了在 cmd2 应用中支持 rich 使用的通用工具类和函数。其中大部分内容并非面向最终用户。

许多 cmd2 应用开发者可能会感兴趣的是 cmd2.theme.update_theme 函数。参阅 rich_theme.py 示例，了解如何为你的应用设置主题（配色方案）。

styles#

错误消息等信息的默认显示样式现在位于新的 cmd2.styles 模块中，并且基于 rich 样式。

此前 cmd2 的默认样式位于 cmd2.ansi 模块中。

参阅 argparse_completion.py 示例，了解如何在 cmd2 应用中利用这些默认样式来保持一致的外观。

string_utils#

各种字符串工具函数已从 cmd2.ansi 模块移至新的 cmd2.string_utils 模块。

其中包括用于文本样式化、对齐以及加引号/去引号的函数。参阅 getting_started.py 示例，了解如何使用通用的 cmd2.string_utils.stylize 函数。

terminal_utils#

设置窗口标题、异步警报等终端控制转义序列的支持已从 cmd2.ansi 移入主 cmd2.Cmd 应用类中。

这部分并非供最终用户直接使用，而是供 cmd2.Cmd.set_window_title 和 cmd2.Cmd.add_alert 等面向最终用户的高层功能使用。

参阅 async_printing.py 了解如何在 cmd2 应用中使用此功能。