使用三重引号在Jupyter Notebook中生成Python自动文档字符串

Question

17

我正在使用Python的Jupyter笔记本工作，并尝试使用自动文档功能生成如下所示的文档字符串。在像PyCharm这样的IDE中，函数下方三引号+Enter会生成如下所示的文档字符串。

def test_function(df: pd.DataFrame, probs: dict) -> int:
    """
    :param df: 
    :param probs: 
    :return: 
    """

目前我的笔记本输出如下，并且不解析函数内的任何参数。

def test_function(df: pd.DataFrame, probs: dict) -> int:
    """

    """

- Roel van der Burg

1

请尝试访问 https://dev59.com/ibHma4cB1Zd3GeqPPrZL，该网站提供 Jupyter Notebook 的文档字符串自动完成工具。 - matan h

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- sh.e.salh · Accepted Answer

您可以在VScode、sublime、pytorch等IDE中拥有该功能，但在jupyter中不行。我找到的最接近的解决方案是安装nbextensions并使用snippets添加文档字符串模板。这可以减少50%的输入量，但仍无法自动生成。