使用argparse获取选定的子命令

Question

当我使用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]是行不通的，因为可能会有全局的参数干扰。我该怎么才能获取到子命令本身呢？

Answer 1

我想分享这个答案，因为它在我最近的工作中非常有用。这个方法使用了装饰器（虽然没有用传统的 @ 语法），特别适合在已经使用 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 函数，将子解析器设置为某个类的属性或全局变量，而不是直接传递它。同时，也可以把它改成一个传统的装饰器来装饰函数，不过那样就需要多加一层。

这样就可以直接引用这个对象了。

Answer 2

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)

Answer 3

在Python文档中关于argparse子命令的最底部，解释了如何做到这一点：

>>> 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()方法，这个方法在我找到的例子上方有提到。