Python argparse參數(shù)模塊之命令行參數(shù)實(shí)例分析

這篇文章主要介紹“Python argparse參數(shù)模塊之命令行參數(shù)實(shí)例分析”的相關(guān)知識(shí)，小編通過(guò)實(shí)際案例向大家展示操作過(guò)程，操作方法簡(jiǎn)單快捷，實(shí)用性強(qiáng)，希望這篇“Python argparse參數(shù)模塊之命令行參數(shù)實(shí)例分析”文章能幫助大家解決問(wèn)題。

前言

help(argparse)查看說(shuō)明文檔，“argparse - Command-line parsing library”我們可以知道是一個(gè)命令行解析庫(kù)，是關(guān)于參數(shù)解析相關(guān)的一個(gè)模塊。

示例一：最簡(jiǎn)參數(shù)對(duì)象

先來(lái)一段簡(jiǎn)單的代碼，快速熟知下這個(gè)參數(shù)是個(gè)啥。
保存為t.py這樣一個(gè)文件

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

然后我們?cè)诿钚兄羞\(yùn)行這個(gè)文件

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

我們來(lái)分析下這段代碼，首先就是創(chuàng)建一個(gè)參數(shù)解析對(duì)象賦給parser，然后在parser對(duì)象中使用add_argument方法添加參數(shù)以及各種選項(xiàng)，其中--test就是參數(shù)，這個(gè)參數(shù)的名稱依其作用自定義，type=str指定輸入值類(lèi)型為字符串，default='China'是默認(rèn)值，就是說(shuō)如果不指定參數(shù)，就顯示China這個(gè)默認(rèn)值
對(duì)于parser.parse_args()解析參數(shù)之后的調(diào)用，需要說(shuō)明下，如果沒(méi)有指定dest，那就是直接調(diào)用去掉短橫線的名稱，如果指定了，比如dest='showstr'，那么就調(diào)用args.showstr屬性，如果還是調(diào)用test就會(huì)報(bào)錯(cuò)，需要修改為print(args.showstr)
AttributeError: 'Namespace' object has no attribute 'test'

示例二：整數(shù)求和

若沒(méi)有指定參數(shù)就取這些整數(shù)當(dāng)中的最大值：

#p.py
import argparse
#創(chuàng)建ArgumentParser對(duì)象，用來(lái)解析
parser = argparse.ArgumentParser(description='處理一些整數(shù)')
#向?qū)ο筇砑訁?shù)
parser.add_argument('integers', metavar='N', type=int, nargs='+',help='累加的整數(shù)')
parser.add_argument('--sum', dest='accumulate', action='store_const',const=sum, default=max,help='求和(默認(rèn)求最大值)')
#解析參數(shù)
args = parser.parse_args()
print(args.accumulate(args.integers))

其中調(diào)用parse_args()方法時(shí)，將返回兩個(gè)參數(shù)屬性(integers和accumulate)，integers屬性是一個(gè)或多個(gè)的整數(shù)，accumulate屬性是sum()求和函數(shù)，如果沒(méi)有--sum參數(shù)的話就是默認(rèn)max()最大值函數(shù)，default=max
另外N可以指定個(gè)數(shù)，nargs='+'，表示一個(gè)或多個(gè)，對(duì)正則表達(dá)式熟悉的那就很簡(jiǎn)單了，是一個(gè)通配符，另外還有'?'表示一個(gè)，'*'表示0個(gè)或多個(gè)。

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

我們可以看到出現(xiàn)一個(gè)命名空間，其中accumulate屬性是一個(gè)sum方法， integers屬性是一系列的整數(shù)。

可以查看使用幫助說(shuō)明：

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

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

處理一些整數(shù)

positional arguments:
  N           累加的整數(shù)

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

帶參與不帶參的操作：

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

當(dāng)然如果是沒(méi)有按照參數(shù)設(shè)定的情況，會(huì)報(bào)錯(cuò)： 

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
#需要輸入整數(shù)，浮點(diǎn)數(shù)就報(bào)錯(cuò)
usage: p.py [-h] [--sum] N [N ...]
p.py: error: argument N: invalid int value: '5.1'

可以看出這個(gè)參數(shù)對(duì)象除了可以在命令行界面方便使用之外，還可以對(duì)其做一些嚴(yán)格的限定。比如類(lèi)型的限定，示例二的類(lèi)型指定為int，那就不能是浮點(diǎn)數(shù)，如果可以是浮點(diǎn)數(shù)就指定成type=float

示例三：文件是否被篡改

我們來(lái)看下，test目錄下面(放了三個(gè)文本文件）,生成每個(gè)文件的md5值，如果和官網(wǎng)提供的md5一樣就說(shuō)明內(nèi)容沒(méi)有被篡改，執(zhí)行完之后將顯示每個(gè)文件生成的MD5值以及生成一個(gè)名為"目錄后綴.txt"文檔（內(nèi)容一樣）

#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')

命令行執(zhí)行：

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

這段代碼可以看出，只需指定一個(gè)文件目錄的參數(shù)即可求出目錄下面所有文件的md5值。當(dāng)然也可以跟示例二那樣做一些說(shuō)明：parser.add_argument('--file_dir', type=str,help='指定文件所在目錄') 加一個(gè)help參數(shù)的說(shuō)明文字。

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

自定義類(lèi)型

除了基本類(lèi)型之外，還可以自定義類(lèi)型，如下定義一個(gè)類(lèi)型只能是完全平方數(shù)的值

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

命令行運(yùn)行：

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

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

自定義類(lèi)型：

positional arguments:
  hi          只能是完全平方數(shù)

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

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

choices選項(xiàng)限定

除了上述類(lèi)型限定和可以自定義類(lèi)型之外，還可以限定在一些自定義的范圍內(nèi)

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

命令行執(zhí)行：
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必選參數(shù)

我們也可以對(duì)可選參數(shù)指定為必選，不指定的情況：

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

這個(gè)例子，我們知道sel參數(shù)是可選的，這樣不會(huì)出錯(cuò)，結(jié)果：Namespace(sel=None)
如果加一個(gè)required=True

parser.add_argument('--sel',required=True,type=int,choices=range(1,9),help='請(qǐng)輸入[1-9)范圍的整數(shù)')
#執(zhí)行就會(huì)報(bào)錯(cuò)：
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.
#這個(gè)時(shí)候的參數(shù)sel就是必選參數(shù)了
print(parser.parse_args(['--sel','2']))
Namespace(sel=2)

子命令

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

命令行執(zhí)行：

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

關(guān)于“Python argparse參數(shù)模塊之命令行參數(shù)實(shí)例分析”的內(nèi)容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業(yè)相關(guān)的知識(shí)，可以關(guān)注億速云行業(yè)資訊頻道，小編每天都會(huì)為大家更新不同的知識(shí)點(diǎn)。