使用argparse的Python脚本Shell补全异常问题求助

问题场景 #

我用Python的argparse模块写了如下脚本：

import argparse

def get_info(line: str) -> tuple:
    print(line.split("|"))
    
def main():
    p = argparse.ArgumentParser()

    p.add_argument("-f", "--file")
    p.add_argument("-d", "--directory")
    p.add_argument("-o", "--output",
                    default="stdout",
                    required=False)
                    
    args = p.parse_args()

if __name__ == "__main__":
    main()

执行python script.py path/to/my/按Tab时，能正常显示文件和目录候选；但用短选项-f执行python script.py -f path/to/my/按Tab时，只补全目录、忽略文件；用长选项--file则恢复正常。这是Shell问题还是Python问题？

结论与原因 #

这是Shell的自动补全规则导致的问题，和Python本身无关。

大部分主流Shell（比如Bash、Zsh）的自动补全逻辑里，对于短选项的参数补全，默认会根据选项的语义猜测补全类型。这里脚本同时有-d/--directory（目录选项）和-f/--file（文件选项），Shell的补全脚本可能把短选项-f和-d的补全规则混淆，或者默认对短选项-f套用了目录补全的规则。

而长选项--file因为名称明确，Shell能准确识别出这是需要补全文件和目录的参数，所以表现正常。

如果要解决这个问题，需要给Shell的自动补全脚本添加明确规则，指定-f选项的参数需要补全文件和目录，而非仅目录。

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