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"

TL; DR

使用する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つ以上の引数をnargs='*'取り、0以上を取ります。

追加する

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与えられている'*'、'+'または'?'。整数などを指定した場合（など4）、オプションに予想される値の数が正確にわかるnargsため、オプションと位置引数を混在させることは問題ありませんargparse。
• コマンドラインで引用符を使用しないでください¹
• 使わない type=listリストのリストを返す、
  • これは、フードの下でのargparse値を使用して、選択した引数を指定された各個人typeに強制するために発生しますtype、すべての引数の集計ではなく、します。
  • type=int（または何でも）を使用して、int（または何でも）のリストを取得できます。

¹：私は一般的には意味しません。.引用符を使用してリストを渡すことargparseは、あなたが望むものではないことを意味します。

スクリプトで後で解析する区切られた文字列を渡すことを好みます。この理由は次のとおりです。リストは任意のタイプintまたはstrにnargsすることができ、複数のオプションの引数と位置引数がある場合、使用すると問題が発生することがあります。

parser = ArgumentParser()
parser.add_argument('-l', '--list', help='delimited list input', type=str)
args = parser.parse_args()
my_list = [int(item) for item in args.list.split(',')]

そして、

python test.py -l "265340,268738,270774,270817" [other arguments]

または、

python test.py -l 265340,268738,270774,270817 [other arguments]

正常に動作します。区切り文字もスペースにすることができますが、質問の例のように、引数値を引用符で囲みます。

に加えてnargs、choices事前にリストを知っている場合は、次のように使用できます。

>>> parser = argparse.ArgumentParser(prog='game.py')
>>> parser.add_argument('move', choices=['rock', 'paper', 'scissors'])
>>> parser.parse_args(['rock'])
Namespace(move='rock')
>>> parser.parse_args(['fire'])
usage: game.py [-h] {rock,paper,scissors}
game.py: error: argument move: invalid choice: 'fire' (choose from 'rock',
'paper', 'scissors')

argparseのadd_argumentメソッドでnargsパラメータを使用する

add_argumentパラメータとして nargs = ' 'を使用します。特にnargs = 'を使用しました明示的な引数を渡さない場合、デフォルトを選択するオプションに '

例としてコードスニペットを含める：

例：temp_args1.py

注意：以下のサンプルコードはpython3で書かれています。印刷ステートメントの形式を変更することで、python2で実行できます

#!/usr/local/bin/python3.6

from argparse import ArgumentParser

description = 'testing for passing multiple arguments and to get list of args'
parser = ArgumentParser(description=description)
parser.add_argument('-i', '--item', action='store', dest='alist',
                    type=str, nargs='*', default=['item1', 'item2', 'item3'],
                    help="Examples: -i item1 item2, -i item3")
opts = parser.parse_args()

print("List of items: {}".format(opts.alist))

注：リストに格納される複数の文字列引数を収集しています-opts.alist整数のリストが必要な場合は、parser.add_argumentのtypeパラメータをintに変更します

実行結果：

python3.6 temp_agrs1.py -i item5 item6 item7
List of items: ['item5', 'item6', 'item7']

python3.6 temp_agrs1.py -i item10
List of items: ['item10']

python3.6 temp_agrs1.py
List of items: ['item1', 'item2', 'item3']

1つのスイッチで複数のパラメータを使用する場合は、を使用しますnargs='+'。あなたの例 '-l'が実際に整数を取る場合：

a = argparse.ArgumentParser()
a.add_argument(
    '-l', '--list',  # either of this switches
    nargs='+',       # one or more parameters to this switch
    type=int,        # /parameters/ are ints
    dest='list',     # store in 'list'.
    default=[],      # since we're not specifying required.
)

print a.parse_args("-l 123 234 345 456".split(' '))
print a.parse_args("-l 123 -l=234 -l345 --list 456".split(' '))

生産する

Namespace(list=[123, 234, 345, 456])
Namespace(list=[456])  # Attention!

同じ引数を複数回指定すると、デフォルトのアクション（'store'）が既存のデータを置き換えます。

代わりに、appendアクションを使用します。

a = argparse.ArgumentParser()
a.add_argument(
    '-l', '--list',  # either of this switches
    type=int,        # /parameters/ are ints
    dest='list',     # store in 'list'.
    default=[],      # since we're not specifying required.
    action='append', # add to the list instead of replacing it
)

print a.parse_args("-l 123 -l=234 -l345 --list 456".split(' '))

どれが

Namespace(list=[123, 234, 345, 456])

または、コンマ区切りの値を解析するカスタムハンドラー/アクションを記述して、

-l 123,234,345 -l 456

ではadd_argument()、type文字列を受け取ってオプション値を返す呼び出し可能なオブジェクトです。

import ast

def arg_as_list(s):                                                            
    v = ast.literal_eval(s)                                                    
    if type(v) is not list:                                                    
        raise argparse.ArgumentTypeError("Argument \"%s\" is not a list" % (s))
    return v                                                                   


def foo():
    parser.add_argument("--list", type=arg_as_list, default=[],
                        help="List of values")

これにより、次のことが可能になります。

$ ./tool --list "[1,2,3,4]"

内部リストが異なるタイプと長さを持つネストされたリストがあり、タイプを保持したい場合、例えば、

[[1, 2], ["foo", "bar"], [3.14, "baz", 20]]

あなたはによって提案されたソリューションを使用することができSAM-石工@にこの質問：下記に示すが、

from argparse import ArgumentParser
import json

parser = ArgumentParser()
parser.add_argument('-l', type=json.loads)
parser.parse_args(['-l', '[[1,2],["foo","bar"],[3.14,"baz",20]]'])

それは与える：

Namespace(l=[[1, 2], ['foo', 'bar'], [3.14, 'baz', 20]])

複数のリスト、整数値、文字列の受け渡しを処理したい。

役立つリンク=> Bash変数をPythonに渡す方法は？

def main(args):
    my_args = []
    for arg in args:
        if arg.startswith("[") and arg.endswith("]"):
            arg = arg.replace("[", "").replace("]", "")
            my_args.append(arg.split(","))
        else:
            my_args.append(arg)

    print(my_args)


if __name__ == "__main__":
    import sys
    main(sys.argv[1:])

順序は重要ではありません。リストを渡したい場合は、中間で"["を実行"]し、コンマを使用してそれらを区切ります。

そして、

python test.py my_string 3 "[1,2]" "[3,4,5]"

出力=> ['my_string', '3', ['1', '2'], ['3', '4', '5']]、my_args変数には引数が順番に含まれます。

Chepnerが述べたように、最もエレガントな解決策はラムダ関数を「type」に渡すことだと思います。これに加えて、リストの区切り文字が事前にわからない場合は、re.splitに複数の区切り文字を渡すこともできます。

# python3 test.py -l "abc xyz, 123"

import re
import argparse

parser = argparse.ArgumentParser(description='Process a list.')
parser.add_argument('-l', '--list',
                    type=lambda s: re.split(' |, ', s),
                    required=True,
                    help='comma or space delimited list of characters')

args = parser.parse_args()
print(args.list)


# Output: ['abc', 'xyz', '123']