Python - 函数注解：初学者指南

你好，有抱负的Python程序员们！今天，我们将深入探讨函数注解的奇妙世界。如果你是编程新手，也不用担心——我会一步一步地引导你理解这个概念，就像我在过去的教学岁月里对无数学生所做的那样。所以，拿起你最喜欢的饮料，舒服地坐好，让我们一起踏上这个Python冒险之旅！

Python - Function Annotations

函数注解是什么？

函数注解是Python中的一个特性，它允许我们为函数参数和返回值添加元数据。你可以把它们想象成我们附加到函数上的小笔记，以提供额外的信息。它们不会影响函数的工作方式，但它们对于文档和类型检查非常有帮助。

让我们从一个简单的例子开始：

def greet(name: str) -> str:
return f"你好, {name}！"

在这个例子中，name后面的: str是一个注解，表示name应该是一个字符串。结尾的-> str表示函数将返回一个字符串。

为什么使用函数注解？

它们使你的代码更具可读性。
它们帮助其他开发者（和未来的你！）更好地理解你的代码。
它们可以被类型检查工具用来捕捉潜在的错误。

现在，让我们深入探讨不同类型的注解！

带参数的函数注解

我们可以注解函数参数，以指示我们期望的数据类型。这里有一个例子：

def calculate_area(length: float, width: float) -> float:
return length * width

在这个函数中，我们表示length和width都应该是浮点数，而函数将返回一个浮点数。

让我们尝试使用它：

area = calculate_area(5.5, 3.2)
print(f"面积是：{area}")

输出：

面积是：17.6

请记住，这些注解并不强制类型——你仍然可以调用calculate_area("hello", "world")，但这并没有多大意义！

带返回类型的函数注解

我们已经看到了-> float用于返回类型的注解，但让我们看一个更复杂的例子：

def get_user_info(user_id: int) -> dict:
# 想象这个函数从数据库中获取用户数据
return {
"id": user_id,
"name": "Alice",
"age": 30,
"email": "[email protected]"
}

user = get_user_info(12345)
print(f"用户名：{user['name']}")

输出：

用户名：Alice

在这里，我们表示函数接受一个整数user_id并返回一个字典。

带表达式的函数注解

注解不仅仅是简单的类型——它们也可以是更复杂的表达式。这里有一个例子：

from typing import List, Union

def process_items(items: List[Union[int, str]]) -> List[str]:
return [str(item).upper() for item in items]

result = process_items([1, "hello", 42, "world"])
print(result)

输出：

['1', 'HELLO', '42', 'WORLD']

在这个例子中，List[Union[int, str]]意味着函数期望一个列表，其中每个项目可以是整数或字符串。

带默认参数的函数注解

我们可以将注解与默认参数结合使用。以下是方法：

def greet_user(name: str = "Guest") -> str:
return f"欢迎，{name}！"

print(greet_user())
print(greet_user("Alice"))

输出：

欢迎，Guest！
欢迎，Alice！

在这个函数中，我们表示name应该是一个字符串，如果没有提供名称，则默认为"Guest"。

把它们放在一起

现在，让我们看一个结合了各种注解技巧的更复杂的例子：

from typing import List, Dict, Union

def analyze_sales(data: List[Dict[str, Union[str, float]]]) -> Dict[str, float]:
total_sales = 0.0
items_sold = 0

for transaction in data:
total_sales += transaction['amount']
items_sold += 1

return {
"total_sales": total_sales,
"average_sale": total_sales / items_sold if items_sold > 0 else 0
}

sales_data = [
{"item": "小部件A", "amount": 10.99},
{"item": "小部件B", "amount": 5.99},
{"item": "小部件C", "amount": 15.99}
]

result = analyze_sales(sales_data)
print(f"总销售额：${result['total_sales']:.2f}")
print(f"平均销售额：${result['average_sale']:.2f}")

输出：

总销售额：$32.97
平均销售额：$10.99

这个例子展示了我们如何使用复杂的注解来描述我们的输入数据和返回值的结构。

函数注解方法总结

以下是不同函数注解方法的总结表：

方法	例子	描述
参数注解	`def func(x: int):`	建议参数的类型
返回类型注解	`def func() -> str:`	建议函数的返回类型
默认值与注解	`def func(x: int = 0):`	将类型建议与默认值结合
复杂类型注解	`def func(x: List[int]):`	使用`typing`模块中的类型以提供更具体的类型提示
多种类型（Union）	`def func(x: Union[int, str]):`	表示参数可以是几种类型之一

请记住，这些注解是提示，而不是严格的规则。Python不会阻止你使用不同的类型，但是像mypy这样的工具可以利用这些注解在运行代码之前捕捉到潜在的错误。

这就是了，我亲爱的学生们！我们已经穿越了Python函数注解的领域。我希望这个指南能够为你们照亮这个概念。记住，学习最好的方法是实践，所以不要犹豫，在你们自己的代码中尝试这些注解吧。祝编程愉快，愿你们的函数总是注解得当！

Credits: Image by storyset