哪个更有效：Python 文档字符串或类型提示？

Question

我想使用 Jedi 为我的 Python 代码添加一些自动完成支持。这可以通过使用函数文档字符串或类型提示（或两者）来完成。

def function_with_types_in_docstring(param1, param2):
    """Example function with types documented in the docstring.

    :type param1: int
    :type param2: str
    :rtype: bool
    """

def function_with_pep484_type_annotations(param1: int, param2: str) -> bool:
    """Example function with PEP 484 type annotations."""

哪种记录类型的方法在内存使用和运行时间方面增加的开销更少？我首先对 Python 代码本身的效率感兴趣，然后才是 Jedi。

Answer 1

不是一个正确的答案，但仅对于自动完成部分，既不需要文档字符串也不需要类型提示。另请注意，无论如何，您会在 stdlib 和第 3 部分包中找到非常非常非常很少的 "type-hinted" 代码。

最后，FWIW：我已经在 Emacs 中使用 Jedi 好几年了，从来没有遇到过性能问题，所以我认为您真的不必担心...

Answer 2

TL;DR：使用类型注释，它们很棒。

对于Python和jedi，无论您使用文档字符串还是函数注解都没有区别。性能和内存影响应该不明显。在这两种情况下，运行时开销显然很小。

Docstrings 被简单地转换为 Python 字符串并存储在属性 function.__doc__ 中。这需要几个字节的内存，但你不应该关心它。一个非常大的 1000 个字符的文档字符串仍然只使用 1kB 的 RAM。如果你的记忆力有限，你可以简单地使用 python -o 来摆脱文档字符串（以及断言，查找它）。

类型注释（PEP 484，例如 def foo(a: int) -> str:）存储在 function.__annotations__:

>>> def foo(bar: int): pass
... 
>>> foo.__annotations__
{'bar': <class 'int'>}

这些注解显然也使用了一些space（但比docstrings还要少）。但是，它们对运行时执行没有影响（除非您明确使用 __annotations__。

我建议您使用类型注释。它们已被引入，因为 static analysis/IDEs 并且在记录您的类型时绝对是未来。在 mypy、jedi 和其他工具上还有很多工作要做，以使类型注释在验证程序中更有用。已经使用类型注释，您将为将来做好准备。

哪个更有效：Python 文档字符串或类型提示？

Which is more efficient: Python docstrings or type-hints?

python

docstring

type-hinting

python-3.x

python-jedi