@typing.overload 是 Python 中类型提示(type hinting)的一部分,用于指示函数或方法的不同重载版本。
- @typing.overload 的作用
@typing.overload 是 Python 标准库 typing 模块中的一个装饰器,用于定义函数的多个重载版本。它的主要作用是提供更详细的类型信息,帮助开发者理解函数在不同情况下的预期输入和输出类型,同时也能增强静态类型检查工具(如 mypy)的能力,以检测潜在的类型错误。
- 如何使用 @typing.overload
通常,@typing.overload 与实际的函数实现结合使用。具体实例如下:
import typing
@typing.overload
def greet(name: str) -> str:
...
@typing.overload
def greet(names: list[str]) -> list[str]:
...
def greet(name_or_names):
if isinstance(name_or_names, str):
return f"Hello, {name_or_names}!"
elif isinstance(name_or_names, list):
return [f"Hello, {name}!" for name in name_or_names]
else:
raise TypeError("Unsupported type")
# 使用示例
print(greet("Alice")) # 输出: Hello, Alice!
print(greet(["Bob", "Charlie"])) # 输出: ['Hello, Bob!', 'Hello, Charlie!']