前言

許多任務(wù)程序如果為其構(gòu)造為一個(gè)命令行界面，就可以通過(guò)接受不同的參數(shù)來(lái)改變它的工作方式。例如，在爬蟲(chóng)程序中，不同 URL 通?？梢宰鳛槊钚袇?shù)傳遞給任務(wù)程序，從而可以爬取不同網(wǎng)頁(yè)中的數(shù)據(jù)。在 Python 標(biāo)準(zhǔn)庫(kù)中包含一個(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)庫(kù)
定義函數(shù)
定義參數(shù)解析器
對(duì)參數(shù)進(jìn)行操作
使用參數(shù)調(diào)用函數(shù)，以執(zhí)行不同操作

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

命令行參數(shù)示例

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

import argparse

def main(num):
????print('Hello world.\n' * num)

if __name__ == '__main__':
????parse = argparse.ArgumentParser()
????parse.add_argument('number', type=int, help='A number')
????args = parse.parse_args()

????main(args.number)

在腳本中，參數(shù)通過(guò) 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ò)展幫助信息：

$ python argparse_example.py
usage: argparse_example.py [-h] number
argparse_example.py: error: the following arguments are required: number
$ python argparse_example.py -h
usage: argparse_example.py [-h] number

positional arguments:
??number ?????A number

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

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

$ python argparse_example.py 3
Hello world.
Hello world.
Hello world.

$ python argparse_example.py three
usage: argparse_example.py [-h] number
argparse_example.py: error: argument number: invalid int value: 'three'

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

import argparse
def main(string, num):
????print(string * num)
if __name__ == '__main__':
????parser = argparse.ArgumentParser()
????parser.add_argument('num', type=int, help='A number')
????parser.add_argument('-s', type=str, help='String to print', default='Hello world.\n')
????args = parser.parse_args()

????main(args.s, args.num)

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

$ python argparse_example_2.py -h
usage: argparse_example_2.py [-h] [-s S] num

positional arguments:
??num ????????A number

optional arguments:
??-h, --help ?show this help message and exit
??-s S ???????String to print
$ python argparse_example_2.py 3Hello world.
Hello world.
Hello world.

$ python argparse_example_2.py 3 -s 'I love movie'
I love movieI love movieI love movie

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

• 如果參數(shù)以 - 開(kāi)頭，則將其視為可選參數(shù)，例如腳本中的 -s 參數(shù)。否則，該參數(shù)為位置參數(shù)，如腳本中的數(shù)字參數(shù)
• 為了清楚起見(jiàn)，應(yīng)當(dāng)始終為可選參數(shù)定義默認(rèn)值。如果不顯式的定義默認(rèn)值，則默認(rèn)為 None，但這可能會(huì)令使用者困惑
• 同時(shí)，在添加命令行參數(shù)時(shí)應(yīng)當(dāng)始終利用 add_agrment() 方法的 help 參數(shù)添加帶有參數(shù)描述的幫助信息，這在調(diào)用腳本時(shí)即為關(guān)鍵，能夠幫助使用者了解每個(gè)命令行參數(shù)的含義

到此這篇關(guān)于Python 添加命令行參數(shù)步驟的文章就介紹到這了,更多相關(guān)Python 添加命令行參數(shù)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論