Наведені нижче аргументи функції, мабуть, є найпоширенішими, коли ви дивитеся на код 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
