函数注解：PEP-3107
我看到了一段展示Python3函数注释的代码片段。这个概念很简单，但我不知道为什么在Python3中会实现它们，也不知道有什么好的用途。也许SO能给我启示？
它是如何工作的：
def foo(a: 'x', b: 5 + 6, c: list) -> max(2, 9):
... function body ...
冒号后跟随参数的内容被称为“注释”，而在->后面的信息是函数返回值的注释。
foo.func_annotations会返回一个字典：
{'a': 'x',
'b': 11,
'c': list,
'return': 9}
有这个可用性的重要性是什么？
函数注释的意义在于你自己定义。
它们可以用于文档编写：
def kinetic_energy(mass: 'in kilograms', velocity: 'in meters per second'):
...
它们可以用于进行前置条件检查：
def validate(func, locals):
for var, test in func.__annotations__.items():
value = locals[var]
msg = 'Var: {0}\tValue: {1}\tTest: {2.__name__}'.format(var, value, test)
assert test(value), msg
def is_int(x):
return isinstance(x, int)
def between(lo, hi):
def _between(x):
return lo <= x <= hi
return _between
def f(x: between(3, 10), y: is_int):
validate(f, locals())
print(x, y)
>>> f(0, 31.1)
Traceback (most recent call last):
...
AssertionError: Var: y Value: 31.1 Test: is_int
另外请参阅http://www.python.org/dev/peps/pep-0362/，了解一种实现类型检查的方法。
Mass和Velocity。 - user1804599def kinetic_energy(mass: '以千克为单位', velocity: '以米/秒为单位') -> float:，同时也展示返回类型。这是我在这里的最爱答案。 - Tommy我认为这实际上是非常好的。
作为一个学术背景的人，我可以告诉您，注解已经证明了它们在使像Java这样的语言的智能静态分析器变得不可或缺。例如，您可以定义像状态限制、允许访问的线程、体系结构限制等语义，然后有相当多的工具可以读取这些并处理它们，提供比编译器更高的保证。甚至可以编写检查前置条件/后置条件的内容。
我觉得这样的东西在Python中特别需要，因为它的类型较弱，但实际上没有任何构造使其简单明了地成为官方语法的一部分。
注解除了保证外还有其他用途。我可以看到如何将我的基于Java的工具应用于Python。例如，我有一个工具，可以为方法指定特殊警告，并在调用它们时提示您应该阅读其文档（例如，想象一下您有一个不能用负值调用的方法，但从名称上不直观）。通过注释，我可以在Python中技术上编写类似的东西。同样，如果有官方语法，可以编写一个根据标记组织大类中方法的工具。
list(fib('a'))，Python 3.7会愉快地接受参数，并抱怨没有办法比较字符串和整数。 - Denis de Bernardy仅为了从我的答案中添加一个好的使用示例，加上装饰器可以实现一种简单的多方法机制。
# This is in the 'mm' module
registry = {}
import inspect
class MultiMethod(object):
def __init__(self, name):
self.name = name
self.typemap = {}
def __call__(self, *args):
types = tuple(arg.__class__ for arg in args) # a generator expression!
function = self.typemap.get(types)
if function is None:
raise TypeError("no match")
return function(*args)
def register(self, types, function):
if types in self.typemap:
raise TypeError("duplicate registration")
self.typemap[types] = function
def multimethod(function):
name = function.__name__
mm = registry.get(name)
if mm is None:
mm = registry[name] = MultiMethod(name)
spec = inspect.getfullargspec(function)
types = tuple(spec.annotations[x] for x in spec.args)
mm.register(types, function)
return mm
并提供一个使用示例：
from mm import multimethod
@multimethod
def foo(a: int):
return "an int"
@multimethod
def foo(a: int, b: str):
return "an int and a string"
if __name__ == '__main__':
print("foo(1,'a') = {}".format(foo(1,'a')))
print("foo(7) = {}".format(foo(7)))
可以通过向装饰器添加类型来实现此操作，就像Guido的原始发布中所示，但注释参数本身更好，因为它避免了错误匹配参数和类型的可能性。
注意：在Python中，您可以访问注释作为function.__annotations__而不是function.func_annotations，因为func_*样式已在Python 3中删除。
function = self.typemap.get(types) 将无法工作。在这种情况下，您可能需要使用 isinstance 循环遍历 typemap。我想知道 @overload 是否正确处理了这个问题。 - Tobias Kienzler__annotations__ 是一个 dict，它不能保证参数的顺序，因此这段代码有时会失败。我建议将 types = tuple(...) 更改为 spec = inspect.getfullargspec(function)，然后 types = tuple([spec.annotations[x] for x in spec.args])。 - xooliveUri已经给出了正确的答案，那么这里是一个不太严肃的回答：这样你可以让你的文档字符串更短。
我第一次看到注解时，想到“太好了！终于可以选择一些类型检查！”当然，我没有注意到注解实际上并没有被强制执行。
因此，我决定编写一个简单的函数装饰器来强制执行它们：
def ensure_annotations(f):
from functools import wraps
from inspect import getcallargs
@wraps(f)
def wrapper(*args, **kwargs):
for arg, val in getcallargs(f, *args, **kwargs).items():
if arg in f.__annotations__:
templ = f.__annotations__[arg]
msg = "Argument {arg} to {f} does not match annotation type {t}"
Check(val).is_a(templ).or_raise(EnsureError, msg.format(arg=arg, f=f, t=templ))
return_val = f(*args, **kwargs)
if 'return' in f.__annotations__:
templ = f.__annotations__['return']
msg = "Return value of {f} does not match annotation type {t}"
Check(return_val).is_a(templ).or_raise(EnsureError, msg.format(f=f, t=templ))
return return_val
return wrapper
@ensure_annotations
def f(x: int, y: float) -> float:
return x+y
print(f(1, y=2.2))
>>> 3.2
print(f(1, y=2))
>>> ensure.EnsureError: Argument y to <function f at 0x109b7c710> does not match annotation type <class 'float'>
Python 3.X（仅限）还将函数定义泛化，允许使用对象值注释参数和返回值用于扩展。
它的元数据解释了函数值，使其更加明确。
注释在参数名称后面并在默认值之前编码为：value，在参数列表后面编码为->value。
它们被收集到函数的__annotations__属性中，但在Python本身中不被视为特殊内容：
>>> def f(a:99, b:'spam'=None) -> float:
... print(a, b)
...
>>> f(88)
88 None
>>> f.__annotations__
{'a': 99, 'b': 'spam', 'return': <class 'float'>}
来源：Python口袋参考，第五版
例子：
typeannotations 模块提供了一组用于类型检查和类型推断的工具。它还提供了一组有用于注释函数和对象的类型。
这些工具主要设计用于静态分析器，例如 linters、代码自动补全库和 IDE。此外，还提供了用于运行时检查的装饰器。在 Python 中，并不总是适合进行运行时类型检查，但在某些情况下它非常有用。
https://github.com/ceronman/typeannotations
类型提示如何帮助编写更好的代码
使用类型提示可以帮助您进行静态代码分析以捕获类型错误，在将代码发送到生产环境之前避免一些明显的错误。有像 mypy 这样的工具，您可以将其作为软件生命周期的一部分添加到工具箱中。mypy 可以通过部分或全部地针对您的代码库运行来检查正确的类型。mypy 还可以帮助您检测诸如从函数返回值时检查 None 类型等错误。类型提示有助于使您的代码更清晰。您可以使用类型而无需付出任何性能成本，而不是使用注释来记录您的代码。
Clean Python: Elegant Coding in Python ISBN: ISBN-13 (pbk): 978-1-4842-4877-5
PEP 526 -- 变量注释的语法
查看PEP获取有关特定点的更多信息（以及它们的参考资料）
any_string # documentation
any_callable # typecast / callback, not called if defaulting
(any_callable, any_string) # combination
AnnotationClass() # package-specific rich annotation object
[AnnotationClass(), AnnotationClass(), …] # cooperative annotation
-O / PYTHONOPTIMIZE环境变量）运行时，可能昂贵（例如递归）的检查被省略，因为你已经在开发中正确测试了应用程序，所以在生产中不需要进行检查。虽然我还没有在3.6中看到任何静默降级，但这很可能会被推迟到3.7。
因此，即使可能存在其他好的用例，如果您不想在未来需要遵守此限制，最好将它们仅用于类型提示。
foo.__annotations__而不是foo.func_annotations，这是一种更现代和推荐的注释语法。 - zhangxaochendef foo(a: 'x', b: 5 + 6, c: list) -> max(2, 9):这段代码的意思是什么？ - Ali SH