Argparse 是一個(gè) Python 庫，用于以用戶友好的方式解析命令行參數(shù)。它可以輕松編寫用戶友好的命令行界面，并且廣泛應(yīng)用于Python應(yīng)用程序中。在本教程中，我們將討論如何使用 Python 中的 Argparse 庫將列表作為命令行參數(shù)傳遞。

使用 Argparse 將列表作為命令行參數(shù)傳遞

要使用Argparse 庫將 Python 列表作為命令行參數(shù)傳遞，我們將在 add_argument() 方法中使用“nargs”參數(shù)。“nargs”代表“參數(shù)數(shù)量”，它告訴 argparse 特定選項(xiàng)應(yīng)該期望多少個(gè)參數(shù)。

使用 Argparse 將列表作為命令行參數(shù)傳遞的步驟

讓我們看看使用 Python 中的 Argparse 庫將列表作為命令行參數(shù)傳遞所涉及的步驟。

第1步： 導(dǎo)入所需模塊

要使用argparse，您需要導(dǎo)入argparse模塊。您可以通過在 Python 腳本的開頭添加以下行來完成此操作：

import argparse

第 2 步： 創(chuàng)建參數(shù)解析器

接下來，通過調(diào)用 ArgumentParser() 方法創(chuàng)建一個(gè)參數(shù)解析器對(duì)象：

parser = argparse.ArgumentParser()

第 3 步： 添加參數(shù)

使用 add_argument() 方法將參數(shù)添加到參數(shù)解析器。使用type參數(shù)指定參數(shù)的數(shù)據(jù)類型，列表可以是任何類型，字符串，整數(shù)等。

parser.add_argument("--numbers", type=int)

第四步： 解析參數(shù)

最后，通過調(diào)用參數(shù)解析器對(duì)象上的 parse_args() 方法來解析命令行參數(shù)。這將返回一個(gè)包含已解析參數(shù)的對(duì)象。

args = parser.parse_args()

第 5 步： 訪問列表

您可以使用 args 對(duì)象的“numbers”屬性訪問作為“–numbers”參數(shù)傳遞的整數(shù)列表。

print(args.numbers)

傳遞字符串列表

在此示例中，list_of_strings 函數(shù)將字符串作為輸入并返回字符串列表。add_argument的類型參數(shù)設(shè)置為list_of_strings，因此當(dāng)調(diào)用parse_args時(shí)，-str-list的字符串值被轉(zhuǎn)換為字符串列表。

import argparse
# 為字符串列表定義自定義參數(shù)類型
def list_of_strings(arg):
	return arg.split(',')
# 創(chuàng)建ArgumentParser對(duì)象
parser = argparse.ArgumentParser()
# 為字符串列表添加參數(shù)
parser.add_argument('--str-list', type=list_of_strings)
# 分析命令行參數(shù)
args = parser.parse_args()
# 使用腳本中的字符串列表
print(args.str_list)

輸出：

您可以使用以下命令運(yùn)行此腳本。這里的“script.py”指的是保存的Python文件的名稱。

python script.py --str-list foo,bar,baz

注意： 確保列表項(xiàng)之間沒有空格，否則可能會(huì)生成錯(cuò)誤。我們將在接下來的示例中了解如何解決此錯(cuò)誤。

傳遞整數(shù)列表

在此示例中，list_of_ints 函數(shù)采用字符串作為輸入并返回 Python 整數(shù)列表。add_argument的類型參數(shù)設(shè)置為list_of_ints，因此當(dāng)調(diào)用parse_args時(shí)，-int-list的字符串值被轉(zhuǎn)換為整數(shù)列表。

import argparse
# 為整數(shù)列表定義自定義參數(shù)類型
def list_of_ints(arg):
	return list(map(int, arg.split(',')))
# 創(chuàng)建ArgumentParser對(duì)象
parser = argparse.ArgumentParser()
# 為整數(shù)列表添加參數(shù)
parser.add_argument('--int-list', type=list_of_ints)
# 分析命令行參數(shù)
args = parser.parse_args()
# 在腳本中使用整數(shù)列表
print(args.int_list)

輸出：

您可以使用以下命令運(yùn)行此腳本：

python script.py --int-list 1,2,3,4,5,6

將列表作為命令行參數(shù)傳遞

讓我們看一些在 Python 中將列表作為命令行參數(shù)傳遞的示例。

示例 1：使用 nargs='+' 傳遞一個(gè)或多個(gè)值

在此示例中，我們使用“add_argument”方法添加一個(gè)名為“my_list”的參數(shù)。“metavar”參數(shù)用于指定使用消息中的參數(shù)名稱。“type”參數(shù)設(shè)置為“str”，因?yàn)槲覀兿Ｍ斜硎亲址斜怼?ldquo;nargs”參數(shù)設(shè)置為“+”表示該參數(shù)可以采用一個(gè)或多個(gè)值。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument('my_list', metavar='N', type=str, nargs='+',
					help='a list of strings')
args = parser.parse_args()
print(args.my_list)

輸出：

僅傳遞一個(gè)參數(shù)：

python my_script.py juejin

傳遞多個(gè)參數(shù)：

python my_script.py jue jin cn

示例 2：使用 nargs='*' 傳遞零個(gè)或多個(gè)值

在此示例中，“nargs”參數(shù)設(shè)置為“*”以指示該參數(shù)可以采用零個(gè)或多個(gè)值。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument('my_list', metavar='N', type=str, nargs='*',
					help='a list of strings')
args = parser.parse_args()
print(args.my_list)

輸出：

傳遞零參數(shù)：

python my_script.py

示例 3：傳遞可選參數(shù)

在此示例中，我們提供了兩個(gè)參數(shù)，一個(gè)是強(qiáng)制性的，另一個(gè)是可選的。我們將“required”參數(shù)設(shè)置為“True”，這意味著它是強(qiáng)制性的。在第二個(gè)參數(shù)中，我們沒有定義必需的參數(shù)，這意味著它是一個(gè)可選參數(shù)。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument('--string1', type=str, required=True)
parser.add_argument('--string2', type=str)
args = parser.parse_args()
if args.string2:
	print(args.string1, args.string2)
else:
	print(args.string1)

輸出：

當(dāng)兩個(gè)參數(shù)都被定義時(shí)：

python my_script.py --string1 Hello --string2 world

當(dāng)可選參數(shù)未定義時(shí)：

python my_script.py --string1 Hello

到此這篇關(guān)于使用Python中的Argparse實(shí)現(xiàn)將列表作為命令行參數(shù)傳遞的文章就介紹到這了,更多相關(guān)Python Argparse內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論