Argparse可选的位置参数？

Question

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

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

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

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

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

Answer 1

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

Answer 2

作为@VinaySajip答案的延伸.还有其他nargs值得一提的.

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

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

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

'*'.存在的所有命令行参数都收集到列表中.请注意,使用多个位置参数通常没有多大意义nargs='*',但可以使用多个可选参数nargs='*'.

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

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

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

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

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

Answer 3

简答

如前两个答案所示，您可以接受带有 的可选位置参数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.versionvs parsed_args.v）并使对安装程序的调用更加明确。

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

可选参数（例如--installdir /usr/bin/）

有人可能会说，就您的情况而言，使用可选参数而不是位置参数会更好。

myfile.py

$ python myfile.py -v
version flag given

$ python myfile.py --version
version flag given

$ python myfile.py
version flag not given

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)