python类库31[命令行解析]

 

python解析命令行参数 [推荐使用optionparser]

 

一 手动对sys.argv[1:]解析

需要自己使用string比较或者regex来解析。

import sys
def TestSys():
  
for arg in sys.argv[1:]:
    
print (arg)

 

 

二 使用getopt模块来解析

1. 处理所使用的函数叫getopt(),因为是直接使用import导入的getopt模块,所以要加上限定getopt才可以。
2. 使用sys.argv[1:]过滤掉第一个参数(它是执行脚本的名字,不应算作参数的一部分)。
3. 使用短格式分析串"ho:"。当一个选项只是表示开关状态时,即后面不带附加参数时,在分析串中写入选项字符。当选项后面是带一个附加参数时,在分析串中写入选项字符同时后面加一个":"号。所以"ho:"就表示"h"是一个开关选项;"o:"则表示后面应该带一个参数。
4. 使用长格式分析串列表:["help", "output="]。长格式串也可以有开关状态,即后面不跟"="号。如果跟一个等号则表示后面还应有一个参数。这个长格式表示"help"是一个开关选项;"output="则表示后面应该带一个参数。
5. 调用getopt函数。函数返回两个列表:opts和args。opts为分析出的格式信息。args为不属于格式信息的剩余的命令行参数。opts是一个两元组的列表。每个元素为:(选项串,附加参数)。如果没有附加参数则为空串''。
6. 整个过程使用异常来包含,这样当分析出错时,就可以打印出使用信息来通知用户如何使用这个程序。

 

程序:

import sys
import getopt
def TestGetOpt():
  
try:
    opts, args 
= getopt.getopt(sys.argv[1:],'d:f:h',['days=','files=','help'])
  
except getopt.GetoptError:
     usage()
     sys.exit()

  
print (opts)
  
print (args)
  
for o, a in opts:
     
if o in ("-h""--help"):
         usage()
         sys.exit()
     
elif o in ("-d""--days"):
         day 
= a
     
elif o in ("-f""--files"):
         files 
= a
  
print (day)
  
print (files)

 

调用及结果:%prog -d 7 -f files.txt c:\backup

[('-d', '7'), ('-f', 'files.txt')]
['c:\\backup']
7
files.txt 

 

 

三 使用optionparser模块来解析

optionparser的执行过程:

导入optionparser : from optparse import OptionParser
构造optionparser的对象:parser = OptionParser()
往optionparser对象中增加option :parser.add_option()

调用optionparser的解析函数:(options, args) = parser.parse_args()
在options中使用解析到的options,在args中使用其他的args。

 

1)简单实例

def TestOpionparser():
  
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()
  
print (options.filename)
  
print (options.verbose)
  
print (args)

 

运行:%prog -f files.txt -q arg1 arg2

运行结果:

files.txt
False
['arg1', 'arg2']

 

2)更多更灵活的参数传入方式:

<yourscript> --file=outfile -q

<yourscript> -f outfile --quiet
<yourscript> --quiet --file outfile
<yourscript> -q -foutfile
<yourscript> -qfoutfile

 

3)帮助被自动的生成,只需要-h来显示

显示帮助:%prog -h

例如1)程序的帮助结果:

Usage: parsecommandline.py [options]

Options:
  -h, --help            show this help message and exit
  -f FILE, --file=FILE  write report to FILE
  -q, --quiet           don't print status messages to stdout

 

如果你需要显示自定义的,可以在定义optionparser时候传入,例如:

usage = "usage: %prog [options] arg1 arg2"
parser = OptionParser(usage=usage)

 

同时还可以增加程序的版本信息,简单地:

parser = OptionParser(usage="%prog [-f] [-q]", version="%prog 1.0")
调用:%prog --version

 

4)add_option()中参数的意义:

short option string: 为第一个参数,表示option的缩写,例如-f;

long option string: 为第二个参数,表示option的全拼,例如--file;

后面的参数皆为命名参数,命名参数为可选参数;

action=: 表示对此option的处理方式,默认值为store,表示存储option的值到解析后的options对象的成员中。action还可以有其他的值:对于bool值,使用store_true来默认存储true,使用store_false来默认存储false,store_const用来存储const设置的值到此option,append表示增加option的参数到list中,此时此option是一个list,可能包含多个值,count表示对counter增加一,callback表示调用指定的函数。所有的action值如下:

store + store_true + store_false + store_const + append + count + callback

type=:表示此option的值的类型,默认为string,可以指定为string, int, choice, float and complex

dest=:表示此option在经过optionparser解析后的options对象中成员的名字,默认使用long option string;

default=:表示比option的默认值;

metavar=:表示显示到help中option的默认值;

const=:当action为store_const的时候,需要设置此值;

choices=:当设置type为choices时,需要设置此值;

 

5)如果options很多的时候,可以进行分组,使用如下:

group = OptionGroup(parser)

group.add_option()
parser.add_option_group(group)

 

6)通常的使用如下,其中包含了parser.error()来抛出与optionparser较一致的异常和错误信息。

from optparse import OptionParser
[...]
def main():
    usage 
= "usage: %prog [options] arg"
    parser 
= OptionParser(usage)
    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")
    [...]
    (options, args) 
= parser.parse_args()
    
if len(args) != 1:
        parser.error(
"incorrect number of arguments")
    
if options.verbose:
        
print("reading %s..." % options.filename)
    [...]

if __name__ == "__main__":
    main()

 

 

 

完!

 

 

参考:

http://bbs.linuxtone.org/thread-4797-1-1.html

http://apps.hi.baidu.com/share/detail/6463885

 

完!

 

posted @ 2010-12-31 11:28  iTech  阅读(5149)  评论(0编辑  收藏  举报