опция 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"
484   7  

7 ответов:

TL; DR

использовать или 'append' задание (в зависимости от того, как вы хотите, чтобы пользовательский интерфейс ведет себя).

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

добавить

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 будете точно знать, сколько значений для параметра.
  • не используйте кавычки в командной строке1
  • не используйте type=list, так как он будет возвращать список списков
    • это происходит потому, что под капотом argparse использовать значение type принуждение каждый отдельный аргумент вы свой выбрали type, не совокупность всех аргументов.
    • можно использовать type=int (или что-то еще), чтобы получить список ints (или что-то еще)

1: я не имею в виду в целом.. Я имею в виду использование кавычек для передайте список в 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='+'. Если ваш пример '- 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]"

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

Я использую 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.алист Если вам нужен список целых чисел, измените параметр type на 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']

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

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(" "))

Comments

    Ничего не найдено.