• optparse：https://docs.python.org/zh-cn/3/library/optparse.html
• argparse ：https://docs.python.org/zh-cn/3/library/argparse.html

3.2 版后已移除 optparse 模块，并且将不再继续开发；开发转至 argparse 模块进行。

​1、argparse --- 命令行选项、参数和子命令解析器 ​

argparse 模块可以让人轻松编写用户友好的命令行接口。程序定义它需要的参数，然后 argparse 将弄清如何从 sys.argv 解析出那些参数。 argparse 模块还会自动生成帮助和使用手册，并在用户给程序传入无效参数时报出错误信息

有关 Python 命令行解析更细致的介绍，请参阅 argparse 教程。

简单示例：

import argparse# 使用 argparse 的第一步是创建一个 ArgumentParser 对象：
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)'
)# 解析参数，ArgumentParser 通过 parse_args() 方法解析参数
# 通常 parse_args() 参数为空时，将自动从 sys.argv 中确定命令行参数。
parser.parse_args()  # 从 sys.argv 读取参数
arg_list = ['--sum', '7', '-1', '42']
parser.parse_args(arg_list)

ArgumentParser 对象

class argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True, exit_on_error=True)

创建一个新的 ArgumentParser 对象。所有的参数都应当作为关键字参数传入。每个参数在下面都有它更详细的描述，但简而言之，它们是：

• prog - 程序的名称（默认值：sys.argv[0]）

• usage - 描述程序用途的字符串（默认值：从添加到解析器的参数生成）

• description - 在参数帮助文档之前显示的文本（默认值：无）

• epilog - 在参数帮助文档之后显示的文本（默认值：无）

• parents - 一个 ArgumentParser 对象的列表，它们的参数也应包含在内

• formatter_class - 用于自定义帮助文档输出格式的类

• prefix_chars - 可选参数的前缀字符集合（默认值： '-'）

• fromfile_prefix_chars - 当需要从文件中读取其他参数时，用于标识文件名的前缀字符集合（默认值： None）

• argument_default - 参数的全局默认值（默认值： None）

• conflict_handler - 解决冲突选项的策略（通常是不必要的）

• add_help - 为解析器添加一个 -h/--help 选项（默认值： True）

• allow_abbrev - 如果缩写是无歧义的，则允许缩写长选项 （默认值：True）

• exit_on_error - 决定当错误发生时是否让 ArgumentParser 附带错误信息退出。 (默认值: True)

位置参数

示例代码：

import argparseparser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number", type=int
)
args = parser.parse_args()
print(args.square ** 2)

运行结果：

$ python3 prog.py 4
16
$ python3 prog.py four
usage: prog.py [-h] square
prog.py: error: argument square: invalid int value: 'four'

可选参数

import argparseparser = argparse.ArgumentParser()
parser.add_argument("--verbosity", help="参数verbosity")
parser.add_argument("--true_or_false", help="参数true_or_false", action="store_true")
args = parser.parse_args()arg_verbosity = args.verbosity
print(arg_verbosity)
arg_true_or_false = args.true_or_false
print(arg_true_or_false)

关键词 action 赋值为 "store_true"。这意味着，当这一选项存在时，为 args.verbose 赋值为 True。没有指定时则隐含地赋值为 False。

短选项

示例代码：

import argparseparser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbose", help="increase output verbosity",action="store_true"
)
args = parser.parse_args()
if args.verbose:print("verbosity turned on")

位置参数、可选参数 混合使用

示例代码：

import argparseparser = argparse.ArgumentParser()
parser.add_argument("square", type=int,help="显示输入数字的平方和"
)
parser.add_argument("-v", "--verbosity", action="count", default=0,help="输出详细信息"
)
args = parser.parse_args()
answer = args.square ** 2
if args.verbosity >= 2:print(f"the square of {args.square} equals {answer}")
elif args.verbosity >= 1:print(f"{args.square}^2 == {answer}")
else:print(answer)

关键字 default 用来设置默认参数。默认情况下如果一个可选参数没有被指定，它的值会是 None，

矛盾的选项（ 互斥参数 ）

add_mutually_exclusive_group() 允许指定彼此相互冲突的选项。

示例：将引入 --quiet 选项，它将与 --verbose 正好相反:

示例代码：

import argparseparser = argparse.ArgumentParser(description="简单计算")group = parser.add_mutually_exclusive_group()
group.add_argument("-v", "--verbose", action="store_true")
group.add_argument("-q", "--quiet", action="store_true")parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
args = parser.parse_args()
answer = args.x ** args.yif args.quiet:print(answer)
elif args.verbose:print("{} to the power {} equals {}".format(args.x, args.y, answer))
else:print("{}^{} == {}".format(args.x, args.y, answer))

2、使用 optparse 处理 命令行参数

Python 有两个内建的模块用于处理命令行参数：

1. 一个是 getopt 只能简单处理 命令行参数；
2. 另一个是 optparse，它功能强大，而且易于使用，可以方便地生成标准的、符合Unix/Posix 规范的命令行说明。会自动帮你负责-h帮助选项。

起初，argparse 曾经尝试通过 optparse 来维持兼容性。 但是，optparse 很难透明地扩展，特别是那些为支持新的 nargs= 描述方式和更好的用法消息所需的修改。

optparse 用法

• 首先，必须导入 OptionParser 类，创建一个 OptionParser 对象：
          from optparse import OptionParser
          parser = OptionParser()
• 然后，使用 add_option 来定义命令行参数：
          parser.add_option(opt_str, ..., attr=value, ...)
          # 每个命令行参数就是由参数名字符串和参数属性组成的,
          # 如 -f 或者 –file 分别是长短参数名：parser.add_option("-f", "--file", ...)
• 最后，一旦你已经定义好了所有的命令行参数，调用 parse_args() 来解析程序的命令行： 
      (options, args) = parser.parse_args()  # 不写这一句 -h 或 --help 不会打印帮助信息

parse_args() 返回的两个值：

• options：它是一个对象（optpars.Values），保存有命令行参数值。只要知道命令行参数名，如 user，就可以访问其对应的值： options.user
• args：返回一个位置参数的列表

action 是 parse_args() 方法的参数之一，它表示当 optparse 解析到一个命令行参数时，将会把参数值保存在 options 对象里。actions 有一组固定的值可供选择，这里只解释 三种类型：

1. action='store' 默认类型，可以忽略不写。用户必须给出一个明确的参数值，该类型定义了将实际参数值保存到dest指定变量中
2. action='store_true' 用户不需给出参数值，该类型定义了将布尔值true保存到dest指定的变量中
3. action='store_false' 用户不需给出参数值，该类型定义了将布尔值false保存到dest指定的变量中 
4. 其它的 actions 值还有：store_const、append、count、callback。

store_true 和 store_false 用于处理带命令行参数后面不带值的情况。如 -v，-q 等命令行参数：

parser.add_option("-v", action="store_true", dest="verbose")
parser.add_option("-q", action="store_false", dest="verbose")

这样的话，当解析到 ‘-v’，options.verbose 将被赋予 True 值，反之，解析到 ‘-q’，会被赋予 False 值。

传递一个命令行参数列表

注： 也可以传递一个命令行参数列表到 parse_args()；否则，默认使用 sys.argv[:1]

from optparse import OptionParserparser = OptionParser()
parser.add_option("-f", "--file",action="store", type="string", dest="filename"
)
args_list = ["-f", "foo.txt"]  # 命令行参数列表
(options, args) = parser.parse_args(args_list)
print(options.filename)

结果打印出 “foo.txt”。当 optparse 解析到 ’-f’ ，会继续解析后面的 ’foo.txt’，然后将 ’foo.txt’ 保存到 options.filename 里。当调用 parser.args() 后，options.filename 的值就为’foo.txt’。

也可以指定 add_option() 方法中 type 参数为其它值，如 int 或者 float 等：
parser.add_option("-n", type="int", dest="num")
默认 type 为 ’string’。正如上面所示，长参数名也是可选的。其实，dest 参数也是可选的。如果没有指定 dest 参数，将用命令行的参数名来对 options 对象的值进行存取。

默认值：

parse_args() 方法提供了一个 default 参数用于设置默认值。如：

parser.add_option("-f","--file", action="store", dest="filename", default="foo.txt")
parser.add_option("-v", action="store_true", dest="verbose", default=True)

又或者使用 set_defaults()：

from optparse import OptionParserparser = OptionParser()
parser.add_option("-f", "--file", action="store", type="string", dest="filename")
parser.add_option("-u", "--user", action="store", type="string", dest="username")parser.set_defaults(filename='test.txt', username='root')# args_list = ["-f", "foo.txt"]
# (options, args) = parser.parse_args(args_list)
(options, args) = parser.parse_args()print(options.filename)
print(options.username)

生成程序帮助

optparse 另一个方便的功能是自动生成程序的帮助信息。你只需要为 add_option() 方法的 help 参数指定帮助信息文本：

from optparse import OptionParserusage = "usage: %prog [options] arg1 arg2"
parser = OptionParser(usage=usage)
parser.add_option("-v", "--verbose",action="store_true", dest="verbose", default=True,help="make lots of noise [default]"
)
parser.add_option("-q", "--quiet",action="store_false", dest="verbose",help="be vewwy quiet (I'm hunting wabbits)"
)
parser.add_option("-f", "--filename",metavar="FILE", help="write output to FILE"
)
parser.add_option("-m", "--mode",default="intermediate",help="interaction mode: novice, intermediate, ""or expert [default: %default]"
)(options, args) = parser.parse_args()

当 optparse 解析到 -h 或者 –help 命令行参数时，会调用 parser.print_help() 打印程序的帮助信息：

usage: <yourscript> [options] arg1 arg2options:-h, --help            show this help message and exit-v, --verbose         make lots of noise [default]-q, --quiet           be vewwy quiet (I'm hunting wabbits)-f FILE, --filename=FILEwrite output to FILE-m MODE, --mode=MODE  interaction mode: novice, intermediate, orexpert [default: intermediate]

注意： 打印出帮助信息后，optparse 将会退出，不再解析其它的命令行参数

usage = "usage: %prog [options] arg1 arg2" 这行信息会优先打印在程序的选项信息前。其中的 %prog，optparse 会以当前程序名的字符串来替代：如 os.path.basename.(sys.argv[0])。

如果用户没有提供自定义的使用方法信息，optparse 会默认使用： “usage: %prog [options]”。

用户在定义命令行参数的帮助信息时，不用担心换行带来的问题，optparse 会处理好这一切。

设置 add_option 方法中的 metavar 参数，有助于提醒用户，该命令行参数所期待的参数，如 metavar=“mode”：

-m MODE, --mode=MODE

注意： metavar 参数中的字符串会自动变为大写。

在 help 参数的帮助信息里使用 %default 可以插入该命令行参数的默认值。

显示程序版本

像 usage message 一样，你可以在创建 OptionParser 对象时，指定其 version 参数，用于显示当前程序的版本信息：parser = OptionParser(usage="%prog [-f] [-q]", version="%prog 1.0")
这样，optparse 就会自动解释 –version 命令行参数：$ /usr/bin/foo --version
foo 1.0

[root@localhost ~]# python  001.py --version
001.py 1.2

命令行参数分组

如果程序有很多的命令行参数，你可能想为他们进行分组，这时可以使用 OptonGroup：

from optparse import OptionParser
from optparse import OptionGroupusage = "usage: %prog [options] arg1 arg2"
parser = OptionParser(usage=usage)group = OptionGroup(parser,'Dangerous Options','Caution: use these options at your own risk.''It is believed that some of them bite.'
)
group.add_option('-g', action='store_true', help='Group option.')
parser.add_option_group(group)

完整代码：

from optparse import OptionParser
from optparse import OptionGroupusage = "usage: %prog [options] arg1 arg2"
parser = OptionParser(usage=usage)
parser.add_option("-v", "--verbose",action="store_true", dest="verbose", default=True,help="make lots of noise [default]"
)
parser.add_option("-q", "--quiet",action="store_false", dest="verbose",help="be vewwy quiet (I'm hunting wabbits)"
)
parser.add_option("-f", "--filename",metavar="FILE", help="write output to FILE"
)
parser.add_option("-m", "--mode",default="intermediate",help="interaction mode: novice, intermediate, ""or expert [default: %default]"
)group = OptionGroup(parser,'Dangerous Options','Caution: use these options at your own risk.''It is believed that some of them bite.'
)
group.add_option('-g', action='store_true', help='Group option.')
parser.add_option_group(group)(options, args) = parser.parse_args()

下面是将会打印出来的帮助信息：

Usage: opt.py [options] arg1 arg2Options:-h, --help            show this help message and exit-v, --verbose         make lots of noise [default]-q, --quiet           be vewwy quiet (I'm hunting wabbits)-f FILE, --filename=FILEwrite output to FILE-m MODE, --mode=MODE  interaction mode: novice, intermediate, or expert[default: intermediate]Dangerous Options:Caution: use these options at your own risk.It is believed that someof them bite.-g                  Group option.

处理异常

包括程序异常和用户异常。这里主要讨论的是用户异常，是指因用户输入无效的、不完整的命令行参数而引发的异常。optparse 可以自动探测并处理一些用户异常：

$ /usr/bin/foo -n 4x
usage: foo [options]
foo: error: option -n: invalid integer value: '4x'

$ /usr/bin/foo -n
usage: foo [options]
foo: error: -n option requires an argument

用户也可以使用 parser.error() 方法来自定义部分异常的处理：

(options, args) = parser.parse_args()
[...]
if options.a and options.b:parser.error("optionsnd -b are mutually exclusive")

上面的例子，当 -b 和 -b 命令行参数同时存在时，会打印出“options -a and -b are mutually exclusive“，以警告用户。

如果以上的异常处理方法还不能满足要求，你可能需要继承 OptionParser 类，并重载 exit() 和 erro() 方法。

示例代码 1：

import optparse# usage 定义的是使用方法，%prog 表示脚本本身，version定义的是脚本名字和版本号
parse = optparse.OptionParser(usage='"usage:%prog [options] arg1,arg2"', version="%prog 1.2")
parse.add_option('-u', '--user', dest='user', action='store', type=str, metavar='user', help='Enter User Name!!')
parse.add_option('-p', '--port', dest='port', type=int, metavar='xxxxx', default=3306, help='Enter Mysql Port!!')
parse.add_option('-v', help='Mysql Version!!')
# -u,--user 表示一个是短选项 一个是长选项
# dest='user' 将该用户输入的参数保存到变量user中，可以通过options.user方式来获取该值
# type=str，表示这个参数值的类型必须是str字符型，如果是其他类型那么将强制转换为str（可能会报错）
# metavar='user'，当用户查看帮助信息，如果metavar没有设值，那么显示的帮助信息的参数后面默认带上dest所定义的变量名
# help='Enter..',显示的帮助提示信息
# default=3306，表示如果参数后面没有跟值，那么将默认为变量default的值
parse.set_defaults(v=1.2)  # 也可以这样设置默认值options, args = parse.parse_args()
print('OPTIONS:', options)
print('ARGS:', args)
print('~' * 20)
print('user:', options.user)
print('port:', options.port)
print('version:', options.v)

运行结果：

python zzz.py -uroot -p3306
OPTIONS: {'v': 1.2, 'port': 3306, 'user': 'root'}
ARGS: []
~~~~~~~~~~~~~~~~~~~~
user: root
port: 3306
version: 1.2python  zzz.py --version
zzz.py 1.2

示例代码 2：

from optparse import OptionParserparser = OptionParser()
parser.add_option("-f", "--file", dest="filename",help="write report to FILE", metavar="FILE"
)
parser.add_option("-q", "--quiet",action="store_false", dest="verbose", default=True,help="don't print status messages to stdout"
)(options, args) = parser.parse_args()

现在你就可以在命令行下输入下面命令了：

<yourscript> --file=outfile -q
<yourscript> -f outfile --quiet
<yourscript> --quiet --file outfile
<yourscript> -q -foutfile
<yourscript> -qfoutfile

上面这些命令是相同效果的。除此之外， optparse 还为我们自动生成命令行的帮助信息：

<yourscript> -h
<yourscript> --help

输出：

usage: <yourscript> [options]
options:
-h, --help show this help message and exit
-f FILE, --file=FILE write report to FILE
-q, --quiet don't print status messages to stdout

示例代码 3：

from optparse import OptionParserdef main():usage = "usage: %prog [options] arg"parser = OptionParser(usage)parser.add_option("-f", "--file", dest="filename", help="read data from FILENAME")parser.add_option("-v", "--verbose", action="store_true", dest="verbose")parser.add_option("-q", "--quiet", action="store_false", dest="verbose")(options, args) = parser.parse_args()if len(args) != 1:parser.error("incorrect of arguments")if options.verbose:print("reading %s..." % options.filename)if __name__ == "__main__":main()