Как да използваме аргументи с променлива дължина (*args, **kwargs) в Python

Бизнес

Следните аргументи на функциите вероятно са най-често срещаните, които ви затрудняват, когато гледате кода на Python и си казвате: „Какво е това?

  • *args
  • **kwargs

Всеки брой аргументи (аргументи с променлива дължина) може да бъде посочен чрез добавяне на звездичка към аргумента в дефиницията на функцията, както следва

  • *
  • **

Имената *args,**kwargs често се използват като условност. Допустими са обаче и други имена, стига * и ** да са в началото. Следващият примерен код използва имената *args,**kwargs.

По-долу са описани следните подробности.

  • *args:Приема множество аргументи като кортеж
  • **kwargs:Приема множество аргументи с ключови думи като речник

*args: Приема множество аргументи като кортеж

Може да се зададе произволен брой аргументи, като се дефинират аргументи с *, както в *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

Няколко аргумента се получават като кортеж във функцията. В примера функцията sum() получава кортеж, за да изчисли сумата.

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

Той може да се комбинира и с аргумент за позиция.

Стойността, посочена след (вдясно от) позиционния аргумент, се предава на args като кортеж. Ако има само позиционен аргумент, той е празен кортеж.

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:  ()

Аргументите, отбелязани с *, могат да бъдат дефинирани първи. В този случай обаче аргументите, дефинирани по-късно от *args, трябва да бъдат посочени под формата на ключови думи. Между другото, форматът на ключовата дума е формата „име на аргумент = стойност“.

Последната стойност не се предава автоматично на позиционния аргумент. Затова, ако не е зададена като аргумент с ключова дума, ще се получи грешка 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)

Ако са зададени само * аргументи, следващите аргументи трябва винаги да се задават като аргументи с ключови думи.(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: Приема множество аргументи с ключови думи като речник

Може да се зададе произволен брой аргументи с ключови думи, като се дефинират аргументи с ,**, както в **kwargs.

Във функцията името на аргумента се получава като речник, чийто ключ е key (ключ) и чиято стойност е 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'>

Той може да се използва и в комбинация с аргумент за позиция.

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}

Чрез посочване на обекта на речника с ** като аргумент при извикването на функцията е възможно той да бъде разширен и предаден като съответен аргумент.

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

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

Аргументите, отбелязани с **, могат да бъдат дефинирани само в края на аргумента. Дефинирането на друг аргумент след аргумента, маркиран с **, ще доведе до грешка SyntaxError.

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

# SyntaxError: invalid syntax
Copied title and URL