كيفية استخدام وسيطات متغيرة الطول (* args ، ** kwargs) في بايثون

اعمال

من المحتمل أن تكون وسيطات الوظيفة التالية هي الأكثر شيوعًا التي تثير حيرة لك عندما تنظر إلى كود 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 () بصفتها tuple لحساب المجموع.

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