Python文档字符串生成器：基于CodeBERT，支持Google、Numpy等多种输出格式

又一款懒人神器问世了：

Visual Studio Code的扩展，基于CodeBERT的Python文档字符串生成器。

看来现在，这群偷「懒」的程序员们连文档字符串都不想自己写了。

基于CodeBERT的生成器

跟正常的DocStrings用法一样，你只需要输入三引号「“””」，之后按Enter，便能调用这个工具。就像这样：

并且，这个生成器还可以在几种不同类型的文档字符串格式之间进行选择。

而这个工具，不仅仅能够帮助写代码的人，还可以方便后来人读代码。可以说是非常方便的一个扩展了。

这个工具的本质，就是一个自然语言识别的AI，它能够识别你所写代码的内容，然后输出对应的字符串。

具体是如何识别的，该AI的作者是这么介绍的：

参数类型是通过PEP 484类型、默认值和var标签进行识别的。

识别输入之后便是推断，这之间进行训练的方法，也并不复杂，通过CodeBERT便可以实现。

CodeBERT是一种双模预训练模型，它可以捕捉自然语言和编程语言之间的语义连接，是目前已知的第一个大型 NL-PL（自然语言-编程语言）预训练模型。

在训练过程中，使用 CodeSearchNet 语料库作为训练数据，并使用 CodeBERT 中的 Code2NL微调任务。

之后，进行的推断基准测试如下：

从上图也能看出，在不同的推断基准测试中，所需要的生成时间都很短（2s内），这体现在操作上的话，就是延迟。

目前，这个生成器可以支持识别args、kwargs、decorators和errors等参数类型。

此外，还可以输出Google、docBlockr、Numpy、Sphinx等Docstring格式，PEP0257类型的格式，也即将上线。

使用方法

1、从容器中运行模型推断服务

具有GPU的话：在安装nvidia-docker后，运行docker run-it-d-GPU 0-p 5000:5000 gray kode/ai-docstring。

只有CPU：运行docker run-it-d-p 5000:5000 gray kode/ai-docstring。

2、在VSCode中安装扩展并使用

光标必须在定义正下方的行上，以生成完全自动填充的文档字符串。

用三重引号「“””或‘’’」打开文档字符串后，按Enter键；

键盘快捷键是ctrl+shift+2，Mac为cmd+shift+2。

网友讨论

该生成器一经发布，便引起了网友们的讨论。

有网友认为这是一项非常便利的技术，非常期待：

不过，也有网友认为这项技术仍具有不小的局限性：

比如这位网友认为：更常见的注释，是在代码中没有立即出现的上下文之间添加内容。

不过，虽然有局限，但是人总是在「懒」的过程中变得更「懒」（狗头）。

比如jQuery的流行，是因为开发者懒得为DOM编写跨浏览器兼容性代码；

而之后Angular.js的流行，是因为开发者连DOM都懒得操作。

所以，还是非常期待这个扩展的后续，这些程序员能不能针对这些局限性进一步偷懒的。

获取资源

目前这个扩展已经在Visual Studio Code上免费上线。

进入链接即可获取资源：

https://marketplace.visualstudio.com/items?itemName=graykode.ai-docstring

也可以通过Github获取源文件：

https://github.com/graykode/ai-docstring

— 完 —