python optparse命令解析模块

Posted wangmo

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了python optparse命令解析模块相关的知识，希望对你有一定的参考价值。

来源：http://www.cnblogs.com/pping/p/3989098.html?utm_source=tuicool&utm_medium=referral

来源：http://www.cnblogs.com/darkpig/p/5677153.html

来源：点击打开链接

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

 

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

 

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

action有三种类型：
action=\'store\' 默认类型，可以忽略不写。用户必须给出一个明确的参数值，该类型定义了将实际参数值保存到dest指定变量中
action=\'store_true\' 用户不需给出参数值，该类型定义了将布尔值true保存到dest指定的变量中
action=\'store_false\' 用户不需给出参数值，该类型定义了将布尔值false保存到dest指定的变量中

[root@localhost ~]# python mysql.py -uroot -p3306
OPTIONS: {\'v\': 1.2, \'port\': 3306, \'user\': \'root\'}
ARGS: []
~~~~~~~~~~~~~~~~~~~~
user: root
port: 3306
version: 1.2

 

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

 

 

示例 2

 

[python] view plain copy
 
  1. <span style="font-size:12px;"># coding = utf-8  
  2.   
  3. from optparse import OptionParser  
  4. from optparse import OptionGroup  
  5.   
  6. usage = \'Usage: %prog [options] arg1 arg2 ...\'  
  7.   
  8. parser = OptionParser(usage,version=\'%prog 1.0\')  
  9. #通过OptionParser类创建parser实例,初始参数usage中的%prog等同于os.path.basename(sys.argv[0]),即  
  10. #你当前所运行的脚本的名字，version参数用来显示当前脚本的版本。  
  11.   
  12. \'\'\'\'\' 
  13. 添加参数，-f、--file是长短options，有一即可。 
  14.  
  15. action用来表示将option后面的值如何处理，比如: 
  16. XXX.py -f test.txt 
  17. 经过parser.parse_args()处理后,则将test.txt这个值存储进-f所代表的一个对象，即定义-f中的dest 
  18. 即option.filename = \'test.txt\' 
  19. action的常用选项还有store_true,store_false等，这两个通常在布尔值的选项中使用。 
  20.  
  21. metavar仅在显示帮助中有用，如在显示帮助时会有： 
  22. -f FILE, --filename=FILE    write output to FILE 
  23. -m MODE, --mode=MODE  interaction mode: novice, intermediate, or expert 
  24.                         [default: intermediate] 
  25. 如果-f这一项没有metavr参数，则在上面会显示为-f FILENAME --filename=FILENAME,即会显示dest的值 
  26.  
  27. defalut是某一选项的默认值，当调用脚本时，参数没有指定值时，即采用default的默认值。 
  28. \'\'\'  
  29.   
  30. parser.add_option(\'-f\',\'--file\',  
  31.                   action=\'store\',dest=\'filename\',  
  32.                   metavar=\'FILE\',help=\'write output to FILE\')  
  33.   
  34. parser.add_option(\'-m\',\'--mode\',  
  35.                   default = \'intermediate\',  
  36.                   help=\'interaction mode:novice,intermediate,or expert [default:%default]\')  
  37. parser.add_option(\'-v\',\'--verbose\',  
  38.                   action=\'store_true\',dest=\'verbose\',default=True,  
  39.                   help=\'make lots of noise [default]\')  
  40.   
  41. parser.add_option(\'-q\',\'--quiet\',  
  42.                   action=\'store_false\',dest=\'verbose\',  
  43.                   help="be vewwy quiet (I\'m hunting wabbits)")  
  44.   
  45. group = OptionGroup(parser,\'Dangerous Options\',  
  46.                     \'Caution: use these options at your own risk.\'  
  47.                     \'It is believed that some of them bite.\')  
  48. #调用OptionGroup类，定制以组显示的option  
  49.   
  50. group.add_option(\'-g\',action=\'store_true\',help=\'Group option.\')  
  51. #添加option  
  52. parser.add_option_group(group)  
  53. #将刚定制的groupoption加入parser中  
  54.   
  55. group = OptionGroup(parser,\'Debug Options\')  
  56. group.add_option(\'-d\',\'--debug\',action=\'store_true\',  
  57.                  help=\'Print debug information.\')  
  58. group.add_option(\'-s\',\'--sql\',action=\'store_true\',  
  59.                  help=\'Print all SQL statements executed\')  
  60. group.add_option(\'-e\',action=\'store_true\',help=\'Print every action done\')  
  61. parser.add_option_group(group)  
  62.   
  63. (options,args) = parser.parse_args()  
  64. #解析脚本输入的参数值，options是一个包含了option值的对象  
  65. #args是一个位置参数的列表</span>  
[plain] view plain copy
 
  1. <span style="font-size:12px;">python.exe xxx.py --help显示结果如下：  
  2.   
  3. Usage: test_optparse.py [options] arg1 arg2 ...  
  4.   
  5. Options:  
  6.   --version             show program\'s version number and exit  
  7.   -h, --help            show this help message and exit  
  8.   -f FILE, --file=FILE  write output to FILE  
  9.   -m MODE, --mode=MODE  interaction mode:novice,intermediate,or expert  
  10.                         [default:intermediate]  
  11.   -v, --verbose         make lots of noise [default]  
  12.   -q, --quiet           be vewwy quiet (I\'m hunting wabbits)  
  13.   
  14.   Dangerous Options:  
  15.     Caution: use these options at your own risk.It is believed that some  
  16.     of them bite.  
  17.   
  18.     -g                  Group option.  
  19.   
  20.   Debug Options:  
  21.     -d, --debug         Print debug information.  
  22.     -s, --sql           Print all SQL statements executed  
  23.     -e                  Print every action done</span>  

Python： 使用 optparse 处理命令行参数

Python 有两个内建的模块用于处理命令行参数，一个是 getopt，《Deep in
python》一书中也有提到，只能简单处理命令行参数；另一个是 optparse，它功能强大，而且易于使用，可以方便地生成标准的、符合

Unix/Posix 规范的命令行说明。

 

示例

 

下面是一个使用 optparse 的简单示例：

[python] view plain copy
 
  1. from optparse import OptionParser  
  2. [...]  
  3. parser = OptionParser()  
  4. parser.add_option("-f", "--file", dest="filename",  
  5.                   help="write report to FILE", metavar="FILE")  
  6. parser.add_option("-q", "--quiet",  
  7.                   action="store_false", dest="verbose", default=True,  
  8.                   help="don\'t print status messages to stdout")  
  9.   
  10. (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

 

简单流程

 

首先，必须 import 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()

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

parse_args() 返回的两个值：

  • options，它是一个对象（optpars.Values），保存有命令行参数值。只要知道命令行参数名，如 file，就可以访问其对应的值： options.file 。
  • args，它是一个由 positional arguments 组成的列表。

Actions

action 是 parse_args() 方法的参数之一，它指示 optparse 当解析到一个命令行参数时该如何处理。actions 有一组固定的值可供选择，默认是’store‘，表示将命令行参数值保存在 options 对象里。

 

示例

parser.add_option("-f", "--file",
                  action="store", type="string", dest="filename")
args = ["-f", "foo.txt"]
(options, args) = parser.parse_args(args)
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 对象的值进行存取。

store 也有其它的两种形式： 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 值。

其它的 actions 值还有：

store_const、append、count、callback。

默认值

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()：

parser.set_defaults(filename="foo.txt",verbose=True
parser.add_option(...)
(options, args) = parser.parse_args()

生成程序帮助

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

usage = "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]")

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

usage: <yourscript> [options] arg1 arg2

options:
  -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=FILE
                        write output to FILE
  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or
                        expert [default: intermediate]

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

以上面的例子来一步步解释如何生成帮助信息：

  • 自定义的程序使用方法信息（usage message）：

    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 可以插入该命令行参数的默认值。

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

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)

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

usage:  [options] arg1 arg2

options:
  -h, --help           show this help message and exit
  -v, --verbose        make lots of noise [default]
  -q, --quiet          be vewwy quiet (I\'m hunting wabbits)
  -fFILE, --file=FILE  write output to FILE
  -mMODE, --mode=MODE  interaction mode: one of \'novice\', \'intermediate\'
                       [default], \'expert\'

  Dangerous Options:
    Caution: use of these options is at your own risk.  It is believed that
    some of them bite.
    -g                 Group option.

显示程序版本

象 usage message 一样，你可以在创建 OptionParser 对象时，指定其 version 参数，用于显示当前程序的版本信息：

parser = OptionParser(usage="%prog [-f] [-q]", version="%prog 1.0")

这样，optparse 就会自动解释 –version 命令行参数：

$ /usr/bin/foo --version
foo 1.0

处理异常

包括程序异常和用户异常。这里主要讨论的是用户异常，是指因用户输入无效的、不完整的命令行参数而引发的异常。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() 方法。

完整的程序例子

from optparse import OptionParser
[...]
def 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("incorrecter of arguments")
    if options.verbose:
        print "reading %s..." % options.filename
    [...]

if __name__ == "__main__":
    main()

以上是关于python optparse命令解析模块的主要内容，如果未能解决你的问题，请参考以下文章

python模块-optparse(解析命令行参数)

python中optparse模块用法

python OptParse模块的用法详解

argparse - 命令行选项与参数解析

Python中optparse模块使用浅析

为啥使用 argparse 而不是 optparse？