前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Python的OptionParser模块教程

Python的OptionParser模块教程

原创
作者头像
Python学习者
发布2023-01-08 16:39:14
3260
发布2023-01-08 16:39:14
举报
文章被收录于专栏:Python学习者

Python中强大的选项处理模块。

示例

代码语言:python
代码运行次数:0
复制
#!/usr/bin/pythonfrom 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()

print options.filename,options.verbose

将上面代码保存到文件option1.py(名字随便),添加执行权限并运行:

代码语言:python
代码运行次数:0
复制
./option1.py
./option1.py -f
./option1.py -f foo.txt
./option1.py -f foo.txt -q
./option1.py -qffoo.txt # 注意这个和下面对比
./option1.py -fqfoo.txt
./option1.py --file foo.txt
./option1.py --quiet
./option1.py -h   # -h和--help默认情况optpars自动处理。
./option1.py --help

查看输出结果,稍稍思考就有所的了。

加载模块

要使用 OptionParser 模块,需要在Python程序中导入:

代码语言:python
代码运行次数:0
复制
from optparse import OptionParser

生成 OptionParser 实例

首先需要生成一个实例,以后的操作都是操作这个实例,相当于分配了一段内存空 间。不然无处可以操作,类似C中的结构说明。不过Python是面向”对象“的语言。对 象的属性比结构多很多,可操作性更强,后面我们会介绍在生成 OptionParser 对象 的时候可以传递的一些参数。

代码语言:python
代码运行次数:0
复制
usage = "usage: %prog [options] arg" # 定义字符串
parser = OptionParser(usage) # 传递一个字符串参数

OptionParser 不要求一定要传递参数,不过传递一些参数,可以方便程序使用。

代码语言:python
代码运行次数:0
复制
OptionParser(usage="%prog [-f] [-g]",version="%prog 1.0")
    # %prog 在这里会自动替换为程序名字
    # usage 可以打印用法
    # version 在使用 %prog --version 的时候输出版本信息

使用add_option添加命令行参数

代码语言:python
代码运行次数:0
复制
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")

最后调用parse_args()解析命令行参数

代码语言:python
代码运行次数:0
复制
(options, args) = parser.parse_args()

可以传递一个参数列表给parse_args(),否则,默认使用命令行参数 (sys.argv1:)。parse_args()返回两个值:

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

parse_args()方法的参数

action

action是parse_args()方法的参数之一,指示optparser解析参数时候该如何处理。 action有一组固定的值可以选择,默认是'store',表是将命令行参数值保存到 options对象里。

代码语言:python
代码运行次数:0
复制
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"

action的值有:store,store_true,store_false,store_const,append,count,callback.

type

type的默认值是"string",也可以是"int""float"等。

dest

如果没有指定dest参数,将用命令行的参数名来对options对象的值进行存取。

store的形式

store可以为 store_true 和 store_false 两种形式。用于处理命令行参数后面不 带值的情况。如 -v, -q 等命令行参数:

代码语言:python
代码运行次数:0
复制
parser.add_option("-v",action="store_true",dest="verbose")
parser.add_option("-q",action="store_false",dest="verbose")

当解析到 -v ,options.verbose值为True,解析到 -q , 值为 False。注意,这里 顺序解析,所以如果有 -vq,最终的值还是False。

default — 设置默认值

代码语言:python
代码运行次数:0
复制
# python学习交流:711312441
parser.add_option("-f","--file",
	action="store",
	dest="filename",
	default="foo.txt")
parser.add_option("-v",
	action="store_true",
	dest="verbose",
	default=True)

help — 指定帮助文档

代码语言:python
代码运行次数:0
复制
parser.add_option("-f", "--filename",
                  metavar="FILE",
                  help="write output to FILE"),

optparse解析到 -h 或者 —help 命令行参数时,调用 parser.print_help()输出 程序帮助信息。help字段很有用。

metavar — 提示用户期望参数

Group — 给参数分组

代码语言:python
代码运行次数:0
复制
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)

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 示例
  • parse_args()方法的参数
  • Group — 给参数分组
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档