Как я могу передать список в качестве аргумента командной строки с argparse?

Ответ 1

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']

Takeaways:

• Используйте nargs или action='append'
  • nargs может быть более простым с точки зрения пользователя, но он может быть неинтуитивным, если существуют позиционные аргументы, потому что argparse не может определить, что должно быть позиционным аргументом и что принадлежит nargs; если у вас есть позиционные аргументы, то action='append' может оказаться лучшим выбором.
  • Вышеуказанное верно, только если nargs задано '*', '+' или '?'. Если вы укажете целочисленное число (например, 4), тогда не будет проблем с параметрами смешивания с nargs и позиционными аргументами, потому что argparse точно знает, сколько значений ожидается для этой опции.
• Не используйте кавычки в командной строке ¹
• Не используйте type=list, так как он вернет список списков
  • Это происходит потому, что под капотом argparse используется значение type для принуждения каждого отдельного заданного аргумента к вашему выбранному type, а не к совокупности всех аргументов.
  • Вы можете использовать type=int (или что-то еще), чтобы получить список int (или что-то еще)

¹: Я не имею в виду вообще. Я имею в виду, что использование кавычек для передачи списка в argparse не то, что вы хотите.

Ответ 2

Я предпочитаю передавать строку с разделителями, которую я анализирую позже в script. Причины этого: список может быть любого типа 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]

будет работать нормально. Разделитель также может быть пространством, которое бы обеспечивало котировки вокруг значения аргумента, как в примере в вопросе.

Ответ 3

В дополнение к 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')

Ответ 4

Использование параметра 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']

Ответ 5

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

Ответ 6

В 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]"

Ответ 7

Может быть, самый простой ответ

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-l", "--tolist", help="input to list", action="store_true")
parser.add_argument("newlist", type=str, help="generate a list")
args = parser.parse_args()
if args.tolist:
    print(args.newlist.split(" "))

Ответ 8

Если у вас есть вложенный список, где внутренние списки имеют разные типы и длины, и вы хотите сохранить тип, например,

[[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]])