python 模块 - optparse

optparse是专门用来在命令行添加选项的一个模块。

首先来看一段示例代码

leco@leco:/tmp/test$ cat test2.py 
import optparse

parser = optparse.OptionParser()
parser.add_option("-s","--server", dest="server", help="ftp server ip_addr")
parser.add_option("-P","--port",type="int", dest="port", help="ftp server port")
parser.add_option("-u","--username", dest="username", help="username info")
parser.add_option("-p","--password", dest="password", help="password info")
options, args = parser.parse_args()
print('options = ',options)
print('args = ',args)

运行

leco@leco:/tmp/test$ python3 test2.py
options =  {'port': None, 'username': None, 'server': None, 'password': None}
args =  []
leco@leco:/tmp/test$ python3 test2.py -h
Usage: test2.py [options]

Options:
  -h, --help            show this help message and exit
  -s SERVER, --server=SERVER
                        ftp server ip_addr
  -P PORT, --port=PORT  ftp server port
  -u USERNAME, --username=USERNAME
                        username info
  -p PASSWORD, --password=PASSWORD
                        password info
leco@leco:/tmp/test$ python3 test2.py  -s 192.168.1.110 -P8080 -ucaimz -pcmz cdcd  # 参数的顺序没有限制，
options =  {'port': 8080, 'username': 'caimz', 'server': '192.168.1.110', 'password': 'cmz'}
args =  ['cdcd']
leco@leco:/tmp/test$ python3 test2.py  -s 192.168.1.110  -ucaimz -pcmz cdcd
options =  {'server': '192.168.1.110', 'port': None, 'username': 'caimz', 'password': 'cmz'}
args =  ['cdcd']

 

add_option()参数说明：

action:存储方式，分为三种store、store_false、store_true

type:类型（我也不知道什么的类型）

dest:存储的变量

default:默认值

help:帮助信息

调用OptionParser.parse_args()剖析并返回一个directory和一个list。

 

 

简单流程

1. 首先，必须 import OptionParser 类，创建一个 OptionParser 对象： 

ptparse.OptionParser()

2. 使用 add_option 来定义命令行参数：

　　每个命令行参数就是由参数名字符串和参数属性组成的。如 -f 或者 –file 分别是长短参数名：

3. 最后，一旦你已经定义好了所有的命令行参数，调用 parse_args() 来解析程序的命令行：

　　options, args = parser.parse_args()

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

parse_args() 返回的两个值：

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