1. 交互式 Shell (REPL) 中的 Tab 补全：在 python 命令行中输入代码时，按 Tab 键补全变量、函数、模块名等。
2. 命令行脚本中的 Tab 补全：当你写一个 Python 脚本，并希望它像 ls, git 等命令一样，在后面可以 Tab 补全参数时。

下面我将详细讲解这两种情况的实现方法。

交互式 Shell (REPL) 中的 Tab 补全

标准的 Python 解释器（CPython）本身不带 Tab 补全功能，但我们可以通过两种方式轻松实现：

方法 1：使用 rlcompleter 模块（推荐，内置）

Python 自带了一个名为 rlcompleter 的模块，它利用 GNU Readline 库来提供补全功能，大多数 Linux 发行版默认安装了 readline。

步骤：

1. 启动 Python 时加载 rlcompleter

   
   （图片来源网络，侵删）

   最简单的方式是在启动 Python 时，通过环境变量 PYTHONSTARTUP 指定一个初始化脚本。

   • 创建初始化脚本： 在你的家目录下创建一个文件，~/.pythonrc.py：

     vim ~/.pythonrc.py

     在文件中添加以下内容：

     try:
         import readline
         import rlcompleter
         readline.parse_and_bind("tab: complete")
     except ImportError:
         pass # 如果系统没有 readline 库（如某些 Windows Python 版本），则忽略

   • 设置环境变量： 将 PYTHONSTARTUP 环境变量指向这个脚本，为了永久生效，将其添加到你的 shell 配置文件中（如 ~/.bashrc, ~/.zshrc）。

     
     （图片来源网络，侵删）

     对于 Bash:

     echo 'export PYTHONSTARTUP=~/.pythonrc.py' >> ~/.bashrc
     source ~/.bashrc

     对于 Zsh:

     echo 'export PYTHONSTARTUP=~/.pythonrc.py' >> ~/.zshrc
     source ~/.zshrc

2. 验证效果

   重新打开一个终端,然后启动 Python：

   python

   你可以尝试输入一些代码并按 Tab 键：

   import os
   os.<Tab>  # 你会看到列出所有 os 模块的属性和方法，如 os.path, os.system 等
   my_var = "hello"
   my_v<Tab>  # 会自动补全为 my_var

优点：

• 无需安装任何额外包。
• 轻量级,与标准 Python 解释器无缝集成。

缺点：

• 补全功能相对基础,不如 IDE 强大。

方法 2：使用 ipython 或 bpython

如果你追求更强大的交互式体验,强烈推荐使用 IPython 或 BPython，它们不仅自带高级 Tab 补全，还提供了语法高亮、命令历史、内联帮助等大量优秀功能。

安装 IPython (推荐):

# 使用包管理器安装
sudo apt-get install ipython  # Debian/Ubuntu
sudo dnf install ipython      # Fedora/CentOS
# 或者使用 pip
pip install ipython

启动 IPython:

ipython

在 IPython 中，Tab 补全功能非常智能：

• 按 Tab：列出所有可能的补全项。
• 按两次 Tab：如果补全项很多，会弹出一个分页的列表。
• 对象内省：输入一个对象名加 ，然后按 Tab，会列出该对象的所有属性和方法，并用不同颜色区分变量、方法、属性等。
• 参数提示：输入一个函数名加 ，然后按 Tab，会显示该函数的签名和文档字符串。

In [1]: import numpy as np
In [2]: np.aran<Tab>  # 会自动补全为 np.arange
In [2]: np.arange(<Tab>  # 会显示 (start, stop[, step, dtype])

命令行脚本中的 Tab 补全

假设你有一个名为 my_cli.py 的脚本，你希望用户可以这样使用它：

my_cli.py --<Tab>   # 补全出 --help, --version 等选项
my_cli.py do_something --<Tab> # 补全出 do_something 子命令的选项

这需要利用 Linux Shell 的 complete 机制，Python 脚本本身不直接实现这个，而是通过生成 Shell 配置代码来让 Shell 完成补全。

这里我们使用一个非常流行的库 argcomplete 来简化这个过程。

使用 argcomplete 实现脚本补全

步骤：

1. 安装 argcomplete

   pip install argcomplete

2. 编写 Python 脚本 (my_cli.py)

   使用 argparse 来定义命令行参数，并激活 argcomplete。

   # my_cli.py
   import argparse
   import argcomplete
   def main():
       parser = argparse.ArgumentParser(description="A sample CLI tool with tab completion.")
       # 添加全局选项
       parser.add_argument('--version', action='version', version='%(prog)s 1.0')
       parser.add_argument('--verbose', '-v', action='store_true', help="Enable verbose output")
       # 添加子命令
       subparsers = parser.add_subparsers(dest='command', help='Available commands')
       # do_something 命令
       parser_do = subparsers.add_parser('do_something', help='Do something important')
       parser_do.add_argument('--input', '-i', required=True, help="Input file")
       parser_do.add_argument('--output', '-o', help="Output file")
       parser_do.add_argument('--format', choices=['json', 'xml'], help="Output format")
       # do_another 命令
       parser_another = subparsers.add_parser('do_another', help='Do another thing')
       parser_another.add_argument('--name', help="Your name")
       # 激活 argcomplete
       argcomplete.autocomplete(parser)
       args = parser.parse_args()
       # 这里是脚本的实际逻辑
       print(f"Executing command: {args.command}")
       if args.verbose:
           print("Verbose mode is ON.")
       if args.command == 'do_something':
           print(f"Input file: {args.input}")
           if args.output:
               print(f"Output file: {args.output}")
           if args.format:
               print(f"Format: {args.format}")
       elif args.command == 'do_another':
           print(f"Hello, {args.name or 'stranger'}!")
   if __name__ == '__main__':
       main()

3. 为脚本注册补全功能

   这是最关键的一步。argcomplete 提供了一个方便的命令 register-python-argcomplete 来帮你完成。

   • 临时注册（当前会话有效）：

     eval "$(register-python-argcomplete my_cli.py)"

     执行后,当前终端会立即拥有 my_cli.py 的补全功能。

   • 永久注册（推荐）： 将注册命令写入你的 shell 配置文件。

     对于 Bash (~/.bashrc):

     # 在文件末尾添加
     eval "$(register-python-argcomplete my_cli.py)"

     然后执行 source ~/.bashrc。

     对于 Zsh (~/.zshrc): Zsh 的补全系统更强大，推荐使用 zsh-completion 包。

     # 安装 zsh-completion 包
     sudo apt-get install zsh-completion
     # 或
     sudo dnf install zsh-completion
     # 创建一个补全函数文件
     sudo tee /usr/local/share/zsh/site-functions/_my_cli > /dev/null <<EOF
     #compdef my_cli.py
     eval "\$(register-python-argcomplete my_cli.py)"
     EOF
     # 然后重新加载 zsh 配置
     exec zsh

     注意：_my_cli 文件名必须以下划线开头，并且放在 Zsh 的函数搜索路径中。

4. 测试补全效果

   确保你的脚本有可执行权限：

   chmod +x my_cli.py

   现在在终端中测试：

   ./my_cli.py <Tab>  # 应该补全出 --help, --version, do_something, do_another
   ./my_cli.py do_something --<Tab> # 应该补全出 --input, --output, --format
   ./my_cli.py --<Tab> # 应该补全出 --help, --version, --verbose

总结与对比

推荐实践：

• 如果你只是偶尔在命令行运行几行 Python，配置 ~/.pythonrc.py 就足够了。
• 如果你经常在命令行进行 Python 开发、数据分析或调试，强烈推荐使用 IPython，它会极大地提升你的效率。
• 如果你正在开发一个复杂的命令行工具,argcomplete 是不二之选，它能让你的工具看起来非常专业和易用。