如何让argparse参数选项与对应帮助说明显示在同一行

argparse默认的帮助格式化类HelpFormatter中，max_help_position默认值偏小，也就是帮助说明文本的起始位置距离行首的预留宽度不足。当参数选项（和metavar拼接后的完整字符串）长度超过预留宽度时，格式化器会自动把对应的帮助说明折到下一行显示，就出现了你看到的换行效果。

初始化ArgumentParser时传入自定义的格式化类，调大max_help_position的数值，让预留宽度足够容纳最长的参数选项字符串即可。
参考代码如下：

import argparse

# max_help_position可根据你自己的最长参数长度调整，数值大于所有参数选项的总长度就不会折行
parser = argparse.ArgumentParser(
    formatter_class=lambda prog: argparse.HelpFormatter(prog, max_help_position=28)
)

parser.add_argument("--hello", type=str, metavar="{greetings}", help="prints hello")

修改后运行python main.py -h，输出效果就和你预期的一致：

optional arguments:
  -h, --help            show this help message and exit
  --hello {greetings}   prints hello

注意：如果后续新增了更长的参数（比如带长参数名、长metavar的参数），只需要对应调大max_help_position的数值即可。

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