【python3】函数注解
Python 函数注解 (Function Annotations)
函数注解是 Python 的一种特性，用于为函数的参数和返回值添加 元数据。注解通常和类型提示（type hinting）相关联，但它们本质上不会影响程序的实际执行，只是作为一种信息记录。
从Python 3.0开始，函数注解就成为了语言的一部分。在Python 3.5中，加入了类型提示（PEP 484），使得函数注解的使用变得更加规范化和流行。
函数注解的基本语法
函数注解的基本形式是使用冒号 : 来为函数的参数指定类型信息，使用 -> 来为函数的返回值指定类型信息。
基本语法格式
def function_name(param_name: annotation, ...) -> return_annotation:
# 函数体
pass
- 参数注解：使用
param_name: annotation的形式为参数进行注解。 - 返回值注解：使用
-> return_annotation的形式为返回值进行注解。 - 注解通常在函数定义中作为可选的元数据存在，不会对实际的代码逻辑产生影响。
示例
def greet(name: str) -> str:
return f"Hello, {name}"
def add(x: int, y: int) -> int:
return x + y
def process_data(data: list[int]) -> dict[str, int]:
# 假设这个函数对输入的数据进行处理并返回一个字典
result = {str(index): value for index, value in enumerate(data)}
return result
-
greet函数：- 参数
name注解为str，表示这个参数应该是一个字符串。 - 返回值注解为
str，表示该函数返回一个字符串。
- 参数
-
add函数：- 参数
x和y注解为int，表示它们应该是整数。 - 返回值注解为
int，表示返回的结果是一个整数。
- 参数
-
process_data函数：- 参数
data注解为list[int]，表示它是一个包含整数的列表。 - 返回值注解为
dict[str, int]，表示它返回一个键为字符串、值为整数的字典。
- 参数
特殊类型注解
Python通过 typing 模块提供了一些用于类型注解的工具，以帮助描述更加复杂的数据结构。这些注解工具使得我们可以对更加复杂的类型关系进行描述，例如列表、字典、元组、联合类型等。
以下是一些常见的 typing 模块的类型：
List：用来注解列表，例如List[int]表示一个包含整数的列表。Dict：用来注解字典，例如Dict[str, int]表示键是字符串、值是整数的字典。Tuple：用来注解元组，例如Tuple[int, str]表示包含一个整数和一个字符串的元组。Optional：用来注解可选值，即参数可能为指定类型或None，例如Optional[str]。Union：用来注解参数可以是多种类型之一，例如Union[int, str]表示参数可以是整数或字符串。
例如：
from typing import List, Dict, Tuple, Optional, Union
def get_user_data(user_id: int) -> Optional[Dict[str, Union[str, int]]]:
if user_id == 1:
return {"name": "Alice", "age": 30}
else:
return None
def get_coordinates() -> Tuple[float, float]:
return (37.7749, -122.4194)
get_user_data函数返回一个Optional的字典，这个字典的键是字符串，值是字符串或整数，或者它可能返回None。get_coordinates函数返回一个元组，包含两个浮点数。
注解信息的存储与访问
函数注解信息存储在函数对象的 __annotations__ 属性中。你可以通过访问这个属性来查看注解信息。
例如：
def multiply(a: int, b: int) -> int:
return a * b
print(multiply.__annotations__)
输出：
{'a': <class 'int'>, 'b': <class 'int'>, 'return': <class 'int'>}
这里的输出表明 multiply 函数的参数 a 和 b 以及返回值都有类型注解为 int。
函数注解的实际用途
-
代码文档化：
注解可以使代码更加自文档化，程序员可以一目了然地了解函数期望的输入类型和输出类型，而不必阅读完整的函数实现。 -
静态类型检查：
使用工具如mypy，可以通过静态类型检查来发现一些潜在的类型错误。例如，mypy可以在开发阶段验证函数的使用是否遵循注解要求，有助于提高代码质量。 -
IDE支持：
现代化的集成开发环境（如 PyCharm, VSCode）可以基于注解提供更好的自动补全、类型推断和错误提示，使得开发者在编写代码时更容易避免错误。
注意事项
-
类型注解并不是强制性的：Python 的注解只是对数据类型的提示，并不强制类型检查，因此即使参数类型与注解不符，Python 也不会报错。
-
避免复杂的注解：有时，过于复杂的类型注解会使得代码难以阅读。此时可以使用
Any来简化类型注解。 -
结合类型检查工具：为了最大化函数注解的效用，可以结合工具如
mypy进行静态检查。这些工具可以帮助你在代码运行前发现类型不匹配的错误。
小结
- 函数注解 是一种为函数的参数和返回值提供元数据的机制。
- 注解可以显著提升代码的可读性和可维护性。
- 函数注解的语法使用冒号
:和箭头->来分别注解参数和返回值类型。 - Python 内置的
typing模块可以用来表示更复杂的数据结构。 - 注解只提供信息，并不会改变Python的运行机制。
原文地址：https://blog.csdn.net/2404_87410060/article/details/143084231
免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！