Python のモジュール argparse
は、プログラムの実行時にコマンドライン引数を処理および解析するための強力なツールです。 これにより、プログラムに必要なパラメータとオプションを簡単に定義でき、それらを読み取って使用するための柔軟なメカニズムが提供されます。
モジュールを使用する手順は次のとおりです argparse
。
-
モジュールをインポートする
argparse
: モジュールをインポートしてプログラムを開始しますargparse
。 -
オブジェクトを定義する
ArgumentParser
:ArgumentParser
プログラムに必要なパラメーターとオプションを定義するオブジェクト を作成します。 -
引数の追加:
.add_argument()
オブジェクトのメソッド を使用してArgumentParser
、プログラムに必要なパラメーターとオプションを追加します。 各引数には、名前、データ型、説明、その他のさまざまな属性を含めることができます。 -
引数を解析する:
.parse_args()
オブジェクトのメソッド を使用してArgumentParser
、コマンドラインからの引数を解析し、オブジェクトに格納します。 -
引数を使用する: 前の手順で解析されたオブジェクトに保存された値を使用して、コマンドラインから指定されたオプションに対応するアクションを実行します。
例: argparse
コマンドラインから 2 つの数値の合計を計算するために 使用する方法の簡単な例を次に示します。
import argparse
# Define the ArgumentParser object
parser = argparse.ArgumentParser(description='Calculate the sum of two numbers.')
# Add arguments to the ArgumentParser
parser.add_argument('num1', type=int, help='First number')
parser.add_argument('num2', type=int, help='Second number')
# Parse arguments from the command-line
args = parser.parse_args()
# Use the arguments to calculate the sum
sum_result = args.num1 + args.num2
print(f'The sum is: {sum_result}')
たとえば: のような引数を指定してプログラムを実行すると python my_program.py 10 20
、出力は次のようになり、 The sum is: 30
コマンドラインから指定された 2 つの数値の合計が表示されます。