ChatGPT解决这个技术问题 Extra ChatGPT

argparse 可选位置参数?

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

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

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

我希望 dir 是可选的:如果未指定,它应该只是 cwd

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


B
Boris Verkhovskiy

使用 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

?* 在正则表达式中的含义是否相同(即 ? 需要 0 或 1,而 * 需要 0 或更多)?如果是这样,+ 是否也有效?
@dolan:是的,+ 也有效。有关详细信息,请参阅 docs.python.org/2/library/argparse.html#nargs
有没有办法让 dir 出现在可选参数中?或者似乎位置参数应该有一个前面的“可选”限定符。是否可以这样注册(就帮助而言)?
@ant 从上面,您可以看到 dir 是可选的(它出现在 argparse 输出中的方括号中表明了这一点)。
这是更新的 (Python 3) 文档——仔细阅读它可以解释一切:docs.python.org/3/library/argparse.html#nargs。对于 argparse 模块的新手,请从教程开始:docs.python.org/3/howto/argparse.html
M
Matas Vaitkevicius

作为@VinaySajip 答案的扩展。 There are additional nargs worth mentioning

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='?' The docs 说:“?”。如果可能,将从命令行使用一个参数并作为单个项目生成。如果不存在命令行参数,则将生成默认值。


但应注意 nargs='?' 不会生成列表。
@ABB 答案的最后一行Generally this means a single command-line argument will be consumed and a single item (not a list) will be produced.希望这会有所帮助......
引用的行是指没有定义 nargs,但 nargs='?' 正在定义它的情况。 docs 说:'?'。如果可能,将从命令行使用一个参数,并将其作为单个项目生成。如果不存在命令行参数,则将生成默认值。
@ABB 如果您觉得缺少某些内容,只需编辑答案。谢谢。
nargs=argparse.REMAINDERnargs='*' 之间有什么区别,在我看来,它们的效果是相同的(在 Python 2.7.10 和 Python 3.6.1 中测试)?
F
FiddleStix

简答

如前两个答案所示,您可以使用 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.versionparsed_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

e
elena

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()

OP 询问的是位置参数,而不是“--dir”。 'required' 是位置参数的无效参数。而“假”是一个错字,她的意思是“假”。 +1 表示新手,-1 表示草率。
我们不能使用 required 作为位置参数。