Argparse：“可选参数”下列出了必需参数吗？

我使用下面的简单代码来解析一些参数。请注意，其中之一是必需的。不幸的是，当用户在不提供参数的情况下运行脚本时，显示的用法/帮助文本并不表示存在一个非可选的参数，我感到非常困惑。如何获取python以指示参数不是可选的？

这是代码：

import argparse
if __name__ == '__main__':
    parser = argparse.ArgumentParser(
        description='Foo')
    parser.add_argument('-i','--input', help='Input file name', required=True)
    parser.add_argument('-o','--output', help='Output file name', default="stdout")
    args = parser.parse_args()
    print ("Input file: %s" % args.input )
    print ("Output file: %s" % args.output )

在不提供必需参数的情况下运行上述代码时，得到以下输出：

usage: foo.py [-h] -i INPUT [-o OUTPUT]

Foo

optional arguments:
    -h, --help            show this help message and exit
    -i INPUT, --input INPUT
                          Input file name
    -o OUTPUT, --output OUTPUT
                          Output file name

以-或开头的参数--通常被认为是可选的。所有其他参数都是位置参数，因此是设计所必需的（例如位置函数自变量）。可能需要可选参数，但这有点违背其设计。由于它们仍然是非位置参数的一部分，因此即使需要它们，它们仍将列在令人困惑的标题“可选参数”下。但是，用法部分缺少的方括号表明确实需要它们。

另请参阅文档：

通常，argparse模块假定-f和--bar之类的标志表示可选参数，在命令行中始终可以将其省略。

注意：必需的选项通常被认为是错误的格式，因为用户期望选项是可选的，因此应尽可能避免使用。

就是说，帮助中的标头“位置参数”和“可选参数”是由两个参数组生成的，参数被自动分成两个。现在，您可以“破解”并更改可选参数的名称，但是一种更为优雅的解决方案是为“必需的命名参数”（或您要调用的任何参数）创建另一个组：

parser = argparse.ArgumentParser(description='Foo')
parser.add_argument('-o', '--output', help='Output file name', default='stdout')
requiredNamed = parser.add_argument_group('required named arguments')
requiredNamed.add_argument('-i', '--input', help='Input file name', required=True)
parser.parse_args(['-h'])

usage: [-h] [-o OUTPUT] -i INPUT

Foo

optional arguments:
  -h, --help            show this help message and exit
  -o OUTPUT, --output OUTPUT
                        Output file name

required named arguments:
  -i INPUT, --input INPUT
                        Input file name

由于我倾向于在可选参数之前列出必需的参数，因此我通过以下方法解决了这个问题：

    parser = argparse.ArgumentParser()
    parser._action_groups.pop()
    required = parser.add_argument_group('required arguments')
    optional = parser.add_argument_group('optional arguments')
    required.add_argument('--required_arg', required=True)
    optional.add_argument('--optional_arg')
    return parser.parse_args()

并输出：

usage: main.py [-h] [--required_arg REQUIRED_ARG]
               [--optional_arg OPTIONAL_ARG]

required arguments:
  --required_arg REQUIRED_ARG

optional arguments:
  --optional_arg OPTIONAL_ARG

我可以在可选参数组中不显示“帮助”的情况下生活。

从@Karl Rosaen建造

parser = argparse.ArgumentParser()
optional = parser._action_groups.pop() # Edited this line
required = parser.add_argument_group('required arguments')
# remove this line: optional = parser...
required.add_argument('--required_arg', required=True)
optional.add_argument('--optional_arg')
parser._action_groups.append(optional) # added this line
return parser.parse_args()

并输出：

usage: main.py [-h] [--required_arg REQUIRED_ARG]
           [--optional_arg OPTIONAL_ARG]

required arguments:
  --required_arg REQUIRED_ARG

optional arguments:
  -h, --help                    show this help message and exit
  --optional_arg OPTIONAL_ARG

再过一次，以@RalphyZ为基础

这个不会破坏公开的API。

from argparse import ArgumentParser, SUPPRESS
# Disable default help
parser = ArgumentParser(add_help=False)
required = parser.add_argument_group('required arguments')
optional = parser.add_argument_group('optional arguments')

# Add back help 
optional.add_argument(
    '-h',
    '--help',
    action='help',
    default=SUPPRESS,
    help='show this help message and exit'
)
required.add_argument('--required_arg', required=True)
optional.add_argument('--optional_arg')

它将显示与上面相同的内容，并且应该在将来的版本中保留下来：

usage: main.py [-h] [--required_arg REQUIRED_ARG]
           [--optional_arg OPTIONAL_ARG]

required arguments:
  --required_arg REQUIRED_ARG

optional arguments:
  -h, --help                    show this help message and exit
  --optional_arg OPTIONAL_ARG