python如何查看函数参数默认值

在Python中查看函数参数默认值的方法有多种，主要包括使用__defaults__属性、inspect模块、以及通过函数的签名进行查看。其中，使用__defaults__属性是最简单直接的方法，inspect模块则提供了更详细和灵活的功能。以下将详细描述这些方法，并提供示例代码。

一、使用`defaults`属性查看默认值

Python的函数对象有一个特殊的属性__defaults__，它是一个元组，包含了所有默认参数的值。如果一个函数有默认参数，可以通过该属性直接访问这些默认值。

def example_function(a, b=10, c=20):
    return a + b + c
查看默认参数的值
print(example_function.__defaults__)  # 输出: (10, 20)

在上面的例子中，example_function的__defaults__属性包含了默认参数b和c的值。需要注意的是，__defaults__只包含从第一个有默认值的参数开始到最后一个参数的所有默认值。因此，如果函数有多个参数且只有部分参数有默认值，__defaults__不会显示没有默认值的参数。

二、使用`inspect`模块查看默认值

inspect模块提供了更为强大的功能，可以获取函数的完整签名，包括参数的名称、默认值、参数类型注释等。使用inspect.signature方法可以获取一个函数的签名对象，然后通过该对象的parameters属性可以访问所有参数的信息。

import inspect
def example_function(a, b=10, c=20):
    return a + b + c
获取函数签名
signature = inspect.signature(example_function)
遍历函数参数
for param_name, param in signature.parameters.items():
    print(f'Parameter: {param_name}, Default: {param.default}')

上述代码将输出以下内容：

Parameter: a, Default: <class 'inspect._empty'>
Parameter: b, Default: 10
Parameter: c, Default: 20

在这个例子中，使用inspect.signature获取了函数的签名，并遍历了所有参数。参数的默认值可以通过param.default属性访问，inspect._empty表示该参数没有默认值。

三、通过函数签名查看默认值

除了上述两种方法，还可以通过手动解析函数签名的方式来查看参数的默认值。虽然这种方法不如前两种直接，但在某些情况下可能会更适合。

def example_function(a, b=10, c=20):
    return a + b + c
获取函数代码对象
code_object = example_function.__code__
获取所有参数的名称
param_names = code_object.co_varnames[:code_object.co_argcount]
获取默认参数的值
default_values = example_function.__defaults__
将参数名称与默认值匹配
param_defaults = dict(zip(param_names[-len(default_values):], default_values))
print(param_defaults)  # 输出: {'b': 10, 'c': 20}

在这个例子中，通过函数的__code__属性获取了参数的名称，并手动将参数名称与默认值进行了匹配。这种方法需要更多的代码，但可以提供更大的灵活性。

四、结合以上方法的实际应用

实际应用中，查看函数参数默认值的需求往往是为了调试或文档生成。以下是一个实际应用的例子，展示了如何结合上述方法获取函数参数的默认值，并生成一个简单的函数说明文档。

import inspect
def generate_function_doc(func):
    signature = inspect.signature(func)
    doc_lines = [f"Function: {func.__name__}", "Parameters:"]
    for param_name, param in signature.parameters.items():
        if param.default is inspect._empty:
            doc_lines.append(f"  - {param_name}: No default value")
        else:
            doc_lines.append(f"  - {param_name}: Default value = {param.default}")
    return "\n".join(doc_lines)
def example_function(a, b=10, c=20):
    return a + b + c
生成函数说明文档
function_doc = generate_function_doc(example_function)
print(function_doc)

上述代码将输出以下内容：

Function: example_function Parameters: - a: No default value - b: Default value = 10 - c: Default value = 20

这段代码展示了如何使用inspect模块生成一个简单的函数说明文档，包含参数的名称和默认值。这种方法可以用于自动化文档生成，帮助开发者更方便地了解函数的使用方式。

五、处理复杂函数签名

在实际开发中，函数的签名可能会非常复杂，包括关键字参数、可变位置参数（*args）、可变关键字参数（kwargs）等。以下示例展示了如何处理复杂函数签名，并提取所有参数的默认值。

import inspect
def complex_function(a, b=10, *args, d=20, kwargs):
    return a + b + d + sum(args) + sum(kwargs.values())
def generate_complex_function_doc(func):
    signature = inspect.signature(func)
    doc_lines = [f"Function: {func.__name__}", "Parameters:"]
    for param_name, param in signature.parameters.items():
        if param.default is inspect._empty:
            doc_lines.append(f"  - {param_name}: No default value")
        else:
            doc_lines.append(f"  - {param_name}: Default value = {param.default}")
    return "\n".join(doc_lines)
生成复杂函数的说明文档
complex_function_doc = generate_complex_function_doc(complex_function)
print(complex_function_doc)

上述代码将输出以下内容：

Function: complex_function Parameters: - a: No default value - b: Default value = 10 - args: No default value - d: Default value = 20 - kwargs: No default value

在这个例子中，complex_function包含了位置参数、关键字参数、可变位置参数和可变关键字参数。通过inspect.signature，可以轻松处理这些复杂的函数签名，并提取所有参数的默认值。

六、总结

在Python中查看函数参数默认值的方法主要包括使用__defaults__属性、inspect模块，以及通过手动解析函数签名。这些方法各有优劣，适用于不同的场景。使用__defaults__属性是最简单直接的方法，inspect模块则提供了更详细和灵活的功能。通过结合这些方法，可以方便地查看函数参数的默认值，并进行文档生成和调试。掌握这些技巧，对于提升代码的可读性和维护性具有重要意义。