升级Click从7.0至8.1.3后Bash补全功能失效求助

问题背景 #

Click 7.0版本下，基于Python开发的show命令Bash补全功能正常工作，环境信息：

• Python 3.9.9
• Click 7.0
• Bash 5.1.8
• Bash-completion 2.11

升级至Click 8.1.3后，命令可正常执行，但Bash补全失效：输入show 按Tab会显示命令帮助，输入show .按Tab会列出当前目录文件，修改原补全配置文件无法解决。

原Python代码 #

import click
@click.group(cls=clicommon.AliasedGroup, context_settings=CONTEXT_SETTINGS)
@click.pass_context
def cli(ctx):
    """SONiC command line - 'show' command"""

    # Load database config files
    load_db_config()
    ctx.obj = Db()

@cli.command()
@click.argument('ipaddress', required=False)
@click.option('-if', '--iface')
@click.option('--verbose', is_flag=True, help="Enable verbose output")
def arp(ipaddress, iface, verbose):
    """Show IP ARP table"""
    cmd = "nbrshow -4"

    if ipaddress is not None:
        cmd += " -ip {}".format(ipaddress)

    if iface is not None:
        if clicommon.get_interface_naming_mode() == "alias":
            if not ((iface.startswith("PortChannel")) or
                    (iface.startswith("eth"))):
                iface = iface_alias_converter.alias_to_name(iface)

        cmd += " -ip {}".format(ipaddress)

    run_command(cmd, display_cmd=verbose)

if __name__ == '__main__':
    cli()

原Bash补全配置 #

_show_completion() {
    COMPREPLY=( $( env COMP_WORDS="${COMP_WORDS[*]}" \
                   COMP_CWORD=$COMP_CWORD \
                   _SHOW_COMPLETE=complete $1 ) )
    return 0
}

complete -F _show_completion -o default show;

原因分析 #

Click 8.x对Bash补全的触发机制和环境变量传递逻辑做了调整，原手动编写的补全函数未适配新版本的变量要求（如缺少COMP_LINE传递），且旧的_SHOW_COMPLETE=complete触发方式不再兼容。

解决方案 #

1. 生成官方适配的补全脚本 #

Click 8.x自带补全脚本生成功能，直接覆盖原配置文件：

show --show-completion bash > /etc/bash_completion.d/show

该命令由show命令自身生成适配当前Click版本的补全逻辑，无需手动编写函数。

2. 重载补全配置 #

执行以下命令使新配置生效，或直接重启终端：

source /etc/bash_completion.d/show

3. 自定义补全函数（备选方案） #

若自动生成的脚本无法满足需求，可修改补全函数以适配Click 8.x：

_show_completion() {
    local cur opts
    cur="${COMP_WORDS[COMP_CWORD]}"
    # 传递Click 8.x所需的环境变量
    opts=$(env COMP_LINE="${COMP_LINE}" COMP_WORDS="${COMP_WORDS[*]}" COMP_CWORD=$COMP_CWORD _SHOW_COMPLETE=bash_complete show)
    COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
    return 0
}

complete -F _show_completion show

额外检查点 #

• 确认clicommon.AliasedGroup自定义组类兼容Click 8.x API，若存在补全逻辑重载，需同步适配新版本。
• 检查CONTEXT_SETTINGS中未设置禁用补全的参数（如disable_completion=True）。

验证 #

1. 输入show 按Tab，应列出子命令（如arp）。
2. 输入show arp --按Tab，应列出--iface、--verbose选项。
3. 输入show arp -按Tab，应列出-if短选项。

若仍有问题，可开启调试模式定位：

export _SHOW_COMPLETE_DEBUG=1

再次尝试补全，查看输出的调试信息排查问题。

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