Python 的 Keyword-Only Arguments (强制关键字参数)

时间:2022-06-12 04:52:36

直接看一个正常的函数及其调用:调用:

def dog(name, host, age):
    print(name, host, age)

dog('dobi', 'xuzhoufeng', 2)
#dobi xuzhoufeng 2

上例中,函数有三个位置参数,我们在调用中在相应位置传递对应值即可,而 keyword-only arguments 其形式是这样子的:

def dog(name, host, *, age):
    print(name, host, age)

参数中有一个 “*” 号,在该符号之后的所有参数(可一至多个)均被称为强制关键字参数,如果按照位置参数的方式对这些参数传值:

dog('dobi', 'xuzhoufeng', 2)
#TypeError: dog() takes 2 positional arguments but 3 were given

就会出现 TypeError,正确的传值形式为:

dog('dobi', 'xuzhoufeng', age = 2)
#dobi xuzhoufeng 2

也即这里的age 必须使用关键字参数的形式进行传值。

另外 keyword-only arguments 还需要注意与列表参数进行区分,列表参数的 "*" 号是紧跟参数的,而非独占一个位置,且列表参数可以传零至多个值:

def dog(name, host, *age):
    print(name, host, age)

dog('dobi', 'xuzhoufeng')
#dobi xuzhoufeng

但强制性关键字参数在传值时不可以缺省(除非其有默认值),且必须使用关键字赋值:

dog('dobi', 'xuzhoufeng')
#TypeError: dog() missing 1 required keyword-only argument: 'age'

def dog(name, host, *, age = 2):
    print(name, host, age)

dog('dobi', 'xizhoufeng')
#dobi xuzhoufeng