python - 子类化 argparse.ArgumentParser 会产生奇怪的行为

Question

我正在对 ArgumentParser 进行子类化，以便我可以干掉我在包中的多个命令中的通用代码。但是，我遇到了一些我无法解释的奇怪行为。
查看我的程序的这个非常简化的版本，并注意末尾带有注释的两行:

class Parser(argparse.ArgumentParser):
    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self._add_common_args() # (1)

    def _add_common_args(self):
        self.add_argument('-s', '--stage', required=True, type=str.lower)

    def parse(self):
        return self.parse_args(['--stage', 'alpha', 'list-services'])

parser = Parser(prog='my_prog')
# parser._add_common_args() # (2)

subparsers = parser.add_subparsers(dest='resource')
subparsers.required = True

services_parser = subparsers.add_parser('list-services')

parser.parse()

如果我运行这个，程序返回

usage: my_prog list-services [-h] -s STAGE
my_prog list-services: error: the following arguments are required: -s/--stage

但是，如果我注释掉 (1) 处的行并取消注释 (2) 处的行，它按预期工作。
这里发生了什么？

Answer 1

In [3]: parser.print_help()
usage: my_prog [-h] -s STAGE {list-services} ...

positional arguments:
  {list-services}

optional arguments:
  -h, --help            show this help message and exit
  -s STAGE, --stage STAGE

查看 services_parser的帮助:

In [4]: services_parser.print_help()
usage: my_prog list-services [-h] -s STAGE

optional arguments:
  -h, --help            show this help message and exit
  -s STAGE, --stage STAGE

使用自定义 Parser 创建的两个解析器类(class)。当该类添加“-s”作为创建的一部分时，两者都会得到该操作:

In [5]: type(parser)
Out[5]: __main__.Parser
In [6]: type(services_parser)
Out[6]: __main__.Parser

因此，您必须在两者中都提供该参数 - 但第二个会覆盖第一个:

In [7]: parser.parse_args('-s foo list-services -s other'.split())
Out[7]: Namespace(resource='list-services', stage='other')

通常，在两者中使用相同的参数(具有相同的 dest )是一个坏主意。 subparser 值(甚至是默认值)占主导地位。
您的版本 (2) 仅在主版本上设置了“-s”。
如果我指定一个替代 parser_class ，只有主解析器获得“-s”:

subparsers = parser.add_subparsers(dest='resource', 
     parser_class=argparse.ArgumentParser)

In [9]: type(services_parser)
Out[9]: argparse.ArgumentParser
In [12]: parser.parse()
Out[12]: Namespace(resource='list-services', stage='alpha')

或者，您可以将主解析器设为常规类，将子解析器设为自定义类。