Python 特殊属性 __defaults__ 参数默认值

在 Python 中，__defaults__ 是一个函数对象的特殊属性，用于获取函数的默认参数值。这个属性是一个元组，包含了函数定义中的所有默认参数的值。

示例

举个例子：

def my_function(x, y=10, z=20):
    pass

print(my_function.__defaults__)  # 输出 (10, 20)

在这个例子中，my_function 函数的 __defaults__ 属性是一个包含默认参数值 (10, 20) 的元组，表示默认参数 y 和 z 的默认值分别是 10 和 20。

__defaults__ 属性主要用于元编程和内省，例如在某些情况下需要动态检查函数的默认参数值，或者根据默认参数值执行一些特定的操作。不过需要注意的是，__defaults__ 属性仅适用于普通函数，对于类方法、静态方法或者类本身而言，其行为可能会不同。

用途

__defaults__ 属性主要用于元编程和内省，以及在某些特定的情况下获取函数的默认参数值。下面列举了一些常见的用途：

动态检查默认参数值

通过访问函数的 __defaults__ 属性，我们可以动态地获取函数的默认参数值。这在需要了解函数默认参数设置时非常有用，例如在调试或者测试过程中。

def my_function(x, y=10, z=20):
    pass

# 获取函数的默认参数值
defaults = my_function.__defaults__
print("Default parameters:", defaults)  # 输出 (10, 20)

区别

• __defaults__ - 位置参数或关键字参数的任何默认值的元组
• __kwdefaults__ - 仅关键字参数的任何默认值的映射

元编程

在元编程中，我们可能需要动态地获取函数的默认参数值，并据此执行一些特定的操作。通过访问函数的 __defaults__ 属性，我们可以实现对函数默认参数的分析、记录或者修改等操作。

def my_decorator(func):
    def wrapper(*args, **kwargs):
        defaults = func.__defaults__
        print("Default parameters:", defaults)
        return func(*args, **kwargs)
    return wrapper

@my_decorator
def example_function(x, y=10, z=20):
    pass

example_function(5)
# Default parameters: (10, 20)

参数自省

有时候我们需要分析函数的参数信息，包括默认参数值。通过访问函数的 __defaults__ 属性，我们可以获取并分析函数的默认参数值，以便进行进一步的参数分析或者其他操作。

def analyze_function(func):
    defaults = func.__defaults__
    print("Function defaults:", defaults)

def my_function(x, y=10, z=20):
    pass

# 分析函数的默认参数值
analyze_function(my_function)
# Function defaults: (10, 20)

动态生成函数调用

在某些情况下，我们可能需要动态地生成函数调用，并根据函数的默认参数值来调整调用方式。通过访问函数的 __defaults__ 属性，我们可以获取默认参数值，并据此生成函数调用，以便满足特定的需求。

def my_function(x, y=10, z=20):
    return x + y + z

# 获取函数的默认参数值
defaults = my_function.__defaults__

# 动态生成函数调用
result = my_function(5, *defaults)
print("Result:", result)  # 输出 35

__defaults__ 属性为开发者提供了一种方便的方式来获取函数的默认参数值，并在元编程、内省和动态调用等方面发挥作用。

参考

• https://docs.python.org/zh-cn/3/reference/datamodel.html#function.__defaults__

更新时间：2024-03-02 21:38:04 标签：python 特殊属性 默认值