基于另一个参数向 argparse 添加参数的 Pythonic 方式

Question

在主函数中，我有一个验证可选输入的解析器：

def main():
    parser = argparse.ArgumentParser()
    parser.add_argument('--platform',required=True)
    parser.add_argument('--foo')
    parser.add_argument('--bar')
    parser.add_argument('--baz')
    parser.parse_args()

上面的 sn-p 是一个示例，仅当我提供 --platform 和 --foo,--bar 时才有效或 --baz.

这段代码被不同的组件使用，我们称它们为组件A、B和C。

组件A实际上只指定了--foo和--bar：

python script.py --platform A --foo first_example --bar first_example

组件B实际上只指定了--bar和--baz：

python script.py --platform B --bar second_example --baz second_exmaple

组件C其实只指定--baz：

python script.py --platform C --baz third_example

随着我引入更多提供不同参数的组件，我必须添加到解析器的参数数量增加。以上只是一个例子，我目前正在处理大约 20 个参数（将来可能会更多）。

我一直在考虑创建一个配置文件 (.yaml)，在其中定义每个组件需要哪些参数：

# parameters.yaml
A:
  - foo
  - bar

B:
  - bar
  - baz

C:
  - baz

我想简化主函数以查看 --platform 参数，并根据作为参数传递的平台，读取配置并向解析器添加其他参数。

这是我尝试过的：

def main():
    parser = argparse.ArgumentParser()
    parser.add_argument('--platform',required=True)
    
    # Read from .yaml file
    with open('parameters.yaml') as parameter_file:
        parameters = yaml.safe_load(parameter_file)
    
    for argument in parameters[sys.argv[sys.argv.index('--platform') + 1]]:
        parser.add_argument(
           '--' + argument
    )

    parser.parse_args()

调用函数：

python script.py --platform C --baz third_example

上面的代码有效，但我正在寻找其他 Pythonic 解决方案，因为我是 Python 的初学者。一世 不太喜欢查看 sys.argv 来确定指定的 --platform 是什么。有没有更好的办法解决这个问题？

Answer 1

使用断言。

如果要禁止某些参数，可以添加assert。例子：

parser = argparse.ArgumentParser()
parser.add_argument('--platform',required=True)
parser.add_argument('--foo')
parser.add_argument('--bar')
parser.add_argument('--baz')
args = parser.parse_args()

if args.platform == 'A':
    assert args.baz is None, "no argument baz for the platform A"
...

使用 del

排除不需要的参数，用del:

parser = argparse.ArgumentParser()
parser.add_argument('--platform',required=True)
parser.add_argument('--foo')
parser.add_argument('--bar')
parser.add_argument('--baz')
args = parser.parse_args()

if args.platform == 'A':
    del args.baz
...

---

我不建议您在同一个脚本中使用 argparse 和 sys.argv，因为在您的情况下它们的目的相同。最好选择其中之一。

argparge 在您的脚本知道值之前解析您的参数。因此，您不能根据其中一个参数的值来更改参数列表。因此，如果您想保留argparse，则必须使用.add_argument 添加整个参数集，并在获取值时在下面做一些额外的事情。

Answer 2

使用子解析器作为子命令：

import argparse

def run_command(parser, args):
    if args.command == 'A':
        print(args)
    elif args.command == 'B':
        print(args)
    elif args.command == 'C':
        print(args)

parser = argparse.ArgumentParser(
    prog='PROG', 
    epilog="See '<command> --help' to read about a specific sub-command."
)
subparsers = parser.add_subparsers(dest='command', help='Sub-commands')

A_parser = subparsers.add_parser('A', help='Platform A')
A_parser.add_argument("--foo")
A_parser.add_argument('--bar')
A_parser.set_defaults(func=run_command)

B_parser = subparsers.add_parser('B', help='Platform B')
B_parser.add_argument('--bar')
B_parser.add_argument('--baz')
B_parser.set_defaults(func=run_command)

C_parser = subparsers.add_parser('C', help='Platform C')
C_parser.add_argument('--baz')
C_parser.set_defaults(func=run_command)

args = parser.parse_args()
if args.command is not None:
    args.func(parser, args)
else:
    parser.print_help()

这会生成：

~ python args.py -h
usage: PROG [-h] {A,B,C} ...

positional arguments:
  {A,B,C}     Sub-commands
    A         Platform A
    B         Platform B
    C         Platform C

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

See '<command> --help' to read about a specific sub-command.

和

~ python args.py B -h
usage: PROG B [-h] [--bar BAR] [--baz BAZ]

optional arguments:
  -h, --help  show this help message and exit
  --bar BAR
  --baz BAZ