コマンドライン引数
コマンドライン引数とは、プログラムを実行する際にコマンドに続けて渡すパラメータのことです。例えばpython main.py helloと実行した場合、helloがコマンドライン引数です。
1. コマンドライン引数とは
コマンドライン引数とは、プログラムを実行する際にコマンドに続けて渡すパラメータのことです。例えばpython main.py helloと実行した場合、helloがコマンドライン引数です。
コマンドライン引数を使うと、プログラムのコードを変更せずに、実行時に動作を変えることができます。例えば、処理対象のファイル名や設定値を引数で渡すといった使い方ができます。
2. sys.argv
Pythonでは、sysモジュールのsys.argvを使ってコマンドライン引数を取得できます。基本的な構文は以下のとおりです。
import sys
引数 = sys.argv[番号]
sys.argvはリストで、sys.argv[0]にはスクリプト名、sys.argv[1]以降に渡された引数が順番に格納されます。
実際に試してみましょう。main.pyに以下の内容を記述して保存します。
import sys
print(f"引数の数: {len(sys.argv)}")
print(f"すべての引数: {sys.argv}")
print(f"スクリプト名(argv[0]): {sys.argv[0]}")
print(f"第1引数(argv[1]): {sys.argv[1]}")
print(f"第2引数(argv[2]): {sys.argv[2]}")
引数を付けて実行してみましょう。
python main.py hello world
以下のように出力されます。
引数の数: 3
すべての引数: ['main.py', 'hello', 'world']
スクリプト名(argv[0]): main.py
第1引数(argv[1]): hello
第2引数(argv[2]): world
sys.argvは["main.py", "hello", "world"]というリストになっています。sys.argv[0]にはスクリプト名が入り、sys.argv[1]以降にコマンドラインで指定した引数が順番に格納されます。引数の数は3つ(スクリプト名を含む)です。
| 📝 sys.argvの値はすべて文字列型 |
|---|
sys.argvの値はすべて文字列型です。数値として使う場合はint()やfloat()で型変換が必要です。例えばpython main.py 100と実行した場合、sys.argv[1]は文字列の"100"であり、整数の100ではありません。 |
| 💡 ポイント |
|---|
| コマンドライン引数は、ツールやスクリプトに柔軟性を持たせるための基本的な仕組みです。処理対象のファイル名、出力先のパス、設定値など、実行のたびに変わる値を引数で渡すことで、コードを変更せずに異なる条件で実行できるようになります。 今回のようにターミナルから直接実行する場合はもちろん、シェルスクリプトやバッチファイルからPythonスクリプトを呼び出す場合にも、コマンドライン引数で値を渡すことができます。たとえば、毎日決まった時間に実行するスクリプトで処理対象の日付を渡したり、複数のファイルを順番に処理するシェルスクリプトからファイル名を渡したりと、他のプログラムと組み合わせて使う場面で広く活用されます。 |