Python命令行解析模塊詳解

更新時間：2018年02月01日 09:24:46 作者：itlance_ouyang

這篇文章主要介紹了Python命令行解析模塊詳解，分享了相關代碼示例，小編覺得還是挺不錯的，具有一定借鑒價值，需要的朋友可以參考下

本文研究的主要是Python命令行解析模塊的相關內容，具體如下。

Python命令行常見的解析器有兩種，一是getopt模塊，二是argparse模塊。下面就解讀下這兩種解析器。

getopt模塊

這個模塊可以幫助腳本解析命令行參數(shù)，一般是sys.argv[1:]。它遵循著Unix的getopt()函數(shù)相同的約定（用-/--指定命令參數(shù)）。這個模塊提供兩個函數(shù)（getopt.getopt()/getopt.gnu_getopt()）和一個參數(shù)異常（getopt.GetoptError）。

這里重點介紹getopt.getopt()這個函數(shù)。

函數(shù)原型：getopt.getopt(args, options[, long_options])

這個函數(shù)有三個參數(shù)：

args：腳本要解析的命令行參數(shù)；
options:命令行短選項，如果指定的短選項后面需要跟參數(shù)的話，要在相應短選項后面加“：”，如e:；
long_options：命令行長選項，這個參數(shù)是可選的。如果指定的長選項后面要跟參數(shù)的話，要在相應長選項后面加上“=”，如conding=；

當給定的命令行參數(shù)解析不了的話，就會拋出GetoptError異常。

函數(shù)的返回值包含兩個元素：

第一個元素是一個（option,value）元組對。Option是解析的參數(shù)，value是對應參數(shù)的值；
第二個元素是腳本不需要執(zhí)行的參數(shù)列表。也就是這些參數(shù)是多余的；

下面看幾個Demo:

短選項：

>>> importgetopt
>>> args='-a -b -cfoo -d bar a1 a2'.split()
>>> args
['-a', '-b', '-cfoo', '-d', 'bar', 'a1','a2']
>>> optlist, args= getopt.getopt(args,'abc:d:')
>>> optlist
[('-a', ''), ('-b', ''), ('-c', 'foo'),('-d', 'bar')]
>>> args
['a1', 'a2']

長選項：

>>> s='--condition=foo --testing --output-file abc.def -x a1 a2'
>>> args= s.split()
>>> args
['--condition=foo', '--testing','--output-file', 'abc.def', '-x', 'a1', 'a2']
>>> optlist, args= getopt.getopt(args,'x', [
...   'condition=','output-file=','testing'])
>>> optlist
[('--condition', 'foo'), ('--testing', ''),('--output-file', 'abc.def'), ('-x', '')]
>>> args
['a1', 'a2']

在腳本當中經典的應用實例：

importgetopt,sys
 
defmain():
  try:
    opts, args = getopt.getopt(sys.argv[1:],"ho:v", ["help","output="])
  except getopt.GetoptErroras err:
    # print help information and exit:
    printstr(err) # will print something like "option -a not recognized"
    usage()
    sys.exit(2)
  output =None
  verbose =False
  for o, a in opts:
    if o =="-v":
      verbose =True
    elif o in ("-h","--help"):
      usage()
      sys.exit()
    elif o in ("-o","--output"):
      output = a
    else:
      assertFalse,"unhandled option"
  # ...
 
if __name__ =="__main__":
  main()

argparse模塊

argparse模塊使得編寫用戶友好的命令行接口非常容易。程序只需定義好它要求的參數(shù)，然后argparse將負責如何從sys.argv中解析出這些參數(shù)。argparse模塊還會自動生成幫助和使用信息并且當用戶賦給程序非法的參數(shù)時產生錯誤信息。
使用argparse模塊一般需要三個步驟：

1. 創(chuàng)建一個解析器

使用argparse的第一步是創(chuàng)建一個ArgumentParser對象：

>>> parser= argparse.ArgumentParser()

ArgumentParser對象會保存把命令行解析成Python數(shù)據(jù)類型所需要的所有信息。

2. 添加參數(shù)

通過調用add_argument()方法向ArgumentParser添加程序的參數(shù)信息。通常情況下，這些信息告訴ArgumentParser如何接收命令行上的字符串并將它們轉換成對象。這些信息被保存下來并在調用parse_args()時用到。例如：

>>> parser.add_argument('--name', help='username')
>>> parser.add_argument('--pass', help='password ')

接下來，調用parse_args()返回的對象將帶有兩個屬性，name和pass。分別保存著用戶名與密碼。

3. 解析參數(shù)

ArgumentParser通過parse_args()方法解析參數(shù)。它將檢查命令行，把每個參數(shù)轉換成恰當?shù)念愋筒⒉扇∏‘數(shù)膭幼?。在大部分情況下，這意味著將從命令行中解析出來的屬性建立一個簡單的 Namespace對象。

>>> argments = parser.parse_args(['--name','li','--pass','si'])

在腳本中，parse_args() 調用一般不帶參數(shù)，ArgumentParser 將根據(jù)sys.argv自動確定命令行參數(shù)。

ArgumentParser 對象

class argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter,prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True)

創(chuàng)建一個新的argmentParserr對象。所有的參數(shù)應該以關鍵字參數(shù)傳遞。下面有對每個參數(shù)各自詳細的描述，但是簡短地講它們是：