Python添加命令行參數(shù)步驟

第Python添加命令行參數(shù)步驟目錄前言添加命令行參數(shù)的一般步驟命令行參數(shù)示例

前言

許多任務(wù)程序如果為其構(gòu)造為一個(gè)命令行界面，就可以通過接受不同的參數(shù)來改變它的工作方式。例如，在爬蟲程序中，不同URL通?？梢宰鳛槊钚袇?shù)傳遞給任務(wù)程序，從而可以爬取不同網(wǎng)頁中的數(shù)據(jù)。在Python標(biāo)準(zhǔn)庫中包含一個(gè)強(qiáng)大的argparse模塊，可以輕松創(chuàng)建豐富的命令行參數(shù)解析。

添加命令行參數(shù)的一般步驟

在程序腳本中，argparse的基本使用方式可以分三個(gè)步驟顯示：

定義腳本要接受的參數(shù)，生成新的參數(shù)解析器調(diào)用定義的解析器，返回一個(gè)包含所有結(jié)果參數(shù)的對(duì)象使用帶有參數(shù)的命令調(diào)用腳本，使得定義的參數(shù)行為生效

一般而言，使用命令行參數(shù)的腳本遵循以下結(jié)構(gòu)：

導(dǎo)入相關(guān)庫

定義函數(shù)

定義參數(shù)解析器

對(duì)參數(shù)進(jìn)行操作

使用參數(shù)調(diào)用函數(shù)，以執(zhí)行不同操作

其中，一般使用main函數(shù)來顯式的聲明代碼的執(zhí)行入口，簡(jiǎn)單情況下，我們可以直接使用命令行傳入的參數(shù)而無需進(jìn)行復(fù)雜處理。

命令行參數(shù)示例

接下來，我們通過一個(gè)示例來了解如何添加并使用命令行參數(shù)。首先創(chuàng)建一個(gè)腳本argparse_example.py，該腳本接受單個(gè)整數(shù)作為位置參數(shù)，并打印執(zhí)行次數(shù)的Helloworld.。腳本代碼如下，我們遵循上述結(jié)構(gòu)，其中定義的main僅僅執(zhí)行打印功能：

importargparse

defmain(num):

print('Helloworld.\n'*num)

if__name__=='__main__':

parse=argparse.ArgumentParser()

parse.add_argument('number',type=int,help='Anumber')

args=parse.parse_args()

main(args.number)

在腳本中，參數(shù)通過add_arguments添加到解析器。定義了所有參數(shù)之后，調(diào)用parse_args()將返回一個(gè)包含參數(shù)解析結(jié)果的對(duì)象，如果出現(xiàn)錯(cuò)誤則退出執(zhí)行。

調(diào)用腳本并檢查參數(shù)的使用方式，不帶參數(shù)調(diào)用腳本時(shí)會(huì)自動(dòng)顯示幫助信息，使用參數(shù)-h可以顯示擴(kuò)展幫助信息：

$pythonargparse_example.py

usage:argparse_example.py[-h]number

argparse_example.py:error:thefollowingargumentsarerequired:number

$pythonargparse_example.py-h

usage:argparse_example.py[-h]number

positionalarguments:

number

Anumber

optionalarguments:

-h,--help

showthishelpmessageandexit

使用額外參數(shù)調(diào)用腳本，可以按程序預(yù)期執(zhí)行腳本：

$pythonargparse_example.py3

Helloworld.

Helloworld.

Helloworld.

$pythonargparse_example.pythree

usage:argparse_example.py[-h]number

argparse_example.py:error:argumentnumber:invalidintvalue:'three'

更改腳本，添加可選參數(shù)用于接受所需打印的字符串，且默認(rèn)值為Helloworld，編寫argparse_example_2.py腳本如下所示：

importargparse

defmain(string,num):

print(string*num)

if__name__=='__main__':

parser=argparse.ArgumentParser()

parser.add_argument('num',type=int,help='Anumber')

parser.add_argument('-s',type=str,help='Stringtoprint',default='Helloworld.\n')

args=parser.parse_args()

main(args.s,args.num)

再次執(zhí)行腳本，可以看到幫助已經(jīng)更新，使用-s選項(xiàng)可以打印不同的字符串：

$pythonargparse_example_2.py-h

usage:argparse_example_2.py[-h][-sS]num

positionalarguments:

num

Anumber

optionalarguments:

-h,--help

showthishelpmessageandexit

-sS

Stringtoprint

$pythonargparse_example_2.py3Helloworld.

Helloworld.

Helloworld.

$pythonargparse_example_2.py3-s'Ilovemovie'

IlovemovieIlovemovieIlovemovie

在實(shí)際場(chǎng)景中，我們應(yīng)當(dāng)為每個(gè)參數(shù)都添加一個(gè)幫助描述信息，參數(shù)可以分為位置參數(shù)和可選參數(shù)，它們的使用方式具有較大差別：

如果參數(shù)以-開頭，則將其視為可選參數(shù)，例如腳本中的-s參數(shù)。否則，該參數(shù)為位置參數(shù)，如腳本中的數(shù)字參數(shù)為了清楚起見