对没有前缀的强制参数使用argparse

Question

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

Answer 1

下面是一个使用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来抑制。使用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 providedn', usage, file=sys.stderr, sep = '')
    sys.exit(1)

if (len(args.integer) > 1):
    print('error: too many argumentsn', usage, file=sys.stderr, sep = '')
    sys.exit(1)
v = args.integer[0]
try:
    v = int(v)
except ValueError:
    print("error: '", v, "'", ' is not an integern', 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)

Answer 2

您只需定义如下参数:

parser.add_argument("x")

不要在x前面添加任何-