Questionary 开源项目使用教程

Questionary 开源项目使用教程

questionaryPython library to build pretty command line user prompts ✨Easy to use multi-select lists, confirmations, free text prompts ...项目地址:https://gitcode.com/gh_mirrors/qu/questionary

1. 项目的目录结构及介绍

Questionary 项目的目录结构如下：

questionary/
├── .github/
│   └── workflows/
├── docs/
├── questionary/
│   ├── __init__.py
│   ├── constants.py
│   ├── form.py
│   ├── prompt.py
│   ├── styles.py
│   └── util.py
├── tests/
│   ├── __init__.py
│   ├── test_form.py
│   ├── test_prompt.py
│   └── test_styles.py
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py

目录结构介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• docs/: 包含项目的文档文件。
• questionary/: 核心代码目录，包含项目的各个模块。
  • __init__.py: 初始化文件。
  • constants.py: 常量定义。
  • form.py: 表单相关的功能。
  • prompt.py: 提示相关的功能。
  • styles.py: 样式相关的功能。
  • util.py: 工具函数。
• tests/: 包含项目的测试文件。
  • __init__.py: 初始化文件。
  • test_form.py: 表单相关的测试。
  • test_prompt.py: 提示相关的测试。
  • test_styles.py: 样式相关的测试。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖文件。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

Questionary 项目的启动文件是 questionary/__init__.py。这个文件负责初始化项目，并导入各个模块以便使用。

# questionary/__init__.py

from .form import Form
from .prompt import prompt
from .styles import default_style, Style
from .util import print_over

__all__ = [
    "Form",
    "prompt",
    "default_style",
    "Style",
    "print_over"
]

启动文件介绍

• Form: 表单类，用于创建和管理表单。
• prompt: 提示函数，用于与用户交互。
• default_style: 默认样式。
• Style: 样式类，用于自定义样式。
• print_over: 工具函数，用于覆盖打印。

3. 项目的配置文件介绍

Questionary 项目没有专门的配置文件，但可以通过修改 questionary/styles.py 中的 default_style 来调整默认样式。

# questionary/styles.py

from prompt_toolkit.styles import Style as PStyle

default_style = PStyle.from_dict({
    "questionmark": "#5F819D",
    "selected": "#FF9D00",  # 高亮选项
    "pointer": "#FF9D00",   # 指示器
    "instruction": "",      # 指令文本
    "answer": "#FF9D00 bold",  # 答案文本
    "question": "",         # 问题文本
})

配置文件介绍

• default_style: 默认样式配置，可以通过修改字典中的键值对来自定义样式。
  • questionmark: 问题标记的样式。
  • selected: 选中选项的样式。
  • pointer: 指示器的样式。
  • instruction: 指令文本的样式。
  • answer: 答案文本的样式。
  • question: 问题文本的样式。

通过修改这些样式，可以定制 Questionary 项目的外观和交互效果。

questionaryPython library to build pretty command line user prompts ✨Easy to use multi-select lists, confirmations, free text prompts ...项目地址:https://gitcode.com/gh_mirrors/qu/questionary