Pythonのargparse
モジュールは、コマンドラインインターフェースの作成を容易にします。このモジュールは、プログラムが必要とする引数を定義し、それらをsys.argv
から解析する方法をargparse
が理解します。
argparse
モジュールの主要な機能は、argparse.ArgumentParser
のインスタンスを中心に構築されています。このインスタンスは、引数仕様のコンテナであり、パーサ全体に適用するオプションを持っています。
parser = argparse.ArgumentParser(
prog='ProgramName',
description='What the program does',
epilog='Text at the bottom of help'
)
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)
引数がヘルプメッセージで別のグループに表示されるように、グループに引数を追加すると、パーサはそれを通常の引数のように扱います。add_argument_group()
メソッドは、この表示をカスタマイズするためのtitle
とdescription
引数を受け入れます。
以上がPythonのargparse
モジュールの基本的な使い方となります。これを利用することで、コマンドライン引数の取り扱いをより柔軟に、そして効率的に行うことが可能となります。