Python 3.6 argparse指定choices后参数名未在帮助菜单显示的问题

哈哈，这个坑我之前踩过！在Python 3.6里用argparse给参数指定choices属性后，默认的帮助输出确实会把所有选项直接替换掉原本的参数名，导致菜单既臃肿又看不到参数标识，光靠nargs（你说的numargs应该是这个）确实解决不了核心问题，得换个思路调整metavar和帮助文本的写法。

问题根源 #

当你给参数设置choices后，argparse默认会把选项列表直接放在参数的位置占位符上，比如你定义--fruit的choices是一堆水果，帮助菜单就会显示--fruit {apple,banana,...}，完全替换了原本应该显示的参数名（比如FRUIT）。

正确解决方案 #

核心是用metavar指定你想显示的参数名，同时把选项说明移到help字段里，不让argparse自动展开选项列表：

基础优化版

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('--fruit',
                    choices=['apple', 'banana', 'cherry', 'date', 'elderberry', 'fig', 'grape'],
                    metavar='FRUIT',  # 指定帮助里显示的参数名
                    help='可选水果列表：apple, banana, cherry, date, elderberry, fig, grape')
args = parser.parse_args()

运行--help后，会看到--fruit FRUIT，参数名正常显示，而选项列表放在帮助文本里，既清晰又整洁。

进阶格式化版（选项特别多时）

如果选项数量很多，还可以用RawTextHelpFormatter来让帮助文本里的选项分行显示，可读性更强：

import argparse
from argparse import RawTextHelpFormatter

parser = argparse.ArgumentParser(formatter_class=RawTextHelpFormatter)
parser.add_argument('--fruit',
                    choices=['apple', 'banana', 'cherry', 'date', 'elderberry', 'fig', 'grape'],
                    metavar='FRUIT',
                    help='可选水果列表：\n- apple\n- banana\n- cherry\n- date\n- elderberry\n- fig\n- grape')
args = parser.parse_args()

这样帮助文本里的选项会以列表形式分行展示，不会挤成一团。

为什么之前用nargs没用？ #

nargs是用来控制参数接受的输入数量（比如接受多个值），和帮助菜单里的参数名显示完全无关。要解决参数名不显示的问题，关键是用metavar覆盖默认的选项列表占位符，同时把选项说明转移到help中。

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