Question

我有一个名为program.py的程序，我使用argparse来进行参数解析。

我想要运行此二进制文件的两种模式： 1）模拟，不需要参数 2）非模拟，需要很多参数

我希望程序接受

python program --simulation

或

python program arg1 arg2 arg3 arg4

需要所有'args'。

我认为这样做的唯一方法是在所有字段中添加'required = False'并手动检查逻辑，但我想知道是否有更优雅的方式。

这是我所拥有的代码的简化版本

def get_args():
    parser = argparse.ArgumentParser(description = "program")
    parser.add_argument("arg1", type = bool)
    parser.add_argument("arg2" ,type = str)
    parser.add_argument("arg3", type = int)
    parser.add_argument("arg4", type = str)
    parser.add_argument("--simulation")
    args = parser.parse_args()
    return args

Answer 1

argparse不能那么聪明。但是，在您的简单情况下，您可以“帮助”它来选择正确的解析选项：

def get_args(args=sys.argv[1:]):
    parser = argparse.ArgumentParser(description = "program")
    if args and args[0].startswith("--"):
        parser.add_argument("--simulation")
    else:
        parser.add_argument("arg1", type = bool)
        parser.add_argument("arg2" ,type = str)
        parser.add_argument("arg3", type = int)
        parser.add_argument("arg4", type = str)
    args = parser.parse_args(args=args)
    return args

所以print(get_args("--simulation xx".split()))产生：

Namespace(simulation='xx')

因为第一个参数以--开头。任何其他选项都无法按预期进行命令行解析。

和print(get_args("True foo 3 bar".split()))产生：

Namespace(arg1=True, arg2='foo', arg3=3, arg4='bar')

忘记4个位置参数中的一个会导致命令行解析失败。

BTW，我添加了一个默认参数，如果省略，则从系统参数中读取（就像在代码中一样）。否则，您可以从文本文件中读取并传递args标记。因此，更容易测试，并创建可以使用其他模块中的参数调用的模块，而无需破解sys.argv。

Answer 2

这显然是argparse的一个尴尬规范，我怀疑大多数其他POSIX样式解析器。

扫描sys.argv并调整解析器定义是一种可行的方法。

另一个是使用2阶段解析器，parse_known_args：

import argparse
usage = 'prog [-h] [--simulation] [arg1 arg2 arg3 arg4]'
parser1 = argparse.ArgumentParser(usage=usage)
parser1.add_argument('--simulation', action='store_true')
# or omit the `store_true` if it just takes one argument
# other possible optionals

parser2 = argparse.ArgumentParser()
#parser2.add_argument("arg1", type = bool)  # not a valid type parameter
parser2.add_argument("arg2" )
parser2.add_argument("arg3", type = int)
parser2.add_argument("arg4")
# positionals are required, unless nargs=? or *

args, extras = parser1.parse_known_args()
if not args.simulation:
    args = parser2.parse_args(extras, namespace=args)
elif extras:
    parser1.error('cannot use --simulation with args')
print(args)

可能的运行包括：

1526:~/mypy$ python stack41556997.py -h
usage: prog [-h] [--simulation] [arg1 arg2 arg3 arg4]

optional arguments:
  -h, --help    show this help message and exit
  --simulation

1526:~/mypy$ python stack41556997.py --simulation
Namespace(simulation=True)

1527:~/mypy$ python stack41556997.py 1 2 3
Namespace(arg2='1', arg3=2, arg4='3', simulation=False)

1527:~/mypy$ python stack41556997.py 1 2 3 --sim
usage: prog [-h] [--simulation] [arg1 arg2 arg3 arg4]
stack41556997.py: error: cannot use --simulation with args

请注意，帮助不包括这两个集。我在自定义用法中包含了一些信息，但arg#没有帮助行。根据您的规范生成好的help消息会很尴尬。

我跳过你的arg1。 type=bool不是有效的type参数。请参阅Parsing boolean values with argparse

上的说明

我将--simulation更改为store_true，因为您说它没有任何参数。这是接受真/假的正常方式。

Subparsers通常是接受不同模式参数的最佳工具。在这种情况下，你可以有一个名为'simulate'的子分析器，不需要任何参数，另一个叫'somethingelse'，需要4个位置。

我打算建议一个包含--simulation和--other选项的mutual_exclusive_group。但是store_true参数在这样的组中不起作用。

=============

subsparser路线：

parser = argparse.ArgumentParser()
sp = parser.add_subparsers(dest='cmd')
sp.add_parser('simulate')
parser2 = sp.add_parser('other')
parser2.add_argument("arg2" )
parser2.add_argument("arg3", type = int)
parser2.add_argument("arg4")
print(parser.parse_args())

测试：

1552:~/mypy$ python stack41556997.py -h
usage: stack41556997.py [-h] {simulate,other} ...

positional arguments:
  {simulate,other}

optional arguments:
  -h, --help        show this help message and exit
1557:~/mypy$ python stack41556997.py simulate
Namespace(cmd='simulate')
1557:~/mypy$ python stack41556997.py other -h
usage: stack41556997.py other [-h] arg2 arg3 arg4

positional arguments:
  arg2
  arg3
  arg4

optional arguments:
  -h, --help  show this help message and exit
1557:~/mypy$ python stack41556997.py other 1 2 3
Namespace(arg2='1', arg3=2, arg4='3', cmd='other')

请注意，arg3 type将输入转换为整数。其他人留下了字符串。使用此设置args.cmd将是subparser的名称，与布尔args.simulation属性不完全相同。

==================

默认情况下，不需要标记的参数。除非nargs值为'？'，否则需要位置参数要么 '*'。您无法为位置提供“必需”参数。

Answer 3

一种稍微简单的方法，假设您很高兴在给定--simulation参数时忽略任何多余的参数，就像这样：

parser = argparse.ArgumentParser(description = "program")
parser.add_argument("arg1", type = bool)
parser.add_argument("arg2" ,type = str)
parser.add_argument("arg3", type = int)
parser.add_argument("arg4", type = str)
parser.add_argument("--simulation")

if "--simulation" in sys.argv:
    simulation()
else:
    args = parser.parse_args()
    main(args)

Python argparse - 不同的选项集

3 个答案: