Python中设置方法参数默认值为类实例变量的正确实现方式

尝试编写如下代码，希望实现类方法参数默认取当前实例的x属性：

class Example:

    def __init__(self, x):
        self.x = x

    def function(self, y=self.x):
        pass

Example(72)

运行后直接抛出如下错误：

Traceback (most recent call last):
  File "/home/millertime/Desktop/example.py", line 1, in <module>
    class Example:
  File "/home/millertime/Desktop/example.py", line 7, in Example
    def function(self, y=self.x):
NameError: name 'self' is not defined

即便把参数默认值改成y=x也会触发同类NameError，核心疑问是：是否存在合规写法，能直接在方法参数列表中引用实例属性作为参数默认值，实现预期逻辑。

不存在可直接在方法参数列表中引用实例属性作为参数默认值的合规语法。
出现这个报错的根本原因是Python的函数默认参数求值规则：

• 函数（包括类中定义的方法）的默认参数，是在函数定义执行的阶段就完成求值、绑定固定值的，不是每次调用函数时动态计算
• 类体内的方法定义，是和类整体定义同步执行的：执行到def function这行时，类本身还没完成创建，更不存在代表类实例的self变量——self是方法被实例调用时，才会自动传入的第一个参数，定义阶段完全不存在这个标识符，自然会触发名称错误。

要实现「参数未传值时默认取实例属性」的逻辑，行业通用的标准写法是在方法内部通过哨兵值判断完成默认值赋值，这也是Python官方推荐的实现方式：

通用场景（参数不需要接收None作为有效值） #

用内置单例None作为哨兵值即可，实现简单可读性高：

class Example:
    def __init__(self, x):
        self.x = x

    def function(self, y=None):
        # 未传y时，默认取实例的x属性
        if y is None:
            y = self.x
        # 后续业务逻辑
        pass

注意判断时必须用is None而不是not y，避免把用户主动传入的0、False、空字符串、空列表等假值误判为未传参。

特殊场景（参数需要支持传入None作为有效值） #

可以自定义一个全局唯一的哨兵对象，避免和所有合法入参冲突：

# 自定义专属哨兵，外部不会拿到这个对象的引用
_DEFAULT_SENTINEL = object()

class Example:
    def __init__(self, x):
        self.x = x

    def function(self, y=_DEFAULT_SENTINEL):
        if y is _DEFAULT_SENTINEL:
            y = self.x
        # 后续业务逻辑，此时用户主动传None也会被正常识别
        pass

内容的提问来源于stack exchange，提问作者MillerTime