【Python】argparseでコマンドライン引数を受け取る方法

Python でちょっとしたCLIツールを作る時、引数処理を雑に書くとすぐ読みにくくなります。
そんな時に標準で使いやすいのが argparse です。

argparseとは

argparse は、Python 標準ライブラリのコマンドライン引数パーサーです。
–help が自動で使えるので、簡単なツールでも見た目を整えやすいのが便利です。

最小構成の例

まずは以下のような形が基本です。

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("name")
args = parser.parse_args()

print(args.name)

この形なら、位置引数として name を1つ受け取れます。

オプション引数を追加する

オプション引数は以下のように追加できます。

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("name")
parser.add_argument("--count", type=int, default=1)
args = parser.parse_args()

for _ in range(args.count):
    print(args.name)

位置引数とオプション引数の違い

• 位置引数は並ぶ位置で意味が決まる必須入力
• オプション引数は –count のように名前付きで追加する入力

この区別だけ押さえておくと、だいぶ読みやすいCLIになります。

まとめ

Python でCLIを作るなら、最初から argparse を使っておくと後で拡張しやすいです。
簡単なスクリプトでも help が自動で付くので、個人的にも最初から入れておくことが多いです。

参考一次情報

• Argparse Tutorial
• argparse Reference