Jak używać argumentów o zmiennej długości (*args, **kwargs) w Pythonie

Biznes

Poniższe argumenty funkcji są prawdopodobnie najczęstszymi argumentami, które wprawiają w zakłopotanie, gdy patrzysz na kod Pythona i pytasz: „Co to jest?

  • *args
  • **kwargs

Można określić dowolną liczbę argumentów (argumenty o zmiennej długości), dodając gwiazdkę do argumentu w definicji funkcji w następujący sposób

  • *
  • **

Nazwy *args,**kwargs są często używane jako konwencja. Dopuszczalne są jednak inne nazwy, o ile * i ** znajdują się na początku. Poniższy przykładowy kod używa nazw *args,**kwargs.

Poniżej przedstawiono szczegółowe informacje na ten temat.

  • *args:Przyjmuje wiele argumentów jako tuple
  • **kwargs:Przyjmuje argumenty wielu słów kluczowych w postaci słownika

*args: Przyjmuje wiele argumentów jako tuple

Można określić dowolną liczbę argumentów, definiując argumenty za pomocą *, tak jak w *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

Wiele argumentów jest przekazywanych do funkcji jako tuple. W przykładzie funkcja suma() otrzymuje tuple w celu obliczenia sumy.

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

Można ją również połączyć z argumentem pozycji.

Wartość określona po argumencie pozycyjnym (na prawo od niego) jest przekazywana do args jako tuple. Jeżeli istnieje tylko argument pozycyjny, to jest to pusta krotka.

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 oznaczone znakiem * mogą być zdefiniowane jako pierwsze. W takim przypadku jednak argumenty zdefiniowane później niż *args muszą być podane w postaci słowa kluczowego. Nawiasem mówiąc, format słowa kluczowego jest formą „nazwa argumentu = wartość”.

Ostatnia wartość nie jest automatycznie przekazywana do argumentu pozycyjnego. Dlatego jeśli nie zostanie ona określona jako argument słowa kluczowego, zostanie wyświetlony błąd typu 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)

Jeśli podano tylko * argumenty, kolejne argumenty muszą być zawsze podawane jako argumenty słowa kluczowego.(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: Przyjmuje argumenty wielu słów kluczowych w postaci słownika

Można określić dowolną liczbę argumentów słowami kluczowymi, definiując argumenty za pomocą ,** jak w **kwargs.

W funkcji nazwa argumentu jest odbierana jako słownik, którego kluczem jest key, a wartością 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'>

Można go również stosować w połączeniu z argumentem stanowiska.

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}

Podając obiekt słownika z ** jako argument podczas wywoływania funkcji, można go rozwinąć i przekazać jako odpowiedni argument.

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

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

Argumenty oznaczone symbolem ** mogą być definiowane tylko na końcu argumentu. Zdefiniowanie innego argumentu po argumencie oznaczonym symbolem ** spowoduje wystąpienie błędu SyntaxError.

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

# SyntaxError: invalid syntax