อะไร**(ดาวคู่) และ*(ดาว) ทำสำหรับพารามิเตอร์
พวกเขาอนุญาตให้ฟังก์ชั่นที่จะกำหนดที่จะยอมรับและสำหรับผู้ใช้ที่จะผ่านหมายเลขใด ๆ ของข้อโต้แย้งตำแหน่ง ( *) และคำหลัก ( **)
กำหนดฟังก์ชั่น
*argsช่วยให้ตัวเลขใด ๆ ของการขัดแย้งตำแหน่งตัวเลือก (พารามิเตอร์) ซึ่งจะถูกกำหนดให้ tuple argsที่ชื่อว่า
**kwargsช่วยให้หมายเลขใด ๆ ของข้อโต้แย้งคำหลักที่เลือกได้ (พารามิเตอร์) kwargsซึ่งจะอยู่ในกิงดิคที่มีชื่อว่า
คุณสามารถ (และควร) เลือกชื่อที่เหมาะสมใด ๆ แต่ถ้าเจตนาคือข้อโต้แย้งที่จะเป็นของความหมายที่ไม่เฉพาะเจาะจงargsและkwargsเป็นชื่อมาตรฐาน
การขยายการส่งผ่านจำนวนอาร์กิวเมนต์ใด ๆ
คุณยังสามารถใช้*argsและ**kwargsส่งต่อพารามิเตอร์จากรายการ (หรือ iterable) และ dicts (หรือการแมปใด ๆ ) ตามลำดับ
ฟังก์ชั่นรับพารามิเตอร์ไม่จำเป็นต้องรู้ว่าพวกเขากำลังขยายตัว
ยกตัวอย่างเช่นงูหลาม 2 xrange ไม่ชัดเจนคาดหวัง*argsแต่เพราะมันใช้เวลา 3 จำนวนเต็มเป็นอาร์กิวเมนต์:
>>> x = xrange(3) # create our *args - an iterable of 3 integers
>>> xrange(*x) # expand here
xrange(0, 2, 2)
เป็นอีกตัวอย่างหนึ่งเราสามารถใช้การขยายแบบตามคำบอกในstr.format:
>>> foo = 'FOO'
>>> bar = 'BAR'
>>> 'this is foo, {foo} and bar, {bar}'.format(**locals())
'this is foo, FOO and bar, BAR'
ใหม่ใน Python 3: การกำหนดฟังก์ชั่นด้วยอาร์กิวเมนต์ที่เป็นคีย์เวิร์ดเท่านั้น
คุณสามารถมีอาร์กิวเมนต์ได้เฉพาะคีย์เวิร์ดหลังจาก*args- ตัวอย่างเช่นที่นี่kwarg2จะต้องได้รับเป็นอาร์กิวเมนต์ของคำหลัก - ไม่ใช่ตำแหน่ง:
def foo(arg, kwarg=None, *args, kwarg2=None, **kwargs):
return arg, kwarg, args, kwarg2, kwargs
การใช้งาน:
>>> foo(1,2,3,4,5,kwarg2='kwarg2', bar='bar', baz='baz')
(1, 2, (3, 4, 5), 'kwarg2', {'bar': 'bar', 'baz': 'baz'})
นอกจากนี้ยัง*สามารถใช้เพื่อระบุว่าคำหลักมีเพียงการขัดแย้งตามเท่านั้น
def foo(arg, kwarg=None, *, kwarg2=None, **kwargs):
return arg, kwarg, kwarg2, kwargs
ที่นี่kwarg2อีกครั้งจะต้องเป็นอาร์กิวเมนต์คำหลักที่มีชื่ออย่างชัดเจน:
>>> foo(1,2,kwarg2='kwarg2', foo='foo', bar='bar')
(1, 2, 'kwarg2', {'foo': 'foo', 'bar': 'bar'})
และเราไม่สามารถยอมรับข้อโต้แย้งตำแหน่งไม่ จำกัด ได้อีกต่อไปเพราะเราไม่มี*args*:
>>> foo(1,2,3,4,5, kwarg2='kwarg2', foo='foo', bar='bar')
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: foo() takes from 1 to 2 positional arguments
but 5 positional arguments (and 1 keyword-only argument) were given
อีกครั้งมากขึ้นที่นี่เราจำเป็นต้องkwargได้รับชื่อไม่ใช่ตำแหน่ง:
def bar(*, kwarg=None):
return kwarg
ในตัวอย่างนี้เราเห็นว่าหากเราพยายามส่งผ่านkwargตำแหน่งเราได้รับข้อผิดพลาด:
>>> bar('kwarg')
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: bar() takes 0 positional arguments but 1 was given
เราต้องส่งkwargพารามิเตอร์เป็นอาร์กิวเมนต์คำหลักอย่างชัดเจน
>>> bar(kwarg='kwarg')
'kwarg'
งูหลาม 2 สาธิตที่เข้ากันได้
*args(โดยทั่วไปจะพูดว่า "star-args") และ**kwargs(ดาวสามารถบอกเป็นนัยได้โดยการพูดว่า "kwargs" แต่จะต้องชัดเจนด้วย "double-star kwargs") เป็นสำนวนทั่วไปของ Python สำหรับการใช้*และ**สัญลักษณ์ ชื่อตัวแปรเฉพาะเหล่านี้ไม่จำเป็น (เช่นคุณสามารถใช้*foosและ**bars) แต่การออกจากการประชุมมีแนวโน้มที่จะทำให้โกรธนักเขียน Python ของคุณ
โดยทั่วไปเราใช้สิ่งเหล่านี้เมื่อเราไม่ทราบว่าฟังก์ชั่นของเราจะได้รับหรือจำนวนข้อโต้แย้งที่เราอาจผ่านและบางครั้งแม้ว่าการตั้งชื่อตัวแปรทุกตัวจะแยกกันยุ่งเหยิงและซ้ำซ้อน (แต่นี่เป็นกรณีที่มักจะชัดเจน ดีกว่าโดยปริยาย)
ตัวอย่างที่ 1
ฟังก์ชั่นต่อไปนี้อธิบายถึงวิธีการใช้งานและสาธิตพฤติกรรม หมายเหตุbอาร์กิวเมนต์ที่ตั้งชื่อจะถูกใช้โดยอาร์กิวเมนต์ตำแหน่งที่สองก่อนหน้านี้:
def foo(a, b=10, *args, **kwargs):
'''
this function takes required argument a, not required keyword argument b
and any number of unknown positional arguments and keyword arguments after
'''
print('a is a required argument, and its value is {0}'.format(a))
print('b not required, its default value is 10, actual value: {0}'.format(b))
# we can inspect the unknown arguments we were passed:
# - args:
print('args is of type {0} and length {1}'.format(type(args), len(args)))
for arg in args:
print('unknown arg: {0}'.format(arg))
# - kwargs:
print('kwargs is of type {0} and length {1}'.format(type(kwargs),
len(kwargs)))
for kw, arg in kwargs.items():
print('unknown kwarg - kw: {0}, arg: {1}'.format(kw, arg))
# But we don't have to know anything about them
# to pass them to other functions.
print('Args or kwargs can be passed without knowing what they are.')
# max can take two or more positional args: max(a, b, c...)
print('e.g. max(a, b, *args) \n{0}'.format(
max(a, b, *args)))
kweg = 'dict({0})'.format( # named args same as unknown kwargs
', '.join('{k}={v}'.format(k=k, v=v)
for k, v in sorted(kwargs.items())))
print('e.g. dict(**kwargs) (same as {kweg}) returns: \n{0}'.format(
dict(**kwargs), kweg=kweg))
เราสามารถตรวจสอบความช่วยเหลือออนไลน์สำหรับลายเซ็นของฟังก์ชั่นด้วยhelp(foo)ซึ่งจะบอกเรา
foo(a, b=10, *args, **kwargs)
เรียกฟังก์ชั่นนี้ด้วย foo(1, 2, 3, 4, e=5, f=6, g=7)
ซึ่งพิมพ์:
a is a required argument, and its value is 1
b not required, its default value is 10, actual value: 2
args is of type <type 'tuple'> and length 2
unknown arg: 3
unknown arg: 4
kwargs is of type <type 'dict'> and length 3
unknown kwarg - kw: e, arg: 5
unknown kwarg - kw: g, arg: 7
unknown kwarg - kw: f, arg: 6
Args or kwargs can be passed without knowing what they are.
e.g. max(a, b, *args)
4
e.g. dict(**kwargs) (same as dict(e=5, f=6, g=7)) returns:
{'e': 5, 'g': 7, 'f': 6}
ตัวอย่างที่ 2
เราสามารถเรียกมันได้โดยใช้ฟังก์ชั่นอื่นซึ่งเราได้เตรียมไว้ให้a:
def bar(a):
b, c, d, e, f = 2, 3, 4, 5, 6
# dumping every local variable into foo as a keyword argument
# by expanding the locals dict:
foo(**locals())
bar(100) พิมพ์:
a is a required argument, and its value is 100
b not required, its default value is 10, actual value: 2
args is of type <type 'tuple'> and length 0
kwargs is of type <type 'dict'> and length 4
unknown kwarg - kw: c, arg: 3
unknown kwarg - kw: e, arg: 5
unknown kwarg - kw: d, arg: 4
unknown kwarg - kw: f, arg: 6
Args or kwargs can be passed without knowing what they are.
e.g. max(a, b, *args)
100
e.g. dict(**kwargs) (same as dict(c=3, d=4, e=5, f=6)) returns:
{'c': 3, 'e': 5, 'd': 4, 'f': 6}
ตัวอย่างที่ 3: การใช้งานจริงในมัณฑนากร
ตกลงดังนั้นเราอาจยังไม่เห็นอรรถประโยชน์นี้ ลองจินตนาการว่าคุณมีหลายฟังก์ชั่นที่มีรหัสซ้ำซ้อนก่อนและ / หรือหลังรหัสที่แตกต่าง ฟังก์ชั่นชื่อดังต่อไปนี้เป็นเพียงนามแฝงรหัสเพื่อเป็นตัวอย่าง
def foo(a, b, c, d=0, e=100):
# imagine this is much more code than a simple function call
preprocess()
differentiating_process_foo(a,b,c,d,e)
# imagine this is much more code than a simple function call
postprocess()
def bar(a, b, c=None, d=0, e=100, f=None):
preprocess()
differentiating_process_bar(a,b,c,d,e,f)
postprocess()
def baz(a, b, c, d, e, f):
... and so on
เราอาจจะสามารถจัดการกับปัญหานี้แตกต่างกัน แต่แน่นอนเราสามารถดึงความซ้ำซ้อนกับมัณฑนากรและอื่น ๆ ตัวอย่างด้านล่างของเราแสดงให้เห็นถึงวิธีการ*argsและ**kwargsจะมีประโยชน์มาก:
def decorator(function):
'''function to wrap other functions with a pre- and postprocess'''
@functools.wraps(function) # applies module, name, and docstring to wrapper
def wrapper(*args, **kwargs):
# again, imagine this is complicated, but we only write it once!
preprocess()
function(*args, **kwargs)
postprocess()
return wrapper
และตอนนี้ทุกฟังก์ชั่นที่ห่อสามารถเขียนได้มากขึ้นอย่างชัดเจนในขณะที่เราได้แยกออกจากความซ้ำซ้อน:
@decorator
def foo(a, b, c, d=0, e=100):
differentiating_process_foo(a,b,c,d,e)
@decorator
def bar(a, b, c=None, d=0, e=100, f=None):
differentiating_process_bar(a,b,c,d,e,f)
@decorator
def baz(a, b, c=None, d=0, e=100, f=None, g=None):
differentiating_process_baz(a,b,c,d,e,f, g)
@decorator
def quux(a, b, c=None, d=0, e=100, f=None, g=None, h=None):
differentiating_process_quux(a,b,c,d,e,f,g,h)
และโดยแฟออกรหัสของเราซึ่ง*argsและ**kwargsช่วยให้เราทำเราลดสายรหัสปรับปรุงการอ่านและการบำรุงรักษาและมีสถานที่เป็นที่ยอมรับ แต่เพียงผู้เดียวสำหรับตรรกะในโปรแกรมของเรา หากเราจำเป็นต้องเปลี่ยนส่วนใดส่วนหนึ่งของโครงสร้างนี้เรามีที่เดียวที่จะทำการเปลี่ยนแปลงแต่ละอย่าง