python项目创建过程

简介

本文默认你已经在自己的电脑中安装好了python及完成了相应的系统配置工作。同时也安装了vs code以及需要的相关插件。

详细步骤

创建虚拟环境

假设我们使用C:\Workspace作为本教程的工作空间，并且working_environment是我们的虚拟环境。

cd C:\Workspace
C:\Workspace>python -m venv working_environment

创建项目和设置VS Code

在C:\Workspace\下创建一个名为project的新文件夹。(这个名称可以根据需要随便起名)然后使用 vs code 打开并可在其下创建相应的pyton文件及项目架构布局等。

我们要使用我们为此项目创建的虚拟环境，working_environment。为此，我们需要告诉VS Code虚拟环境的路径。

• 文件->首选项->设置
• 类型venv path在顶部的搜索栏
• 添加C:\Workspace

当你在项目目录下创建了虚拟环境后，vs code 也会检查到，并在右下角有提示是否选择此虚拟文件，可以直接点击确定选择。

配置Linting，类型检查等

默认情况下，在VS Code中为Python启用了Pylint功能，但VS Code支持许多其他的检查器。本节演示了我每天使用的一些检查设置。

• 文件->首选项->设置，然后在顶部搜索栏输入linting。将会出现许多检查器选项。

启用并安装pydocstyle

• 选中pydocstyle选项框

• 一旦我们选中该框，就会弹出一个安装选项。单击它进行安装pydocstyle。

• 如果我们要为pydocstyle添加非默认选项，请点击添加项目按钮。

添加我们想要的参数。例如，如果我们要使用numpy样式，请添加--convention=numpy。

• 然后单击确定按钮。它看起来像：

注意：pydocstyle的完整参数可以在http://www.pydocstyle.org/en/4.0.0/usage.html#command-line-interface上找到。

启用并安装mypy和启用并安装pep8

选中mypy、pep8选项框。(具体可以参考上一部分内容)

注意：所有检查器都安装在working_environment。

测试与调试

对于测试和调试的设置，VS Code具有非常全面的文档：

• 测试：https://code.visualstudio.com/docs/python/testing
• 调试：https://code.visualstudio.com/docs/python/debugging

关于用vs code连接到远程Linux主机、WSL等，可参考此文章。

总结

本文到这里就结束了。本文简单介绍使用 vs code 创建 python 项目的方式：创建项目并选择相应创建的虚拟环境，这样可以减少多个项目及项目包之间的依赖混乱问题。