web-dev-qa-db-ja.com

Pythonのargparseで同じオプションを複数回使用する

複数の入力ソースを受け入れ、それぞれに対して何かを行うスクリプトを作成しようとしています。このようなもの

./my_script.py \
    -i input1_url input1_name input1_other_var \
    -i input2_url input2_name input2_other_var \
    -i input3_url input3_name
# notice inputX_other_var is optional

ただし、argparseを使用してこれを行う方法はわかりません。各オプションフラグは1回しか使用できないように設定されているようです。複数の引数を単一のオプション(nargs='*'またはnargs='+')に関連付ける方法は知っていますが、それでも-iフラグを複数回使用することはできません。これを達成するにはどうすればよいですか?

明確にするために、私が最後に望むのは、文字列のリストのリストです。そう

[["input1_url", "input1_name", "input1_other"],
 ["input2_url", "input2_name", "input2_other"],
 ["input3_url", "input3_name"]]
52
John Allard

繰り返しの2つの引数をオプションで処理するパーサーを次に示します。名前はmetavarで定義されています。

parser=argparse.ArgumentParser()
parser.add_argument('-i','--input',action='append',nargs=2,
    metavar=('url','name'),help='help:')

In [295]: parser.print_help()
usage: ipython2.7 [-h] [-i url name]

optional arguments:
  -h, --help            show this help message and exit
  -i url name, --input url name
                        help:

In [296]: parser.parse_args('-i one two -i three four'.split())
Out[296]: Namespace(input=[['one', 'two'], ['three', 'four']])

これは2 or 3 argumentの場合を処理しません(そのような範囲を処理するPythonバグ/問題のためにしばらく前にパッチを書きましたが)。

nargs=3metavar=('url','name','other')を使用した個別の引数定義はどうですか?

タプルmetavarは、nargs='+'およびnargs='*'でも使用できます。 2つの文字列は[-u A [B ...]]または[-u [A [B ...]]]として使用されます。

63
hpaulj

-iは、3つの引数を受け入れ、appendアクションを使用するように構成する必要があります。

>>> p = argparse.ArgumentParser()
>>> p.add_argument("-i", nargs=3, action='append')
_AppendAction(...)
>>> p.parse_args("-i a b c -i d e f -i g h i".split())
Namespace(i=[['a', 'b', 'c'], ['d', 'e', 'f'], ['g', 'h', 'i']])

オプションの値を処理するには、単純なカスタムタイプを使用してみてください。この場合、-iへの引数は、カンマで区切られた単一の文字列で、分割数は2に制限されます。値を後処理して、少なくとも2つの値が指定されるようにする必要があります。

>>> p.add_argument("-i", type=lambda x: x.split(",", 2), action='append')
>>> print p.parse_args("-i a,b,c -i d,e -i g,h,i,j".split())
Namespace(i=[['a', 'b', 'c'], ['d', 'e'], ['g', 'h', 'i,j']])

さらに制御するには、カスタムアクションを定義します。これは、組み込みの_AppendActionaction='append'で使用)を拡張しますが、-iに指定された引数の数を範囲チェックするだけです。

class TwoOrThree(argparse._AppendAction):
    def __call__(self, parser, namespace, values, option_string=None):
        if not (2 <= len(values) <= 3):
            raise argparse.ArgumentError(self, "%s takes 2 or 3 values, %d given" % (option_string, len(values)))
        super(TwoOrThree, self).__call__(parser, namespace, values, option_string)

p.add_argument("-i", nargs='+', action=TwoOrThree)
16
chepner

これは簡単です。 action='append'nargs='*'(または'+')の両方を追加するだけです。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument('-i', action='append', nargs='+')
args = parser.parse_args()

それを実行すると、次のようになります

In [32]: run test.py -i input1_url input1_name input1_other_var -i input2_url i
...: nput2_name input2_other_var -i input3_url input3_name

In [33]: args.i
Out[33]:
[['input1_url', 'input1_name', 'input1_other_var'],
 ['input2_url', 'input2_name', 'input2_other_var'],
 ['input3_url', 'input3_name']]
13
Amir