InquirerPy 使用教程

InquirerPy 使用教程

InquirerPy:snake: Python port of Inquirer.js (A collection of common interactive command-line user interfaces)项目地址:https://gitcode.com/gh_mirrors/in/InquirerPy

1. 项目介绍

InquirerPy 是一个 Python 端口，源自著名的 Inquirer.js（一个包含常见交互式命令行用户界面的集合）。该项目旨在提供一个跨平台的、易于使用的命令行交互工具，适用于所有操作系统。尽管 Unix 平台可能比 Windows 有更好的体验，但 InquirerPy 在所有平台上都能正常工作。

主要特点

• 跨平台支持：适用于所有操作系统。
• 丰富的交互类型：支持文本输入、密码输入、文件路径选择、数字输入、确认、选择列表、复选框、模糊搜索等多种交互类型。
• 高度可定制：提供丰富的样式和键绑定自定义选项。
• 高性能：基于 prompt_toolkit，性能优越。

2. 项目快速启动

安装

首先，使用 pip 安装 InquirerPy：

pip3 install InquirerPy

快速启动代码示例

以下是一个简单的示例，展示了如何使用 InquirerPy 进行命令行交互：

from InquirerPy import prompt

questions = [
    {"type": "input", "message": "What's your name:", "name": "name"},
    {"type": "confirm", "message": "Confirm?", "name": "confirm"},
]

result = prompt(questions)
name = result["name"]
confirm = result["confirm"]

print(f"Name: {name}")
print(f"Confirm: {confirm}")

使用 InquirerPy 的另一种语法

InquirerPy 还支持另一种更简洁的语法：

from InquirerPy import inquirer

name = inquirer.text(message="What's your name:").execute()
confirm = inquirer.confirm(message="Confirm?").execute()

print(f"Name: {name}")
print(f"Confirm: {confirm}")

3. 应用案例和最佳实践

应用案例

InquirerPy 可以用于各种需要命令行交互的场景，例如：

• 配置文件生成器：通过命令行交互收集用户输入，生成配置文件。
• 自动化脚本：在自动化脚本中添加用户交互，提高脚本的灵活性和用户体验。
• CLI 工具：开发命令行工具时，使用 InquirerPy 提供友好的用户界面。

最佳实践

• 使用 prompt_toolkit 的特性：InquirerPy 基于 prompt_toolkit，可以充分利用其提供的特性，如自动补全、历史记录等。
• 自定义样式：通过自定义样式，使交互界面更符合项目风格。
• 处理用户输入：在获取用户输入后，进行必要的验证和处理，确保数据的正确性。

4. 典型生态项目

相关项目

• questionary：一个基于 prompt_toolkit 的命令行交互库，与 InquirerPy 类似，但提供了不同的自定义选项。
• python-inquirer：另一个 Python 端口，使用 blessed 库实现 UI，稳定性较高，但自定义选项较少。

生态系统

InquirerPy 可以与其他命令行工具和库结合使用，例如：

• Click：一个用于创建命令行界面的 Python 库，可以与 InquirerPy 结合使用，提供更复杂的命令行应用。
• Typer：一个基于 Click 的库，简化了命令行应用的开发，同样可以与 InquirerPy 结合使用。

通过结合这些工具，可以构建功能强大且用户友好的命令行应用。

InquirerPy:snake: Python port of Inquirer.js (A collection of common interactive command-line user interfaces)项目地址:https://gitcode.com/gh_mirrors/in/InquirerPy