Python 的命令行参数处理 optparse->argparse

optaprse自2.7版开始弃用:弃用optparse模块,不会进一步开发,将继续开发argparse模块作为替代。

但是用习惯了optparse，还是很好用的撒。

optparse使用起来，相比旧的getopt模块，更方便、灵活而且解析命令行选项的库功能强大。

optparse使用声明样式的命令行解析:你创建一个OptionParser实例,填充选项,并解析命令行。

optparse允许用户使用在传统GNU / POSIX语法的选项,而且会生成的使用和帮助信息（就是你没有显式的定义-h/--help也可以调用查看）。

 1 from optparse import OptionParser 2  3 parser = OptionParser()
 4 parser.add_option("-f", "--file", dest="filename",
 5                   help="write report to FILE", metavar="FILE")
 6 parser.add_option("-q", "--quiet",
 7                   action="store_false", dest="verbose", default=True,
 8                   help="don‘t print status messages to stdout")
 9
10 (options, args) = parser.parse_args()

然后options保存一个dict对象，就是一个哈希表。arg就是剩下的参数了


optparse的option提供两种语法，就是短选项(short options)和长选项(long options)了

传统的Unix语法是一个连字符("-")后面紧跟一个字母,例如- x或- f。并且传统的Unix语法允许多个选项被合并成一个单一的参数,例如 ps -ef 相当于ps -e -f 。

GNU项目引入了"--"后面紧跟着一串可以用"-"分割的单词，像 --threads, --input-file-with-fq。

但是optparse功能强大支持就是，除了传统的option语法支持，还有一些奇葩语法也支持，或者少数派的。

  • 支持以"+"开头紧跟字母单词的(+rgb)
  • 支持以"-"开头但接多个字母的（和上面说的合并不是一回事,-pf）
  • 支持以"-"但是接一个单词的（-file, -in, -out）
  • 支持以"/"接单字母，多字母，单词的（这不就是MS-DOS的option语法吗，嘻嘻， dir /T /S /B /in /file）

optparse的option和option argument之间的空格必须有，但是能区分的情况下可以使用，-n10和-n 10是一样的

就是 -f disk和-fdisk（Linux/Unix允许，但optparse不），--file disk和--file=disk（Linux/Unix允许，但optparse不）


parser = OptionParser() 这就是创建一个OptionParser实例：

查看一下这个类有的方法：

 1 >>> for a in dir(optparse.OptionParser):
 2 ...     if not a.startswith("_"):
 3 ...         print a
 4 ...
 5 add_option
 6 add_option_group
 7 add_options
 8 check_values
 9 destroy
10 disable_interspersed_args
11 enable_interspersed_args
12 error
13 exit
14 expand_prog_name
15 format_description
16 format_epilog
17 format_help
18 format_option_help
19 get_default_values
20 get_description
21 get_option
22 get_option_group
23 get_prog_name
24 get_usage
25 get_version
26 has_option
27 parse_args
28 print_help
29 print_usage
30 print_version
31 remove_option
32 set_conflict_handler
33 set_default
34 set_defaults
35 set_description
36 set_process_default_values
37 set_usage
38 standard_option_list

OptionParser也可以指定参数呀，常用的usage等

usage (default: "%prog [options]") help的时候usage，表明程序的整体结构，不想显示的话，赋值usage=optparse.SUPPRESS_USAGE.

option_list (default: []) 已弃用，和add_option冗余

option_class (default: optparse.Option) add_option所使用的类

version (default: None) 默认是空，版本号不显示，True/False

conflict_handler (default: "error") 指定如果option有冲突的情况下如何处理

description (default: None) 在打印help的时候添加在usage后的一点介绍性文字

formatter (default: a new IndentedHelpFormatter) 打印help的时候的格式，可选IndentedHelpFormatter和TitledHelpFormatter.

add_help_option (default: True) 自动添加 -h和--help选项prog 默认值是 os.path.basename(sys.argv[0])，自定义usage和version中%prog

epilog (default: None) 打印help的时候添加在最后(option介绍之后)的一段说明文字


add_option方法使用

parser.add_option([short_option_str,long_option_str],attr_option_pair,...)

short_option_str和long_option_str，至少要有一个，可以有多个

attr_option_pair就是一组键值对attr=value, 有几个常用的，

  • action   读取对应option的value后怎么处理
  • dest      用哪个key引用(dict)或者理解为存到哪个变量中
  • nargs    表示该option有几个值，默认是1，则对饮的dest存的就是tuple
  • type      读取值得类型
  • choices  给定该option的值得选择范围
  • metavar 指定，option value的占位符
  • default   默认值
  • help       解释信息
  • ...

典型的：parser.add_option("-f", "--file", action="store", type="string", dest="name")

action指定在命令行参数中遇到一个选项(option)的时候应该怎么处理，默认的是store，就是将下一个参数在类型正确的情况下存到dest指定的中

action的值有以下这些：

  • store 默认的
  • store_const 存为常量，必须指定const
  • append 追加到一个列表
  • append_const 加为常量，必须指定const
  • count就是自加"++"，每有一个加一次
  • callback调用一个函数处理
  • store_true 真值 对应True
  • store_false 假值 对应False
  • help 打印usage信息以及所有option的信息，以及注释信息

如store_const

parser.add_option("-q", "--quiet",action="store_const", const=0, dest="verbose")
parser.add_option("-v", "--verbose",action="store_const", const=1, dest="verbose")
parser.add_option("--noisy",action="store_const", const=2, dest="verbose")

type表示值的类型限定：

  • string 接受为字符串类型 默认的
  • int 识别为整型
  • float 浮点型数字

metavar表示值得占位符

  • 举个例子，打印help的时候，一般 -f FILE, --file FILE 中的FILE就是这个变量指定的
  • 默认是把dest指定的内容，变成大写然后做占位符

dest 表示要保存读取的值到哪里

  • 默认没有指定的话，是长选项(long option name)一致的,如果长的也没有，就用短选项的，反正长短总得有

default 设置默认值

  • 就是即使没有指定这个Option或者它的值，dest指定的变量也会有值
  • 更直接的办法是用set_defaults()方法

help 是解释信息，解释你这个option是什么作用，注意事项是什么。

  • help可以使用%default来引用default指定的值 [2.4版开始]
  • 若default没有指定，则引用%default的值为None

Note:

1. 处理布尔型，开关型的参数option，action指定为store_true或者store_false, default则指定默认是True还是False. 例如常用的-v,--verbose; -q,--quiet


OptionGroup

当然如果option有类别之分，最好将其分组，每个组表示相对功能比较统一的一组，也就涉及到分组问题，optparse是有的啦。

我是在看cufflinks的代码的时候，是用Python写的，发现这个的，然后才阅读optparse的documentation了解的。

其实就是：

  1. 将OptionParser实例parser传给OptionGroup，创建OptionGroup实例，如命名为group_dgr
  2. 在所创建的实例group_dgr中添加选项条目，用group_dgr.add_option("","","",...)。
  3. 将group_dgr添加到parser(OptionParser的实例)
  4. 重复1-3，指导所添加的组都添加完成。
  1. group_dgr = OptionGroup(parser,"Group Name","Group Description")
  2. group_dgr.add_option("-g","--group",action="store_true",help="",dest=‘‘,default=False)
  3. add more options if avialable
  4. parser.add_option_group(group_dgr)

注意:

1. OptionParser中有一个getter方法()是get_option_group()，就是输入option，输出option所在的OptionGroup

2. 最后添加完了之后要用parser.parse_args() 来解析，输入2个元素列表，第一个元素是个dict，第二个是list。


注意到OptionParser有很多的getter和setter可供使用

19 get_default_values
20 get_description
21 get_option
22 get_option_group
23 get_prog_name
24 get_usage 
25 get_version

28 print_help
29 print_usage

30 print_version

对应的还有

32 set_conflict_handler
33 set_default
34 set_defaults
35 set_description
36 set_process_default_values
37 set_usage 可以不作为OptionParser的参数给定，然后通过此方法设置
38 standard_option_list


最后，还有错误处理，还有就打印个help需要这么麻烦吗。

时间： 2024-10-18 17:03:53

Python 的命令行参数处理 optparse->argparse的相关文章

【Python 命令行参数解析: optparse 模块】

大家在使用Python进行脚本开发时,经常需要通过终端交互的方式对Python的脚本模块进行调用.这时在 Python模块中提供基础的命令行参数支持是必不可少的.那么,在Python中我们如何实现命令行参数的传入和解析呢,如下内容将对此进行简要的介绍. Python对命令行参数解析的支持 Python中通过两个内建模块对命令行参数解析进行支持:getopt 和 optparse 两种内置支持 模块名 功能说明 getopt 对命令行参数进行简单的处理 optparse 能够对命令行参数进行复杂的

Python命令行参数处理之argparse模块

介绍 平时我们想要了解一个命令的用法时,会使用『 --help 』或是『 --version 』参数,Python中也可以自定义命令行参数. 用法实例 先创建一个Python脚本test.py import argparse # 创建解析 parser = argparse.ArgumentParser(prog="This is a description.") # 添加位置参数(必须参数) parser.add_argument("name", type = s

awk,perl,python的命令行参数处理

Python,Perl,Bash命令行参数 Part I 日常经常性的和Perl,Python,Bash打交道,但是又经常性的搞混他们之间,在命令行上的特殊性和index的区别,Python真的是人性化到家了,但是命令行上就很原始,但是很有分类感.还是会喜欢Perl一点(至少还可以动脑子,不至于生锈),感觉Perl是个杂合子,而python像胡彦斌,bash像韩红(最近看我是歌手第三季,嘻嘻).Bash就是家常菜了,虽然Perl可以大部分代替Bash的功能,像grep sort map等,但是某

Python处理命令行参数

1. 将命令行参数保存在列表中,注意argv[0]是程序本身的名字: import sys print(sys.argv) print(sys.argv[1]) python argv.py localhost 3306['argv.py', 'localhost', '3306']localhost 2. 使用sys.stdin和fileinput读取标准输入,并打印在终端类似shell中的管道 import sys for line in sys.stdin: print(line,end=

Python 获得命令行参数的方法

本篇将介绍python中sys, getopt模块处理命令行参数 如果想对python脚本传参数,python中对应的argc, argv(c语言的命令行参数)是什么呢?需要模块:sys参数个数:len(sys.argv)脚本名: sys.argv[0]参数1: sys.argv[1]参数2: sys.argv[2] test.py 1 import sys 2 print "脚本名:", sys.argv[0] 3 for i in range(1, len(sys.argv)):

python中命令行参数

python中的命令行参数 python中有一个模块sys,sys.argv这个属性提供了对命令行参数的访问.命令行参数是调用某个程序时除程序名外的其他参数. sys.argv是命令行参数的列表 len(sys.argv)是命令行参数的个数 下面我们用一个简单的例子来说明一下. #!/usr/bin/python #coding:utf-8 import sys ##加载sys这个模块. for i in range(len(sys.argv)): print "第%d个参数是:%s"

Python 中命令行参数解析工具 docopt 安装和应用

什么是 docopt? 1.docopt 是一种 Python 编写的命令行执行脚本的交互语言. 它是一种语言! 它是一种语言! 它是一种语言! 2.使用这种语言可以在自己的脚本中,添加一些规则限制.这样脚本在执行的时候就必须按照这样格式来执行,同时,也可以很方便的编写一些帮助信息(其实很多软件在输入 -h 的时候显示信息 .例如 python -h ,会显示所有的 python 指令,并且页通过 docopt 限制了 python 指令的格式),下面是一些简单的例子: docopt 的安装 d

python添加命令行参数和异常处理

异常处理+命令行解析库argparse Socket.error 与一般I/O和通信问题有关的 Socket.gaierror 与查询地址有关的 Socket.herror 与其他地址错误有关 Socket.timeout 与一个socket上调用settimeout()后,超时处理有关 #-*- coding:utf-8 -*- import sys import socket import argparse #通过命令行输入参数 python 1_7_socket_errors.py --h

python的命令行参数处理

import argparse # A position argument func_choice = {'client' : 'client function', "server" : "server function"} # parser parser = argparse.ArgumentParser(description = "Select your favorite function") # add argument parser.a