787

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

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

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

def f(x) -> 123:
    return x

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

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

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

4

10 回答 10

602

这是一个函数注释。

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

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

于 2013-01-17T13:04:57.427 回答
476

这些是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>
于 2013-02-25T17:46:19.943 回答
234

在以下代码中：

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/

于 2019-05-06T09:34:03.177 回答
120

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

PEP 3107 - 函数注释描述了规范，定义了语法更改，func.__annotations__它们存储在其中的存在，以及它的用例仍然开放的事实。

但是在 Python3.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 本身不会以任何方式使用注释，它几乎会填充并忽略它们。由 3rd 方库与他们合作。

于 2016-12-16T23:19:19.327 回答
11

这意味着函数返回的结果类型，但它可以是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.
于 2019-12-13T16:09:01.663 回答
9 
def f(x) -> 123:
    return x

我的总结：

  1. 简单->介绍是为了让开发人员有选择地指定函数的返回类型。请参阅Python 增强提案 3107

  2. 这表明随着 Python 被广泛采用，未来事情会如何发展——表明强类型化——这是我个人的观察。

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

  4. 您可以将表达式作为返回类型（在函数和参数级别），并且可以通过注释对象的“返回”属性访问表达式的结果。对于 lambda 内联函数的表达式/返回值，注释将为空。

于 2020-05-30T22:53:59.743 回答
8

def function(arg)->123:

它只是一个返回类型，在这种情况下，整数与你写的数字无关。

像Java：

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

但是对于 Python（Jim Fasarakis Hilliard怎么说） 返回类型只是一个提示，所以它建议返回，但无论如何都允许返回其他类型，如字符串..

于 2019-04-06T16:39:29.073 回答
6

->在python3中引入。

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

于 2021-06-10T05:08:07.283 回答
4 
def f(x) -> str:
return x+4

print(f(45))

将给出结果：49。

或者换句话说 '-> str' 对返回类型没有影响：

print(f(45).__class__)

<class 'int'>
于 2020-11-12T21:43:05.210 回答
0

它只是告诉用户它期望什么或返回值

funcname.__annotations__将打印详细信息

像

def function(name:str ,age:int) -> "printing the personal details ":
    print(f"name is {name} age is {age}")

function("test",20)
print(function.__annotations__)

输出

name is test age is 20
{'name': <class 'str'>, 'age': <class 'int'>, 'return': 'printing the personal details '}

即使您返回值，它也不会显示任何内容。

于 2021-12-13T10:44:58.930 回答