argparseで選択したサブコマンドを取得する


129

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]グローバル引数が存在する可能性があるため、単純に記述しても機能しません。サブコマンド自体を取得するにはどうすればよいですか?

回答:


184

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()私が見つけた例のすぐ上で参照されているメソッドを使用することもできます。


5
また、required=Trueユーザーにサブコマンドの使用を強制するために追加することも好きです。
ベン

14

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)
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.