一、argparse模塊簡介
argparse是Python自帶的一個命令行參數解析模塊。它可以輕鬆地處理命令行中的參數,並且帶有自動生成幫助和用法的功能。argparse模塊可以解析命令行參數,生成參數幫助信息,支持互斥選項,選項依賴等。argparse最大的特點是其易用性,它提供了極為友好的API,對於開發者來說非常容易上手。
二、使用argparse模塊
為了解析命令行參數,我們需要創建一個ArgumentParser對象,並定義需要使用的命令行選項和參數。我們可以通過add_argument()方法來添加命令行選項和參數。下面是一個簡單的示例:
import argparse parser = argparse.ArgumentParser(description='Process some integers.') parser.add_argument('integers', metavar='N', type=int, nargs='+', help='an integer for the accumulator') parser.add_argument('--sum', dest='accumulate', action='store_const', const=sum, default=max, help='sum the integers (default: find the max)') args = parser.parse_args() print(args.accumulate(args.integers))
在這個示例中,我們首先創建了一個ArgumentParser對象,並定義了一個描述。然後使用add_argument()方法添加了兩個命令行選項:integers和–sum。其中,integers是一個需要輸入整數值的參數,nargs=’+’ 表示該參數是一個或多個值,並且被儲存為列表;而–sum則是一個標誌,如果在命令行中加入了該選項,則args.accumulate將會被賦予一個function(sum),否則賦予一個function(max)。最後,我們使用parser.parse_args()解析了命令行參數。
三、參數選項
在使用argparse解析命令行參數時,往往我們需要一些參數選項(也叫選項參數)。參數選項通常是以「-」(單破折線)或「–」(雙破折線)開頭,後面跟一個選項名稱。argparse提供了add_argument()方法來添加參數選項。
下面是一個例子,添加了name和age兩個參數選項:
import argparse parser = argparse.ArgumentParser() parser.add_argument("--name", help="your name") parser.add_argument("--age", help="your age", type=int) args = parser.parse_args() print(args.name) print(args.age)
在命令行中執行時,可以輸入以下代碼(其中”name” 和 “age”是自定義的參數名稱):
python test.py --name "John" --age 20
命令行實際上將會被解析成如下:
args = parser.parse_args() #即 args.name=”John”, args.age=20
除了上述示例中的–name和–age之外,還有一些常用的參數選項:
- -h, –help:顯示幫助信息
- -v, –version:顯示版本信息
- -f, –file FILE:指定文件(FILE為文件名)
四、位置參數
除了參數選項,Python的命令行程序還支持位置參數。位置參數要求在命令行中以給定的順序輸入參數。它們不需要指定名稱,並且是必需的。Positional arguments可以使用add_argument()方法添加:
import argparse parser = argparse.ArgumentParser() parser.add_argument("echo", help="echo the string you use here") args = parser.parse_args() print(args.echo)
在這個示例中,我們定義了一個位置參數echo,這個參數會重複輸出我們在命令行中輸入的值。在執行腳本時,我們可以這樣使用:
python test.py hello world
輸出值將會是:
hello world
五、組合使用
argparse提供了參數組合的功能,可以同時使用參數選項和位置參數。
import argparse parser = argparse.ArgumentParser(description='Process some integers.') parser.add_argument("square", type=int, help="display a square of a given number") parser.add_argument("-v", "--verbose", action="store_true", help="increase output verbosity") args = parser.parse_args() answer = args.square**2 if args.verbose: print("the square of {} equals {}".format(args.square, answer)) else: print(answer)
在這個例子中,我們定義了一個(必要的)位置參數square和一個可選的-v選項,用於提供更多輸出信息。執行腳本」test.py 4 -v」會顯示出方框的結果以及更具體的信息。
總結
argparse是Python中解析命令行參數的標準模塊,它提供了豐富的參數選項和位置參數的支持,非常容易上手並且非常靈活。本文介紹了argparse的使用方法,並且舉了幾個例子。相信在開發過程中,使用argparse可以大大提高效率。
原創文章,作者:XAWFB,如若轉載,請註明出處:https://www.506064.com/zh-tw/n/324944.html