Pythonのargparseモジュールについて

Pythonの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)

以上がPythonのargparseモジュールの基本的な使い方になります。より詳細な情報や使用例については、公式ドキュメンテーションを参照してください。