1. readline 是什么？ #

• readline 是 Python 标准库，为交互式命令行提供行编辑和命令历史功能。
• 在支持 readline 的终端中，用户可以用方向键翻阅历史、用退格键编辑，体验类似 Bash。
• 适合需要反复输入命令的交互式 CLI 工具，如简易 Shell、数据库客户端、调试控制台。
• 简单的一次性提问用内置 input() 即可；需要历史记录和 Tab 补全时再用 readline。

2. 前置知识 #

• readline 主要依赖底层 GNU readline 库，在 Linux/macOS 上通常开箱可用。
• Windows 原生 Python 可能没有 readline 模块，需安装 pyreadline3 或接受功能受限。
• 使用前可用 try: import readline 判断环境是否支持，不支持时降级为普通 input()。
• argparse 处理启动参数，readline 处理运行中的交互输入。

# 尝试导入 readline，检测环境是否支持
try:
    # 导入交互式行编辑库
    import readline
    # 标记当前环境支持 readline
    HAS_READLINE = True
# 捕获导入失败异常
except ImportError:
    # 标记当前环境不支持 readline
    HAS_READLINE = False

pip install pyreadline3
pip install prompt_toolkit

3. 命令历史 #

• readline 导入后会自动增强 input()，在交互式终端中可用上下方向键翻阅历史。
• readline.add_history(line) 手动将一行加入历史，适合程序代替用户"记住"某些输入。
• readline.write_history_file(path) 退出时保存历史，readline.read_history_file(path) 启动时加载。
• 历史文件通常放在用户目录，如 ~/.myapp_history，下次启动可继续用上次的命令。

# 导入 readline 模块
import readline
# 导入路径处理工具
from pathlib import Path

# 定义历史文件路径（存放在用户主目录）
HISTORY = Path.home() / ".history"

# 启动时加载历史
# 若历史文件已存在则读取
if HISTORY.exists():
    # 从文件加载命令历史到内存
    readline.read_history_file(HISTORY)

# 使用 try/finally 确保退出时保存历史
try:
    # 提示用户输入并获取姓名
    name = input("你叫什么名字？ ")
    # 打印问候语
    print(f"你好，{name}！")
    # 手动将输入加入历史（可选）
    readline.add_history(f"name {name}")
finally:
    # 退出时保存历史
    # 将内存中的命令历史写入文件
    readline.write_history_file(HISTORY)

4. Tab 自动补全 #

• readline.set_completer(func) 注册补全函数，用户按 Tab 时自动调用。
• 补全函数接收 (text, state) 两个参数，返回第 state 个匹配项，无更多匹配时返回 None。
• readline.parse_and_bind("tab: complete") 将 Tab 键绑定到补全功能，这一行必不可少。
• 项目中常用于命令名补全、路径补全、子命令补全等交互式 CLI 场景。

# 导入 readline 模块
import readline

# 定义可供 Tab 补全的命令列表
COMMANDS = ["help", "exit", "list", "show"]

# 定义 Tab 补全回调函数
def completer(text, state):
    # 筛选以当前输入开头的命令
    options = [cmd for cmd in COMMANDS if cmd.startswith(text)]
    # 返回第 state 个匹配项，无更多时返回 None
    return options[state] if state < len(options) else None

# 注册补全函数
readline.set_completer(completer)
# 将 Tab 键绑定到补全功能
readline.parse_and_bind("tab: complete")

# 开始一个无限循环，持续读取用户输入
while True:
    # 提示用户输入命令，并将输入内容赋值给 user_input
    user_input = input("请输入命令: ")
    # 判断输入是否为 "exit"，若是则跳出循环
    if user_input == "exit":
        break
    # 判断输入是否为 "help"，若是则输出所有可用命令
    elif user_input == "help":
        print("可用的命令：", ", ".join(COMMANDS))
    # 判断输入是否为 "list"，若是则提示正在列出命令
    elif user_input == "list":
        print("正在列出命令……")
    # 判断输入是否为 "show"，若是则提示正在显示命令
    elif user_input == "show":
        print("正在显示命令……")
    # 如果输入的命令未知，则提示未知命令
    else:
        print(f"未知命令：{user_input}")

# 输入 hel 后按 Tab → 自动补全为 help

5. 交互式命令行 #

• REPL 模式是 readline 最典型的用法：while True 循环 + input(prompt) + 处理命令。
• 配合 Tab 补全和命令历史，用户可以像使用 Shell 一样操作你的程序。
• 输入 exit 或 quit 时 break 跳出循环，退出前调用 write_history_file 保存历史。
• 不要把 input() 循环和 argparse 混在同一流程：argparse 解析启动参数，循环处理运行时命令。

# 导入 readline 模块
import readline
# 导入路径处理工具
from pathlib import Path

# 定义历史文件路径
HISTORY = Path.home() / ".mycli_history"
# 定义可补全的命令列表
COMMANDS = ["help", "exit", "hello"]

# 若历史文件存在则加载
if HISTORY.exists():
    # 从文件恢复命令历史
    readline.read_history_file(HISTORY)

# 定义 Tab 补全回调函数
def completer(text, state):
    # 筛选以当前输入开头的命令
    opts = [c for c in COMMANDS if c.startswith(text)]
    # 返回第 state 个匹配项
    return opts[state] if state < len(opts) else None

# 注册补全函数
readline.set_completer(completer)
# 启用 Tab 键补全
readline.parse_and_bind("tab: complete")

# 打印欢迎提示信息
print("CLI（输入 help 查看命令，exit 退出）")
# 主循环：持续接收并处理用户输入
while True:
    try:
        # 读取一行输入并去除首尾空白
        line = input(">>> ").strip()
    # 捕获 Ctrl+D（EOF）或 Ctrl+C 中断
    except (EOFError, KeyboardInterrupt):
        # 换行后退出循环
        print()
        break
    # 空行则跳过，继续等待输入
    if not line:
        continue
    # exit 命令退出循环
    if line == "exit":
        break
    # help 命令显示所有可用命令
    if line == "help":
        print("可用命令:", ", ".join(COMMANDS))
    # hello 命令打印 world
    elif line == "hello":
        print("world")
    # 未知命令给出提示
    else:
        print(f"未知命令: {line}")

# 退出前将命令历史保存到文件
readline.write_history_file(HISTORY)
# 打印告别语
print("再见！")

6. 常见错误 #

• 忘记调用 parse_and_bind("tab: complete") 导致 Tab 补全不生效。
• 补全函数参数写错：必须是 (text, state)，返回第 state 个匹配项或 None。
• 在 Windows 上直接 import readline 报错，需 try/except 或安装 pyreadline3。
• 把 readline 当作文件行读取工具——读文件用 for line in open(...)。

7. 总结 #

• readline 为交互式 CLI 提供命令历史和 Tab 补全，导入后自动增强 input()。
• 核心 API：set_completer、parse_and_bind("tab: complete")、read/write_history_file。
• 典型模式：while True + input(">>> ") + 命令分发，输入 exit 退出。
• 简单场景用 input() 即可；跨平台项目注意 Windows 兼容性。

7.1 速查 #

# 导入 readline 模块
import readline

# 启用 Tab 补全
readline.parse_and_bind("tab: complete")
# 注册自定义补全函数
readline.set_completer(my_completer)
# 手动添加一条命令到历史
readline.add_history("某条命令")
# 从文件加载历史记录
readline.read_history_file("~/.history")
# 将历史记录保存到文件
readline.write_history_file("~/.history")

# 使用增强后的 input 读取一行输入
line = input(">>> ")

7.2 最佳实践 #

• 启动时 read_history_file，退出时 write_history_file
• 补全列表从固定命令表或动态扫描生成，保持精简
• Windows 用 try/except 包裹 import readline，保证降级可用
• 与 argparse 分工：启动参数用 argparse，运行时交互用 readline