23

我花了一些时间在 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"))

我希望第一个参数是一个字符串(type str)并且是强制性的,而第二个参数应该是 type int,如果没有给出值,则有一个默认值(比如说default=50)。当只需要一个参数时,我知道该怎么做,但是当 nargs=2 时我不知道如何进行……这可能吗?

4

5 回答 5

21

您可以执行以下操作。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
于 2013-06-06T10:37:05.643 回答
10

我倾向于同意迈克的解决方案,但这是另一种方式。这并不理想,因为用法/帮助字符串告诉用户使用 1 个或多个参数。

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
于 2013-06-06T11:19:05.280 回答
2

我建议使用两个参数:

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
于 2013-06-06T10:24:24.507 回答
2

抱歉迟到了。我会使用一个函数来调用类型。

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"))
于 2019-04-25T21:42:46.307 回答
0

我有一个类似的问题,但是“使用两个参数”方法对我不起作用,因为我需要一个配对列表:parser.add_argument('--replace', nargs=2, action='append')如果我使用单独的参数,那么我将不得不验证列表的长度等。这是我所做的:

  1. 用于正确显示帮助:导致帮助字符串显示tuple为. 它已记录在案,但在尝试不同的选项之前我找不到它。metavartuple=('OLD', 'NEW')--replace OLD NEW
  2. 使用自定义验证:在 之后parse_args,验证结果列表的项目并parser.error()在出现问题时调用。那是因为它们有不同的数据类型。
于 2019-08-09T13:38:41.767 回答