Argparse可选的位置参数?

我有一个脚本,打算这样使用:usage: installer.py dir [-h] [-v]

dir是一个位置参数,定义如下:

parser.add_argument('dir', default=os.getcwd())

我希望dir是可选的:当它没有指定时,它应该只是cwd

不幸的是,当我不指定dir参数时,我得到Error: Too few arguments

371286 次浏览

使用nargs='?'(如果需要多个目录,则使用nargs='*'

parser.add_argument('dir', nargs='?', default=os.getcwd())

扩展示例:

>>> import os, argparse>>> parser = argparse.ArgumentParser()>>> parser.add_argument('-v', action='store_true')_StoreTrueAction(option_strings=['-v'], dest='v', nargs=0, const=True, default=False, type=None, choices=None, help=None, metavar=None)>>> parser.add_argument('dir', nargs='?', default=os.getcwd())_StoreAction(option_strings=[], dest='dir', nargs='?', const=None, default='/home/vinay', type=None, choices=None, help=None, metavar=None)>>> parser.parse_args('somedir -v'.split())Namespace(dir='somedir', v=True)>>> parser.parse_args('-v'.split())Namespace(dir='/home/vinay', v=True)>>> parser.parse_args(''.split())Namespace(dir='/home/vinay', v=False)>>> parser.parse_args(['somedir'])Namespace(dir='somedir', v=False)>>> parser.parse_args('somedir -h -v'.split())usage: [-h] [-v] [dir]
positional arguments:dir
optional arguments:-h, --help  show this help message and exit-v

作为@VinaySajip答案的扩展。还有额外的#0值得一提

  1. parser.add_argument('dir', nargs=1, default=os.getcwd())

N(一个整数)。命令行中的N个参数将被收集到一个列表中

  1. parser.add_argument('dir', nargs='*', default=os.getcwd())

'*'。所有存在的命令行参数都聚集到一个列表中。说明,通常使用nargs='*'有多个位置参数没有多大意义,但使用nargs='*'有多个可选参数是可能的。

  1. parser.add_argument('dir', nargs='+', default=os.getcwd())

'+'。就像'*'一样,存在的所有命令行参数都聚集在一个列表中。此外,如果没有至少一个命令行参数存在,将生成错误消息。

  1. parser.add_argument('dir', nargs=argparse.REMAINDER, default=os.getcwd())

argparse.REMAINDER。所有剩余的命令行参数都聚集到一个列表中。这对于分派到其他命令行实用程序的命令行实用程序通常很有用

如果未提供nargs关键字参数,则使用的参数数由操作决定。通常这意味着将使用单个命令行参数并生成单个项目(不是列表)。

编辑(从@Acumenus的评论中复制)nargs='?'这些文档说: '?'. 如果可能,将从命令行使用一个参数并作为单个项目生成。如果不存在命令行参数,则将生成默认值。

parser.add_argument也有一个开关选填/必填。您可以使用required=False。这是Python 2.7的示例片段:

parser = argparse.ArgumentParser(description='get dir')parser.add_argument('--dir', type=str, help='dir', default=os.getcwd(), required=False)args = parser.parse_args()

简短回答

如前两个答案所示,您可以接受带有nargs='?'的可选位置参数。如果您愿意,您还可以将参数直接转换为Path类型和/或将cwd缩短为.

myfile.py

import argparseimport pathlib
parser = argparse.ArgumentParser()parser.add_argument("dir", nargs="?", default=".", type=pathlib.Path)parsed_args = parser.parse_args()
print("Installing to", parsed_args.dir.resolve())
$ python myfile.pyInstalling to /users/myname/myfolder
$ python myfile.py /usr/bin/Installing to /usr/bin

更长的答案

由于您在问题中还提到了标志样式的True/False选项-h-v,因此这些示例可能有用:

旗帜(例如-v

我们可能会将不接受参数的可选选项称为“标志”。对于标志,我们只关心是否给出它们。-h是一个标志,artparse会自动添加(以及更长的版本--help),所以我们不应该真的覆盖它。如果我们考虑-v然后,

myfile.py

import argparse
parser = argparse.ArgumentParser()parser.add_argument("-v","--version",action="store_true")parsed_args = parser.parse_args()
if parsed_args.version:print("version flag given")else:print("version flag not given")

请注意,add_argument()的第二个参数是该选项的更长名称。它不是强制性的,但它确实使您的后续代码更具可读性(parsed_args.version vsparsed_args.v),并使对安装程序的调用更加明确。

$ python myfile.py -vversion flag given
$ python myfile.py --versionversion flag given
$ python myfile.pyversion flag not given

可选参数(例如--installdir /usr/bin/

有人可能会争辩说,在你的情况下,你最好选择一个可选的参数,而不是一个位置参数。

myfile.py

import argparseimport pathlib
parser = argparse.ArgumentParser()parser.add_argument("-i","--installdir",  # Optional (but recommended) long versiontype=pathlib.Path,default="/bin")parsed_args = parser.parse_args()
print("Installing to", parsed_args.installdir)
$ python myfile.py -i /usr/bin/Installing to /usr/bin
$ python myfile.py --installdir /usr/bin/Installing to /usr/bin
$ python myfile.pyInstalling to /bin