我将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)
处取消注释,则该行将按预期工作。
这是怎么回事?
答案 0 :(得分:2)
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
类创建。当该类在创建过程中添加“ -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
)是一个坏主意。次解析器值(甚至是默认值)占主导。
您的版本(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')
或者,您可以将主解析器设为常规类,将子解析器设为自定义类。