python之argparse子產品的使用

以下内容主要來自：http://wiki.jikexueyuan.com/project/explore-python/Standard-Modules/argparse.html

argparse 使用

簡單示例

我們先來看一個簡單示例。主要有三個步驟：

• 建立 ArgumentParser() 對象
• 調用 add_argument() 方法添加參數
• 使用 parse_args() 解析添加的參數

示例：

1 2 3 4 5 6 7 8 9

# -*- coding: utf-8 -*- import argparse parser = argparse.ArgumentParser() parser.add_argument( 'integer' , type= int , help= 'display an integer' ) args = parser.parse_args() print(args.integer)

 将上面的代碼儲存為檔案 

argparse_usage.py

，在終端運作，結果如下：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

$ python argparse_usage.py usage: argparse_usage.py [-h] integer argparse_usage.py: error: too few arguments $ python argparse_usage.py abcd usage: argparse_usage.py [-h] integer argparse_usage.py: error: argument integer: invalid  int value:  'abcd' $ python argparse_usage.py -h usage: argparse_usage.py [-h] integer positional arguments: integer     display an integer optional arguments: -h, --help  show  this help message and exit $ python argparse_usage.py 10 10

定位參數

上面的示例，其實就展示了定位參數的使用，我們再來看一個例子 - 計算一個數的平方：

1 2 3 4 5 6 7 8

# -*- coding: utf-8 -*- import argparse parser = argparse.ArgumentParser() parser.add_argument( "square" , help= "display a square of a given number" , type= int ) args = parser.parse_args() print(rgs.square**2)

 将上面的代碼儲存為檔案 

argparse_usage.py

，在終端運作，結果如下：

1 2	$ python argparse_usage.py 9 81

可選參數

現在看下可選參數的用法，所謂可選參數，也就是指令行參數是可選的，廢話少說，看下面例子：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

# -*- coding: utf-8 -*- import argparse parser = argparse.ArgumentParser() parser.add_argument( "--square" , help= "display a square of a given number" , type= int ) parser.add_argument( "--cubic" , help= "display a cubic of a given number" , type= int ) args = parser.parse_args() if args.square: print(args.square**2) if args.cubic: print(args.cubic**3)

将上面的代碼儲存為檔案 

argparse_usage.py

，在終端運作，結果如下：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

$ python argparse_usage.py --h usage: argparse_usage.py [-h] [--square SQUARE] [--cubic CUBIC] optional arguments: -h, --help       show  this help message and exit --square SQUARE  display a square of a given number --cubic CUBIC    display a cubic of a given number $ python argparse_usage.py --square 8 64 $ python argparse_usage.py --cubic 8 512 $ python argparse_usage.py 8 usage: argparse_usage.py [-h] [--square SQUARE] [--cubic CUBIC] argparse_usage.py: error: unrecognized arguments: 8 $ python argparse_usage.py  # 沒有輸出

混合使用

定位參數和選項參數可以混合使用，看下面一個例子，給一個整數序列，輸出它們的和或最大值（預設）：

1 2 3 4 5 6 7 8 9 10 11

import argparse parser = argparse.ArgumentParser(description= 'Process some integers.' ) parser.add_argument( 'integers' , metavar= 'N' , type= int , nargs= '+' , help= 'an integer for the accumulator' ) parser.add_argument( '--sum' , dest= 'accumulate' , action= 'store_const' , const =sum,  default =max, help= 'sum the integers (default: find the max)' ) args = parser.parse_args() print(args.accumulate(args.integers))

結果：

1 2 3 4 5 6 7

$ python argparse_usage.py usage: argparse_usage.py [-h] [--sum] N [N ...] argparse_usage.py: error: too few arguments $ python argparse_usage.py 1 2 3 4 4 $ python argparse_usage.py 1 2 3 4 --sum 10

add_argument() 方法

add_argument() 方法定義如何解析指令行參數：

1	ArgumentParser.add_argument(name or flags...[, action][, nargs][,  const ][,  default ][, type][, choices][, required][, help][, metavar][, dest])

每個參數解釋如下:

• name or flags - 選項字元串的名字或者清單，例如 foo 或者 -f, --foo。
• action - 指令行遇到參數時的動作，預設值是 store。
  • store_const，表示指派為const；
  • append，将遇到的值存儲成清單，也就是如果參數重複則會儲存多個值;
  • append_const，将參數規範中定義的一個值儲存到一個清單；
  • count，存儲遇到的次數；此外，也可以繼承 argparse.Action 自定義參數解析；
• nargs - 應該讀取的指令行參數個數，可以是具體的數字，或者是?号，當不指定值時對于 Positional argument 使用 default，對于 Optional argument 使用 const；或者是 * 号，表示 0 或多個參數；或者是 + 号表示 1 或多個參數。
• const - action 和 nargs 所需要的常量值。
• default - 不指定參數時的預設值。
• type - 指令行參數應該被轉換成的類型。
• choices - 參數可允許的值的一個容器。
• required - 可選參數是否可以省略 (僅針對可選參數)。
• help - 參數的幫助資訊，當指定為 

  argparse.SUPPRESS

   時表示不顯示該參數的幫助資訊.
• metavar - 在 usage 說明中的參數名稱，對于必選參數預設就是參數名稱，對于可選參數預設是全大寫的參數名稱.
• dest - 解析後的參數名稱，預設情況下，對于可選參數選取最長的名稱，中劃線轉換為下劃線.