->在Python函数定义中是什么意思？

python annotations python-3.x function-definition

2022-09-05 01:19:28

我最近在查看Python 3.3语法规范时注意到一些有趣的事情：

funcdef: 'def' NAME parameters ['->' test] ':' suite

可选的“箭头”块在Python 2中不存在，我在Python 3中找不到有关其含义的任何信息。事实证明，这是正确的Python，它被解释器所接受：

def f(x) -> 123:
    return x

我认为这可能是某种前提条件语法，但是：

我无法在这里进行测试，因为它仍未定义，x
无论我在箭头后面放什么（例如），它都不会影响函数行为。2 < 1

任何熟悉这种语法风格的人都可以解释一下吗？

答案 1

这是一个函数注释。

更详细地说，Python 2.x具有文档字符串，允许您将元数据字符串附加到各种类型的对象。这非常方便，因此Python 3通过允许您将元数据附加到描述其参数和返回值的函数来扩展该功能。

没有先入为主的用例，但PEP建议了几个。一个非常方便的方法是允许您使用其预期类型来注释参数;然后，很容易编写一个装饰器来验证注释或将参数强制为正确的类型。另一种方法是允许特定于参数的文档，而不是将其编码到文档字符串中。

答案 2

这些是 PEP 3107 中介绍的功能注释。具体来说，标记返回函数注释。->

例子：

def kinetic_energy(m:'in KG', v:'in M/S')->'Joules': 
    return 1/2*m*v**2
 
>>> kinetic_energy.__annotations__
{'return': 'Joules', 'v': 'in M/S', 'm': 'in KG'}

批注是字典，因此您可以执行以下操作：

>>> '{:,} {}'.format(kinetic_energy(12,30),
      kinetic_energy.__annotations__['return'])
'5,400.0 Joules'

您还可以拥有python数据结构，而不仅仅是字符串：

rd={'type':float,'units':'Joules',
    'docstring':'Given mass and velocity returns kinetic energy in Joules'}
def f()->rd:
    pass

>>> f.__annotations__['return']['type']
<class 'float'>
>>> f.__annotations__['return']['units']
'Joules'
>>> f.__annotations__['return']['docstring']
'Given mass and velocity returns kinetic energy in Joules'

或者，您可以使用函数属性来验证调用的值：

def validate(func, locals):
    for var, test in func.__annotations__.items():
        value = locals[var]
        try: 
            pr=test.__name__+': '+test.__docstring__
        except AttributeError:
            pr=test.__name__   
        msg = '{}=={}; Test: {}'.format(var, value, pr)
        assert test(value), msg

def between(lo, hi):
    def _between(x):
            return lo <= x <= hi
    _between.__docstring__='must be between {} and {}'.format(lo,hi)       
    return _between

def f(x: between(3,10), y:lambda _y: isinstance(_y,int)):
    validate(f, locals())
    print(x,y)

指纹

>>> f(2,2) 
AssertionError: x==2; Test: _between: must be between 3 and 10
>>> f(3,2.1)
AssertionError: y==2.1; Test: <lambda>