Python - 函数注解

函数注解

Python 的函数注解功能使您能够添加有关在函数定义中声明的参数以及返回值类型的其他解释性元数据。 Python 解释器在执行函数时不会考虑它们。它们主要用于 Python IDE，以便为程序员提供详细的文档。

尽管您可以使用 Python 的文档字符串功能来记录函数，但如果对函数的原型进行了某些更改，它可能会过时。因此，注解功能是在 PEP 3107 的结果下引入 Python 的。

注解是添加到参数或返回值类型中的任何有效的 Python 表达式。注解的最简单示例是规定参数的数据类型。注解是在参数前面放置一个冒号后作为表达式提到的。

示例

请记住，Python 是一种动态类型语言，并且在运行时不强制执行任何类型检查。因此，使用数据类型对参数进行注解在调用函数时没有任何效果。即使给出了非整数参数，Python 也不会检测到任何错误。

def myfunction(a: int, b: int):
   c = a+b
   return c
   
print (myfunction(10,20))
print (myfunction("Hello ", "Python"))

它将产生以下输出 -

30
Hello Python

带返回值的函数注解

注解在运行时会被忽略，但对 IDE 和静态类型检查器库（如 mypy）很有用。

您也可以为返回值类型提供注解。在括号之后和冒号符号之前，放置一个箭头（->），后跟注解。

示例

在此示例中，我们为返回值类型提供了注解。

def myfunction(a: int, b: int) -> int:
   c = a+b
   return c
print(myfunction(56,88))
print(myfunction.__annotations__)

这将生成以下输出 -

144
{'a': <class 'int'>, 'b': <class 'int'>, 'return': <class 'int'>}

带表达式的函数注解

由于在运行时会忽略使用数据类型作为注解，因此您可以放置任何用作参数元数据的表达式。因此，函数可以具有任何任意表达式作为注解。

示例

在下面的示例中，我们使用表达式作为函数注解。

def total(x : 'marks in Physics', y: 'marks in chemistry'):
   return x+y
print(total(86, 88))
print(total.__annotations__)

以下是输出 -

174
{'x': 'marks in Physics', 'y': 'marks in chemistry'}

带默认参数的函数注解

如果要同时指定默认参数和注解，需要将它放在注解表达式之后。默认参数必须位于参数列表中必需参数之后。

示例 1

以下示例演示了如何为函数的默认参数提供注解。

def myfunction(a: "physics", b:"Maths" = 20) -> int:
   c = a+b
   return c
print (myfunction(10))

Python 中的函数也是一个对象，并且它的一个属性是 __annotations__。您可以使用 dir() 函数进行检查。

print (dir(myfunction))

这将打印 myfunction 对象的列表，其中包含 __annotations__ 作为其中一个属性。

['__annotations__', '__builtins__', '__call__', '__class__', '__closure__', '__code__', '__defaults__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__get__', '__getattribute__', '__getstate__', '__globals__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__kwdefaults__', '__le__', '__lt__', '__module__', '__name__', '__ne__', '__new__', '__qualname__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__']

示例 2

__annotations__ 属性本身是一个字典，其中参数是键，注解是其值。

def myfunction(a: "physics", b:"Maths" = 20) -> int:
   c = a+b
   return c
print (myfunction.__annotations__)

它将产生以下输出 -

{'a': 'physics', 'b': 'Maths', 'return': <class 'int'>}

示例 3

函数可以具有任意位置和/或任意关键字参数。也可以为它们提供注解。

def myfunction(*args: "arbitrary args", **kwargs: "arbitrary keyword args") -> int:
   pass
print (myfunction.__annotations__)

它将产生以下输出 -

{'args': 'arbitrary args', 'kwargs': 'arbitrary keyword args', 'return': <class 'int'>}

示例 4

如果您需要为函数参数提供多个注解表达式，请以字典对象的形式将其放在参数本身之前。

def division(num: dict(type=float, msg='numerator'), den: dict(type=float, msg='denominator')) -> float:
   return num/den
print (division.__annotations__)

它将产生以下输出 -

{'num': {'type': <class 'float'>, 'msg': 'numerator'}, 'den': {'type': <class 'float'>, 'msg': 'denominator'}, 'return': <class 'float'>}

打印页面