如何为Python Argparse模块添加Bash自动补全功能？

argparse本身不自带Bash自动补全功能，但可以结合Bash的补全机制和Python脚本扩展，实现你要的效果——比如输入my_module rollback -c后按Tab列出候选提交哈希。下面是具体实现步骤：

1. 修改Python脚本，添加补全逻辑 #

在原脚本中加入补全处理分支，当脚本收到--complete参数时，根据当前命令上下文输出候选值：

#!/usr/bin/env python3

import argparse
import sys
import subprocess

def get_commit_hashes():
    # 替换为实际获取提交哈希的逻辑，比如从git仓库读取
    # 示例：调用git获取本地提交短哈希
    try:
        result = subprocess.run(
            ["git", "log", "--oneline", "--format=%h"],
            capture_output=True, text=True, check=True
        )
        return result.stdout.strip().split("\n")
    except Exception:
        # 异常时返回空列表或默认候选
        return []

def handle_completion():
    # 获取Bash传递的当前命令行参数
    args = sys.argv[2:]  # 跳过脚本名和--complete参数
    cur_arg = args[-1] if args else ""

    # 判断当前补全的是哪个参数
    if len(args) >= 1:
        # 检查是否在补全rollback的-c/--commit参数
        if args[-2:-1] in (["-c"], ["--commit"]) or cur_arg in ("-c", "--commit"):
            print("\n".join(get_commit_hashes()))
    sys.exit(0)

# 优先处理补全请求
if len(sys.argv) > 1 and sys.argv[1] == "--complete":
    handle_completion()

# 原有argparse逻辑
parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers(dest='command')

rollback = subparsers.add_parser('rollback', help='回滚到之前的提交')
rollback.add_argument('-c', '--commit', dest='incomingCommitHash', default=None, type=str, required=False, help='要部署的提交哈希')

args = parser.parse_args()

# 原有业务逻辑...

2. 编写Bash补全函数 #

创建一个Bash脚本，让它调用你的Python脚本获取补全候选，并关联到你的命令别名：

_module_completion() {
    # 初始化Bash补全环境
    local cur prev words cword
    _init_completion || return

    # 调用Python脚本获取补全候选，传递当前命令行参数
    local candidates=$("${CONDA_PREFIX}/bin/python3" /path/to/your/module.py --complete "${words[@]:0:$cword}")

    # 将候选值返回给Bash补全系统
    COMPREPLY=($(compgen -W "$candidates" -- "$cur"))
    return 0
}

# 将补全函数关联到你的conda环境别名（假设别名是my_module）
complete -F _module_completion my_module

3. 配置conda环境自动加载补全 #

为了让补全在激活conda环境时自动生效，把上面的Bash脚本放到你的conda环境的激活目录中：

1. 找到你的conda环境路径，比如~/miniconda3/envs/your_env/
2. 创建目录etc/conda/activate.d/（如果不存在）
3. 在该目录下创建文件completion.sh，将上面的Bash脚本内容粘贴进去
4. 替换脚本中的/path/to/your/module.py为模块的实际路径，my_module为你的命令别名

注意事项 #

• 如果你的模块是直接通过python3 ./module.py运行，可以把complete命令关联到这个命令，比如complete -F _module_completion python3，但别名方式更贴合你的使用场景。
• get_commit_hashes函数可以根据你的实际需求修改，比如从数据库、配置文件读取候选值，而不是从git获取。

内容的提问来源于stack exchange，提问作者bitbyte