Python 有两个内建的模块用于处理命令行参数
:
一个是 getopt,《Deep in python》一书中也有提到,只能简单处理 命令行参数;
另一个是 optparse
,它功能强大,而且易于使用,可以方便地生成标准的、符合Unix/Posix 规范的命令行说明。
from optparse import OptionParser
[...]
parser = 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
流程
首先,必须 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 组成的列表。
class Argvhandler:
def __init__(self):
self.op=optparse.OptionParser()
self.op.add_option("-s","--server",dest="server")
self.op.add_option("-P","--port",dest="port")
options,args=self.op.parse_args()
#options为一个对象
#python ftp_sever.py -s 127.0.0.1 -P 8080
print(options)# {'server': '127.0.0.1', 'port': '8080'}
print(args) # []
#输入其它的参数
#python ftp_sever.py -s 127.0.0.1 -P 8080 star end
print(options) # {'server': '127.0.0.1', 'port': '8080'}
print(args) # ['star', 'end']
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 对象的值进行存取。
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)
parse_args()
返回的两个值:
- options,它是一个对象(optpars.Values),保存有命令行参数值。只要知道命令行参数名,如 user,就可以访问其对应的值: options.user
- args:返回一个位置参数的列表
action有三种类型:
- action=‘store’ 默认类型,可以忽略不写。用户必须给出一个明确的参数值,该类型定义了将实际参数值保存到dest指定变量中
- action=‘store_true’ 用户不需给出参数值,该类型定义了将布尔值true保存到dest指定的变量中
- action=‘store_false’ 用户不需给出参数值,该类型定义了将布尔值false保存到dest指定的变量中