Python 使用 argparse 获取选定的子命令

声明:本页面是StackOverFlow热门问题的中英对照翻译,遵循CC BY-SA 4.0协议,如果您需要使用它,必须同样遵循CC BY-SA许可,注明原文地址和作者信息,同时你必须将它归于原作者(不是我):StackOverFlow 原文地址: http://stackoverflow.com/questions/4575747/
Warning: these are provided under cc-by-sa 4.0 license. You are free to use/share it, But you must attribute it to the original authors (not me): StackOverFlow

提示:将鼠标放在中文语句上可以显示对应的英文。显示中英文
时间:2020-08-18 16:24:02  来源:igfitidea点击:

Get selected subcommand with argparse

pythoncommand-lineargparse

提问by Adam Schmideg

When I use subcommands with python argparse, I can get the selected arguments.

当我将子命令与 python argparse 一起使用时,我可以获得选定的参数。

parser = argparse.ArgumentParser()
parser.add_argument('-g', '--global')
subparsers = parser.add_subparsers()   
foo_parser = subparsers.add_parser('foo')
foo_parser.add_argument('-c', '--count')
bar_parser = subparsers.add_parser('bar')
args = parser.parse_args(['-g, 'xyz', 'foo', '--count', '42'])
# args => Namespace(global='xyz', count='42')

So argsdoesn't contain 'foo'. Simply writing sys.argv[1]doesn't work because of the possible global args. How can I get the subcommand itself?

所以args不包含'foo'. sys.argv[1]由于可能的全局参数,简单地编写是行不通的。我怎样才能获得子命令本身?

采纳答案by robert

The very bottom of the Python docs on argparse sub-commandsexplains how to do this:

关于 argparse 子命令Python 文档的最底部解释了如何执行此操作:

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('-g', '--global')
>>> subparsers = parser.add_subparsers(dest="subparser_name") # this line changed
>>> foo_parser = subparsers.add_parser('foo')
>>> foo_parser.add_argument('-c', '--count')
>>> bar_parser = subparsers.add_parser('bar')
>>> args = parser.parse_args(['-g', 'xyz', 'foo', '--count', '42'])
>>> args
Namespace(count='42', global='xyz', subparser_name='foo')

You can also use the set_defaults()method referenced just above the example I found.

您还可以使用set_defaults()我发现的示例上方引用的方法。

回答by saaj

ArgumentParser.add_subparsershas destformal argument described as:

ArgumentParser.add_subparsersdest正式的论证描述为:

dest- name of the attribute under which sub-command name will be stored; by default Noneand no value is stored

dest- 将存储子命令名称的属性名称;默认情况下None,不存储任何值

In the example below of a simple task function layout using subparsers, the selected subparser is in parser.parse_args().subparser.

在下面使用子解析器的简单任务函数布局示例中,选定的子解析器位于parser.parse_args().subparser.

import argparse


def task_a(alpha):
    print('task a', alpha)


def task_b(beta, gamma):
    print('task b', beta, gamma)


if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    subparsers = parser.add_subparsers(dest='subparser')

    parser_a = subparsers.add_parser('task_a')
    parser_a.add_argument(
        '-a', '--alpha', dest='alpha', help='Alpha description')

    parser_b = subparsers.add_parser('task_b')
    parser_b.add_argument(
        '-b', '--beta', dest='beta', help='Beta description')
    parser_b.add_argument(
        '-g', '--gamma', dest='gamma', default=42, help='Gamma description')

    kwargs = vars(parser.parse_args())
    globals()[kwargs.pop('subparser')](**kwargs)