使用argparse实现不带前缀的必选参数

Question

使用argparse实现不带前缀的必选参数

pythonargparse

6

我正在尝试在我的Python应用程序中使用argparse模块。

我的应用程序应该使用单个必需参数运行，不带任何前缀。但我无法想出如何实现。

- Naftaly

2

我猜你想要像 python myscript.py argument 这样的命令。在我看来，添加一个单一位置参数应该可以实现你想要的功能。 - Amy Teegarden

2个回答

0

你只需要像这样定义参数：

parser.add_argument("x")

不要在 x 前面添加任何 -。

- namespace-Pt

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- user4322779 · Accepted Answer

这里是一个使用argparse要求精确一个整数参数的简单示例：

import argparse

parser = argparse.ArgumentParser(description='process an integer')
parser.add_argument('integer', metavar='N', type=int, nargs=1,
               help='an integer')
args = parser.parse_args()
print(args.integer)

将此代码保存为argparse1.py并运行，将会得到以下结果：

$ python argparse1.py 5
[5]  

$ python argparse1.py
usage: argparse1.py [-h] N
argpars1.py: error: the following arguments are required: N

$ python argparse1.py 5 7
usage: argparse1.py [-h] N
argparse1.py: error: unrecognized arguments: 7

$ python argparse1.py test
usage: argparse1.py N
argparse1.py: error: argument N: invalid int value: 'test'

$ python argparse1.py -h
usage: argparse1.py [-h] N

process an integer

positional arguments:
  N           an integer

optional arguments:
  -h, --help  show this help message and exit

为了删除可选参数，请按照以下步骤定义 ArgumentParser 并将 add_help=False 作为参数添加：

import argparse

parser = argparse.ArgumentParser(add_help=False)
parser.add_argument('integer', metavar='N', type=int, nargs=1)
args = parser.parse_args()
print(args.integer)

将此代码放在argparse2.py中并进行测试，结果如下：

$ python argparse2.py
usage: argparse2.py N
argparse2.py: error: the following arguments are required: N

$ python argparse2.py 5
[5]

$ python argparse2.py 5 7
usage: argparse2.py N
argparse2.py: error: unrecognized arguments: 7

$ python argparse2.py hello
usage: argparse2.py N
argparse2.py: error: argument N: invalid int value: 'hello'

$ python argparse2.py -h
usage: argparse2.py N
argparse2.py: error: the following arguments are required: N

所有的使用信息都可以通过导入argparse.SUPPRESS并配置ArgumentParser为usage=SUPPRESS来抑制，格式如下:

from argparse import ArgumentParser,SUPPRESS

parser = ArgumentParser(add_help=False, usage=SUPPRESS)
parser.add_argument('integer', metavar='N', type=int, nargs=1)
args = parser.parse_args()
print(args.integer)

将此代码保存在argparse3.py中并运行，将会得到以下结果：

$ python argparse3.py 5
[5]

$ python argparse3.py 5 7 9
argparse3.py: error: unrecognized arguments: 7 9

$ python argparse3.py -h
argparse3.py: error: the following arguments are required: N

"未识别参数"错误是硬编码在ArgumentParser.parse_args()函数中（https://hg.python.org/cpython/file/3.4/Lib/argparse.py#l1727），而"需要以下参数"的错误则是单独硬编码的(https://hg.python.org/cpython/file/3.4/Lib/argparse.py#l1994)，这两个错误信息都无法通过API修改。后者似乎出现在_parse_known_args(self, arg_strings, namespace)中，虽然可以重写该函数，但需要复制大约250行代码才能修改其中的一行来更改该错误信息。

不过，您可以通过添加一个具有nargs='*'和没有类型的参数来避免这些错误消息，这实际上允许所有命令行，并添加包括您自己的错误和用法消息的自定义错误处理。例如：

import os
import sys
from argparse import ArgumentParser,SUPPRESS

script =  os.path.basename(sys.argv[0])
usage = 'usage: ' + script + ' n (int)'

parser = ArgumentParser(add_help=False, usage=SUPPRESS)
parser.add_argument('integer', nargs='*')
args = parser.parse_args()

if (len(args.integer) == 0):
    print('error: no argument provided\n', usage, file=sys.stderr, sep = '')
    sys.exit(1)


if (len(args.integer) > 1):
    print('error: too many arguments\n', usage, file=sys.stderr, sep = '')
    sys.exit(1)

v = args.integer[0]

try:
    v = int(v)
except ValueError:
    print("error: '", v, "'", ' is not an integer\n', usage, file=sys.stderr, sep='')
    sys.exit(1)

print(v + 2)

将此代码放在argparse4.py中并进行测试，结果如下：

$ python argparse4.py 5
7

$ python argparse4.py
error: no argument provided
usage: argparse4.py n (int)

$ python argparse4.py 5 9
error: too many arguments
usage: argparse4.py n (int)

$ python argparse4.py hello
error: 'hello' is not an integer
usage: argparse4.py n (int)