Pythonでコマンドライン引数を取得する

Pythonでコマンドライン引数を取得する場合は、sysモジュールのargvを参照します。
インデックスの1つ目がPythonファイル名で、2つ目以降からコマンドライン引数を参照することができます。
また、argparseモジュールを使うと入力チェック処理を実装することもできます。

動作環境

Python 3.12.7

コマンドライン引数の使い方(sys.argv)

コマンドライン引数とは、スクリプトを実行するときに外部から渡す値のことです。
Pythonでは、これらの引数をsys.argvを使って取得できます。

コマンドライン引数を渡す

引数を指定してPythonコードを実行する場合は、以下のように指定します。

構文

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

実行例

例えば、ターミナルやコマンドプロンプトで以下のようにPythonスクリプトを実行すると、argv-test.py に apple,banana,orange という引数が渡されます。

1
python argv-test.py apple banana orange

Kindle Unlimited

IT専門書も30日間無料で読み放題

1冊数千円する専門書から、ビジネス書、実用書、雑誌まで幅広いジャンルが定額で読み放題。ITスキルの向上はもちろん、日々の情報収集や教養を深めるのにも最適です。

• 📚 技術書も月額定額で読み放題
• 📱 マルチデバイス対応
• ✨ 30日間の無料体験

無料で30日間試してみる

コマンドライン引数を受け取る

Pythonではargv[0]がargv-test.pyで、argv[1]以降がコマンドライン引数となります。

引数のインデックス

python argv-test.py apple banana orangeを実行した場合、引数とインデックスの紐づきは以下の通りとなります。

sys.argv[インデックス]で値を受け取ります。

コードサンプル

Pythonのsysモジュールに含まれるargvを使用し、コマンドライン引数をリストとして取得するサンプルコードです。

1
import sys
2

3
# 引数のリストを取得
4
args = sys.argv
5

6
# スクリプト名を取得
7
script_name = args[0]
8

9
# 実際の引数（スクリプト名以降）を取得
10
parameters = args[1:]
11

12
print(f"スクリプト名: {script_name}")
13
print(f"引数: {parameters}")

実行例

以下サンプルコードの実行コマンドです。

1
python argv-test.py apple banana orange

コマンドを実行すると次のような出力が得られます。

1
スクリプト名: argv-test.py
2
引数: ['apple', 'banana', 'orange']

引数の数をチェックする

ユーザーが引数を正しく渡しているかをチェックすることは重要です。
以下のように、引数の数を確認することでエラーハンドリングが可能です。

1
import sys
2

3
if len(sys.argv) < 2:
4
    print("エラー: 少なくとも1つの引数を指定してください。")
5
    sys.exit(1)
6

7
print(f"入力された引数: {sys.argv[1:]}")

実行結果例

以下のように引数が足りないエラーメッセージが表示されました。

1
$ python argv-test2.py
2
エラー: 少なくとも1つの引数を指定してください。

argparseで入力チェックを実装

argparseモジュールを使うと、入力チェックを含めた実装が簡単にできます。

実装例

以下サンプルのソースコードになります。

1
import argparse
2

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

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

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

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

argparse.ArgumentParserのインスタンス引数は以下のように指定します。

ヘルプ表示方法

-hまたは--helpを指定することで、ヘルプを表示することができます。(add_helpがTrueの場合)

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

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

6
positional arguments:
7
  user_name   ユーザ名
8
  password    パスワード
9
  age         年齢
10

11
options:
12
  -h, --help  show this help message and exit
13

14
以上

実行例(正常系)

テストプログラムの正常系の実行例です。

1
python argv-test.py test_user password 21

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

実行例(異常系①)

年齢(第三引数)に文字列を指定した場合の挙動を確認しました。

1
python argv-test.py test_user password aaa

年齢に数値を指定していないため、以下エラーメッセージが表示されました。

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

実行結果例(異常系②)

年齢(第三引数)を指定しなかった場合の挙動を確認しました。

1
python argv-test.py test_user password

年齢が必須である旨のエラーメッセージが表示されました。

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

まとめ

• Pythonでコマンドライン引数を扱うには、sysモジュールのargvを利用する。
• インデックス0は、実行ファイル名でインデックス1以降がコマンドライン引数となる。
• 入力チェックや引数の指定方法を実装する場合は、argparseモジュールを利用すると便利。

Pythonユーザにお勧めの本

人気

スッキリわかるPython入門 第2版 スッキリわかるシリーズ

難易度

実用性

読みやすさ

こんな人におすすめ： プログラミング完全未経験者、Pythonに再挑戦したい人

対話形式でスラスラ読める。複雑な概念もキャラクターが分かりやすく解説してくれます。

Amazonで詳細 🔴 楽天

独習Python

難易度

実用性

網羅性

こんな人におすすめ： Pythonを体系的に、かつ深くマスターしたい人

言語仕様を深く解説。なんとなく書ける状態から、自信を持って書ける状態へ引き上げてくれます。

Amazonで詳細 🔴 楽天

Python1年生 第2版 体験してわかる！会話でまなべる！プログラミングのしくみ

難易度

実用性

読みやすさ

こんな人におすすめ： 超初心者が最初に手にする一冊

イラスト中心で、プログラミングの楽しさを教えてくれる。ワクワクしながら学べる入門書です。

Amazonで詳細 🔴 楽天

📚 ITエンジニア向けおすすめ技術書・関連書籍まとめはこちら