Python命令列參數解析的實用技巧
在使用Python編寫腳本時,經常需要從命令列取得參數。 Python內建的argparse
模組提供了一個簡單而強大的實作命令列參數解析的工具。本文將介紹argparse
的基本用法,並提供一些實用的技巧和程式碼範例。
首先,需要匯入argparse
模組:
import argparse
然後,可以建立一個argparse.ArgumentParser
」物件來解析命令列參數:
parser = argparse.ArgumentParser(description='命令行参数解析示例')
description
參數用於提供一個簡短的描述,以便在說明資訊中顯示。
接下來,可以為ArgumentParser
物件新增不同的命令列參數。例如,新增一個位置參數:
parser.add_argument('input_file', help='输入文件路径')
這會建立一個名為input_file
的位置參數,用於指定輸入檔案的路徑。
為了提供更多彈性,可以加入可選參數。例如,新增一個--output
參數,用來指定輸出檔案的路徑:
parser.add_argument('--output', help='输出文件路径')
使用--output
這樣的長參數形式,也可以使用簡短的單字形式,如-o
。若要新增簡短形式的參數,可以將-o
新增至參數的dest
參數:
parser.add_argument('-o', '--output', help='输出文件路径')
然後,可以使用parse_args()
方法解析命令列參數:
args = parser.parse_args()
解析結果將保存在args
物件中。可以透過物件的屬性來存取這些值:
print(args.input_file) print(args.output)
對於位置參數,可以使用nargs
參數來指定接受多個值。例如,要接受多個輸入檔路徑,可以使用nargs=' '
:
parser.add_argument('input_files', nargs='+', help='输入文件路径')
可以為參數提供預設值。例如,要將--output
參數的預設值設為output.txt
:
parser.add_argument('--output', default='output.txt', help='输出文件路径')
如果沒有在命令列指定--output
參數,則將使用預設值。
可以為參數新增限制條件。例如,可以使用choices
參數指定某個參數只能接受特定的值:
parser.add_argument('--mode', choices=['A', 'B', 'C'], help='运行模式')
只有當--mode
參數的值為A
、B
或C
時,才會被接受。
有時候,需要確保某些參數是互斥的。可以使用add_mutually_exclusive_group()
方法建立一個互斥參數群組。例如,要確保--input
和--output
參數只能選擇其中一個,可以這樣做:
group = parser.add_mutually_exclusive_group() group.add_argument('--input', help='输入文件路径') group.add_argument('--output', help='输出文件路径')
有時候,可能希望為腳本新增多個子命令。可以使用subparsers
來實現這一點。例如,假設希望腳本有一個run
子命令和一個test
子命令,可以這樣做:
subparsers = parser.add_subparsers(dest='command') run_parser = subparsers.add_parser('run', help='运行程序') run_parser.add_argument('--input', help='输入文件路径') test_parser = subparsers.add_parser('test', help='测试程序') test_parser.add_argument('--input', help='输入文件路径')
然後,在解析命令列參數後,可以根據args.command
的值來決定使用哪個子指令。
下面是一個範例程式碼,示範了上述提到的技巧和用法:
import argparse def main(args): print('输入文件:', args.input_file) print('输出文件:', args.output) if args.input_files: print('输入文件列表:', args.input_files) if args.mode: print('运行模式:', args.mode) if args.command == 'run': print('运行程序') elif args.command == 'test': print('测试程序') if __name__ == '__main__': parser = argparse.ArgumentParser(description='命令行参数解析示例') parser.add_argument('input_file', help='输入文件路径') parser.add_argument('--output', default='output.txt', help='输出文件路径') parser.add_argument('-o', '--output', help='输出文件路径') parser.add_argument('input_files', nargs='+', help='输入文件路径') parser.add_argument('--mode', choices=['A', 'B', 'C'], help='运行模式') subparsers = parser.add_subparsers(dest='command') run_parser = subparsers.add_parser('run', help='运行程序') run_parser.add_argument('--input', help='输入文件路径') test_parser = subparsers.add_parser('test', help='测试程序') test_parser.add_argument('--input', help='输入文件路径') args = parser.parse_args() main(args)
以上是Python命令列參數解析的實用技巧的介紹和範例程式碼。 argparse
提供了一種靈活、強大的方式來解析命令列參數,並可以根據應用程式的需求進行自訂。使用argparse
,可以輕鬆處理各種複雜的命令列參數,並提高腳本的可擴充性和易用性。
以上是Python命令列參數解析的實用技巧的詳細內容。更多資訊請關注PHP中文網其他相關文章!