我花了一些时间在argparse文档上,但是我仍在努力使用这个模块在我的程序中选择一个选项:
parser.add_argument("-r", "--rmsd", dest="rmsd", nargs=2,
help="extract the poses that are close from a ref according RMSD",
metavar=("ref","rmsd"))
我希望第一个参数是一个字符串(类型str
)和必需的,而第二个参数应该具有类型int
,如果没有给出值,则具有默认值(让我们说default=50
)。我知道当预期只有一个参数时如何做到这一点,但我不知道当nargs = 2时如何进行......这是否可能?
答案 0 :(得分:14)
您可以执行以下操作。 required
关键字将字段设置为必填字段,default=50
将选项的默认值设置为50(如果未指定):
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-s", "--string", type=str, required=True)
parser.add_argument("-i", "--integer", type=int, default=50)
args = parser.parse_args()
print args.string
print args.integer
输出:
$ python arg_parser.py -s test_string
test_string
50
$ python arg_parser.py -s test_string -i 100
test_string
100
$ python arg_parser.py -i 100
usage: arg_parser.py [-h] -s STRING [-i INTEGER]
arg_parser.py: error: argument -s/--string is required
答案 1 :(得分:7)
我倾向于同意Mike的解决方案,但这是另一种方式。它并不理想,因为用法/帮助字符串告诉用户使用一个或多个参数。
import argparse
def string_integer(int_default):
"""Action for argparse that allows a mandatory and optional
argument, a string and integer, with a default for the integer.
This factory function returns an Action subclass that is
configured with the integer default.
"""
class StringInteger(argparse.Action):
"""Action to assign a string and optional integer"""
def __call__(self, parser, namespace, values, option_string=None):
message = ''
if len(values) not in [1, 2]:
message = 'argument "{}" requires 1 or 2 arguments'.format(
self.dest)
if len(values) == 2:
try:
values[1] = int(values[1])
except ValueError:
message = ('second argument to "{}" requires '
'an integer'.format(self.dest))
else:
values.append(int_default)
if message:
raise argparse.ArgumentError(self, message)
setattr(namespace, self.dest, values)
return StringInteger
然后,你得到:
>>> import argparse
>>> parser = argparse.ArgumentParser(description="")
parser.add_argument('-r', '--rmsd', dest='rmsd', nargs='+',
... action=string_integer(50),
... help="extract the poses that are close from a ref "
... "according RMSD")
>>> parser.parse_args('-r reference'.split())
Namespace(rmsd=['reference', 50])
>>> parser.parse_args('-r reference 30'.split())
Namespace(rmsd=['reference', 30])
>>> parser.parse_args('-r reference 30 3'.split())
usage: [-h] [-r RMSD [RMSD ...]]
: error: argument -r/--rmsd: argument "rmsd" requires 1 or 2 arguments
>>> parser.parse_args('-r reference 30.3'.split())
usage: [-h] [-r RMSD [RMSD ...]]
: error: argument -r/--rmsd: second argument to "rmsd" requires an integer
答案 2 :(得分:1)
我建议使用两个参数:
import argparse
parser = argparse.ArgumentParser(description='Example with to arguments.')
parser.add_argument('-r', '--ref', dest='reference', required=True,
help='be helpful')
parser.add_argument('-m', '--rmsd', type=int, dest='reference_msd',
default=50, help='be helpful')
args = parser.parse_args()
print args.reference
print args.reference_msd
答案 3 :(得分:0)
抱歉,您跳得太晚了。我会使用函数进行类型调用。
def two_args_str_int(x):
try:
return int(x)
except:
return x
parser.add_argument("-r", "--rmsd", dest="rmsd", nargs=2, type=two_args_str_int
help="extract the poses that are close from a ref according RMSD",
metavar=("ref","rmsd"))
答案 4 :(得分:0)
我有一个类似的问题,但是“使用两个参数”方法对我不起作用,因为我需要一个成对的列表:parser.add_argument('--replace', nargs=2, action='append')
,如果我使用单独的参数,则必须验证列表的长度等等
这是我所做的:
tuple
使用metavar
正确显示帮助:tuple=('OLD', 'NEW')
导致帮助字符串显示为--replace OLD NEW
。它已记录在案,但直到尝试其他选项后我才能找到它。parse_args
之后,验证结果列表中的项目,如果发现错误,请致电parser.error()
。那是因为它们具有不同的数据类型。