python命令行参数解析

sys.argv

sys.argv[0]是脚本文件的名字，如：test.py

sys.argv[1:]是以空格分割的参数列表

getopt

函数原型：

getopt(args, shortopts, longopts = [])

参数：
args：需要解析的参数，一般是sys.argv[1:]
shortopts：短格式 (-)，有冒号:表示参数后面需要参数值，没有冒号表示后面无需参数值
longopts：长格式(--) ，有等号表示参数后面需要参数值，没有等号表示后面无需参数值
返回值：
options是个包含元祖的列表，每个元祖是分析出来的格式信息，比如 [('-i','127.0.0.1'),('-p','80')] ;
args 是个列表，包含那些没有‘-’或‘--’的参数，比如：['55','66']

示例：

import sys
import getopt
try:
    options,args = getopt.getopt(sys.argv[1:],"hp:i:", ["help","ip=","port="])
except getopt.GetoptError:
    sys.exit()
for name,value in options:
    if name in ("-h","--help"):
        usage()
    if name in ("-i","--ip"):
        print 'ip is----',value
    if name in ("-p","--port"):
        print 'port is----',value

python test.py -i 127.0.0.1 -p 80 55 66
python test.py --ip=127.0.0.1 --port=80 55 66

“hp:i:”
短格式 --- h 后面没有冒号：表示后面不带参数，p：和 i：后面有冒号表示后面需要参数
["help","ip=","port="]
长格式 --- help后面没有等号=，表示后面不带参数，其他三个有=，表示后面需要参数
注意：定义命令行参数时，要先定义带'-'选项的参数，再定义没有‘-’的参数

optparse

类OptionParser

class optparse.OptionParser(usage=None, 
                 option_list=None,
                 option_class=Option,
                 version=None,
                 conflict_handler="error",
                 description=None,
                 formatter=None,
                 add_help_option=True,
                 prog=None,
                 epilog=None)

参数：
usage：程序的使用说明，其中"%prog"会替换为文件名（或者prog属性，若指定了prog属性值），"[options]"会替换为各个参数的使用说明
version：版本号

函数add_option()

add_option(short, long, action, type, dest, default, help)

参数：
short option string: 为第一个参数，表示option的缩写，例如-f;
long option string: 为第二个参数，表示option的全拼，例如--file;
action=: 表示对此option的处理方式，默认值为store，表示存储option的值到解析后的options对象的成员中。

action还可以有其他的值：对于bool值，使用store_true来默认存储true，使用store_false来默认存储false，store_const用来存储const设置的值到此option，append表示增加option的参数到list中，此时此option是一个list，可能包含多个值，count表示对counter增加一，callback表示调用指定的函数。所有的action值如下：
store + store_true + store_false + store_const + append + count + callback

type=:表示此option的值的类型，默认为string，可以指定为string, int, choice, float and complex；
dest=：表示此option在经过optionparser解析后的options对象中成员的名字，默认使用long option string；
help=:表示这个参数的使用说明;
default=:表示比option的默认值；
metavar=:表示显示到help中option的默认值；
const=:当action为store_const的时候，需要设置此值；
choices=:当设置type为choices时，需要设置此值；

函数parse_args

(options, args) = parser.parse_args()

返回值：
options为是一个directory,它的内容为“参数/值 ”的键值对。
args是一个list，它的内容是所有参数除去options后，剩余的输入内容。

简单用法：

from optparse import OptionParser  
  
parser = OptionParser(usage="usage:%prog [options] arg1 arg2")  
parser.add_option("-t", "--timeout",  
                action = "store",  
                type = 'int',  
                dest = "timeout",  
                default = None,  
                help="Specify annalysis execution time limit"  
                )  
parser.add_option("-u", "--url",  
                action = "store_true",  
                dest = "url",  
                default = False,  
                help = "Specify if the target is an URL"  
                )
(options, args) = parser.parse_args() 
if options.url:  
    print(args[0])

复杂用法：参数分组

parser = optparse.OptionParser(version="%prog " + config.version)
# common_group
common_group = optparse.OptionGroup(
    parser, "Common Options",
    "Common options for code-coverage.")
parser.add_option_group(common_group)
common_group.add_option(
    "-l", "--lang", dest="lang", type="string", default="cpp",
    help="module language.", metavar="STRING")
common_group.add_option(
    "--module_id", dest="module_id", type="int", default=None,
    help="module id.", metavar="INT")
cpp_group = optparse.OptionGroup(
    parser, "C/C++ Options",
    "Special options for C/C++.")
# cpp_group
parser.add_option_group(cpp_group)
cpp_group.add_option(
    "--local-compile", action="store_true", dest="local_compile",
    help="compile locally, do not use compile cluster.")
cpp_group.add_option(
    "--module_path", dest="module_path", type="string", default=None,
    help="module path, like app/ecom/nova/se/se-as.", metavar="STRING")
    
options, arguments = parser.parse_args()
lang = options.lang
module_id = options.module_id
local_compile = options.local_compile
module_path = options.local_compile

argparse

类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)

参数：
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）

函数add_argument()

add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

参数：
name or flags：选项字符串的名字或者列表，例如foo 或者-f, --foo。
action：在命令行遇到该参数时采取的基本动作类型。
nargs：应该读取的命令行参数数目。
const：某些action和nargs选项要求的常数值。
default：如果命令行中没有出现该参数时的默认值。
type：命令行参数应该被转换成的类型。
choices：参数可允许的值的一个容器。
required：该命令行选项是否可以省略（只针对可选参数）。
help:参数的简短描述。
metavar：参数在帮助信息中的名字。
dest：给parse_args()返回的对象要添加的属性名称。