每個 arg 具有多個值的 arg 解析器的最佳實踐

Question

我正在為 python 中的程序制作一個 arg 解析器，想知道多值 args 的典型格式是什么。

例如，假設我正在嘗試發出命令將視頻與評級相關聯。 我想允許用戶在一個命令中包含多個視頻。 視頻與評級之間存在 1:1 的關系，因此對於每個視頻，它們都是一個評級。

我應該把它格式化成這樣：

協會：

cat_video.mp4 --> 6

video1.mp4 --> 9

vidrate --video cat_video.mp4 video1.mp4 --rating 6 9

或者像這樣組合由冒號分隔的路徑和整數

vidrate --video cat_video.mp4:6 video1.mp4:9

我寧願使用典型的格式，所以任何其他選項都值得贊賞。

提前致謝

Answer 1

Python 標准庫直接支持這兩種風格。

• --video <video> <rating>對用戶來說可能更自然
• 如果您已經在調用腳本中分離了數據，則--videos / --ratings可能會很有用。

如果您願意，您可以同時支持兩者； 您選擇哪個主要是意見問題，取決於您的腳本最有可能如何使用。

import argparse

p = argparse.ArgumentParser()
p.add_argument('--video', nargs=2, action='append')
p.add_argument('--videos', nargs='+')
p.add_argument('--ratings', nargs='+')
args = p.parse_args()

for vid, rating in args.video:
    print("Video: {}, rating: {}".format(vid, rating))

# It is up to the caller to make sure the same number of videos and ratings
# are specified with --videos and --ratings
for vid, rating in zip(args.videos, args.ratings):
    print("Video: {}, rating: {}".format(vid, rating))

然后你可以簡單地使用

vidrate --video cat_video.mp4 6 video1.mp4 9

或者

vidrate --videos cat_video.mp4 video1.mp4 --ratings 6 9

甚至組合

vidrate --video cat_video.mp4 6 video1.mp4 9 --videos foo.mp4 bar.mp4 baz.mp4 --ratings 1 2 3

結合 shell 數組，您可以像這樣使用它：

cat_vid=(cat_video.mp4 6)
vid_one=(video1.mp4 9)
other_videos=(foo.mp4 bar.mp4 baz.mp4)
other_ratings=(1 2 3)
vidrate --video "${cat_vid[@]}" --video "${vid_one[@]}" --videos "${other_videos[@]}" --ratings "${other_ratings[@]}}"