Pythonの可変長引数（*args, **kwargs）の使い方
Python初心者がサンプルコードを見て「何だこれ」とつまずきやすいのが、関数の引数の*argsと**kwargs。
関数定義で引数に*と**（1個または2個のアスタリスク）をつけると、呼び出し時に任意の数の引数（可変長引数）を指定できる。慣例として*args, **kwargsという名前が使われることが多いが、*と**が頭についていれば他の名前でも問題ない。以下のサンプルコードでは*args, **kwargsという名前を使う。
関数についての基本的な説明は以下の記事を参照。
関数定義時ではなく呼び出し時に*, **をつけるとリストや辞書を展開して渡すことができる。以下の記事を参照。
*args: 複数の引数をタプルとして受け取る
*argsのように*をつけた引数を定義すると、呼び出し時に任意の数の引数を指定できる。
def my_sum(*args):
return sum(args)
print(my_sum(1, 2, 3, 4))
# 10
print(my_sum(1, 2, 3, 4, 5, 6, 7, 8))
# 36
関数の中では複数の引数がタプルとして受け取られる。例ではsum()関数にタプルを渡して合計を算出している。
def my_sum2(*args):
print('args: ', args)
print('type: ', type(args))
print('sum : ', sum(args))
my_sum2(1, 2, 3, 4)
# args: (1, 2, 3, 4)
# type: <class 'tuple'>
# sum : 10
位置引数と組み合わせることもできる。
位置引数より後ろ（右側）で指定した値がargsにタプルとして渡される。位置引数のみの場合は空のタプルになる。
def func_args(arg1, arg2, *args):
print('arg1: ', arg1)
print('arg2: ', arg2)
print('args: ', args)
func_args(0, 1, 2, 3, 4)
# arg1: 0
# arg2: 1
# args: (2, 3, 4)
func_args(0, 1)
# arg1: 0
# arg2: 1
# args: ()
*がついた引数を先に定義することもできるが、この場合は*argsよりも後ろで定義された引数はキーワード形式引数名=値で指定する必要がある。
例えば、以下のサンプルコードでは、最後の値が自動的に位置引数として渡されたりすることはなく、キーワード引数として指定しないとエラーTypeErrorとなる。
def func_args2(arg1, *args, arg2):
print('arg1: ', arg1)
print('arg2: ', arg2)
print('args: ', args)
# func_args2(0, 1, 2, 3, 4)
# TypeError: func_args2() missing 1 required keyword-only argument: 'arg2'
func_args2(0, 1, 2, 3, arg2=4)
# arg1: 0
# arg2: 4
# args: (1, 2, 3)
*だけの引数を指定すると、それ以降の引数は必ずキーワード引数として指定しなければならない。"keyword-only argument"（キーワード専用引数、キーワード限定引数）と呼ばれる。
def func_args_kw_only(arg1, *, arg2):
print('arg1: ', arg1)
print('arg2: ', arg2)
# func_args_kw_only(100, 200)
# TypeError: func_args_kw_only() takes 1 positional argument but 2 were given
func_args_kw_only(100, arg2=200)
# arg1: 100
# arg2: 200
**kwargs: 複数のキーワード引数を辞書として受け取る
**kwargsのように**をつけた引数を定義すると、呼び出し時に任意の数のキーワード引数を指定できる。
関数の中では引数名がキーkey、値がvalueとなる辞書として受け取られる。
def func_kwargs(**kwargs):
print('kwargs: ', kwargs)
print('type: ', type(kwargs))
func_kwargs(key1=1, key2=2, key3=3)
# kwargs: {'key1': 1, 'key2': 2, 'key3': 3}
# type: <class 'dict'>
位置引数と合わせて使用することもできる。
def func_kwargs_positional(arg1, arg2, **kwargs):
print('arg1: ', arg1)
print('arg2: ', arg2)
print('kwargs: ', kwargs)
func_kwargs_positional(0, 1, key1=1)
# arg1: 0
# arg2: 1
# kwargs: {'key1': 1}
関数呼び出し時に辞書オブジェクトに**をつけて引数に指定することで、展開してそれぞれの引数として渡すことも可能。
d = {'key1': 1, 'key2': 2, 'arg1': 100, 'arg2': 200}
func_kwargs_positional(**d)
# arg1: 100
# arg2: 200
# kwargs: {'key1': 1, 'key2': 2}
引数の展開についての詳細は以下の記事を参照。
**をつけた引数は引数の最後でのみ定義できる。**をつけた引数以降に別の引数を定義するとエラーSyntaxErrorとなる。
# def func_kwargs_error(**kwargs, arg):
# print(kwargs)
# SyntaxError: invalid syntax