Python如何定义有默认参数的函数

Python默认参数基础

问题

在开发过程中，经常需要创建函数或方法，其中部分参数允许用户省略，并自动赋予一个预设值。

解决方案

实现带有可选参数的函数非常直观，只需在定义函数时直接为参数指定默认值，并确保该参数位于参数列表的末尾即可。例如：

def spam(a, b=42):
  print(a, b)

spam(1) # Ok. a=1, b=42
spam(1, 2) # Ok. a=1, b=2

当默认参数涉及可变容器（如列表、集合或字典）时，直接赋值可能导致意外行为。推荐的做法是使用None作为默认值，并在函数内部进行初始化，示例如下：

# Using a list as a default value
def spam(a, b=None):
  if b is None:
    b = []
  ...

若目标并非提供默认值，而是需要区分“用户未传递参数”与“用户显式传递None”这两种情况，可采用如下写法：

_no_value = object()

def spam(a, b=_no_value):
  if b is _no_value:
    print('No b value supplied')
  ...

对该函数进行实际测试：

>>> spam(1)
No b value supplied
>>> spam(1, 2) # b = 2
>>> spam(1, None) # b = None
>>>

通过观察输出结果，可以清晰看到传递None值与完全不传参在行为上存在显著差异。

默认参数深层机制与陷阱

讨论

虽然定义带默认值的函数看似简单，但其中隐藏着一些关键细节值得深入探讨。

首先，默认参数的值仅在函数定义阶段被评估和赋值一次。请运行以下示例进行验证：

>>> x = 42
>>> def spam(a, b=x):
...   print(a, b)
...
>>> spam(1)
1 42
>>> x = 23 # Has no effect
>>> spam(1)
1 42
>>>

可以看到，即使后续修改变量x的值，也不会影响函数spam的默认参数值。这是因为默认值在函数定义时就已经固定了。

其次，默认参数的值应当是不可变对象，例如None、True、False、数字或字符串。特别需要注意的是，应避免以下写法：

def spam(a, b=[]): # NO!
  ...

如果采用上述方式，当默认值在其他地方被修改后，后续调用该函数时将遇到难以排查的问题，因为默认值会被意外改变。例如：

>>> def spam(a, b=[]):
...   print(b)
...   return b
...
>>> x = spam(1)
>>> x
[]
>>> x.append(99)
>>> x.append('Yow!')
>>> x
[99, 'Yow!']
>>> spam(1) # Modified list gets returned!
[99, 'Yow!']
>>>

这种结果通常不符合预期。为了避免此类问题，最佳实践是将默认值设为None，并在函数内部进行检查和初始化，前文的示例正是采用了这一策略。

在测试None值时，使用is操作符至关重要，这也是该方案的核心。然而，有时开发者会犯以下错误：

def spam(a, b=None):
  if not b: # NO! Use 'b is None' instead
    b = []
  ...

这种写法的问题在于，虽然None在布尔上下文中被视为False，但其他对象（如长度为0的字符串、列表、元组、字典等）同样会被视为False。因此，上述代码可能会错误地将这些合法输入视为未提供参数。例如：

>>> spam(1) # OK
>>> x = []
>>> spam(1, x) # Silent error. x value overwritten by default
>>> spam(1, 0) # Silent error. 0 ignored
>>> spam(1, '') # Silent error. '' ignored
>>>

检测参数是否显式传递的高级技巧

最后一个问题较为微妙，即当函数需要判断某个可选参数是否由用户显式传递时。此时，不能使用None、0或False等作为默认值来测试用户提供的值，因为这些值本身可能是合法的输入。因此，需要采用其他解决方案。

为解决此问题，可以创建一个独一无二的私有对象实例，如前文示例中的_no_value变量。在函数内部，通过检查传递的参数值是否与该实例相同来判断。其核心思路是：用户不可能主动传递这个_no_value实例作为输入，因此通过检查该值即可确定参数是否被传递。

此处使用object()看似不常见。object是Python中所有类的基类。你可以创建object类的实例，但这些实例没有实际用途，因为它没有任何有用的方法，也没有任何实例数据（没有实例字典，甚至无法设置任何属性值）。你唯一能做的就是测试同一性。这恰好符合我的需求，因为在函数中我只需要一个同一性测试。

以上就是Python如何定义有默认参数的函数的详细内容，更多关于Python定义有默认参数的函数的资料请关注本站其它相关文章！