一. argparse介紹

很多時候，我們的程序要帶參數(shù)來運(yùn)行不同的功能，需要解析命令行參數(shù)。argparse模塊能夠很好的提供支持。

argparse是 python 自帶的命令行參數(shù)解析包，用于解析命令行參數(shù)的標(biāo)準(zhǔn)模塊。可以讓人輕松編寫用戶友好的命令行接口，還會自動生成幫助和使用手冊，并在用戶給程序傳入無效參數(shù)時報出錯誤信息。

二. 使用步驟及參數(shù)介紹

argparse模塊的使用可以簡化成下面四個步驟：

1）import argparse 導(dǎo)入模塊

2）parser = argparse.ArgumentParser() 創(chuàng)建一個解析對象（命令行解析器）
  ArgumentParser對象的相關(guān)屬性，全部參數(shù)：

3）parser.add_argument() 向該對象中添加要關(guān)注的命令行參數(shù)和選項，每一個add_argument方法對應(yīng)一個要關(guān)注的參數(shù)或選項；

add_argument相關(guān)屬性，全部參數(shù)：

4）parser.parse_args() 調(diào)用parse_args()方法進(jìn)行解析

parse_args相關(guān)屬性，全部參數(shù)：

三. 具體使用

add_argument() 方法必須知道它是否是一個選項，例如 -f 或 --foo，或是一個位置參數(shù)。

第一個傳遞給 add_argument() 的參數(shù)必須是一系列旗標(biāo)或者是一個簡單的參數(shù)名。

當(dāng) parse_args() 被調(diào)用，選項會以 - 前綴識別，剩下的參數(shù)則會被假定為位置參數(shù)。

-（橫杠）和 –（雙橫杠）都是用來表示命令行參數(shù)的前綴符號：

-用來表示短參數(shù)（Short options），通常只有一個字符。

–用來表示長參數(shù)（Long options），通常是一個單詞或短語。

在argparse中，-和–可以用來定義命令行參數(shù)的簡寫和全名，例如：parser.add_argument(‘-n’, ‘–name’, help=‘輸入姓名’)

import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('-n', '--name', help='輸入姓名')
    args = parser.parse_args()
    # 獲得傳入的參數(shù)
    print(args)

帶參執(zhí)行結(jié)果：

3.1 設(shè)置必需參數(shù)

add_argument方法的required參數(shù)可以設(shè)置該參數(shù)是否是必需。

如果該參數(shù)設(shè)置為必需參數(shù)，程序執(zhí)行時未指定該參數(shù)會報錯！

import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('--name', help='輸入姓名', required=True)
    parser.parse_args()
    # 獲得傳入的參數(shù)
    print(args)
    # 獲得指定的參數(shù)
    print(args.name)

運(yùn)行 python test.py 和 python test.py --name Elaine

結(jié)果：

3.2 傳一個參數(shù)

add_argument添加一個參數(shù)選項

import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('--name', help='輸入姓名')
    args = parser.parse_args()
    # 獲得傳入的參數(shù)
    print(args)
    # 獲得指定的參數(shù)
    print(args.name)

運(yùn)行程序 -h 看一下效果

D:\>python test.py -h
usage: test.py [-h] [--name NAME]

optional arguments:
  -h, --help   show this help message and exit
  --name NAME  輸入姓名

帶一個參數(shù)和帶三個參數(shù)運(yùn)行的結(jié)果：

可以看到，這種情形下傳入三個參數(shù)會報錯！

3.3 傳多個參數(shù)

1）add_argument加上nargs參數(shù)，nargs是用來說明傳入的參數(shù)個數(shù)，例如：

import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('--name', nargs=3, help='輸入姓名')
    args = parser.parse_args()
    # 獲得傳入的參數(shù)
    print(args)
    # 獲得指定的參數(shù)
    print(args.name)

運(yùn)行 python test.py --name Elaine 和 python test.py --name Elaine Elaine1 Elaine2

結(jié)果：

2）nargs為’+’ 表示傳入至少一個參數(shù)，可以不用指定具體多少個參數(shù)，例如：

import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('--name', nargs='+', help='輸入姓名')
    args = parser.parse_args()
    # 獲得傳入的參數(shù)
    print(args)
    # 獲得指定的參數(shù)
    print(args.name)

運(yùn)行 python test.py --name Elaine 和 python test.py --name Elaine Elaine1 Elaine2

結(jié)果：

3.4 位置參數(shù)和可選參數(shù)

add_argument() 方法必須知道它是否是一個選項，例如 -f 或 --foo，或是一個位置參數(shù)。

第一個傳遞給 add_argument() 的參數(shù)必須是一系列旗標(biāo)或者是一個簡單的參數(shù)名。

當(dāng) parse_args() 被調(diào)用，選項會以 - 前綴識別，剩下的參數(shù)則會被假定為位置參數(shù)。

1）位置參數(shù)

add_argument第一個參數(shù)可以這么創(chuàng)建：parser.add_argument(‘name’, help=‘輸入姓名’)

其中第一個參數(shù)可以是任何參數(shù)名，但前面不要加 - （橫杠）或 –（雙橫杠）

這些參數(shù)是不帶前綴的參數(shù)，它們通常用于需要按特定順序提供的參數(shù)，且通常是必需的。

import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description='命令行中傳入一個參數(shù)')
    parser.add_argument('name', help='輸入姓名')
    parser.add_argument('country', help='國家')
    args = parser.parse_args()
    # 獲得傳入的參數(shù)
    print(args)

執(zhí)行 python test.py Elaine China 和 python test.py China Elaine

結(jié)果：

所以位置參數(shù)都是順序的，在命令行中傳入?yún)?shù)時候，傳入的參數(shù)的先后順序不同，運(yùn)行結(jié)果往往會不同！

執(zhí)行 python test.py Elaine 時缺少第二個位置參數(shù)會報錯，所以位置參數(shù)通常是必須的。例如：

2）可選參數(shù)

為了在命令行中避免上述位置參數(shù)的順序混亂，可以使用可選參數(shù)。這個很像關(guān)鍵詞傳參，但是需要在關(guān)鍵詞前面加-

例如：

import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('--name', nargs='+', help='輸入姓名')
    parser.add_argument('--country', nargs='+', help='國家名稱')
    args = parser.parse_args()
    # 獲得傳入的參數(shù)
    print(args)

執(zhí)行 python test.py --name Elaine Elaine1 Elaine2 和 python test.py --name Elaine Elaine1 Elaine2 --country China

結(jié)果：

可選參數(shù)雖然寫法比較繁瑣，但是增加了命令行中的可讀性，不容易因為參數(shù)傳入順序?qū)е聰?shù)據(jù)錯亂。

3.5 參數(shù)設(shè)置默認(rèn)值

add_argument加上default參數(shù)

import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('-n', '--name', help='輸入姓名')
    parser.add_argument('-c', '--country', default='China', help='國家名稱')
    args = parser.parse_args()
    # 獲得傳入的參數(shù)
    print(args)

運(yùn)行python test.py --name Elaine 和 python test.py

結(jié)果：

3.6 其它用法

想要了解更多，可以去看看官方文檔

參考官方文檔:https://docs.python.org/zh-cn/3.9/library/argparse.html#parents

總結(jié)

到此這篇關(guān)于python程序運(yùn)行添加命令行參數(shù)argparse模塊具體用法的文章就介紹到這了,更多相關(guān)python命令行參數(shù)argparse模塊內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論