使用argparse作为不带前缀的强制参数

时间:2015-07-26 22:04:33

标签: python argparse

我试图在我的python应用程序中使用argparse模块。 我的应用程序应该使用单个强制参数运行,不带任何前缀。我无法想出办法。

1 个答案:

答案 0 :(得分:7)

这是一个使用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

要删除可选参数,请使用add_help = False定义ArgumentParser,如下所示:

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并使用usage = SUPPRESS配置ArgumentParser来抑制所有使用消息,如下所示:

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行代码以修改1行来更改该错误消息。

但是,可以通过添加一个带有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)