Kako uporabljati argumente spremenljive dolžine (*args, **kwargs) v Pythonu

Posel

Naslednji argumenti funkcij so verjetno najpogostejši argumenti, ki vas ob pogledu na kodo Pythona zmotijo, ko rečete: “Kaj je to?

  • *args
  • **kwargs

Poljubno število argumentov (argumentov spremenljive dolžine) lahko določite tako, da argumentu v definiciji funkcije dodate zvezdico, kot sledi

  • *
  • **

Imena *args,**kwargs se pogosto uporabljajo kot konvencija. Vendar so sprejemljiva tudi druga imena, če sta na začetku * in **. Naslednji vzorec kode uporablja imena *args,**kwargs.

V nadaljevanju so opisane naslednje podrobnosti.

  • *args:sprejme več argumentov kot tuple
  • **kwargs:sprejme več argumentov ključnih besed kot slovar

*args: sprejme več argumentov kot tuple

Poljubno število argumentov lahko določite z definiranjem argumentov z *, kot 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

Več argumentov je v funkciji prejetih kot tuple. V primeru je funkciji sum() za izračun vsote posredovan tuple.

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

Lahko se kombinira tudi z argumentom za položaj.

Vrednost, določena za pozicijskim argumentom (desno od njega), se posreduje args kot tuple. Če je na voljo samo položajni argument, je to prazen 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:  ()

Argumente, označene z *, lahko določite najprej. V tem primeru morajo biti argumenti, ki so definirani pozneje kot *args, navedeni v obliki ključne besede. Mimogrede, oblika ključne besede je oblika “ime argumenta = vrednost”.

Zadnja vrednost ni samodejno posredovana pozicijskemu argumentu. Če ni navedena kot argument s ključno besedo, se pojavi napaka 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)

Če so navedeni samo * argumenti, morajo biti naslednji argumenti vedno navedeni kot ključne besede.(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: sprejme več argumentov ključnih besed kot slovar

Poljubno število argumentov s ključnimi besedami lahko določite tako, da določite argumente z ,** kot v **kwargs.

V funkciji se ime argumenta prejme kot slovar, katerega ključ je key (ključ), vrednost pa value (vrednost).

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'>

Uporablja se lahko tudi v povezavi z argumentom za položaj.

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}

Če ob klicu funkcije kot argument navedete objekt slovarja z **, ga lahko razširite in posredujete kot ustrezen argument.

d = {'key1': 1, 'key2': 2, 'arg1': 100, 'arg2': 200}

func_kwargs_positional(**d)
# arg1:  100
# arg2:  200
# kwargs:  {'key1': 1, 'key2': 2}

Argumente, označene z **, lahko določite samo na koncu argumenta. Če za argumentom, označenim z **, določite drug argument, se pojavi napaka SyntaxError.

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

# SyntaxError: invalid syntax
Copied title and URL