Python コマンドライン引数の使い方：詳細解説と実践例

Python は、その柔軟性と使いやすさから、様々なタスクに利用される汎用性の高いプログラミング言語です。スクリプトの自動化、データ処理、Web アプリケーション開発など、その応用範囲は多岐にわたります。Python スクリプトをさらに強力にする要素の一つが、コマンドライン引数の利用です。

コマンドライン引数を使用することで、スクリプトの実行時に外部から値を渡すことができ、スクリプトの動作を動的に制御することが可能になります。これにより、同じスクリプトを異なる設定やデータで実行したり、インタラクティブな入力を必要とせずにバッチ処理を実行したりすることが容易になります。

本稿では、Python におけるコマンドライン引数の基本から応用までを詳細に解説し、実践的な例を通してその使い方を習得していただきます。

1. コマンドライン引数とは？

コマンドライン引数とは、スクリプトを実行する際に、コマンドライン (またはターミナル、コンソール) からスクリプトに渡される値のことです。これらの引数は、スクリプトの実行方法をカスタマイズするために使用されます。

例えば、次のようなコマンドを実行するとします。

bash
python my_script.py input.txt output.txt -v

この場合、my_script.py が実行される Python スクリプトの名前であり、input.txt、output.txt、-v がコマンドライン引数です。スクリプト内でこれらの引数にアクセスし、その値に基づいて処理を行うことができます。

2. sys.argv を使用した基本的なコマンドライン引数の取得

Python でコマンドライン引数を取得する最も基本的な方法は、sys モジュールに含まれる argv 変数を使用することです。sys.argv は、スクリプト名を含む、コマンドライン引数のリストです。

“`python

sys_argv_example.py

import sys

print(“スクリプト名:”, sys.argv[0])
print(“コマンドライン引数の数:”, len(sys.argv))
print(“コマンドライン引数リスト:”, sys.argv)

if len(sys.argv) > 1:
print(“最初の引数:”, sys.argv[1])
if len(sys.argv) > 2:
print(“2番目の引数:”, sys.argv[2])
“`

このスクリプトをコマンドラインから実行してみましょう。

bash
python sys_argv_example.py file1.txt file2.txt -d

出力は以下のようになります。

スクリプト名: sys_argv_example.py
コマンドライン引数の数: 4
コマンドライン引数リスト: ['sys_argv_example.py', 'file1.txt', 'file2.txt', '-d']
最初の引数: file1.txt
2番目の引数: file2.txt

• sys.argv[0] は常にスクリプトの名前 (またはスクリプトへの絶対パス) を含みます。
• sys.argv[1] 以降が、コマンドラインで渡された引数を順番に格納しています。
• len(sys.argv) は、引数の総数（スクリプト名を含む）を返します。

注意点:

• sys.argv の要素は常に文字列型です。数値として扱う場合は、int() や float() を使用して型変換する必要があります。
• 引数の存在をチェックしてからアクセスするように注意してください。存在しないインデックスにアクセスすると IndexError が発生します。

3. argparse モジュールを使用した高度なコマンドライン引数の処理

sys.argv は基本的な引数の取得には便利ですが、複雑なスクリプトになると、引数の種類、デフォルト値、ヘルプメッセージなどを管理するのが難しくなります。そこで登場するのが argparse モジュールです。

argparse モジュールを使用すると、コマンドライン引数の解析をより構造化し、ユーザーフレンドリーなスクリプトを簡単に作成できます。

3.1. argparse モジュールの基本的な使い方

argparse モジュールを使った基本的なコマンドライン引数の処理の流れは以下の通りです。

1. ArgumentParser オブジェクトの作成: argparse.ArgumentParser() を使用して、引数の解析を行う ArgumentParser オブジェクトを作成します。このオブジェクトは、スクリプトの引数の定義と解析を管理します。

2. 引数の定義: ArgumentParser.add_argument() メソッドを使用して、スクリプトが受け取る引数を定義します。各引数に対して、名前、型、ヘルプメッセージ、デフォルト値などを指定できます。

3. 引数の解析: ArgumentParser.parse_args() メソッドを呼び出して、コマンドライン引数を解析します。このメソッドは、解析された引数の値を属性として持つオブジェクトを返します。

4. 引数の利用: parse_args() メソッドが返したオブジェクトの属性として、解析された引数の値にアクセスし、スクリプトのロジックで使用します。

3.2. add_argument() メソッドの詳細

add_argument() メソッドは、引数を定義するために使用される最も重要なメソッドです。以下に、主要な引数とその意味を示します。

• name or flags (必須): 引数の名前またはフラグを指定します。

  • 名前 (例: filename) は、位置引数として扱われます。位置引数は、コマンドラインで指定された順序で解釈されます。
  • フラグ (例: -f または --file) は、オプション引数として扱われます。オプション引数は、コマンドラインで任意に指定でき、順序は重要ではありません。ハイフン (-) が一つ付いている場合は短いフラグ、二つ付いている場合は長いフラグを意味します。

• action (オプション): 引数がコマンドラインに現れたときに実行される基本的なアクションを指定します。

  • store (デフォルト): 引数の値を格納します。
  • store_const: const 引数で指定された値を格納します。通常、フラグが指定された場合にのみ使用されます。
  • store_true: フラグが存在する場合に True を格納し、存在しない場合に False を格納します。
  • store_false: フラグが存在する場合に False を格納し、存在しない場合に True を格納します。
  • append: 引数の値をリストに追加します。同じ引数が複数回指定された場合に便利です。
  • append_const: const 引数で指定された値をリストに追加します。
  • count: フラグがコマンドラインに現れた回数をカウントします。
  • help: 引数に関するヘルプメッセージを表示します。
  • version: プログラムのバージョン情報を表示します。

• nargs (オプション): 引数が取るべきコマンドライン引数の数を指定します。

  • N: 引数は N 個の引数を取ることを意味します。
  • ?: 引数は 0 または 1 個の引数を取ることを意味します。引数が指定されない場合は、default 値が使用されます。
  • *: 引数は 0 個以上の引数を取ることを意味します。引数はリストとして格納されます。
  • +: 引数は 1 個以上の引数を取ることを意味します。引数はリストとして格納されます。
  • argparse.REMAINDER: コマンドラインに残ったすべての引数をリストとして格納します。

• const (オプション): store_const または append_const アクションで使用される定数値を指定します。

• default (オプション): 引数がコマンドラインで指定されなかった場合に、使用されるデフォルト値を指定します。

• type (オプション): 引数の型を指定します。指定可能な型には、int、float、str、argparse.FileType などがあります。

• choices (オプション): 引数が取りうる値のリストを指定します。引数の値がリストに含まれていない場合、エラーが発生します。

• required (オプション): 引数が必須かどうかを指定します。True を指定すると、引数がコマンドラインで指定されなかった場合にエラーが発生します。

• help (オプション): 引数の説明を表示するためのヘルプメッセージを指定します。

• metavar (オプション): ヘルプメッセージで引数の名前の代わりに表示される名前を指定します。

• dest (オプション): parse_args() が返すオブジェクトの属性名として使用される名前を指定します。指定されない場合、引数の名前が使用されます。

3.3. 実践的な例

以下に、argparse モジュールを使用した実践的な例をいくつか示します。

例1: 簡単な計算スクリプト

“`python

calculate.py

import argparse

parser = argparse.ArgumentParser(description=”簡単な計算スクリプト”)
parser.add_argument(“x”, type=float, help=”最初の数値”)
parser.add_argument(“y”, type=float, help=”2番目の数値”)
parser.add_argument(“-o”, “–operation”, choices=[“add”, “subtract”, “multiply”, “divide”], default=”add”, help=”実行する演算 (add, subtract, multiply, divide)”)

args = parser.parse_args()

if args.operation == “add”:
result = args.x + args.y
elif args.operation == “subtract”:
result = args.x – args.y
elif args.operation == “multiply”:
result = args.x * args.y
elif args.operation == “divide”:
if args.y == 0:
print(“エラー: 0 で割ることはできません”)
exit()
result = args.x / args.y

print(“結果:”, result)
“`

このスクリプトは、2つの数値を引数として受け取り、指定された演算（デフォルトは加算）を実行します。

実行例:

bash
python calculate.py 10 5 -o multiply

出力:

結果: 50.0

例2: ファイル処理スクリプト

“`python

file_process.py

import argparse
import os

parser = argparse.ArgumentParser(description=”ファイル処理スクリプト”)
parser.add_argument(“input_file”, type=argparse.FileType(“r”), help=”入力ファイル”)
parser.add_argument(“-o”, “–output_file”, type=str, default=”output.txt”, help=”出力ファイル名”)
parser.add_argument(“-u”, “–uppercase”, action=”store_true”, help=”内容を大文字に変換する”)

args = parser.parse_args()

try:
with open(args.output_file, “w”) as outfile:
for line in args.input_file:
if args.uppercase:
outfile.write(line.upper())
else:
outfile.write(line)
print(f”処理完了: {args.output_file} に出力”)

except Exception as e:
print(f”エラー: {e}”)
“`

このスクリプトは、入力ファイルを読み込み、必要に応じて内容を大文字に変換して、出力ファイルに書き込みます。

実行例:

bash
python file_process.py input.txt -o result.txt -u

解説:

• argparse.FileType("r") は、入力ファイルを読み取りモードで開き、ファイルオブジェクトを args.input_file に格納します。
• -o または --output_file で出力ファイル名を指定できます。指定しない場合は output.txt が使用されます。
• -u または --uppercase フラグを指定すると、ファイルの内容が大文字に変換されます。

例3: 複数の値を引数として受け取るスクリプト

“`python

multi_args.py

import argparse

parser = argparse.ArgumentParser(description=”複数の値を引数として受け取るスクリプト”)
parser.add_argument(“numbers”, type=int, nargs=”+”, help=”数値のリスト”)
parser.add_argument(“-s”, “–sum”, action=”store_true”, help=”数値の合計を計算する”)
parser.add_argument(“-a”, “–average”, action=”store_true”, help=”数値の平均を計算する”)

args = parser.parse_args()

if args.sum:
print(“合計:”, sum(args.numbers))
elif args.average:
print(“平均:”, sum(args.numbers) / len(args.numbers))
else:
print(“数値リスト:”, args.numbers)
“`

このスクリプトは、複数の数値を引数として受け取り、合計または平均を計算します。

実行例:

bash
python multi_args.py 1 2 3 4 5 -s

出力:

合計: 15

3.4. ヘルプメッセージの表示

argparse モジュールは、自動的にヘルプメッセージを生成します。スクリプトを -h または --help オプションで実行すると、ヘルプメッセージが表示されます。

bash
python calculate.py -h

出力例:

“`
usage: calculate.py [-h] [-o {add,subtract,multiply,divide}] x y

簡単な計算スクリプト

positional arguments:
x 最初の数値
y 2番目の数値

options:
-h, –help show this help message and exit
-o {add,subtract,multiply,divide}, –operation {add,subtract,multiply,divide}
実行する演算 (add, subtract, multiply, divide)
“`

ヘルプメッセージは、スクリプトの使い方をユーザーに伝える上で非常に重要です。add_argument() メソッドの help 引数を使用して、各引数の説明を記述することで、ユーザーフレンドリーなスクリプトを作成できます。

4. コマンドライン引数を使用する際のベストプラクティス

• 明確な引数名を付ける: 引数名は、その目的を明確に表すようにしてください。
• 適切な型を指定する: 引数の型を type 引数で指定することで、入力値の検証を自動化できます。
• デフォルト値を設定する: 必須でない引数には、default 引数で適切なデフォルト値を設定してください。
• ヘルプメッセージを記述する: help 引数を使用して、各引数の説明を記述してください。これにより、ユーザーがスクリプトの使い方を理解しやすくなります。
• エラー処理を実装する: 引数の値が期待される範囲外の場合や、必要な引数が指定されていない場合に、適切なエラーメッセージを表示し、スクリプトを終了するようにしてください。
• 引数の順序に依存しないようにする: 可能であれば、オプション引数を使用し、引数の順序に依存しないように設計してください。
• ドキュメントを整備する: スクリプトの引数に関する情報を、README ファイルやドキュメントに記述してください。

5. まとめ

コマンドライン引数は、Python スクリプトの柔軟性と再利用性を高めるための強力なツールです。sys.argv を使用することで基本的な引数の取得が可能ですが、argparse モジュールを使用することで、より複雑な引数の解析、検証、およびヘルプメッセージの生成を容易に行うことができます。

本稿で解説した内容と実践的な例を参考に、コマンドライン引数を効果的に活用し、より高度な Python スクリプトの開発に挑戦してみてください。コマンドライン引数を使いこなすことで、Python スクリプトは単なるプログラムから、さまざまなタスクを自動化できる強力なツールへと進化します。