Python命令行参数解析模块
命令行参数解析模块
在Python中,解析命令行参数通常使用sys.argv和optparse模块。
optparse模块主要用于解析脚本的命令行参数,通过预先定义好的选项来处理输入参数。
通过实例化OptionParser对象可以创建解析器(可带参数,也可不带参数),带参数时会将参数内容作为帮助信息输出。
模块简介
基本用法示例
import optparse
parser = optparse.OptionParser() # 创建解析器对象
parser.add_option("-s", "--server", dest="server", help="指定FTP服务器IP地址") # 定义字符串参数
parser.add_option("-P", "--port", type="int", dest="port", help="指定FTP服务器端口") # 定义整数参数
parser.add_option("-u", "--username", dest="username", help="指定用户名") # 定义字符串参数
parser.add_option("-p", "--password", dest="password", help="指定密码") # 定义字符串参数
simulated_args = ['-s', '192.168.1.1', '-P', '8080', '-u', 'admin', '-p', 'secret'] # 模拟命令行参数
options, args = parser.parse_args(simulated_args) # 解析参数
add_option方法参数说明:
- dest:用于存储参数的属性名称,多个参数用逗号分隔
- type:指定参数值的数据类型(如字符串、整数、浮点数)
- help:显示在帮助信息中的说明
- metavar:在帮助信息中显示参数的占位符名称
- default:未指定参数时的默认值
深入解析
创建解析器对象
创建OptionParser对象时可传入以下参数:
- usage:指定帮助信息中的使用格式
- version:指定版本信息
- description:帮助信息中的描述部分
- add_help_option:是否自动添加
-h/--help选项
定义参数选项 支持多种类型的动作处理:
- store:存储参数值(需要参数)
- store_true:存储
True(无需参数) - store_false:存储
False(无需参数) - append:将值添加到列表中(需要参数)
- store_const:存储固定常量值(无需参数)
- append_const:将常量值添加到列表中(无需参数)
- count:统计选项出现次数(无需参数)
- callback:自定义回调函数
操作选项
- has_option:检查是否存在指定选项
- remove_option:移除指定选项
- set_default:设置默认值
选项分组
可以通过OptionGroup将相关选项分组:
group = optparse.OptionGroup(parser, title="网络设置", description="用于指定网络连接参数")
group.add_option("-H", "--host", ...)
parser.add_option_group(group)
解析参数
parse_args方法返回两个值:
- options:包含所有已解析选项的命名空间对象
- args:未解析的剩余参数列表
帮助信息
默认支持-h和--help选项显示帮助信息:
parser = optparse.OptionParser(usage="%prog [options]", description="这是一个示例程序")
parser.add_option("-v", "--version", version="%prog 1.0", help="显示程序版本")
parser.print_help()
可以通过以下方法自定义帮助信息:
- print_usage:输出使用格式
- print_description:输出描述信息
- print_version:输出版本信息