A következő függvény argumentumok valószínűleg a leggyakoribbak, amelyek megakasztják az embert, amikor a Python kódot nézi, és azt kérdezi: “Mi ez?”.
*args**kwargs
Bármennyi argumentum (változó hosszúságú argumentum) megadható, ha a függvénydefinícióban az argumentumhoz csillagot csatolunk a következőképpen
***
A *args,**kwargs neveket gyakran használják konvencióként. Azonban más nevek is elfogadhatóak, amennyiben a * és a ** az elején van. A következő példakód a *args,**kwargs neveket használja.
Az alábbiakban a következő részleteket ismertetjük.
*args:Több argumentumot fogad el tupliként**kwargs:Több kulcsszó argumentumot fogad el szótárként
*args: Több argumentumot fogad el tupliként
Tetszőleges számú argumentum adható meg az argumentumok *-gal történő definiálásával, mint a *args-ben.
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
A függvényben több argumentumot kapunk egy tupliként. A példában a sum() függvénynek egy tuple-t adunk át az összeg kiszámításához.
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
Kombinálható egy pozíció érvvel is.
A pozicionális argumentum után (attól jobbra) megadott értéket az args-nek egy tuple-ként adja át. Ha csak egy pozicionális argumentum van, akkor ez egy üres 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: ()
A *-gal jelölt argumentumokat lehet először definiálni. Ebben az esetben azonban a *args után definiált argumentumokat kulcsszó formájában kell megadni. A kulcsszó formátum egyébként az “argumentum neve = érték” forma.
Az utolsó érték nem kerül automatikusan átadásra a pozicionális argumentumhoz. Ezért, ha nem kulcsszó-argumentumként van megadva, TypeError hiba keletkezik.
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)
Ha csak * argumentumok vannak megadva, a további argumentumokat mindig kulcsszó-argumentumként kell megadni.(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: Több kulcsszó argumentumot fogad el szótárként
Tetszőleges számú kulcsszavas argumentum adható meg az argumentumok ,**-val történő definiálásával, mint a **kwargs-ban.
A függvényben az argumentum neve egy szótárként érkezik, amelynek kulcsa a kulcs, értéke pedig az érték.
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'>
A pozíció érvvel együtt is használható.
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}
Ha a függvény hívásakor argumentumként megadjuk a szótárobjektumot **-val, akkor lehetőség van annak kibontására és átadására a megfelelő argumentumként.
d = {'key1': 1, 'key2': 2, 'arg1': 100, 'arg2': 200}
func_kwargs_positional(**d)
# arg1: 100
# arg2: 200
# kwargs: {'key1': 1, 'key2': 2}
A **-gal jelölt argumentumokat csak az argumentum végén lehet definiálni. A **-gal jelölt argumentum után egy másik argumentum definiálása SyntaxError hibát eredményez.
# def func_kwargs_error(**kwargs, arg):
# print(kwargs)
# SyntaxError: invalid syntax
