2. 程式人生 > >【轉】python argparse用法總結

【轉】python argparse用法總結

阿新 • • 發佈：2019-01-20
-- virt asc 可用 nal calc mutual ror 就會

轉自：https://www.jianshu.com/p/fef2d215b91d

1. argparse介紹

是python的一個命令行解析包，非常編寫可讀性非常好的程序

2. 基本用法

prog.py是我在linux下測試argparse的文件，放在/tmp目錄下，其內容如下：

#!/usr/bin/env python
# encoding: utf-8


import argparse
parser = argparse.ArgumentParser()
parser.parse_args()

測試：

yarving@yarving-VirtualBox /tmp $ python prog.py 

yarving@yarving-VirtualBox /tmp $ python prog.py --help
usage: prog.py [-h]

optional arguments:
  -h, --help  show this help message and exit

yarving@yarving-VirtualBox /tmp $ python prog.py -v 
usage: prog.py [-h]
prog.py: error: unrecognized arguments: -v

yarving@yarving-VirtualBox /tmp $ python prog.py foo
usage: prog.py [-h]
prog.py: error: unrecognized arguments: foo
  • 第一個沒有任何輸出和出錯
  • 第二個測試為打印幫助信息，argparse會自動生成幫助文檔
  • 第三個測試為未定義的-v參數，會出錯
  • 第四個測試為未定義的參數foo，出錯

3. positional arguments

positional arguments為英文定義，中文名叫有翻譯為定位參數的，用法是不用帶-就可用
修改prog.py的內容如下：

#!/usr/bin/env python
# encoding: utf-8


import argparse


parser = argparse.ArgumentParser()
parser.add_argument("echo")
args = parser.parse_args()
print args.echo

執行測試如下

yarving@yarving-VirtualBox /tmp $ python prog.py   
usage: prog.py [-h] echo
prog.py: error: too few arguments

yarving@yarving-VirtualBox /tmp $ python prog.py -h
usage: prog.py [-h] echo

positional arguments:
  echo

optional arguments:
  -h, --help  show this help message and exit

yarving@yarving-VirtualBox /tmp $ python prog.py hahahaha
hahahaha

定義了一個叫echo的參數，默認必選

  • 第一個測試為不帶參數，由於echo參數為空，所以報錯，並給出用法（usage）和錯誤信息
  • 第二個測試為打印幫助信息
  • 第三個測試為正常用法，回顯了輸入字符串hahahaha

4. optional arguments

中文名叫可選參數，有兩種方式：

  1. 一種是通過一個-來指定的短參數，如-h；
  2. 一種是通過--來指定的長參數，如--help

這兩種方式可以同存，也可以只存在一個，修改prog.py內容如下：

#!/usr/bin/env python
# encoding: utf-8


import argparse


parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbosity", help="increase output verbosity")
args = parser.parse_args()
if args.verbosity:
        print "verbosity turned on"

註意這一行：parser.add_argument("-v", "--verbosity", help="increase output verbosity")
定義了可選參數-v或--verbosity，通過解析後，其值保存在args.verbosity變量中
用法如下：

yarving@yarving-VirtualBox /tmp $ python prog.py -v 1
verbosity turned on

yarving@yarving-VirtualBox /tmp $ python prog.py --verbosity 1
verbosity turned on

yarving@yarving-VirtualBox /tmp $ python prog.py -h           
usage: prog.py [-h] [-v VERBOSITY]

optional arguments:
  -h, --help            show this help message and exit
  -v VERBOSITY, --verbosity VERBOSITY
                        increase output verbosity

yarving@yarving-VirtualBox /tmp $ python prog.py -v 
usage: prog.py [-h] [-v VERBOSITY]
prog.py: error: argument -v/--verbosity: expected one argument
  • 測試1中，通過-v來指定參數值
  • 測試2中，通過--verbosity來指定參數值
  • 測試3中，通過-h來打印幫助信息
  • 測試4中，沒有給-v指定參數值，所以會報錯

5. action=‘store_true‘

上一個用法中-v必須指定參數值，否則就會報錯，有沒有像-h那樣，不需要指定參數值的呢，答案是有，通過定義參數時指定action="store_true"即可，用法如下

#!/usr/bin/env python
# encoding: utf-8


import argparse


parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbose", help="increase output verbosity",
                    action="store_true")
args = parser.parse_args()
if args.verbose:
        print "verbosity turned on"

測試：

yarving@yarving-VirtualBox /tmp $ python prog.py -v
verbosity turned on

yarving@yarving-VirtualBox /tmp $ python prog.py -h
usage: prog.py [-h] [-v]

optional arguments:
  -h, --help     show this help message and exit
  -v, --verbose  increase output verbosity

第一個例子中，-v沒有指定任何參數也可，其實存的是True和False，如果出現，則其值為True，否則為False

6. 類型 type

默認的參數類型為str，如果要進行數學計算，需要對參數進行解析後進行類型轉換，如果不能轉換則需要報錯，這樣比較麻煩
argparse提供了對參數類型的解析，如果類型不符合，則直接報錯。如下是對參數進行平方計算的程序：

#!/usr/bin/env python
# encoding: utf-8


import argparse


parser = argparse.ArgumentParser()
parser.add_argument(‘x‘, type=int, help="the base")
args = parser.parse_args()
answer = args.x ** 2
print answer

測試

yarving@yarving-VirtualBox /tmp $ python prog.py 2
4

yarving@yarving-VirtualBox /tmp $ python prog.py two
usage: prog.py [-h] x
prog.py: error: argument x: invalid int value: ‘two‘

yarving@yarving-VirtualBox /tmp $ python prog.py -h 
usage: prog.py [-h] x

positional arguments:
  x           the base

optional arguments:
  -h, --help  show this help message and exit
  • 第一個測試為計算2的平方數，類型為int，正常
  • 第二個測試為一個非int數，報錯
  • 第三個為打印幫助信息

7. 可選值choices=[]

5中的action的例子中定義了默認值為True和False的方式，如果要限定某個值的取值範圍，比如6中的整形，限定其取值範圍為0， 1， 2，該如何進行呢？
修改prog.py文件如下：

#!/usr/bin/env python
# encoding: utf-8


import argparse


parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print "the square of {} equals {}".format(args.square, answer)
elif args.verbosity == 1:
    print "{}^2 == {}".format(args.square, answer)
else:
    print answer

測試如下：

yarving@yarving-VirtualBox /tmp $ python prog.py 4 -v 0
16
yarving@yarving-VirtualBox /tmp $ python prog.py 4 -v 1
4^2 == 16
yarving@yarving-VirtualBox /tmp $ python prog.py 4 -v 2
the square of 4 equals 16
yarving@yarving-VirtualBox /tmp $ python prog.py 4 -v 3
usage: prog.py [-h] [-v {0,1,2}] square
prog.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2)
yarving@yarving-VirtualBox /tmp $ python prog.py -h
usage: prog.py [-h] [-v {0,1,2}] square

positional arguments:
  square                display a square of a given number

optional arguments:
  -h, --help            show this help message and exit
  -v {0,1,2}, --verbosity {0,1,2}
                        increase output verbosity
  • 測試1， 2， 3 為可選值範圍，通過其值，打印不同的格式輸出；
  • 測試4的verbosity值不在可選值範圍內，打印錯誤
  • 測試5打印幫助信息

8. 自定義幫助信息help

上面很多例子中都為help賦值，如
parser.add_argument("square", type=int, help="display a square of a given number")
在打印輸出時，會有如下內容

positional arguments:
  square                display a square of a given number

也就是help為什麽，打印輸出時，就會顯示什麽

9. 程序用法幫助

8中介紹了為每個參數定義幫助文檔，那麽給整個程序定義幫助文檔該怎麽進行呢？
通過argparse.ArgumentParser(description="calculate X to the power of Y")即可
修改prog.py內容如下：

#!/usr/bin/env python
# encoding: utf-8


import argparse


parser = argparse.ArgumentParser(description="calculate X to the power of Y")
group = parser.add_mutually_exclusive_group()
group.add_argument("-v", "--verbose", action="store_true")
group.add_argument("-q", "--quiet", action="store_true")
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
args = parser.parse_args()
answer = args.x**args.y

if args.quiet:
    print answer
elif args.verbose:
    print "{} to the power {} equals {}".format(args.x, args.y, answer)
else:
    print "{}^{} == {}".format(args.x, args.y, answer)

打印幫助信息時即顯示calculate X to the power of Y

yarving@yarving-VirtualBox /tmp $ python prog.py -h
usage: prog.py [-h] [-v | -q] x y

calculate X to the power of Y

positional arguments:
  x              the base
  y              the exponent

optional arguments:
  -h, --help     show this help message and exit
  -v, --verbose
  -q, --quiet

10. 互斥參數

在上個例子中介紹了互斥的參數

group = parser.add_mutually_exclusive_group()
group.add_argument("-v", "--verbose", action="store_true")
group.add_argument("-q", "--quiet", action="store_true")

第一行定義了一個互斥組，第二、三行在互斥組中添加了-v和-q兩個參數，用上個例子中的程序進行如下測試：

yarving@yarving-VirtualBox /tmp $ python prog.py 4 2      
4^2 == 16
yarving@yarving-VirtualBox /tmp $ python prog.py 4 2 -v
4 to the power 2 equals 16
yarving@yarving-VirtualBox /tmp $ python prog.py 4 2 -q
16
yarving@yarving-VirtualBox /tmp $ python prog.py 4 2 -q -v

可以看出，-q和-v不出現，或僅出現一個都可以，同時出現就會報錯。
可定義多個互斥組

11.參數默認值

介紹了這麽多，有沒有參數默認值該如何定義呢？
修改prog.py內容如下：

#!/usr/bin/env python
# encoding: utf-8


import argparse


parser = argparse.ArgumentParser(description="calculate X to the power of Y")
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2], default=1,
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print "the square of {} equals {}".format(args.square, answer)
elif args.verbosity == 1:
    print "{}^2 == {}".format(args.square, answer)
else:
    print answer

測試結果如下

yarving@yarving-VirtualBox /tmp $ python prog.py 8 
8^2 == 64
yarving@yarving-VirtualBox /tmp $ python prog.py 8 -v 0
64
yarving@yarving-VirtualBox /tmp $ python prog.py 8 -v 1
8^2 == 64
yarving@yarving-VirtualBox /tmp $ python prog.py 8 -v 2
the square of 8 equals 64

可以看到如果不指定-v的值，args.verbosity的值默認為1，為了更清楚的看到默認值，也可以直接打印進行測試。

【轉】python argparse用法總結

相關推薦

【轉】python argparse用法總結

-- virt asc 可用 nal calc mutual ror 就會 轉自：https://www.jianshu.com/p/fef2d215b91d 1. argparse介紹 是python的一個命令行解析包，非常編寫可讀性非常好的程序 2. 基本用法 pr

【轉】Python關鍵語法-閉包：函式中的函式用法例項

本文例項講述了Python閉包的用法。分享給大家供大家參考，具體如下： Python函式中也可以定義函式，也就是閉包。跟js中的閉包概念其實差不多，舉個Python中閉包的例子。 def make_adder(addend): def adder(augend

【轉】Python之FLAGS用法

【轉】https://www.cnblogs.com/huangshiyu13/p/8415665.html flag_test.py 測試：python flag_test.py --gpu=abc import sys, os from absl import app from absl

【轉】Python 變數命名規範 以及 Python全域性變數、區域性變數、類變數、例項變數 總結

變數命名規範：      函式和普通變數名 由小寫字母和下劃線組成，類 大寫 全域性變數，區域性變數，類變數，例項變數總結： （python大盤點：全域性變數、區域性變數、類變數、例項變數） （python中的類變數、成員變數和成員函式的區域性變數使用）

【轉】python qt(pyqt)的文件打開、文件保存、文件夾選擇對話框

utf spl 文件對話框 出現 tin ans none 轉換 選擇文件夾 import PyQt4.QtCore,PyQt4.QtGui # 獲取文件路徑對話框 file_name = QFileDialog.getOpenFileName(self,"open

【轉】event.keyCode用法及列表

strong page ets cells 不支持 和數 jump fire 靜音 event.keyCode用法及列表 HTML 用戶名：<input type="text" id="UserAccount" onKeyPress="JumpByEnter(

【轉】python字符串/元組/列表/字典互轉

python字符串 互轉 utf () __str__ 返回 list log utf-8 #-*-coding:utf-8-*- #1、字典 dict = {‘name‘: ‘Zara‘, ‘age‘: 7, ‘class‘: ‘First‘} #字典轉為字符串，

【轉】Python+pyplot繪制帶文本標註的柱狀圖

spa app topic tro ins str com png 技術分享 import numpy as npimport matplotlib.pyplot as plt # 生成測試數據x = np.linspace(0, 10, 11)y = 11-x #

【轉】python的淺拷貝和深拷貝

end ont code append pen ron 實例 賦值 深拷貝 直接賦值：其實就是對象的引用（別名）。 淺拷貝(copy)：拷貝父對象，不會拷貝對象的內部的子對象。 深拷貝(deepcopy)： copy 模塊的 deepcopy 方法，完全拷貝了父對象及其

【轉】Python 玩轉隨機數

int pytho stop 機器 sample 永遠 支持 orange ron Python中的random模塊用於生成隨機數。下面介紹一下random模塊中最常用的幾個函數。 random.random random.random()用於生成一個0到1的隨機符點數:

【轉】Python max內置函數詳細介紹

使用 pri 數據 否則 索引 def 取數 而且 ace #max() array1 = range(10) array2 = range(0, 20, 3) print(‘max(array1)=‘, max(array1)) print(‘

【轉】python文件打開方式詳解——a、a+、r+、w+區別

不能 mos open col strong cnblogs span ast last 原文地址：http://blog.csdn.net/ztf312/article/details/47259805 第一步 排除文件打開方式錯誤： r只讀，r+讀寫，不創建 w新建只寫

【轉】接口測試總結

方法 服務 系統 查詢 註冊 都沒有 構造 通過 只需要 序 網絡上接口測試資料很多，但是都是很散亂的，於是整理下資料，就有了這個blog 什麽是接口測試 接口測試是測試系統組件間接口的一種測試。 接口測試可以分為哪幾種 　　1、系統與系統之間的調用，比如銀行會提供接口供電

python argparse用法總結

計算 註意 get 一行 false lB 數學計算 valid else 轉:python argparse用法總結 1. argparse介紹 　　argparse是python的一個命令行解析包，非常編寫可讀性非常好的程序 2. 基本用法 　　prog.py是

【轉】Python中操作mysql的pymysql模塊詳解

定義 padding 參數化查詢 finall 支持 順序 執行sql mysq syntax Python中操作mysql的pymysql模塊詳解 前言 pymsql是Python中操作MySQL的模塊，其使用方法和MySQLdb幾乎相同。但目前pymysql支持p

【轉】Python處理wave文件

方式 RM ani tag 文件格式 嵌套 場景 分享圖片 wave #本文PDF版下載 Python解析Wav文件並繪制波形的方法 #本文代碼下載 Wav波形繪圖代碼 #本文實例音頻文件night.wav下載 音頻文件下載 （石進-夜的鋼琴曲） 前言 在現在繁忙的生活中，

【轉】python中獲取python版本號的方法

n) https href light nor body true print brush 原文 python3 #!/usr/bin/python # 第1種方法 import platform print(platform.python_version())

【轉】python基礎-編碼與解碼

什麽 浪費 2.x sys 拼接 aced tro lte bytes 【轉自：https://www.cnblogs.com/OldJack/p/6658779.html】 一、什麽是編碼 編碼是指信息從一種形式或格式轉換為另一種形式或格式的過程。 在計算機中，編碼，簡而

【轉】python mysql數據庫 'latin-1' codec can't encode character錯誤問題解決

處理 tin sql數據庫 clas question ack RM can 意思 UnicodeEncodeError: ‘latin-1‘ codec can‘t encode character "UnicodeEncodeError:‘latin-1‘ co

【轉】#pragma的用法

導出數據 AS val bad 允許 包括 record -name nds 在所有的預處理指令中，#Pragma 指令可能是最復雜的了，它的作用是設定編譯器的狀態或者是指示編譯器完成一些特定的動作。#pragma指令對每個編譯器給出了一個方法，在保持與C和C++語言完