☰

argparse でリストをコマンドライン引数として渡すにはどうすればいいですか? 質問する

tag-icon • tag-icon python argparse
argparse でリストをコマンドライン引数として渡すにはどうすればいいですか? 質問する

コマンドラインプログラムに引数としてリストを渡そうとしています。argparseリストをオプションとして渡すオプションはありますか?

parser.add_argument('-l', '--list',
                      type=list, action='store',
                      dest='list',
                      help='<Required> Set flag',
                      required=True)

スクリプトは以下のように呼び出されます

python test.py -l "265340 268738 270774 270817"

ベストアンサー1

短い答え

nargsオプションまたはオプション'append'の設定を使用しますaction(ユーザー インターフェイスの動作方法によって異なります)。

ナーグス

parser.add_argument('-l','--list', nargs='+', help='<Required> Set flag', required=True)
# Use like:
# python arg.py -l 1234 2345 3456 4567

nargs='+'1 つ以上の引数を取ります。0nargs='*'個以上を取ります。

追加

parser.add_argument('-l','--list', action='append', help='<Required> Set flag', required=True)
# Use like:
# python arg.py -l 1234 -l 2345 -l 3456 -l 4567

appendリストを構築するためにオプションを複数回提供します。

type=list!!!を使用しないでくださいtype=list- !!!を と一緒に使用したい状況はおそらくありませんargparse。

長い答え

これを実現するためのさまざまな方法と最終結果を詳しく見てみましょう。

import argparse

parser = argparse.ArgumentParser()

# By default it will fail with multiple arguments.
parser.add_argument('--default')

# Telling the type to be a list will also fail for multiple arguments,
# but give incorrect results for a single argument.
parser.add_argument('--list-type', type=list)

# This will allow you to provide multiple arguments, but you will get
# a list of lists which is not desired.
parser.add_argument('--list-type-nargs', type=list, nargs='+')

# This is the correct way to handle accepting multiple arguments.
# '+' == 1 or more.
# '*' == 0 or more.
# '?' == 0 or 1.
# An int is an explicit number of arguments to accept.
parser.add_argument('--nargs', nargs='+')

# To make the input integers
parser.add_argument('--nargs-int-type', nargs='+', type=int)

# An alternate way to accept multiple inputs, but you must
# provide the flag once per input. Of course, you can use
# type=int here if you want.
parser.add_argument('--append-action', action='append')

# To show the results of the given option to screen.
for _, value in parser.parse_args()._get_kwargs():
    if value is not None:
        print(value)

期待できる出力は次のとおりです。

$ python arg.py --default 1234 2345 3456 4567
...
arg.py: error: unrecognized arguments: 2345 3456 4567

$ python arg.py --list-type 1234 2345 3456 4567
...
arg.py: error: unrecognized arguments: 2345 3456 4567

$ # Quotes won't help here... 
$ python arg.py --list-type "1234 2345 3456 4567"
['1', '2', '3', '4', ' ', '2', '3', '4', '5', ' ', '3', '4', '5', '6', ' ', '4', '5', '6', '7']

$ python arg.py --list-type-nargs 1234 2345 3456 4567
[['1', '2', '3', '4'], ['2', '3', '4', '5'], ['3', '4', '5', '6'], ['4', '5', '6', '7']]

$ python arg.py --nargs 1234 2345 3456 4567
['1234', '2345', '3456', '4567']

$ python arg.py --nargs-int-type 1234 2345 3456 4567
[1234, 2345, 3456, 4567]

$ # Negative numbers are handled perfectly fine out of the box.
$ python arg.py --nargs-int-type -1234 2345 -3456 4567
[-1234, 2345, -3456, 4567]

$ python arg.py --append-action 1234 --append-action 2345 --append-action 3456 --append-action 4567
['1234', '2345', '3456', '4567']

要点:

  • 使用nargsまたはaction='append'
    • nargsは、ユーザーの観点からはよりわかりやすいですが、位置引数がある場合は、argparse何が位置引数で何が に属するのかがわからないため、直感的ではない可能性があります。nargs位置引数がある場合は、 の方action='append'が良い選択になる可能性があります。
    • 上記は、 、 、または が指定されている場合にのみ当てはまります。などnargsの整数を指定した場合、はオプションに期待される値の数が正確にわかるため、オプションと位置引数を混在させても問題はありません。'*''+''?'4nargsargparse
  • コマンドラインでは引用符を使用しないでください1
  • type=listはリストのリストを返すので 使用しないでください。
    • これは、内部的にはargparseの値を使用して、すべての引数の合計ではなく、選択した個々の引数typeを強制的に適用するために発生します。type
    • type=int(または何でも)を使用してint(または何でも)のリストを取得できます。

1 : 一般的な意味ではありません。引用符を使用してリストを渡すのargparseは望ましくないということです。

おすすめ記事