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

关键字参数，则消耗的参数数量由操作决定。通常这意味着将使用单个命令行参数并生成单个项目（不是列表）。

编辑（从@Acumenus 的评论中复制）

nargs='?'

文档说：“？”。如果可能，将从命令行使用一个参数并将其作为单个项目生成。如果不存在命令行参数，将生成默认值。

Answer 3

简答

如前两个答案所示，您可以接受带有

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 --version
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

Answer 4

import argparse
import os

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('-i', '--input', type=str, required=True, help='Input directory')
parser.add_argument('-o', '--output', type=str, required=True, help='Output directory')
parser.add_argument('-v', '--verbose', action='store_true', help='Enable verbose output')

args = vars(parser.parse_args())

input_dir = args['input']
output_dir = args['output']
verbose = args['verbose']

if verbose:
    print('Input directory:', input_dir)
    print('Output directory:', output_dir)

# Create the output directory and any necessary parent directories
os.makedirs(output_dir, exist_ok=True)

# Use input_dir and output_dir as needed

我使用 vars() 函数将 parse_args() 返回的 Namespace 对象转换为字典。这允许您将命令行参数作为字典键而不是单独的变量来访问。

我还使用 os.makedirs() 而不是 os.mkdir() 来创建输出目录，并且我传递了 exist_ok=True 参数以避免在目录已经存在时引发错误。这可以使您的代码更加高效和健壮。

Answer 5

parser.add_argument

还有一个开关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()