関数の引数

可変長の引数

Pythonでは関数の引数の個数を可変にできる。

*argsの利用例

個数が決まってない部分は習慣的に引数名*argsとしておく。

def test(arg1, *args):
    print("arg1:", arg1)
    print("*kwargs:", *args)
    print("kwargs:", args)

test(1,2,3)

arg1: 1
*kwargs: 2 3
kwargs: (2, 3)

test(1,2,3)の第2,3引数を、関数内では*argsにtupleとして参照できることがわかる。

逆に、タプルで複数の引数をまとめて渡すこともできる。

def test(arg1, arg2, arg3):
    print("arg1:", arg1)
    print("arg2:", arg2)
    print("arg3:", arg3)

arg_list=[2,3]
test(1, *arg_list)

arg1: 1
arg2: 2
arg3: 3

これだけなら、引数の一つをtupleやlistにすれば同じ話になりそうだが、 呼び出した関数から、さらに他の関数を呼び出して、そこに色々な引数を指定 したいときには、とても便利に使える。

引数を辞書にしてまとめてわたす

ここまでの説明で多分わかるように，関数の引数は実は辞書dictにまとめて渡すことができる。 引数が多いときにはとても便利。 データ解析等でチューニングパラメータが多いとき等によく使う。

params = {
    'val1': 1,
    'val2': 2, 
    'val3': 3
}

test(**params)

**kwargsの利用例

可変長の引数指定を引数名とともにしたいときには、以下のように**kwargsを使う。 kwargsはkeyworded argumentsの意味。他の名前にしても良いが、習慣的にこの名前が大抵使われる。

def test(arg1, **kwargs):
    print("*kwargs:", *kwargs)
    print("kwargs:", kwargs)
    print(type(kwargs))

test(arg1=1,arg2=2,arg3=3)

*kwargs: arg2 arg3
kwargs: {'arg2': 2, 'arg3': 3}
<class 'dict'>

関数内ではオブジェクトkwargsはdictを，*kwargsはそのキー一覧を表すことがわかる。 逆に、dictで引数をまとめて渡すこともできる。

def test(arg1, arg2, arg3):
    print("arg1:", arg1)
    print("arg2:", arg2)
    print("arg3:", arg3)

arg_list={"arg2":2, "arg3":3}
test(1, **arg_list)

arg1: 1
arg2: 2
arg3: 3

上の2つの組み合わせると、以下のように、関数内で呼び出す関数に色々な引数を渡せる。

def test(df, *args)
    # ここで何かデータフレームdfの前処理をする
    df.plot(*args) # plotの引数を渡す

test(df, kind='bar', legend=True)

引数を関数にする

以下のように関数の引数に、関数を指定することができる。 ついでに可変引数**kwargsも利用して、色々な関数のグラフ化を簡単にできるようにしてみた。

import matplotlib.pyplot as plt
import numpy as np

def plot_function(fn,**kwargs):
    x = np.linspace(0, 10, 100)
    y = fn(x)

    plt.plot(x, y, **kwargs)
    plt.show()

plot_function(
    fn=np.sin, color='green', marker='o', linestyle='dashed', linewidth=2, markersize=2
    )

plot_function()を呼び出す側は，以下のように引数を辞書にまとめておくこともできる。

params={
    "color":"green",
    "marker":"o", 
    "linestyle":"dashed", 
    "linewidth": 2,
    "markersize": 2
}

plot_function(fn=np.sin, **params)