如果提供了可选参数,则需要命令行参数

时间:2018-09-19 18:54:38

标签: python command-line-arguments argparse optional-arguments

我正在尝试编写一个脚本,用户可以在其中从三个不同的选项中进行选择:

python foo.py 
python foo.py -a
python foo.py -b address_arg data_arg

如果用户选择了最后一个选项,则我需要他们为地址和数据提供两个附加参数。

我目前正在使用它,因此它需要一个参数,例如此处的地址:

parser.add_argument('-b', '--boo', dest='address', type=str, help="Help message")

如果我跑步,哪个会起作用

python foo.py -b 0x00

但是我如何要求用户为数据提供第二个参数?

2 个答案:

答案 0 :(得分:6)

您可以使用nargs=2设置期望的参数个数。

https://docs.python.org/3/library/argparse.html#the-add-argument-method

>>> import argparse
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('-b', '--bar', nargs=2)
_StoreAction(option_strings=['-b', '--bar'], dest='bar', nargs=2, const=None, default=None, type=None, choices=None, help=None, metavar=None)
>>> args = parser.parse_args(['--bar', 'arg1', 'arg2'])
>>> args.bar
['arg1', 'arg2']
>>> args = parser.parse_args(['--bar', 'arg1'])
usage: [-h] [-b BAR BAR]
: error: argument -b/--bar: expected 2 arguments

请注意,此处显示的帮助显示-b BAR BAR,这很烦人(默认情况下它会复制参数名称)。您可以将metavar设置为元组,以针对需要传递的两个参数显示更好的帮助消息。

>>> parser.add_argument('-f', '--foo', nargs=2, metavar=('desc1', 'desc2'))
_StoreAction(option_strings=['-f', '--foo'], dest='foo', nargs=2, const=None, default=None, type=None, choices=None, help=None, metavar=('desc1', 'desc2'))
>>> parser.print_help()
usage: [-h] [-b BAR BAR] [-f desc1 desc2]

optional arguments:
  -h, --help            show this help message and exit
  -b BAR BAR, --bar BAR BAR
  -f desc1 desc2, --foo desc1 desc2

有关更多信息,请参见此处:https://docs.python.org/3/library/argparse.html#metavar

答案 1 :(得分:0)

您在action的{​​{1}}例程中强制执行额外的参数。

在那里,您检查期望的-b的存在和有效性。 仅出于存在性考虑,只需检查参数数量即可。