22

我想使用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。

4

2 回答 2

23

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'>}

这些注释显然也使用了一些空间（但甚至少于文档字符串）。但是，它们对运行时执行没有影响（除非您明确使用__annotations__.

我建议您使用类型注释。由于静态分析/IDE，它们已经被引入，并且绝对是记录类型的未来。还有很多工作正在进行中mypy，jedi以及其他工具以使类型注释在验证程序中更有用。已经使用类型注释，您将为未来做好准备。

于 2017-06-06T14:26:52.293 回答
0

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

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

于 2017-06-06T12:41:45.340 回答