使用 argparse 获取选定的子命令

当我在 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')

所以 args不包含 'foo'。简单地编写 sys.argv[1]不起作用，因为可能有全局参数。如何获取子命令本身？

62626 次浏览
小开
最佳答案

关于 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')

您还可以使用我找到的示例上面引用的 set_defaults()方法。

小开

ArgumentParser.add_subparsers 将 dest的正式论点描述为:

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

在下面使用子解析器的简单任务函数布局的示例中，选定的子解析器位于 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)
小开

只是想张贴这个答案，因为这在我最近的一些工作中非常方便。这种方法利用了装饰符(尽管不与传统的@语法一起使用) ，如果推荐的 set_defaults已经在子解析器中使用，那么这种方法特别方便。

import argparse
from functools import wraps
import sys


def foo(subparser):
subparser.error('err')


def bar(subparser):
subparser.error('err')


def map_subparser_to_func(func, subparser):
@wraps(func)
def wrapper(*args, **kwargs):
return func(subparser, *args, **kwargs)
return wrapper


parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers()


foo_parser = subparsers.add_parser('foo')
foo_parser.set_defaults(func = map_subparser_to_func(foo, foo_parser))


bar_parser = subparsers.add_parser('bar')
bar_parser.set_defaults(func = map_subparser_to_func(bar, bar_parser))


args = parser.parse_args(sys.argv[1:])
args.func()

可以修改 map_subparser_to_func函数，将子解析器设置为 wrapper函数内部的某个类属性或全局变量，而不是直接传递它，也可以重新设置为函数的常规修饰符，尽管这需要添加另一个层。

这样就有了对对象的直接引用。


提交答案