python的VSCode自动完成字符串参数

Question

我一直在寻找是否可以在 VSCode 中为 Python 创建与在 JavaScript 中使用 jsdoc 相同的行为来显示字符串参数输入。

带有 JSDoc 的 JavaScript 示例：

/**
* @method someMethod
* @description A special method.
* @param { "option1" | "option2" } param1 Choose an option.
*/
function someMethod(param1) {
    console.log(param1);
}

所以调用方法的时候，VSCode会给param1自动补全选项。

所以我正在寻找一个 Python 等价物，最好使用 google docstring 格式：

def some_method(param1: str) -> None:
    """A special method.

    Args:
        param1 (str): Choose an option. # HOW CAN WE ADD INTELLISENSE OPTIONS HERE??
    
    """
    print(param1)

Answer 1

在 VSCode 中，使用的语言服务器决定了自动补全。当前 Python 补全的“黄金标准”是 Microsoft Pylance extension，它建立在 Microsoft Pyright 之上，用于分析您的源代码。

反过来，Pyright 依靠类型推断和 type hints 来了解您有哪些可用的自动完成选项。虽然这确实包括support for comments，但不支持文档字符串中的类型提示（这是类型提示规范中的explicitly rejected）。

如果您习惯于 Typescript，Python 类型提示和 Pylance 应该以几乎相同的方式工作。您自己的示例已经包含类型提示，您的示例的 literal 翻译将使用 literal types:

from typing import Literal

def some_method(param1: Literal["option1", "option2"]) -> None:
    """A special method."""
    print(param1)```

然后您可以自动完成这些值：

.

（我注意到appears to be a bug in the current VSCode or Pylance release 只能通过将光标放在结束引号之后来自动完成字符串；我相信这将在未来的版本中得到修复）。

一个警告：Pylance 仍被标记为 preview 项目。但是，它的改进非常快，我在所有 Python 工作中都使用它。