Muuttuvan pituisten argumenttien (*args, **kwargs) käyttö Pythonissa

liiketoiminta

Seuraavat funktioiden argumentit ovat luultavasti yleisimpiä, jotka saavat sinut ymmälleen, kun katsot Python-koodia ja kysyt: ”Mikä tämä on?”.

  • *args
  • **kwargs

Mikä tahansa määrä argumentteja (muuttuvan pituisia argumentteja) voidaan määrittää lisäämällä tähti argumentin perään funktion määritelmässä seuraavasti

  • *
  • **

Nimiä *args,**kwargs käytetään usein sopimuksena. Muut nimet ovat kuitenkin hyväksyttäviä, kunhan * ja ** ovat alussa. Seuraavassa esimerkkikoodissa käytetään nimiä *args,**kwargs.

Seuraavassa kuvataan seuraavat yksityiskohdat.

  • *args:Hyväksyy useita argumentteja tuplina
  • **kwargs:Hyväksyy useita avainsana-argumentteja sanakirjana.

*args: Hyväksyy useita argumentteja tuplina

Argumentteja voidaan määritellä mielivaltainen määrä määrittelemällä argumentit *-merkillä, kuten *args-koodissa.

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

Useat argumentit vastaanotetaan funktiossa tuplina. Esimerkissä sum()-funktiolle annetaan tuple summan laskemista varten.

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

Se voidaan myös yhdistää sijaintiargumenttiin.

Paikka-argumentin jälkeen (sen oikealla puolella) määritetty arvo siirretään args:iin tuplina. Jos on olemassa vain sijaintiargumentti, se on tyhjä 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:  ()

*-merkillä merkityt argumentit voidaan määritellä ensin. Tällöin kuitenkin *argsin jälkeen määritellyt argumentit on määriteltävä avainsanan muodossa. Avainsanamuotona käytetään muuten muotoa ”argumentin nimi = arvo”.

Viimeistä arvoa ei automaattisesti siirretä sijaintiargumenttiin. Jos sitä ei siis määritetä avainsana-argumenttina, tuloksena on TypeError-virhe.

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)

Jos vain * argumentit on määritetty, seuraavat argumentit on aina määritettävä avainsana-argumentteina.(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: Hyväksyy useita avainsana-argumentteja sanakirjana.

Avainsana-argumentteja voidaan määrittää mielivaltainen määrä määrittelemällä argumentit tunnuksella ,** kuten **kwargs.

Funktiossa argumentin nimi vastaanotetaan sanakirjana, jonka avain on avain ja arvo on arvo.

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

Sitä voidaan käyttää myös yhdessä sijaintiargumentin kanssa.

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}

Määrittämällä funktiota kutsuttaessa argumenttina sanakirjaobjektin, jossa on **, on mahdollista laajentaa sitä ja siirtää se vastaavana argumenttina.

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

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

Argumentit, jotka on merkitty **-merkillä, voidaan määritellä vain argumentin lopussa. Toisen argumentin määrittäminen **:lla merkityn argumentin jälkeen johtaa SyntaxError-virheeseen.

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

# SyntaxError: invalid syntax