Nasledujúce argumenty funkcií sú pravdepodobne tie najčastejšie, ktoré vás pri pohľade na kód jazyka Python zarazia a poviete si: „Čo je to?
*args
**kwargs
Ľubovoľný počet argumentov (argumenty s premenlivou dĺžkou) možno špecifikovať pripojením hviezdičky k argumentu v definícii funkcie takto
*
**
Názvy *args,**kwargs sa často používajú ako konvencia. Prípustné sú však aj iné názvy, ak sú na začiatku * a **. Nasledujúca ukážka kódu používa názvy *args,**kwargs.
Nižšie sú opísané tieto podrobnosti.
*args
:Prijíma viacero argumentov ako tuple**kwargs
:Prijíma argumenty viacerých kľúčových slov ako slovník
*args: Prijíma viacero argumentov ako tuple
Ľubovoľný počet argumentov možno určiť definovaním argumentov pomocou *, ako v *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
Viacero argumentov sa vo funkcii prijíma ako tuple. V príklade sa funkcii sum() odovzdáva tuple na výpočet súčtu.
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
Môže sa tiež kombinovať s argumentom polohy.
Hodnota zadaná za pozičným argumentom (vpravo od neho) sa odovzdá do args ako tuple. Ak je uvedený len pozičný argument, je to prázdny tuple.
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: ()
Argumenty označené * môžu byť definované ako prvé. V takom prípade však argumenty definované neskôr ako *args musia byť uvedené vo forme kľúčového slova. Mimochodom, formát kľúčového slova je tvar „meno argumentu = hodnota“.
Posledná hodnota nie je automaticky odovzdaná pozičnému argumentu. Preto ak nie je zadaná ako argument kľúčového slova, dôjde k chybe 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)
Ak sú zadané iba * argumenty, ďalšie argumenty musia byť vždy zadané ako kľúčové slová.(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: Prijíma argumenty viacerých kľúčových slov ako slovník
Ľubovoľný počet argumentov kľúčového slova možno určiť definovaním argumentov s ,** ako v **kwargs.
Vo funkcii je názov argumentu prijatý ako slovník, ktorého kľúčom je key a hodnotou je 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'>
Môže sa použiť aj v spojení s argumentom pozície.
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}
Ak pri volaní funkcie uvediete ako argument objekt slovníka s príponou **, je možné ho rozšíriť a odovzdať ako príslušný argument.
d = {'key1': 1, 'key2': 2, 'arg1': 100, 'arg2': 200}
func_kwargs_positional(**d)
# arg1: 100
# arg2: 200
# kwargs: {'key1': 1, 'key2': 2}
Argumenty označené ** možno definovať len na konci argumentu. Definovanie ďalšieho argumentu za argumentom označeným ** bude mať za následok chybu SyntaxError.
# def func_kwargs_error(**kwargs, arg):
# print(kwargs)
# SyntaxError: invalid syntax