Question

我已经看到了几种标准，用于编写关于函数期望并在Python中返回的数据类型的注释。关于哪一个是最佳实践，是否达成共识？

我应该开始使用http://www.python.org/dev/peps/pep-3107/中的新功能吗？

Answer 1

功能注释不是用于特定用途，它们可以用于任何事情。

可以编写工具以从注释中提取信息并执行任何操作，包括检查类型或生成文档。但是python本身对信息没有任何作用。您可以使用完全不同的目的，即提供将在参数上调用的函数或声明可能的返回值字符串。

注释可以是任何对象：

def somefunc(param1: "string annotation", 
             param2: 151631,  
             param3: any_object): -> "some information here":

您可以使用以下方法检索对象：

print (somefunc.func_annotations)
{'param1': "string annotation", 
 'param2': 151631,  
 'param3': <object any_object>,
 'return': "some information here"}

PEP提供的用例建议：

提供打字信息
- 类型检查
- 让IDE显示函数期望和返回的类型
- 功能重载/通用功能
- 外语桥梁
- 适应
- 谓词逻辑功能
- 数据库查询映射
- RPC参数编组
其他信息
- 参数和返回值的文档

由于函数注释语法太新，因此它实际上不用于任何生产工具。

我建议使用其他方法来记录。我使用epydoc生成我的文档，它可以从docstrings中读取参数输入信息：

def x_intercept(m, b):
    """
    Return the x intercept of the line M{y=m*x+b}.  The X{x intercept}
    of a line is the point at which it crosses the x axis (M{y=0}).

    This function can be used in conjuction with L{z_transform} to
    find an arbitrary function's zeros.

    @type  m: number
    @param m: The slope of the line.
    @type  b: number
    @param b: The y intercept of the line.  The X{y intercept} of a
              line is the point at which it crosses the y axis (M{x=0}).
    @rtype:   number
    @return:  the x intercept of the line M{y=m*x+b}.
    """
    return -b/m

此示例来自epydoc's website。它可以生成各种格式的文档，并可以从您的类和调用配置文件生成好的图表。

Answer 2

如果您使用epydoc生成API文档，则有三种选择。

Epytext。
ReStructuredText，RST。
JavaDoc表示法，看起来有点像epytext。

我建议使用RST，因为它可以与sphinx一起生成包含API引用的整体文档套件。 RST标记定义为here。您可以指定的各种epydoc字段定义为here。

实施例

def someFunction( arg1, arg2 ):
    """Returns the average of *two* (and only two) arguments.

    :param arg1: a numeric value
    :type arg1: **any** numeric type

    :param arg2: another numeric value
    :type arg2: **any** numeric type

    :return: mid-point (or arithmetic mean) between two values 
    :rtype: numeric type compatible with the args.
    """
    return (arg1+arg2)/2

Answer 3

Python 3.5官方typing

https://docs.python.org/3/library/typing.html

此更新使类型成为语言的实际部分。

示例：

#!/usr/bin/env python3

from typing import List

def f(x: int, ys: List[float]) -> str:
    return "abc"

# Good.
f(1, [2.0, 3.0])

# Bad.
f("abc", {}) # line 12

x = 1
x = "a" # line 15

y = [] # type: List[int]
y.append("a") # line 18

此代码正常运行：默认情况下，Python 3.5不强制键入。

然而，它可以被静态短绒用来诊断问题，例如：

sudo pip3 install mypy
mypy a.py

给出：

a.py:12: error: Argument 1 to "f" has incompatible type "str"; expected "int"
a.py:12: error: Argument 2 to "f" has incompatible type Dict[<nothing>, <nothing>]; expected List[float]
a.py:15: error: Incompatible types in assignment (expression has type "str", variable has type "int")
a.py:18: error: Argument 1 to "append" of "list" has incompatible type "str"; expected "int"

像Pycharm这样的现有静态分析器已经可以解析Sphinx文档类型，但是这种语言更新提供了一种可能占主导地位的官方规范方式。

Sphinx 1.8.2似乎还不支持它，但这只是时间问题：Python 3: Sphinx doesn't show type hints correctly

如何在python注释中指定输入和输出数据类型？

3 个答案: