argparse option pour passer d'une liste comme option

TL;DR

Utiliser le nargs option ou le 'append' réglage de la action option (en fonction de comment vous voulez que l'interface utilisateur de se comporter).

nargs

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

nargs='+' prend 1 ou plusieurs arguments, nargs='*' prend zéro ou plus.

ajouter

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

Avec append vous fournir l'option plusieurs fois pour construire la liste.

Ne pas utiliser type=list!!! - Il n'y a probablement pas de situation où vous souhaitez utiliser type=list avec argparse. Jamais.

---

Jetons un coup d'oeil de plus près quelques-unes des différentes façons on pourrait, pour ce faire, et le résultat final.

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)

Ici est la sortie que vous pouvez attendre de nous:

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

Plats à emporter:

• Utilisation nargs ou action='append'
  • nargs peut être plus simple à partir d'un point de vue utilisateur, mais il peut être non-intuitif si il y a des arguments de position parce que argparse peut pas dire ce qui devrait être une position d'argument et ce qui appartient à la nargs; si vous avez des arguments de position puis action='append' peut-être un meilleur choix.
  • Ci-dessus n'est vrai que si nargs est donné '*', '+', ou '?'. Si vous fournissez un nombre entier (comme 4) alors il n'y aura pas de problème de mélange des options avec nargs et les arguments de position parce que argparse permettra de savoir exactement combien de valeurs à attendre pour l'option.
• Ne pas utiliser les citations sur la ligne de commande¹
• Ne pas utiliser type=list, comme il sera de retour une liste de listes
  • Cela se produit parce que sous le capot argparse utilise la valeur de type afin de le contraindre à chaque argument donné vous choisi type, pas le total de tous les arguments.
  • Vous pouvez utiliser type=int (ou autre) pour obtenir une liste d'entiers (ou autre)

---

¹: je ne veux pas en général.. je veux dire à l'aide de citations de passer d'une liste à argparse n'est pas ce que vous voulez.

En outre à nargs, vous pouvez utiliser choix si vous connaissez la liste à l'avance:

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

Si vous avez l'intention de faire un seul commutateur de prendre plusieurs paramètres, puis vous utilisez nargs='+'. Si votre exemple '-l' est en fait de prendre les entiers:

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

Produit

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

Si vous spécifiez le même argument à plusieurs reprises, l'action par défaut ('store') remplace les données existantes.

L'alternative est d'utiliser le append action:

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

Qui produit

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

Ou vous pouvez écrire un gestionnaire personnalisé/action pour analyser les valeurs séparées par des virgules afin que vous puissiez faire

-l 123,234,345 -l 456

Peut-être la réponse la plus simple

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