【python】引数を取得する方法【→プログラム初心者向け】

Pythonで引数を取得する方法の概要

この記事では、pythonプログラムをコマンドラインから実行した場合に、コマンドライン引数の値をpythonファイル内部のプログラムに反映する方法を説明します。

pythonファイルを実行する時に、同時に引数（パラメータ）を渡し、内部の処理で、渡されたパラメータを使うといった処理ができるようになります。

これによって、pythonで予めプログラムできないものを処理することができます。

例えば、pythonファイルを実行するユーザーが複数人数居る場合に、ユーザーごとのユーザー名やパスワードは、ユーザーによって変わります。

pythonファイル実行時にどのユーザーがpythonファイルを実行しているかが分かるので、pythonプログラム処理内部でユーザー名やパスワードを使った処理ができるようになります。

Pythonで引数を取得する方法の前提の環境

Pythonで引数を使った実行方法の前提の環境は、下の記事で説明している私の環境と同じ環境で確認しています。

【python】バージョン確認の方法【→プログラミング初心者向け】

レンタルサーバなどのLinuxサーバを使っている場合は、下の記事でプログラミングする環境の作り方を説明しています。

もし、まだプログラムする環境ができていない方は、先にこちらの記事を読んで、プログラミングできる環境をつくることをおすすめします。

レンタルサーバでプログラミングする方法【→レンタルサーバでできる！】

Pythonで引数を取得する方法のサンプルプログラム

ライブラリインポート

ここでは、pythonファイル実行時に指定された引数の値を取得する為に、sysライブラリをインポートしています。

import sys

引数入力を取得する関数の定義

今回のサンプルプログラムは、pythonファイルの実行時にユーザーのユーザー名を第一引数に、パスワードを第二引数に指定されることを期待したものにします。

sysライブラリのargvと呼ばれるメソッドで引数全体argsを取得し、その引数全体はリストで渡される為、argvの２番目の要素をユーザー名として取得、３番目の要素をパスワードとして取得します。

また、このリストの１番目にはpythonのファイル名が入っています。

def get_input_param():

	user = ''
	passwd = ''
	result = False

	# 引数の取得
	args = sys.argv

	# 引数の個数が足りない場合
	if 2 >= len(args):
		result = False

	else:
		result = True
		user = args[1]
		passwd = args[2]

	return user,passwd,result

定義した関数の実行

ここでは、先程定義した関数の実行処理を説明します。

まず、引数で指定された値をを取得するメソッド get_input_param() を呼び出します。

get_input_param() の結果がFalseだった場合は、入力が異常である旨のメッセージを表示し、入力が正常であれば、ユーザー名とパスワードを表示するというプログラムです。

if __name__ == '__main__':

	username, password, result = get_input_param()

	if False == result:
		print("Incorrect input.")

	else:
		print("User Name: " + username)
		print("User Pswd: " + password)

実行の結果【正常処理】

下の結果は、pythonファイルtest.pyを実行した際に、第一引数にユーザー名Tommyを、第二引数にパスワードhogeを入れて、実行した結果を表しています。

内部の処理で引数で取得されたユーザー名とパスワードをprint文で表示しているので、結果としてUser NameとUser Pswdの値が表示されていることが分かります。

$ python test.py Tommy hoge
User Name: Tommy
User Pswd: hoge

実行の結果【エラー処理】

下の結果は、引数なしでpythonファイルtest.pyを実行した際の結果を表しています。

引数が２つ未満だとエラー処理（入力が間違っているメッセージを表示）にしているので、エラー処理されていることが分かります。

$ python test.py
Incorrect input.

pythonのその他「初心者向け」技術

その他のpythonプログラムの「基礎知識」を下記の記事にまとめています。

どれもpythonの文法というべき、基本的なものばかりで、これから「pythonでプログラムを学びたい」という人は、「知っておいて方がよいもの」ばかりです。

私は、「プログラム」は「動いて」こそ価値ががあると考えています。 もともと、「プログラムを学ぶ」というのは、「自分が意図した動作をプログラムにさせるようになる」ということだと思います。 つまり、プログラムを自分の意図通りに動かして、初めて「学べた」と言えるということです。

しかし、実際に手で書いて動かしてみないと「学べない」ことがあります。 頭で理解したと思っても、いざプログラムを書こうとおもっても思い通りにいかない場合があるからです。 それには、プログラムを書く環境の問題だったり、pythonのバージョンが違ったり、ライブラリのバージョンが違ったり、いろいろな事情があります。

「頭で理解する」ことと「実際に動かす」ということは違うのです。 だから、プログラムを学ぶ時には実際にプログラムを書いて「動かしてみる」ことを強くおすすめします。

それぞれの記事には、実行可能なサンプルプログラムを掲載しています。 記事を読んで、実際に自分で書いてみてプログラムの動作をご自身で確認することができます。 是非、下記の記事を読んで、「知識」としてだけではなく、「手」でpythonを覚えていってください。

【python】初心者向けおすすめ記事まとめ【pythonの文法をマスターする！】