京东|VScode配置用于数据科学开发的Python环境和3个必须的插件介绍( 二 )



现在我们可以通过脚本或jupyter使用 Python 。接下来让我们添加一些额外的功能 。
Python docstring生成器

编写好的 Python 代码的一个重要工作就是编写好的注释 。在VSCode中我们可以安装 Python Docstring Generator 扩展 。

让我们看看它是如何工作的 。编写一个对两个整数求和的 Python 函数:

您现在可以通过在函数声明下方写三个双引号并选择generate docstring 选项来添加docstring :

结果是这样的 , 插件会根据模板为我们生成相应的注释格式我们只要修改就可以了

Python linter

最后 , 我想聊聊 linting 。在 VSCode 中启用 linting 可以自动判断我们的代码是否遵循 Python 约定并生成报告 。例如会告诉你是否有已导入但未使用的模块 , 或者是否有任何需要改进的代码 。
首先 , 打开命令面板(设置 — 命令面板...或按 F1)并输入 Linter 。选择 Select Linter 选项:

PyLint 是最常用的 , 所以可以选择它:

如果尚未安装 PyLint , 它会要求安装 。它只针对目前激活的环境 , 如果有其他的环境必须为每个虚拟环境重复该过程:

现在让我们删除 add() 函数并测试 PyLint 提供的功能 。导入 json 和 random 模块并打印一个 1 到 100 之间的随机整数:

保存文件后 , 您会立即看到警告消息 。打印语句提示是因为它后面没有新行 , 只需在行尾按 Enter 键(这是一个快速解决方案) 。
顶部的 import 语句有下划线 , 因为顶部没有文件级的docstring , 所以让我们快速写一个:

如果您保存文件 , 警告不会消失 。它现在提示你已经导入了 json 但没有在文件中使用它:

删除未使用的导入后 , 该消息就消失了 。
linter 可以帮助您编写更好的 Python 代码 , 并确保遵循所有约定 。如果 linter 给你警告信息 , 你的代码可能仍然会运行起来 。 但看着它们很烦人(尤其是对于像我这样的强迫症患者) , 所以尽量在提示出现时解决它们这样才能够保证良好的使用习惯 。
通过以上的步骤已经可以使用vscode进行Python的开发了 , 如果你有什么好的插件或者技巧 , 可以直接留言告诉我们 。
作者:Dario Rade?i?