什么 - >意味着在Python函数定义?

时间:2013-01-17 13:03:36

标签: python python-3.x annotations function-definition

在查看Python 3.3 grammar specification时,我最近发现了一些有趣的事情:

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

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

def f(x) -> 123:
    return x

我认为这可能是某种先决条件语法,但是:

  • 我无法在这里测试x,因为它仍未定义,
  • 无论我在箭头后面放置什么(例如2 < 1),它都不会影响功能行为。

任何习惯这种语法的人都可以解释一下吗?

9 个答案:

答案 0 :(得分:244)

这是function annotation

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

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

答案 1 :(得分:162)

这些是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(20,3000),
      kinetic_energy.__annotations__['return'])
'90,000,000.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>

答案 2 :(得分:54)

正如其他答案所述,->符号用作功能注释的一部分。但是,在更新版本的Python >= 3.5中,它具有定义的含义。

PEP 3107 -- Function Annotations描述了规范,定义了语法更改,存储它们的func.__annotations__的存在,以及它的用例仍然是开放的。

在Python 3.5中,PEP 484 -- Type Hints附加了一个含义:->用于指示函数返回的类型。在What about existing uses of annotations

中描述的未来版本中似乎也会强制执行此操作
  

最快的可想到的方案将引入静态弃用3.6中的非类型提示注释,3.7中的完全弃用,以及声明类型提示作为Python 3.8中唯一允许使用的注释。

(强调我的)

就我所知,3.6实际上并未实现这一点,因此它可能会受到未来版本的影响。

根据这个,您提供的示例:

def f(x) -> 123:
    return x

将来会被禁止(并且在当前版本中会令人困惑),它需要更改为:

def f(x) -> int:
    return x

有效地描述函数f返回int类型的对象。

Python本身并没有以任何方式使用注释,它几乎填充并忽略它们。这取决于第三方图书馆与他们合作。

答案 3 :(得分:3)

def f(x) -> 123:
    return x

我的总结:

    引入
  1. 简单地->是为了使开发人员可以选择指定函数的返回类型。参见Python Enhancement Proposal 3107

  2. 这表明随着Python的广泛采用,事情将来会如何发展-指示强类型化-这是我个人的观察。

  3. 您还可以为参数指定类型。指定函数和参数的返回类型将有助于减少逻辑错误并改进代码增强功能。

  4. 您可以将表达式作为返回类型(对于函数和参数级别),并且可以通过 annotations 对象的'return'属性访问表达式的结果。对于lambda内联函数,注释将为空。

答案 4 :(得分:3)

-> 是在python3中引入的。

简单来说,->后面的内容表示函数的返回类型。 返回类型是可选的。

答案 5 :(得分:2)

Python忽略它。在以下代码中:

def f(x) -> int:
    return int(x)

-> int仅告诉f()返回一个整数。它称为返回注释,可以作为f.__annotations__['return']访问。

Python还支持参数注释:

def f(x: float) -> int:
    return int(x)

: float告诉阅读该程序(和某些第三方库/程序,例如pylint)的人x应该是float。它以f.__annotations__['x']的形式访问,它本身没有任何意义。有关更多信息,请参见文档:

https://docs.python.org/3/reference/compound_stmts.html#function-definitions https://www.python.org/dev/peps/pep-3107/

答案 6 :(得分:0)

def function(arg)->123:

这只是一个返回类型,在这种情况下,整数与您写的哪个数字都没有关系。

喜欢 Java

public int function(int args){...}

但是对于Python(Jim Fasarakis Hilliard来说)返回类型只是一个提示,因此建议返回,但无论如何都可以返回其他类型,例如字符串。

答案 7 :(得分:0)

这意味着函数返回的结果类型,但是可以是None

它在面向Python 3.x的现代库中很普遍。

例如,在许多地方,库 pandas-profiling 中都有代码,例如:

def get_description(self) -> dict:

def get_rejected_variables(self, threshold: float = 0.9) -> list:

def to_file(self, output_file: Path or str, silent: bool = True) -> None:
"""Write the report to a file.

答案 8 :(得分:0)

def f(x) -> str:
return x+4

print(f(45))

# will give the result : 
49

# or with other words '-> str' has NO effect to return type:

print(f(45).__class__)

<class 'int'>