อาร์กิวเมนต์ของฟังก์ชันต่อไปนี้อาจเป็นอาร์กิวเมนต์ที่พบบ่อยที่สุดที่ทำให้คุณสะดุดเมื่อคุณดูโค้ด 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 เป็น tuple ถ้ามีเพียงอาร์กิวเมนต์ตำแหน่ง ทูเพิลว่างเปล่า
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