Jak používat argumenty proměnné délky (*args, **kwargs) v jazyce Python

Podnikání

Následující argumenty funkcí jsou pravděpodobně těmi nejčastějšími, které vás při pohledu na kód Pythonu zarazí a řeknete si: „Co to je?

  • *args
  • **kwargs

Libovolný počet argumentů (argumenty s proměnnou délkou) lze zadat tak, že se k argumentu v definici funkce připojí hvězdička, a to následujícím způsobem

  • *
  • **

Názvy *args,**kwargs se často používají jako konvence. Přípustné jsou však i jiné názvy, pokud jsou * a ** na začátku. Následující ukázka kódu používá názvy *args,**kwargs.

Níže jsou popsány následující podrobnosti.

  • *args:Přijímá více argumentů jako tuple
  • **kwargs:Přijímá více argumentů klíčových slov jako slovník

*args: Přijímá více argumentů jako tuple

Libovolný počet argumentů lze zadat definováním argumentů pomocí *, jako 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

Více argumentů je ve funkci přijímáno jako tuple. V příkladu je funkci sum() předán tuple pro výpočet souč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

Lze jej také kombinovat s argumentem pozice.

Hodnota zadaná za pozičním argumentem (vpravo od něj) je předána do argumentů jako tuple. Pokud je uveden pouze poziční argument, je to prázdný 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é * mohou být definovány jako první. V takovém případě však musí být argumenty definované později než *args uvedeny ve formě klíčového slova. Mimochodem, formát klíčového slova je tvar „jméno argumentu = hodnota“.

Poslední hodnota není automaticky předána pozičnímu argumentu. Pokud tedy není zadána jako argument klíčového slova, dojde k chybě 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)

Pokud jsou zadány pouze argumenty *, musí být další argumenty vždy zadány jako argumenty klíčových 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: Přijímá více argumentů klíčových slov jako slovník

Libovolný počet argumentů klíčových slov lze zadat definováním argumentů pomocí ,** jako ve slově **kwargs.

Ve funkci je jméno argumentu přijato jako slovník, jehož klíčem je key a jehož 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'>

Lze jej také použít ve spojení s argumentem pozice.

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}

Pokud při volání funkce uvedete jako argument objekt slovníku s **, je možné jej rozbalit a předat jako pří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é ** lze definovat pouze na konci argumentu. Definování dalšího argumentu za argumentem označeným ** způsobí chybu SyntaxError.

# def func_kwargs_error(**kwargs, arg):
#     print(kwargs)

# SyntaxError: invalid syntax