我有一个脚本,打算这样使用:用法:installer.py dir[-h][-v]
dir是一个位置参数,其定义如下:
parser.add_argument('dir', default=os.getcwd())
我希望目录是可选的:如果没有指定,则应该是cwd。
不幸的是,当我没有指定dir参数时,我会得到错误:参数太少。
我有一个脚本,打算这样使用:用法:installer.py dir[-h][-v]
dir是一个位置参数,其定义如下:
parser.add_argument('dir', default=os.getcwd())
我希望目录是可选的:如果没有指定,则应该是cwd。
不幸的是,当我没有指定dir参数时,我会得到错误:参数太少。
使用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答案的扩展。还有其他值得一提的麻醉。
parser.add_argument('dir',nargs=1,default=os.getcwd())
N(整数)。命令行中的N个参数将汇集到一个列表中
parser.add_argument('dir',nargs='*',default=os.getcwd())
'*'. 所有存在的命令行参数都收集到一个列表中。请注意,使用多个nargs=“*”的位置参数通常没有多大意义,但可以使用多个具有nargs=”*“的可选参数。
parser.add_argument('dir',nargs='+',default=os.getcwd())
'+'. 与“*”一样,所有存在的命令行参数都被收集到一个列表中。此外,如果没有至少一个命令行参数,将生成一条错误消息。
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 argparse
import 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.py
Installing to /users/myname/myfolder
$ python myfile.py /usr/bin/
Installing to /usr/bin
更长的答案
由于您在问题中还提到了标志样式True/False选项-h和-v,因此这些示例可能有用:
标志(例如-v)
我们可以引用不带参数作为“标志”的可选选项。对于旗帜,我们只关心它们是否被赋予-h是argparse自动添加的标志(以及较长的版本--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 vs parsed_args.v),并使对安装程序的调用更加明确。
$ python myfile.py -v
version flag given
$ python myfile.py --version
version flag given
$ python myfile.py
version flag not given
可选参数(例如--installdir/usr/bin/)
有人可能会说,在你的情况下,你最好选择一个可选的论点,而不是一个立场性的论点。
myfile.py
import argparse
import pathlib
parser = argparse.ArgumentParser()
parser.add_argument(
"-i",
"--installdir", # Optional (but recommended) long version
type=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.py
Installing to /bin