Kako koristiti argumente promjenjive duljine (*args, **kwargs) u Pythonu

Sljedeći argumenti funkcije vjerojatno su najčešći oni koji vas zbune kada pogledate Python kod i kažete: “Što je ovo?

• *args
• **kwargs

Bilo koji broj argumenata (argumenata promjenjive duljine) može se navesti dodavanjem zvjezdice argumentu u definiciji funkcije na sljedeći način

• *
• **

Nazivi *args,**kwargs često se koriste kao konvencija. Međutim, druga imena su prihvatljiva sve dok su * i ** na početku. Sljedeći primjer koda koristi nazive *args,**kwargs.

Sljedeći detalji su opisani u nastavku.

• *args:Prihvaća više argumenata kao tuple
• **kwargs:Prihvaća više argumenata ključnih riječi kao rječnik

*args:Prihvaća više argumenata kao tuple

Proizvoljan broj argumenata može se odrediti definiranjem argumenata sa *, kao u *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

Više argumenata se prima kao torka u funkciji. U primjeru, funkciji sum() prosljeđuje se tor za izračunavanje zbroja.

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

Također se može kombinirati s argumentom pozicije.

Vrijednost navedena nakon (desno od) pozicijskog argumenta prosljeđuje se args-u kao tuple. Ako postoji samo pozicijski argument, to je prazan 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:  ()

Argumenti označeni sa * mogu se prvo definirati. U ovom slučaju, međutim, argumenti definirani kasnije od *args moraju biti navedeni u obliku ključne riječi. Usput, format ključne riječi je obrazac “ime argumenta = vrijednost”.

Posljednja vrijednost se ne prenosi automatski u pozicijski argument. Stoga, ako nije naveden kao argument ključne riječi, rezultirat će pogreškom 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)

Ako su navedeni samo argumenti *, sljedeći argumenti uvijek moraju biti navedeni kao argumenti ključne riječi.(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:Prihvaća više argumenata ključnih riječi kao rječnik

Proizvoljan broj argumenata ključne riječi može se odrediti definiranjem argumenata s ,** kao u **kwargs.

U funkciji se ime argumenta prima kao rječnik čiji je ključ ključ, a vrijednost vrijednost.

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

Također se može koristiti zajedno s argumentom pozicije.

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}

Navođenjem objekta rječnika s ** kao argumentom prilikom pozivanja funkcije, moguće ga je proširiti i proslijediti kao odgovarajući argument.

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

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

Argumenti označeni sa ** mogu se definirati samo na kraju argumenta. Definiranje drugog argumenta nakon argumenta označenog s ** rezultirat će pogreškom SyntaxError.

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

# SyntaxError: invalid syntax