Наступныя аргументы функцый, верагодна, з’яўляюцца найбольш распаўсюджанымі, калі вы глядзіце на код 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.
У функцыі імя аргумента прымаецца ў выглядзе слоўніка, ключ якога з’яўляецца ключом, а значэнне – значэннем.
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