【Python argparseの完全ガイド】コマンドライン引数の解析から応用まで

1. argparseとは？Pythonでの基本的な使い方

argparseとは何か

import argparse

parser = argparse.ArgumentParser(description="ファイル処理プログラム")
parser.add_argument("input_file", help="処理するファイルのパス")
args = parser.parse_args()

print(f"処理するファイルは: {args.input_file}")

2. argparseを使用する理由：CLIツールに最適な選択肢

CLIツールとは？

argparseの利点

• 柔軟な引数設定: 必須引数やオプション引数の定義が簡単で、ユーザーが使いやすいプログラムを設計可能です。
• 自動エラーハンドリング: 引数が不足している場合や無効な値が指定された場合、argparseが自動的にエラーメッセージを出力します。
• ヘルプメッセージ: argparseはデフォルトで--helpオプションを提供し、ユーザーが使い方を簡単に確認できるようにします。

$ python script.py --help
usage: script.py [-h] input_file

positional arguments:
  input_file  処理対象のファイル

optional arguments:
  -h, --help  show this help message and exit

Ad

3. argparseの基本的な構造：ステップごとの解説

ArgumentParserの作成

parser = argparse.ArgumentParser(description="ファイル処理プログラム")

引数の追加

parser.add_argument("input_file", type=str, help="入力ファイルを指定してください")
parser.add_argument("--verbose", action="store_true", help="詳細な出力を有効にします")

引数の解析

args = parser.parse_args()

4. 実例：argparseを使った簡単なPythonプログラム

基本的な例

import argparse

parser = argparse.ArgumentParser(description="ファイルを処理するプログラム")
parser.add_argument("file", help="ファイルのパスを指定してください")
parser.add_argument("--verbose", action="store_true", help="詳細出力を有効にします")

args = parser.parse_args()

if args.verbose:
    print(f"ファイル '{args.file}' を詳細モードで処理します")
else:
    print(f"ファイル '{args.file}' を処理します")

Ad

5. argparseの知っておくべき機能

排他的引数（Mutually Exclusive Arguments）

parser = argparse.ArgumentParser(description="排他的引数の例")
group = parser.add_mutually_exclusive_group()
group.add_argument("--foo", action="store_true", help="fooを有効にする")
group.add_argument("--bar", action="store_true", help="barを有効にする")

args = parser.parse_args()

サブコマンド

parser = argparse.ArgumentParser(description="サブコマンドの例")
subparsers = parser.add_subparsers(dest="command")

install_parser = subparsers.add_parser('install')
install_parser.add_argument('package', help="インストールするパッケージ名")

uninstall_parser = subparsers.add_parser('uninstall')
uninstall_parser.add_argument('package', help="アンインストールするパッケージ名")

args = parser.parse_args()

if args.command == "install":
    print(f"パッケージ {args.package} をインストールします")
elif args.command == "uninstall":
    print(f"パッケージ {args.package} をアンインストールします")

6. argparseでのエラーハンドリングとデバッグ

自動エラーメッセージ

$ python script.py
usage: script.py [-h] --input INPUT
script.py: error: the following arguments are required: --input

カスタムエラーメッセージ

parser = argparse.ArgumentParser(description="カスタムエラーメッセージの例")
parser.add_argument("--input", required=True, help="入力ファイルを指定してください")

try:
    args = parser.parse_args()
except argparse.ArgumentError as err:
    print(f"エラー: {err}")

7. argparseの実世界での応用例

自動化ツールでの使用

$ python data_processor.py --input data.csv --output results.json --verbose

大規模プロジェクトでの使用

$ python package_manager.py install package_name

8. まとめ

Ad