Python 教程 / 位置参数、关键字参数与默认值

Python 函数可按位置或关键字接收实参,并用默认值提供可选参数。如果每次调用都应获得新的状态,就不要把列表等可变对象直接作为默认值;默认表达式在函数定义执行时求值,而不是每次调用时重新创建。

让实参与参数的对应关系清楚可见

位置实参按顺序对应形参,关键字实参则按名称对应。多个可选项的含义容易混淆时,用名称传递可以让调用代码更容易读。函数基础见定义函数与返回结果。

同一形参不能同时从位置和关键字获得两个值;普通位置实参也不能写在关键字实参之后。前者通常在调用时产生 TypeError,后者是调用语法不合法,会产生 SyntaxError。不要只看提供的值是否“够多”,还要看它们绑定到哪个参数。

参数列表中的单独 *之后是仅限关键字的参数。下面的 currency 有默认值 KRW,可以省略,但需要修改时必须写 currency=...,不能当作第三个普通位置实参。相关规则见Python 官方默认值与关键字参数说明。

运行关键字参数与新列表默认值

在独立练习目录,将以下完整代码保存为 UTF-8 文件 arguments.py,在项目环境执行 python arguments.py。macOS、Ubuntu 若使用 python3,使用已核对的解释器命令。无需安装第三方包。

def format_expense(name, amount, *, currency="KRW"):
    return f"{name}: {amount:,} {currency}"

def append_name(name, names=None):
    if names is None:
        names = []
    names.append(name)
    return names

print(format_expense("lunch", 8000))
print(format_expense(amount=9000, name="dinner", currency="KRW"))
print(append_name("A"))
print(append_name("B"))

预期输出:

lunch: 8,000 KRW
dinner: 9,000 KRW
['A']
['B']

第一次格式化调用使用两个位置实参和默认货币代码;第二次按名称提供 amount、name 和 currency,所以前两个参数也可以换顺序书写。格式化只输出已有金额与单位文字,不执行汇率换算。

append_name()收到 None 时,在本次函数调用内部创建新列表。两次省略 names 的调用各自得到独立列表,因此第二次只显示 B,不会留下 A。函数同时支持调用者明确传入列表,这种情况下会修改那份列表。

比较定义时创建与调用时创建

把 names=[]放进参数默认值,列表会在 def 执行时创建,以后省略该参数的调用继续复用它。用下面独立程序比较,不要把“函数调用结束”理解为默认对象也一定被销毁。

将完整内容保存为 defaults.py,在同一练习目录执行 python defaults.py:

def shared(name, names=[]):
    names.append(name)
    return names
def fresh(name, names=None):
    if names is None:
        names = []
    names.append(name)
    return names
print(shared("A"))
print(shared("B"))
print(fresh("A"))
print(fresh("B"))

预期输出:

['A']
['A', 'B']
['A']
['B']

shared 的第二次调用保留了 A,再追加 B;fresh 在每次未提供列表时创建新对象。None 在这里表示“没有提供列表”,不是一个会被自动转换为空列表的特殊语言规则,实际创建来自函数体中的 if。

应检查 if names is None,而不是 if not names。调用者传来的空列表也是一个有效对象;用 not 检查会把它替换成另一份列表,原调用者就看不到预期的追加结果。

验证调用接口与共享对象约定

  1. 尝试 format_expense("lunch", 8000, "KRW"),检查仅限关键字的 currency 不能按第三个位置传入;改为 currency="KRW"后再确认正常。
  2. 在函数定义后的调用区创建 names = [],执行 result = append_name("A", names)。此后 names 应为 ["A"],且 result 引用的正是同一列表。
  3. 把 None 判断临时改为 if not names再测试传入空列表,比较调用者的列表是否没有被修改。之后恢复 is None。
  4. 恢复两份完整程序,分别重新运行,核对上面的两组输出。

“不复用可变默认值”和“不修改显式传入对象”是两项不同约定。这个 append_name 函数刻意修改调用者传来的列表;如果接口要求保留原列表,就需要另行复制并说明复制层级,参见列表复制与共享引用。

当前日期、当前时间等计算表达式用作默认值时,也可能保留定义时的结果。需要每次获取新值时,可以用 None 作缺省标记,再在函数体中计算。如果 None 本身必须是一个有意义、允许传入的值,则要选择其他明确的缺省标记,不能让“未提供”和“明确提供 None”无法区分。