Python 函数默认参数：全面指南，助你提升代码灵活度

2024-03-03 16:47:52

Python 函数默认参数：全面指南

在 Python 中，函数默认参数是提升代码灵活性和可读性的强大工具。它们允许您在函数调用时省略参数，并提供预定义的值。本文将深入探讨使用默认参数的两种方法，位置参数和参数，以及它们的实际应用。

默认参数的类型

位置参数

位置参数是指在函数定义中从左到右按顺序出现的参数。为它们设置默认值时，您需要在参数类型标注后面加上一个等号（=）后跟默认值。例如：

def my_function(name: str, age: int = 18) -> None:
    print(f"Hello, {name}! You are {age} years old.")

在这个示例中，name 参数的类型标注是 str，而 age 参数的类型标注是 int，默认值为 18。

关键字参数

关键字参数在函数调用时通过参数名和值对明确指定。在函数定义中，您需要在参数类型标注后面加上一个冒号（:），后跟参数名和默认值。星号（*）表示该参数是一个关键字参数。例如：

def my_function(name: str, *, age: int = 18) -> None:
    print(f"Hello, {name}! You are {age} years old.")

关键字参数与位置参数的主要区别在于，在函数调用时，您可以按任意顺序传递关键字参数，而位置参数则必须按照函数定义中的顺序传递。

使用 `typing.Optional`

除了使用默认值之外，您还可以使用 typing.Optional 类来表示参数可以为 None。这在处理可空值时非常有用。例如：

from typing import Optional

def my_function(name: str, age: Optional[int] = None) -> None:
    if age is None:
        print(f"Hello, {name}!")
    else:
        print(f"Hello, {name}! You are {age} years old.")

最佳实践

避免使用 None 作为默认值，因为它可能表示不同的含义。
使用明确的值作为默认值，例如空列表或空字典。
仅在必要时使用默认参数。
在文档中清楚地记录默认参数的使用。

示例：计算平均值

以下示例展示了如何使用默认参数计算数字列表的平均值：

def calculate_average(numbers: list[int], *, skip_zeroes: bool = False) -> float:
    """Calculates the average of a list of numbers.

    Args:
        numbers: The list of numbers to average.
        skip_zeroes: If True, zeroes will be skipped when calculating the average.

    Returns:
        The average of the numbers.
    """

    if not numbers:
        return 0.0

    if skip_zeroes:
        numbers = [number for number in numbers if number != 0]

    return sum(numbers) / len(numbers)