[英]Argparse optional positional arguments?
我有一个打算像这样使用的脚本: usage: installer.py dir [-h] [-v]
dir
是一个位置参数,定义如下:
parser.add_argument('dir', default=os.getcwd())
我希望dir
是可选的:当未指定时,它应该只是cwd
。
不幸的是,当我没有指定dir
参数时,我得到Error: Too few arguments
。
使用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 答案的扩展。 还有其他值得一提的nargs
。
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='?'
文档说:“?”。 如果可能,将从命令行使用一个参数并作为单个项目生成。 如果不存在命令行参数,则将生成默认值。
如前两个答案所示,您可以接受带有nargs='?'
的可选位置参数 . 您还可以将参数直接转换为Path
类型和/或将 cwd 缩短为.
如果你想:
我的文件.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
那么,
我的文件.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 --verbose
version flag given
$ python myfile.py
version flag not given
--installdir /usr/bin/
)有人可能会争辩说,在您的情况下,使用可选参数而不是位置参数会更好。
我的文件.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
parser.add_argument
也有一个 switch required 。 您可以使用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()
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.