Python argparseモジュールのガイド

Pythonのargparseモジュールは、コマンドラインインターフェースの作成を容易にする強力なツールです。このモジュールは、プログラムが必要とする引数を定義し、それらをsys.argvから解析する方法をargparseが理解するようにします。

基本的な使用法

argparseモジュールの使用は、argparse.ArgumentParserのインスタンスを作成することから始まります。以下に非常に単純な例を示します：

import argparse
parser = argparse.ArgumentParser()
parser.parse_args()

このコードを実行すると、何も表示されません。しかし、--helpオプションを付けて実行すると、argparseモジュールの便利さがわかります。

$ python prog.py --help
usage: prog.py [-h]
options:
  -h, --help  show this help message and exit

引数の追加

argparse.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

引数の解析

argparse.ArgumentParser.parse_args()メソッドは、パーサーを実行し、抽出したデータをargparse.Namespaceオブジェクトに配置します。

args = parser.parse_args()
print(args.filename, args.count, args.verbose)

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