每个 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[@]}}"