一、argparse模塊和參數解析
Python提供了argparse模塊來實現命令行參數解析,該模塊具有使用簡單、靈活的特點,可以輕鬆實現複雜的命令行參數解析。在使用argparse模塊進行參數解析時,需要按照以下步驟進行:
- 創建ArgumentParser對象
- 添加命令行選項和參數
- 解析命令行參數
下面是一個簡單的示例:
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))
運行該代碼,帶上一些參數和選項,你就可以看到結果:
$ python argparse_demo.py 1 2 3 4 4 $ python argparse_demo.py 1 2 3 4 --sum 10
在這個例子中,我們實現了一個名為”Process some integers.”的命令,它帶有一些整數,這些整數可以使用”–sum”選項進行求和或者求最大值(默認)。
二、add_argument方法和參數解析
使用ArgumentParser對象的add_argument方法添加選項和參數,可以實現靈活的命令行參數解析。add_argument方法有多個參數,下面分別介紹幾個常用的參數:
- name or flags:
‘-f’, ‘–foo’ 這種形式是完全一致的,’-‘ 和 ‘–‘ 是互換的 - action:
表示這個參數在命令行遇到時的動作,默認情況下是存儲參數值,也可以要求其執行一個指定的動作,比如 count、version 或者其他各種自定義 action,這個選項參數通常不需要值 - nargs:
命令行參數的數量,可以是固定數量(比如 2),或者是可變長度的(’*’ 或 ‘+’),也可以指定一個範圍(’1~3’)。 - const:
一些 action 和 nargs 選項要求其指定一個常量值,比如將 –version 變成一個值,用於對應的參數。 - default:
如果命令行中沒有任何輸入,則默認使用此值。 - type:
將命令行參數轉換為其他類型,如整數、浮點數、布爾值等。 - choices:
可以限制參數的值,如:choices=[‘spam’, ‘eggs’, ‘ham’]。 - required:
表示這個命令行選項是否必須要使用,默認為False。 - help:
使用-h/–help調用時顯示。
下面是一個實現了一些參數選項的例子:
import argparse parser = argparse.ArgumentParser(description='Process some integers.') parser.add_argument('--foo', action='store_true', help='an boolean flag option') parser.add_argument('bar', nargs=1, help='a positional argument') parser.add_argument('--baz', choices=['one', 'two', 'three'], help='a option with choices') args = parser.parse_args() print(args)
運行該代碼:
$ python argparse_demo.py --foo arg1 --baz=one arg2 Namespace(bar=['arg2'], baz='one', foo=True)
在這個例子中,我們添加了一個布爾型選項”–foo”,一個需要字元串參數的位置選項”bar”,一個帶有選項限制的”baz”選項。
三、subparser子命令
有時我們需要在一個命令行程序中實現多個不同的功能,這時可以使用subparser子命令。這個功能可以通過給ArgumentParser對象add_subparsers方法傳遞參數來完成,然後用子命令名稱在命令行上觸發對應的操作。例如:
import argparse parser = argparse.ArgumentParser() subparsers = parser.add_subparsers(help='sub-command help') # create the parser for the "foo" command parser_foo = subparsers.add_parser('foo', help='foo help') parser_foo.add_argument('--bar', help='bar help') # create the parser for the "bar" command parser_bar = subparsers.add_parser('bar', help='bar help') parser_bar.add_argument('bar') args = parser.parse_args() print(args)
我們創建了兩個子命令:foo和bar,並為它們分別添加了不同的選項。然後,根據在命令行中輸入的子命令名稱,在命令解析時將選擇合適的代碼執行。例如:
$ python subparsers_demo.py foo --bar XYZ Namespace(bar='XYZ')
在這個例子中,我們實現了兩個子命令foo和bar,foo選項中添加了”–bar”選項,bar選項中添加了一個參數,可以通過命令行輸入來調用子命令。
四、小結
Python提供了argparse模塊,可以輕鬆地完成命令行參數解析。使用add_argument方法添加選項和參數可以實現靈活的命令行參數解析,可以通過參數來進行限制和定義。另外,使用subparser子命令可以處理多個命令行操作。以上為本文對Python命令行參數解析的詳細介紹,希望對大家有所幫助。
原創文章,作者:小藍,如若轉載,請註明出處:https://www.506064.com/zh-tw/n/190293.html