每个arg具有多个值的arg解析器的最佳实践

时间:2017-01-10 10:32:55

标签: python linux bash command-line

我正在为python中的程序创建一个arg解析器,并想知道什么是多值args的典型格式。

例如,我说我正在尝试制作一个命令,将视频与评级相关联。我想允许用户在一个命令中包含多个视频。视频与评级之间存在1:1的关系,因此对于每个视频,它们都是一个评级。

我应该格式化它,所以它是这样的:

协会

cat_video.mp4 - > 6

video1.mp4 - > 9

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

或组合路径和int分隔冒号,如

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

我宁愿使用典型的格式,以便欣赏任何其他选项。

提前致谢

1 个答案:

答案 0 :(得分: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[@]}}"