Làm cách nào để chuyển một danh sách dưới dạng đối số dòng lệnh với argparse?

505
carte blanche 2013-04-02 13:34.

Tôi đang cố gắng chuyển một danh sách dưới dạng đối số cho một chương trình dòng lệnh. Có argparsetùy chọn để chuyển danh sách dưới dạng tùy chọn không?

parser.add_argument('-l', '--list',
                      type=list, action='store',
                      dest='list',
                      help='<Required> Set flag',
                      required=True)

Script được gọi như dưới đây

python test.py -l "265340 268738 270774 270817"

10 answers

1006
SethMMorton 2013-04-02 13:37.

TL; DR

Sử dụng nargstùy chọn hoặc 'append'cài đặt của actiontùy chọn (tùy thuộc vào cách bạn muốn giao diện người dùng hoạt động).

tường thuật

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

nargs='+'có 1 hoặc nhiều đối số, nargs='*'lấy 0 hoặc nhiều hơn.

nối thêm

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

Với việc appendbạn cung cấp tùy chọn nhiều lần để xây dựng danh sách.

Không sử dụng type=list!!! - Có lẽ là không có tình huống mà bạn muốn sử dụng type=listvới argparse. Không bao giờ.


Chúng ta hãy xem xét chi tiết hơn về một số cách khác nhau mà người ta có thể thử để làm điều này và kết quả cuối cùng.

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)

Đây là kết quả mà bạn có thể mong đợi:

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

Kết quả rút ra :

  • Sử dụng nargshoặcaction='append'
    • nargscó thể đơn giản hơn từ góc độ người dùng, nhưng có thể không trực quan nếu có các đối số vị trí vì argparsekhông thể phân biệt đâu là đối số vị trí và cái gì thuộc về nargs; nếu bạn có các lập luận về vị trí thì action='append'cuối cùng có thể là một lựa chọn tốt hơn.
    • Trên đây chỉ là đúng nếu nargsđược đưa ra '*', '+'hoặc '?'. Nếu bạn cung cấp một số nguyên (chẳng hạn 4) thì sẽ không có vấn đề gì khi trộn các tùy chọn với nargsvà các đối số vị trí vì argparsesẽ biết chính xác có bao nhiêu giá trị mong đợi cho tùy chọn.
  • Không sử dụng dấu ngoặc kép trên dòng lệnh 1
  • Đừng sử dụng type=list, vì nó sẽ trả về một danh sách các danh sách
    • Điều này xảy ra bởi vì ẩn argparsesử dụng giá trị của typeđể ép buộc từng đối số đã cho riêng lẻ mà bạn đã chọn type, không phải tổng hợp của tất cả các đối số.
    • Bạn có thể sử dụng type=int(hoặc bất cứ thứ gì) để lấy danh sách các int (hoặc bất cứ thứ gì)

1 : Ý tôi không phải là nói chung .. Ý tôi là việc sử dụng dấu ngoặc kép để chuyển danh sách đếnargparse không phải là điều bạn muốn.

93
dojuba 2014-07-22 03:55.

Tôi thích chuyển một chuỗi được phân tách mà tôi phân tích cú pháp sau đó trong tập lệnh. Những lý do cho điều này là; danh sách có thể thuộc bất kỳ loại nào inthoặc strvà đôi khi sử dụng, nargstôi gặp sự cố nếu có nhiều đối số tùy chọn và đối số vị trí.

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

Sau đó,

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

hoặc là,

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

sẽ hoạt động tốt. Dấu phân cách cũng có thể là một khoảng trắng, mặc dù sẽ thực thi các dấu ngoặc kép xung quanh giá trị đối số như trong ví dụ trong câu hỏi.

Hoặc bạn có thể sử dụng kiểu lambda như được đề xuất trong phần nhận xét của Chepner:

parser.add_argument('-l', '--list', help='delimited list input', 
    type=lambda s: [int(item) for item in s.split(',')])
19
Martin Thoma 2014-03-28 01:52.

Ngoài ra nargs, bạn có thể muốn sử dụng choicesnếu bạn biết trước danh sách:

>>> 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')
12
Py_minion 2017-01-21 10:30.

Sử dụng tham số tường thuật trong phương thức add_argument của argparse

Tôi sử dụng nargs = ' ' làm tham số add_argument. Tôi đã đặc biệt sử dụng nargs = ' ' cho tùy chọn chọn giá trị mặc định nếu tôi không chuyển bất kỳ đối số rõ ràng nào

Bao gồm một đoạn mã làm ví dụ:

Ví dụ: temp_args1.py

Xin lưu ý: Mã mẫu dưới đây được viết bằng python3. Bằng cách thay đổi định dạng câu lệnh in, có thể chạy trong 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))

Lưu ý: Tôi đang thu thập nhiều đối số chuỗi được lưu trữ trong danh sách - opts.alist Nếu bạn muốn danh sách các số nguyên, hãy thay đổi tham số kiểu trên parser.add_argument thành int

Kết quả thực thi:

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
kfsone 2017-04-01 06:45.

Nếu bạn đang có ý định thực hiện một công tắc duy nhất có nhiều tham số, thì bạn sử dụng nargs='+'. Nếu ví dụ '-l' của bạn thực sự lấy số nguyên:

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

Sản xuất

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

Nếu bạn chỉ định cùng một đối số nhiều lần, thì hành động mặc định ( 'store') sẽ thay thế dữ liệu hiện có.

Cách thay thế là sử dụng appendhành động:

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

Sản xuất

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

Hoặc bạn có thể viết một trình xử lý / hành động tùy chỉnh để phân tích cú pháp các giá trị được phân tách bằng dấu phẩy để bạn có thể làm

-l 123,234,345 -l 456
5
wonder.mice 2017-11-11 07:04.

Trong add_argument(), typechỉ là một đối tượng có thể gọi nhận chuỗi và trả về giá trị tùy chọn.

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

Điều này sẽ cho phép:

$ ./tool --list "[1,2,3,4]"
2
Meysam Sadeghi 2019-07-20 03:14.

Nếu bạn có một danh sách lồng nhau trong đó các danh sách bên trong có các kiểu và độ dài khác nhau và bạn muốn giữ nguyên kiểu, ví dụ:

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

thì bạn có thể sử dụng giải pháp do @ sam-mason đề xuất cho câu hỏi này , được hiển thị bên dưới:

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

mang lại:

Namespace(l=[[1, 2], ['foo', 'bar'], [3.14, 'baz', 20]])
1
Nebulastic 2020-04-15 00:43.

Tôi nghĩ giải pháp thanh lịch nhất là chuyển một hàm lambda thành "type", như Chepner đã đề cập. Ngoài ra, nếu bạn không biết trước dấu phân cách trong danh sách của mình, bạn cũng có thể chuyển nhiều dấu phân cách vào 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']
0
alper 2020-03-17 07:12.

Tôi muốn xử lý việc chuyển nhiều danh sách, giá trị số nguyên và chuỗi.

Liên kết hữu ích => Làm thế nào để chuyển một biến Bash sang 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:])

Thứ tự không quan trọng. Nếu bạn muốn chuyển một danh sách, chỉ cần làm như ở giữa "[""]và phân tách chúng bằng dấu phẩy.

Sau đó,

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

Output => ['my_string', '3', ['1', '2'], ['3', '4', '5']], my_argsbiến chứa các đối số theo thứ tự.

0
Léonard 2020-09-25 20:40.

Bạn có thể phân tích cú pháp danh sách dưới dạng một chuỗi và sử dụng evalhàm nội trang để đọc nó dưới dạng danh sách. Trong trường hợp này, bạn sẽ phải đặt dấu ngoặc kép thành dấu ngoặc kép (hoặc ngược lại) để đảm bảo phân tích cú pháp chuỗi thành công.

# declare the list arg as a string
parser.add_argument('-l', '--list', type=str)

# parse
args = parser.parse()

# turn the 'list' string argument into a list object
args.list = eval(args.list)
print(list)
print(type(list))

Thử nghiệm:

python list_arg.py --list "[1, 2, 3]"

[1, 2, 3]
<class 'list'>

Related questions

MORE COOL STUFF

Cate Blanchett chia tay chồng sau 3 ngày bên nhau và vẫn kết hôn với anh ấy 25 năm sau

Cate Blanchett chia tay chồng sau 3 ngày bên nhau và vẫn kết hôn với anh ấy 25 năm sau

Cate Blanchett đã bất chấp những lời khuyên hẹn hò điển hình khi cô gặp chồng mình.

Tại sao Michael Sheen là một diễn viên phi lợi nhuận

Tại sao Michael Sheen là một diễn viên phi lợi nhuận

Michael Sheen là một diễn viên phi lợi nhuận nhưng chính xác thì điều đó có nghĩa là gì?

Hallmark Star Colin Egglesfield Các món ăn gây xúc động mạnh đối với người hâm mộ tại RomaDrama Live! [Loại trừ]

Hallmark Star Colin Egglesfield Các món ăn gây xúc động mạnh đối với người hâm mộ tại RomaDrama Live! [Loại trừ]

Ngôi sao của Hallmark Colin Egglesfield chia sẻ về những cuộc gặp gỡ với người hâm mộ ly kỳ tại RomaDrama Live! cộng với chương trình INSPIRE của anh ấy tại đại hội.

Tại sao bạn không thể phát trực tuyến 'chương trình truyền hình phía Bắc'

Tại sao bạn không thể phát trực tuyến 'chương trình truyền hình phía Bắc'

Bạn sẽ phải phủi sạch đầu đĩa Blu-ray hoặc DVD để xem tại sao Northern Exposure trở thành một trong những chương trình nổi tiếng nhất của thập niên 90.

Where in the World Are You? Take our GeoGuesser Quiz

Where in the World Are You? Take our GeoGuesser Quiz

The world is a huge place, yet some GeoGuessr players know locations in mere seconds. Are you one of GeoGuessr's gifted elite? Take our quiz to find out!

8 công dụng tuyệt vời của Baking Soda và Giấm

8 công dụng tuyệt vời của Baking Soda và Giấm

Bạn biết đấy, hai sản phẩm này là nguồn điện để làm sạch, riêng chúng. Nhưng cùng với nhau, chúng có một loạt công dụng hoàn toàn khác.

Hạn hán, biến đổi khí hậu đe dọa tương lai của thủy điện Hoa Kỳ

Hạn hán, biến đổi khí hậu đe dọa tương lai của thủy điện Hoa Kỳ

Thủy điện rất cần thiết cho lưới điện của Hoa Kỳ, nhưng nó chỉ tạo ra năng lượng khi có nước di chuyển. Bao nhiêu nhà máy thủy điện có thể gặp nguy hiểm khi các hồ và sông cạn kiệt?

Quyên góp tóc của bạn để giúp giữ nước sạch của chúng tôi

Quyên góp tóc của bạn để giúp giữ nước sạch của chúng tôi

Tóc tỉa từ các tiệm và các khoản quyên góp cá nhân có thể được tái sử dụng như những tấm thảm thấm dầu và giúp bảo vệ môi trường.

BoJack Horseman vẫn gan ruột và gan dạ hơn bao giờ hết trong phần 3

BoJack Horseman vẫn gan ruột và gan dạ hơn bao giờ hết trong phần 3

BoJack Horseman (Ảnh: Netflix) BoJack Horseman bắt đầu mùa thứ ba với sự xuất hiện của nhân vật tiêu biểu, người vẫn đang theo đuổi những lời khen ngợi từ giới phê bình trong một nỗ lực tuyệt vọng để tìm ra ý nghĩa trong cuộc sống của mình. Mùa thứ hai về số phận bi kịch của Raphael Bob-Waksberg dày đặc những trò đùa cũng như tuyệt vọng.

Xem cách tính năng lái tự động cập nhật của Tesla bùng phát như thế nào khi bạn bỏ qua các cảnh báo của nó

Xem cách tính năng lái tự động cập nhật của Tesla bùng phát như thế nào khi bạn bỏ qua các cảnh báo của nó

Bản nâng cấp Phiên bản 8.0 gần đây của Tesla đối với hệ thống Lái xe tự động được thiết kế để cải thiện hệ thống và mối quan hệ của nó với người lái.

UnREAL, Chương trình Truyền hình Về Truyền hình Thực tế Chúng tôi Không biết Chúng tôi Cần

UnREAL, Chương trình Truyền hình Về Truyền hình Thực tế Chúng tôi Không biết Chúng tôi Cần

Chắc chắn khi con cái chúng ta xem lại các chương trình chúng ta đã xem vào khoảng năm 2015, chúng sẽ thấy UnREAL, một chương trình truyền hình mới chiếu vào tối Thứ Hai của Lifetime — bạn sẽ thấy đúng lúc, sẽ phát sóng ngay sau khi The Bachelor kết thúc — như một chương trình không thể được thực hiện vào bất kỳ thời điểm nào khác trong lịch sử truyền hình, nhưng một chương trình cảm thấy cần thiết để xem bây giờ. UnREAL có sự tham gia của Shiri Appleby trong vai Rachel, một nhà sản xuất truyền hình cho một chương trình về cơ bản là The Bachelor, mặc dù trong thế giới này, nó được gọi là Vĩnh viễn.

Sau tất cả, Josh Trank sẽ không đạo diễn bộ phim tuyển tập Star Wars thứ hai

Sau tất cả, Josh Trank sẽ không đạo diễn bộ phim tuyển tập Star Wars thứ hai

Thông báo chính thức đến trực tiếp từ trang web của Star Wars: Fantastic Four, đạo diễn Josh Trank, một người bí ẩn không xuất hiện tại đại hội Star Wars Celebration gần đây, sẽ không chỉ đạo phần hai Star Wars Anthology. Đây là tuyên bố được đăng ngày hôm qua: Tất cả thực sự là ngôn ngữ rất lịch sự, nhưng một bài báo của Hollywood Reporter cho thấy tất cả đều không tốt ở hậu trường, gọi sự ra đi là "một vụ sa thải" một phần dựa trên "hành vi bất thường" của Trank trong khi quay Fantastic Four: The Bài báo trích dẫn các nguồn gọi là Trank “đôi khi thiếu quyết đoán và thiếu sáng tạo,” và lưu ý rằng Fantastic Four, khởi chiếu vào ngày 7 tháng 8, đã được khởi động lại vào cuối tháng 4.

Edwin McCain ra mắt Grand Ole Opry: Quay cảnh hậu trường với nhạc sĩ 'I'll Be'

Edwin McCain ra mắt Grand Ole Opry: Quay cảnh hậu trường với nhạc sĩ 'I'll Be'

McCain, người đang làm việc cho một album mới, lần đầu tiên bước vào vòng kết nối vào tối thứ Sáu ở Nashville

Nicky Hilton Forced to Borrow Paris' 'I Love Paris' Sweatshirt After 'Airline Loses All [My] Luggage'

Nicky Hilton Forced to Borrow Paris' 'I Love Paris' Sweatshirt After 'Airline Loses All [My] Luggage'

Nicky Hilton Rothschild's luggage got lost, but luckily she has an incredible closet to shop: Sister Paris Hilton's!

Kate Middleton dành một ngày bên bờ nước ở London, cùng với Jennifer Lopez, Julianne Hough và hơn thế nữa

Kate Middleton dành một ngày bên bờ nước ở London, cùng với Jennifer Lopez, Julianne Hough và hơn thế nữa

Kate Middleton dành một ngày bên bờ nước ở London, cùng với Jennifer Lopez, Julianne Hough và hơn thế nữa. Từ Hollywood đến New York và mọi nơi ở giữa, hãy xem các ngôi sao yêu thích của bạn đang làm gì!

17 tuổi bị đâm chết trong khi 4 người khác bị thương trong một cuộc tấn công bằng dao trên sông Wisconsin

17 tuổi bị đâm chết trong khi 4 người khác bị thương trong một cuộc tấn công bằng dao trên sông Wisconsin

Các nhà điều tra đang xem xét liệu nhóm và nghi phạm có biết nhau trước vụ tấn công hay không

Tôi viết như thế nào

Tôi viết như thế nào

Đối với tôi, mọi thứ là về dòng đầu tiên đó và nó sẽ đưa bạn đến đâu. Một số nhà văn bị điều khiển bởi cốt truyện, sự sắp xếp tinh tế của các quân cờ, trong khi những người khác bị lôi cuốn bởi một nhân vật và khả năng thực hiện một cuộc hành trình với một người bạn hư cấu mới.

Đường băng hạ cánh

Đường băng hạ cánh

Cuối hè đầu thu là mùa hoài niệm. Những chiếc đèn đường chiếu ánh sáng của chúng qua những con đường đẫm mưa, và những chiếc lá dưới chân - màu đỏ cam tắt trong bóng chạng vạng - là lời nhắc nhở về những ngày đã qua.

Hãy tưởng tượng tạo ra một chiến lược nội dung thực sự CHUYỂN ĐỔI. Nó có thể.

Hãy tưởng tượng tạo ra một chiến lược nội dung thực sự CHUYỂN ĐỔI. Nó có thể.

Vào năm 2021, tôi khuyến khích bạn suy nghĩ lại mọi thứ bạn biết về khách hàng mà bạn phục vụ và những câu chuyện bạn kể cho họ. Lùi lại.

Sự mất mát của voi ma mút đã mở ra trái tim tôi để yêu

Sự mất mát của voi ma mút đã mở ra trái tim tôi để yêu

Vào ngày sinh nhật thứ 9 của Felix The Cat, tôi nhớ về một trong những mất mát lớn nhất trong cuộc đời trưởng thành của tôi - Sophie của tôi vào năm 2013. Tôi đã viết bài luận này và chia sẻ nó trên nền tảng này một thời gian ngắn vào năm 2013.

Language