简介
argparse模块是Python中的一个常用模块，和sys.argv()功能类似，主要用于编写命令行接口：对于程序所需要的参数，它可以进行正确的解析。另外，argparse还可以自动的生成help和 usage信息，当程序的参数无效时，它可以自动生成错误信息。
参考文档：https://docs.python.org/3/library/argparse.html
argparse模块主要函数
（1） parser = argparse.ArgumentParser()
使用argparse的第一步是创建ArgumentParser对象
parser = argparse.ArgumentParser(description='Process some integers.')
ArgumentParser对象保存了所有必要的信息，用以将命令行参数解析为相应的python数据类型。
（2）parser.add_argument()
调用add_argument(）向ArgumentParser对象添加命令行参数信息，这些信息告诉ArgumentParser对象如何处理命令行参数。可以通过调用parse_agrs()来使用这些命令行参数。例如：
parser.add_argument('integers', metavar='N',
type=int,
nargs='+',
help='an integer for the accumulator')
parser.add_argument('--sum',
dest='accumulate',
action='store_const',
const=sum,
default=max,
help='sum the integers (default: find the max)')
之后，调用parse.args()将返回一个对象，它具有两个属性：integers和accumulate，前者是一个整数集合，后者根据命令行参数的不同，代表不同的函数，可以是max()，也可以是sum()。
（3）args = parser.parse_args()
通过调用parse_args()来解析ArgumentParser对象中保存的命令行参数：将命令行参数解析成相应的数据类型并采取相应的动作，它返回一个Namespace对象。
$ parser.parse_args(['--sum', '7', '-1', '42'])
Namespace(accumulate=<built-in function sum>, integers=[7, -1, 42])
在实际的python脚本中，parse_args()一般并不使用参数，它的参数由sys.argv决定。
一、ArgumentParser对象
class ArgumentParser(_AttributeHolder, _ActionsContainer):
"""Object for parsing command line strings into Python objects.
Keyword Arguments:
- prog -- The name of the program (default: sys.argv[0])
- usage -- A usage message (default: auto-generated from arguments)
- description -- A description of what the program does
- epilog -- Text following the argument descriptions
- parents -- Parsers whose arguments should be copied into this one
- formatter_class -- HelpFormatter class for printing help messages
- prefix_chars -- Characters that prefix optional arguments
- fromfile_prefix_chars -- Characters that prefix files containing
additional arguments
- argument_default -- The default value for all arguments
- conflict_handler -- String indicating how to handle conflicts
- add_help -- Add a -h/-help option
- allow_abbrev -- Allow long options to be abbreviated unambiguously
"""
def __init__(self,
prog=None,
usage=None,
description=None,
epilog=None,
parents=[],
formatter_class=HelpFormatter,
prefix_chars='-',
fromfile_prefix_chars=None,
argument_default=None,
conflict_handler='error',
add_help=True,
allow_abbrev=True):
对象参数简介：
- prog 程序文件名
- usage 程序使用说明
- description 程序目的说明
- epilog 程序说明后记
- parents ArgumentParser对象的父对象的参数列表
-
formatter_class
help信息的说明格式 - prefix_chars 命令行参数的前缀
- argument_default 参数的全局默认值
- conflict_handler 冲突处理
-
add_help 是否增加
help选项 - allow_abbrev 是否使用参数的缩写
二、add_argument()方法
通过add-argument()方法来给ArgumentParser对象添加新的命令行参数，参数的类型和相应的处理方法由不同的参数决定。
ArgumentParser.add_argument(name or flags…[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
函数参数简介
-
name or flags - Either a name or a list of option strings, e.g. foo or -f, –foo.
- 参数名或者参数标识
- 带
-的为可选参数（optional parameter） - 不带
-的为必选参数（positional parametrer）。
- action - 参数的处理方法
- nargs - 参数的数量
- const - 参数的常量值
- default - 参数的默认值
- type - 参数的数据类型
- choices -参数的取值范围
- required -参数是否可以忽略不写 ，仅对可选参数有效
- help - 参数的说明信息
-
metavar -参数在说明信息
usage中的名称 - dest - 对象的属性名
三、parse_args()方法
ArgumentParser.parse_args(args=None, namespace=None)
parse_args()方法将命令行参数字符串转换为相应对象并赋值给Namespace对象的相应属性，默认返回一个Namespace对象。
args - List of strings to parse. The default is taken from sys.argv.
字符串列表，默认来自sys.argv
namespace - An object to take the attributes. The default is a new empty Namespace object.
对象名，默认是一个空Namespace对象。
四、The Namespace object
class argparse.Namespace
调用parse_args()的返回值是一个Namespace对象，它具有很多属性，每个属性都代表相应的命令行参数。
Namespace对象是一个非常简单的类，可以通过vars()将之转换成字典类型。例如：
$ parser = argparse.ArgumentParser()
$ parser.add_argument('--foo')
$ args = parser.parse_args(['--foo', 'BAR'])
# args
Namespace(foo='BAR')
$ vars(args)
{'foo': 'BAR'}
另外还可以将ArgumentParser对象赋值给别的命令空间，而不是新建一个Namespace对象，例如：
$ class C:
... pass
...
$ c = C()
$ parser = argparse.ArgumentParser()
$ parser.add_argument('--foo')
$ parser.parse_args(args=['--foo', 'BAR'], namespace=c)
$ c.foo
'BAR'
五、例子
import argparse
parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N',
type=int,
nargs='+',
help='an integer for the accumulator')
parser.add_argument('--sum',
dest='accumulate',
action='store_const',
const=sum,
default=max,
help='sum the integers (default: find the max)')
args = parser.parse_args()
print(args.accumulate(args.integers))
'''
usage: test.py [-h] [--sum] N [N ...]
test.py: error: the following arguments are required: N
'''
假定上述代码保存为test.py，它可以在命令行执行并自动提供有用的help信息：
$ python test.py -h
usage: prog.py [-h] [--sum] N [N ...]
Process some integers.
positional arguments:
N an integer for the accumulator
optional arguments:
-h, --help show this help message and exit
--sum sum the integers (default: find the max)
该程序可以接受相应的参数并给出相应的输出：
$ python prog.py 1 2 3 4
4
$ python prog.py 1 2 3 4 --sum
10
如果传入无效的参数，它可以自动生成error信息：
$ python prog.py a b c
usage: prog.py [-h] [--sum] N [N ...]
prog.py: error: argument N: invalid int value: 'a'
