Python詳解argparse參數模塊之命令行參數

前言

help(argparse)查看說明文檔,“argparse – Command-line parsing library”我們可以知道是一個命令行解析庫,是關於參數解析相關的一個模塊。

示例一:最簡參數對象

先來一段簡單的代碼,快速熟知下這個參數是個啥。
保存為t.py這樣一個文件

import argparse
parser = argparse.ArgumentParser(description='最簡單的測試')
parser.add_argument('--test', type=str, default='China')
args = parser.parse_args()
print(args.test)

然後我們在命令行中運行這個文件

C:\Users\Tony>python t.py –test "I love China"
I love China

我們來分析下這段代碼,首先就是創建一個參數解析對象賦給parser,然後在parser對象中使用add_argument方法添加參數以及各種選項,其中–test就是參數,這個參數的名稱依其作用自定義,type=str指定輸入值類型為字符串,default='China'是默認值,就是說如果不指定參數,就顯示China這個默認值
對於parser.parse_args()解析參數之後的調用,需要說明下,如果沒有指定dest,那就是直接調用去掉短橫線的名稱,如果指定瞭,比如dest='showstr',那麼就調用args.showstr屬性,如果還是調用test就會報錯,需要修改為print(args.showstr)
AttributeError: 'Namespace' object has no attribute 'test'

示例二:整數求和

若沒有指定參數就取這些整數當中的最大值:

#p.py
import argparse
#創建ArgumentParser對象,用來解析
parser = argparse.ArgumentParser(description='處理一些整數')
#向對象添加參數
parser.add_argument('integers', metavar='N', type=int, nargs='+',help='累加的整數')
parser.add_argument('--sum', dest='accumulate', action='store_const',const=sum, default=max,help='求和(默認求最大值)')
#解析參數
args = parser.parse_args()
print(args.accumulate(args.integers))

其中調用parse_args()方法時,將返回兩個參數屬性(integers和accumulate),integers屬性是一個或多個的整數,accumulate屬性是sum()求和函數,如果沒有–sum參數的話就是默認max()最大值函數,default=max
另外N可以指定個數,nargs='+',表示一個或多個,對正則表達式熟悉的那就很簡單瞭,是一個通配符,另外還有'?'表示一個,'*'表示0個或多個。

print(parser.parse_args(['--sum','1','33','5','6']))
'''
Namespace(accumulate=<built-in function sum>, integers=[1, 33, 5, 6])
'''

我們可以看到出現一個命名空間,其中accumulate屬性是一個sum方法, integers屬性是一系列的整數。

可以查看使用幫助說明:

C:\Users\Tony>python p.py -h

usage: p.py [-h] [–sum] N [N …]

處理一些整數

positional arguments:
  N           累加的整數

optional arguments:
  -h, –help  show this help message and exit
  –sum       求和(默認求最大值)

帶參與不帶參的操作:

C:\Users\Tony>python p.py 1 33 5 6
33

C:\Users\Tony>python p.py -sum 1 33 5 6

C:\Users\Tony>python p.py 1 33 5 6 –sum
45

當然如果是沒有按照參數設定的情況,會報錯: 

C:\Users\Tony>python p.py
#需要輸入值N
usage: p.py [-h] [–sum] N [N …]
p.py: error: the following arguments are required: N

C:\Users\Tony>python p.py 1 33 5.1 6
#需要輸入整數,浮點數就報錯
usage: p.py [-h] [–sum] N [N …]
p.py: error: argument N: invalid int value: '5.1'

可以看出這個參數對象除瞭可以在命令行界面方便使用之外,還可以對其做一些嚴格的限定。比如類型的限定,示例二的類型指定為int,那就不能是浮點數,如果可以是浮點數就指定成type=float

示例三:文件是否被篡改

我們來看下,test目錄下面(放瞭三個文本文件),生成每個文件的md5值,如果和官網提供的md5一樣就說明內容沒有被篡改,執行完之後將顯示每個文件生成的MD5值以及生成一個名為"目錄後綴.txt"文檔(內容一樣)

#m.py
import os
from hashlib import md5
import argparse
 
def parse_args():
    parser =argparse.ArgumentParser()
    parser.add_argument('--file_dir', type=str)
    return parser.parse_args()
def generate_md5(file_path):
    m =md5()
    file = open(file_path, 'rb')
    f = file.read()
    m.update(f)
    file.close()
    return m.hexdigest()
 
if __name__ == '__main__':
    args = parse_args()
    file_dir = args.file_dir
    log_path = args.file_dir + '.txt'
    log = open(log_path, 'w+')
    for root, _, files in os.walk(file_dir):
        for file in files:
            file_path = os.path.join(root, file)
            md5_value = generate_md5(file_path)
            print(file + " : " + md5_value)
            log.write(file + " : " + md5_value + '\n')

命令行執行:

C:\Users\Tony>python m.py –file_dir "C:/Users/Tony/test"
1.txt : 81dc9bdb52d04dc20036dbd8313ed055
2.txt : d84b0391f5ce6b011e4086ed73d9dd9b
3.txt : 2b3b15ac34d69fa01e851d483e61f029

這段代碼可以看出,隻需指定一個文件目錄的參數即可求出目錄下面所有文件的md5值。當然也可以跟示例二那樣做一些說明:parser.add_argument('–file_dir', type=str,help='指定文件所在目錄') 加一個help參數的說明文字。

C:\Users\Tony>python m.py -h
usage: m.py [-h] [–file_dir FILE_DIR]

optional arguments:
  -h, –help           show this help message and exit
  –file_dir FILE_DIR  指定文件所在目錄

parser = argparse.ArgumentParser('對文件批量生成MD5值')
parser.add_argument('--file_dir',dest='fdir',type=str,help='指定文件所在目錄')
print(parser.print_help())
'''
usage: 對文件批量生成MD5值 [-h] [--file_dir FDIR]
optional arguments:
  -h, --help       show this help message and exit
  --file_dir FDIR  指定文件所在目錄
None
'''

自定義類型

除瞭基本類型之外,還可以自定義類型,如下定義一個類型隻能是完全平方數的值

#d.py
import argparse
import math
 
def perfect_square(s):
    v=int(s)
    vs=math.sqrt(v)
    if vs!=int(vs):
        msg="%r 不是一個完全平方數" %s
        raise argparse.ArgumentTypeError(msg)
    return v
parser=argparse.ArgumentParser(description='自定義類型')
parser.add_argument('hi',type=perfect_square,help='隻能是完全平方數')
args = parser.parse_args()
print(args.hi)

命令行運行:

C:\Users\Tony>python d.py 3
usage: d.py [-h] hi
d.py: error: argument hi: '3' 不是一個完全平方數

C:\Users\Tony>python d.py -h
usage: d.py [-h] hi

自定義類型:

positional arguments:
  hi          隻能是完全平方數

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

可以看到hi參數是一個positional arguments(位置參數),也就是說是必須的,不像前面有短橫線的optional arguments(可選參數)

choices選項限定

除瞭上述類型限定和可以自定義類型之外,還可以限定在一些自定義的范圍內

#c.py
parser=argparse.ArgumentParser(description='自定義選項')
parser.add_argument('sel',type=int,choices=range(1,9),help='請輸入[1-9)范圍的整數')
args = parser.parse_args()
print(args.sel)

命令行執行:
C:\Users\Tony>python c.py 10
usage: c.py [-h] {1,2,3,4,5,6,7,8}
c.py: error: argument sel: invalid choice: 10 (choose from 1, 2, 3, 4, 5, 6, 7, 8)

required必選參數

我們也可以對可選參數指定為必選,不指定的情況:

parser=argparse.ArgumentParser(description='自定義選項')
parser.add_argument('--sel',type=int,choices=range(1,9),help='請輸入[1-9)范圍的整數')
print(parser.parse_args([]))

這個例子,我們知道sel參數是可選的,這樣不會出錯,結果:Namespace(sel=None)
如果加一個required=True

parser.add_argument('--sel',required=True,type=int,choices=range(1,9),help='請輸入[1-9)范圍的整數')
#執行就會報錯:
usage: ipykernel_launcher.py [-h] --sel {1,2,3,4,5,6,7,8}
ipykernel_launcher.py: error: the following arguments are required: --sel
An exception has occurred, use %tb to see the full traceback.
#這個時候的參數sel就是必選參數瞭
print(parser.parse_args(['--sel','2']))
Namespace(sel=2)

子命令

主要是set_defaults方法的用途,在多個解析器的時候顯得很重要。
#s.py
def f(v):
     r=v.x + v.y + v.z
     print('x+y+z=',r)
parser = argparse.ArgumentParser(description='求三個輸入值的和')
subparsers = parser.add_subparsers(help='子命令的用法')
parser_a = subparsers.add_parser('add', help='加法運算')
parser_a.add_argument('--x', type=int)
parser_a.add_argument('--y', type=int)
parser_a.add_argument('--z', type=int)
parser_a.set_defaults(func=f)#parser_a設置默認函數為f
args = parser.parse_args()
args.func(args)#運行函數

命令行執行:

C:\Users\Tony>python s.py add –x 11 –y 2 –z 9
x+y+z= 22

到此這篇關於Python詳解argparse參數模塊之命令行參數的文章就介紹到這瞭,更多相關Python argparse 內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

推薦閱讀: