Как я могу передать список в качестве аргумента командной строки с 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опции (в зависимости от того, как вы хотите, чтобы пользовательский интерфейс вел себя).

nargs

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='*'принимает ноль или более.

Append

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(или что-то еще), чтобы получить список целых (или что-то еще)

¹ : я не имею в виду вообще ... я имею в виду, что использование кавычек для передачи списка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')

Использование параметра nargs nargs в методе argparse add_argument

Я использую nargs = ' ' в качестве параметра add_argument. Я специально использовал 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 на 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']

Если вы собираетесь сделать так, чтобы один переключатель принимал несколько параметров, используйте 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

In 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-mason для этого вопроса , показанное ниже:

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переменная содержит аргументы в порядке.

Я думаю, что самое элегантное решение - передать лямбда-функцию в тип, как упоминал Чепнер. В дополнение к этому, если вы заранее не знаете, каким будет разделитель вашего списка, вы также можете передать несколько разделителей в 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']