Pythonのargparseモジュールは、コマンドライン引数の解析を容易にするための強力なツールです。このモジュールを使用すると、プログラムが必要とする引数を定義し、argparseがそれらをsys.argvから解析する方法を決定します。
argparse.ArgumentParserの作成
argparseを使用する最初のステップは、ArgumentParserオブジェクトを作成することです。
import argparse
parser = argparse.ArgumentParser(description='Process some integers.')
このArgumentParserオブジェクトは、コマンドラインからPythonのデータ型への解析に必要なすべての情報を保持します。
引数の追加
ArgumentParser.add_argument()メソッドを使用して、個々の引数の仕様をパーサーに追加します。これは位置引数、値を受け入れるオプション、オン/オフフラグをサポートします。
parser.add_argument('filename') # positional argument
parser.add_argument('-c', '--count') # option that takes a value
parser.add_argument('-v', '--verbose', action='store_true') # on/off flag
引数の解析
ArgumentParser.parse_args()メソッドを使用してパーサーを実行し、抽出されたデータをargparse.Namespaceオブジェクトに配置します。
args = parser.parse_args()
print(args.filename, args.count, args.verbose)
これらの基本的なステップを使用して、Pythonのargparseモジュールを活用することができます。これにより、ユーザーフレンドリーなコマンドラインインターフェースを簡単に作成できます。