【Python】コマンドライン引数の取得とargparseの使い方

python [ファイル名].py [引数1] [引数2] [引数3]…

python argv-test.py apple banana orange

import sys

for i in range(len(sys.argv)):
    print("argv[" + str(i) + "] = " + sys.argv[i]);

argv[0] = argv-test.py
argv[1] = apple
argv[2] = banana
argv[3] = orange

import argparse

# インスタンス作成
parser = argparse.ArgumentParser(
    prog="サンプルプログラム",
    usage="python argv-test.py <user_name:str> <password:str> <age:int>",
    description="引数のチェックを行うプログラムです。",
    epilog="以上",
    add_help=True,
)

# 引数を設定する
parser.add_argument("user_name", type=str, help="ユーザ名")
parser.add_argument("password", type=str, help="パスワード")
parser.add_argument("age", type=int, help="年齢")

# 引数を解析する
args = parser.parse_args()

# argsから設定値を取得して、表示する。
print(f"ユーザ名: {args.user_name}")
print(f"パスワード: {args.password}")
print(f"年齢: {args.age}")

$ python argv-test.py -h
usage: python argv-test.py <user_name:str> <password:str> <age:int>

引数のチェックを行うプログラムです。

positional arguments:
  user_name   ユーザ名
  password    パスワード
  age         年齢

options:
  -h, --help  show this help message and exit

以上

python argv-test.py test_user password 21

ユーザ名: test_user
パスワード: password
年齢: 21

python argv-test.py test_user password aaa

usage: python argv-test.py <user_name:str> <password:str> <age:int>
サンプルプログラム: error: argument age: invalid int value: 'aaa'

python argv-test.py test_user password

usage: python argv-test.py <user_name:str> <password:str> <age:int>
サンプルプログラム: error: the following arguments are required: age