Pythonのコマンドライン引数とは?取得方法を3つのパターンで解説


Pythonのコマンドライン引数って何?
コマンドライン引数はどうやって指定するの?
コマンドライン引数はどうやって取得するの?

Pythonでコマンドラインによる引数を指定してプログラムの処理を実行したい場合はよくあります。

しかし、初心者にとっては、上記のようなそもそも指定方法や取得方法がわからない…なんて声が聞こえてきそうですね。

そこでここでは、Pythonで使用するコマンドライン引数について、

  • そもそもコマンドライン引数とは
  • コマンドライン引数の取得方法
  • コマンドライン引数の数を調べる方法
  • コマンドライン引数で取得した要素分ループする方法

などについて解説していきます。

コマンドライン引数の取得方法は、方法さえ覚えてしまえばとても簡単です。ここでは、そんなコマンドライン引数について、わかりやすく解説していきます!

なお、Pythonの記事については、こちらにまとめています。

目次

Pythonのコマンドライン引数とは

そもそもコマンドライン引数とは、Pythonのプログラム実行時にコマンドラインで引数を指定することにより、プログラム内で引数を受け取ってプログラムの挙動を変えたい場合に使用します。

コマンドライン引数は、以下のようにプログラム実行時に、Pythonのファイル名の後に指定します。

$ python XXXX.py 引数1 …

コマンドライン引数を受け取るにはsysモジュールのargvを指定します。

そのため、sysモジュールをインポートしておく必要があります。

import sys

それでは次項よりコマンドライン引数の使い方を詳しく見ていきましょう。

コマンドライン引数を取得する方法

コマンドライン引数の値を取得する

ではコマンドライン引数を受け取るプログラムを作ってみましょう。

sample.pyの名前で以下のプログラムを記述します。

サンプルプログラム:

import sys
  
value = sys.argv
print(value)

実行結果:

$ python sample.py test
['sample.py', 'test']

ここでは、プログラムファイルの後にコマンドライン引数として「test」を指定しています。

argvには0番目の要素にプログラムファイル名が、以降の要素にコマンドライン引数の値が設定されています。また、コマンドライン引数は以下のように複数指定することもできます。

実行結果:

$ python sample.py apple orange melon
['sample.py', 'apple', 'orange', 'melon']

このようにコマンドライン引数を指定した分出力されました!

コマンドライン引数の数を調べる

コマンドライン引数で指定された引数の数をあらかじめチェックしておきたい場合は、要素数を調べるlen関数を使用すると便利です。

サンプルプログラム:

import sys
  
value = sys.argv

if len(value) > 1:
  print(value)
else:
  print("引数が指定されていません")

実行結果:

$ python sample.py
引数が指定されていません

このように引数を指定しないと、メッセージが出力されるようにしましたので引数の指定有無を確認することができました。

なお、前述したようにargvには0番目の要素にプログラムファイル名が入りますので、引数チェックを行いたい場合は「len(value) > 1」のようにしたほうが良いでしょう。

コマンドライン引数の要素分ループする

コマンドライン引数で取得した引数の値を順番に取得したい場合はfor文を使用すると便利です。

サンプルプログラム:

import sys
  
value = sys.argv

if len(value) > 1:

  for arg in value:
    print(arg)

else:
  print("引数が指定されていません")

実行結果:

$ python sample.py apple orange melon
sample.py
apple
orange
melon

なお、for文については以下の記事で詳しく解説しています!

まとめ

ここでは、Pythonで使用するコマンドライン引数について、

  • コマンドライン引数とは
  • コマンドライン引数の取得方法
  • コマンドライン引数の数を調べる方法
  • コマンドライン引数で取得した要素分ループする方法

などについて解説しました。

コマンドライン引数の取得はやり方さえ分かればとても簡単であることがわかりましたね。

もし、コマンドライン引数の取得方法を忘れてしまったら、この記事を思い出してくださいね!

なお、今Pythonを学習している方は以下の記事もどうぞ。

はじめてPythonを使う方でもわかりやすいように、Pythonでできることやその学習法などを中心にまとめています。

復習にも使えると思いますので、ぜひ一度ご覧になってみてくださいね。

Python 入門完全攻略ガイド

この記事を書いた人

侍エンジニア塾は「人生を変えるプログラミング学習」をコンセンプトに、過去多くのフリーランスエンジニアを輩出したプログラミングスクールです。侍テック編集部では技術系コンテンツを中心に有用な情報を発信していきます。

目次