Python从定位参数到仅限关键字参数
摘自:《流畅的Python》第5章 一等函数
Python 最好的特性之一是提供了极为灵活的参数处理机制,而且 Python 3 进一步提供了仅限关键字参数(keyword-only argument)。与之密切相关的是,调用函数时使用 * 和 **“展开”可迭代对象,映射到单个参数。下面通过示例 5-10 中的代码展示这些特性,实际使用的代码在示例 5-11 中。
示例 5-10 tag 函数用于生成 HTML 标签;使用名为 cls 的关键字参数传入“class”属性,这是一种变通方法,因为“ class”是 Python 的关键字
def tag(name, *content, cls=None, **attrs):
"""生成一个或多个HTML标签"""
if cls is not None:
attrs['class'] = cls
if attrs:
attr_str = ''.join(' %s="%s"' % (attr, value)
for attr, value
in sorted(attrs.items()))
else:
attr_str = ''
if content:
return '\n'.join('%s%s>' %
(name, attr_str, c, name) for c in content)
else:
return '' % (name, attr_str)
tag 函数的调用方式很多,如示例 5-11 所示。
示例 5-11 tag 函数(见示例 5-10)众多调用方式中的几种
>>> tag('br') ➊
'
'
>>> tag('p', 'hello') ➋
'
hello
'>>> print(tag('p', 'hello', 'world'))
hello
world
>>> tag('p', 'hello', id=33) ➌
'
hello
'>>> print(tag('p', 'hello', 'world', cls='sidebar')) ➍
>>> tag(content='testing', name="img") ➎
''
>>> my_tag = {'name': 'img', 'title': 'Sunset Boulevard',
... 'src': 'sunset.jpg', 'cls': 'framed'}
>>> tag(**my_tag) ➏
''
❶ 传入单个定位参数,生成一个指定名称的空标签。
❷ 第一个参数后面的任意个参数会被 *content 捕获,存入一个元组。
❸ tag 函数签名中没有明确指定名称的关键字参数会被 **attrs 捕获,存入一个字典。
❹ cls 参数只能作为关键字参数传入。
❺ 调用 tag 函数时,即便第一个定位参数也能作为关键字参数传入。
❻ 在 my_tag 前面加上 **,字典中的所有元素作为单个参数传入,同名键会绑定到对应的具名参数上,余下的则被 **attrs 捕获。
仅限关键字参数是 Python 3 新增的特性。在示例 5-10 中,cls 参数只能通过关键字参数指定,它一定不会捕获未命名的定位参数。定义函数时若想指定仅限关键字参数,要把它们放到前面有 * 的参数后面。如果不想支持数量不定的定位参数,但是想支持仅限关键字参数,在签名中放一个 *,如下所示:
>>> def f(a, *, b):
... return a, b
...
>>> f(1, b=2)
(1, 2)
注意,仅限关键字参数不一定要有默认值,可以像上例中 b 那样,强制必须传入实参。