选自 Real Python
作者:Jon Fincher 机器之心编译在 Windows 上怎样做 Python 开发?是像大神那样使用纯文本编辑器,还是用更加完善的 IDE?到底是用自带的命令行工具,还是需要装新的 Terminal?本文将带你了解如何利用微软官方维护的 MS Terminal 与 VS Code,来为 Python 开发保驾护航。使用 Windows 系统一大好处是它的应用太丰富了,甚至强大的 GPU 也能在闲暇时间做点其它「工作」。然而与 Linux 或 macOS 不同,在 Windows 上做开发总会遇到很多挑战,不论是文件编码、环境控制还是项目编译,开发过程中总会有一些神奇的收获。 这些对于初学者来说尤其突出:我们在安装某个库时可能出现各种依赖项错误,我们在读写文本时出现各种编码错误等等。 那么在 Windows 上如何做 Python 开发呢?相信大神们都会有自己的解决方案,但本文希望介绍微软官方发布的 Terminal 和 Visual Studio Code,希望它们能构建更流畅的 Windows 开发体验。
Visual Studio Code 是程序员可以使用的最酷的代码编辑器之一,是一个可在所有平台上使用的开源、可扩展和轻量级编辑器。正是这些品质使微软的 VS Code 大受欢迎,并成为 Python 开发的绝佳平台。可能很多读者都比较熟悉 PyCharm 与 Jupyter Notebook 等常见的 Python IDE,但 VS Code 一样不会令你失望。
在本文中,你将学习到微软 Terminal 和 Visual Studio Code 的特性,包括:
-
什么是微软 Terminal
-
微软 Terminal 效果怎么样
-
安装 Visual Studio Code
-
发现并安装 Python 扩展
-
编写简单的 Python 应用程序
-
了解如何在 VS Code 中运行和调试现有 Python 程序
-
将 VS Code 连接到 Git 和 GitHub,与全世界分享你的代码
-
MS Terminal 开源地址:https://github.com/microsoft/terminal
此外,除了功能外,更重要的就是颜值,就像我们常用 zsh 来提供更美观的命令行一样。虽然 zsh 目前的 GitHub 收藏量已经达到 9.4 万了,但 ReadMe 文档清楚地写着它最好用于 macOS 或 Linux。而新发布的 MS Terminal 不论在界面还是在文字风格,都以前都强了很多。
背景透明度、文字高亮都可以自行定义,还能定义 emoji 等符号。如下为基本的展示,我们可以根据自己的需要调整整个界面。
整个项目还在积极开发中,很多功能也都在完善与增加。不过既然是微软官方维护的开源项目,那么我们还是非常有信心的,至少在命令行部分可以降低开发过程中的各种报错。当然如果读者在 Windows 上有更好的命令行工具推荐,也可以在文末留言。
安装和配置 VS Code
前面介绍了开发中必不可缺的命令行工具,下面我们该聊一聊 VS Code 了,它是支持 Python 开发的核心工具。下面我们从最初的安装、环境管理到编写、测试、发布代码,介绍我们该如何优雅地使用 VS Code。
在任何平台上都可以安装 Visual Studio Code。官网提供了 Windows、Mac 和 Linux 的完整安装说明,并且会每月更新编辑器,其中包含新功能和错误修正。你可以在 Visual Studio Code 网站上找到所有安装内容:
此外,除名称相近外,Visual Studio Code(简称 VS Code)与基于 Windows 的更大规模的 Visual Studio 几乎没有其他相同的地方。
Visual Studio Code 本身支持多种语言,并且它的一个扩展模型具有支持其他组件的丰富生态系统。VS Code 每月更新,你可以在微软 Python 博客中了解更新信息。任何用户都可以克隆微软的 VS Code Github 仓库并贡献自己的代码。
VS Code UI 已有详细记录,这里不予赘述:
Python 扩展
如上所述,VS Code 通过详细记录的扩展模型支持多种编程语言的开发。Python 扩展使用户可以在 Visual Studio Code 中进行 Python 开发,具有以下特征:
-
既支持 Python 3.4 及更高版本,也支持 Python 2.7 版本
-
使用 IntelliSense 完成代码补全
-
Linting
-
调试支持
-
代码片段支持
-
单元测试支持
-
自动使用 conda 和虚拟环境
-
在 Jupyter 环境和 Jupyter 笔记本中进行代码编辑
Visual Studio Code 扩展不仅仅具有编程功能:
-
Keymaps 允许已经熟悉 Atom,Sublime Text,Emacs,Vim,PyCharm 或其他环境的用户更加容易上手。
-
主题自定义 UI,无论您喜欢在明亮,黑暗或更丰富多彩的地方进行编码。
-
语言包提供本地化体验。
-
GitLens 直接在编辑视窗中提供了大量有用的 Git 功能,包括非责任注释和存储库开发功能。
-
通过从菜单中选择 File, Auto Save,可以轻松进行自动保存。默认延迟时间为 1000 毫秒,也可以重新配置。
-
Settings Sync 允许用户借助 GitHub 在不同的装置中同步自己的 VS Code 设置。如果用户在不同的计算机上工作,这有助于运行环境保持一致。
-
Docker 让用户可以快速轻松地使用 Docker,帮助创作 Dockerfile 和 docker-compose.yml,打包和部署项目,甚至为项目生成适当的 Docker 文件。

打开新文件后,你即可以输入代码。
输入 Python 代码
作为测试,我们可以快速编码埃拉托斯特尼筛法(Sieve of Eratosthenes,它可以找出小于已知数的所有质数)。在刚打开的新选项卡中键入以下代码:
等等,这是怎么回事?为什么 Visual Studio Code 没有进行任何关键词高亮显示,也没有进行任何自动格式化或任何真正有用的操作呢?它提供了什么?
答案是,VS Code 不知道它正在处理的是什么类型的文件。缓冲区被称为 Untitled-1,如果你查看窗口的右下角,则可以看到 Plain Text(纯文本)。
若要激活 Python 扩展,请保存文件(从菜单中选择 File-Save 或者从命令面板中选择 File-Save File 或者只使用 Ctrl + S)为 sieve.py。VS Code 将看到.py 扩展名并正确地将该文件转化为 Python 代码。
现在你的窗口视图应如下所示:
这样就好多了!VS Code 会自动将文件重新格式化为 Python 代码,你可以通过检查左下角的语言模式予以验证。
如果你有多个 Python 安装(如 Python 2.7、Python 3.x 或 Anaconda),则可以通过单击语言模式指示器或者从命令面板中选择 Python: Select Interpreter 来更改 VS Code 所要使用的 Python 解释器。默认情况下,VS Code 支持使用 pep8 格式,但你也可以选择 black 或 yapf。
现在可以添加其余的 Sieve 代码。若要查看 IntelliSense,请直接键入此代码而不要剪切和粘贴,你应该看到如下内容:


-
创建一个文件夹来保存项目(可能包含一个新的 GitHub 项目)
-
更改为新文件夹
-
使用命令 code filename.py 创建初始 Python 代码
cd /path/to/project code .当你这种方式打开时,VS Code 了解并将使用它看到的任何 virtualenv、pipenv 或 conda 环境。你甚至不需要首先启动虚拟环境。通过菜单中的 File, Open Folder、键盘上的 Ctrl+K, Ctrl+O 或者命令面板中的 File, Open Folder 等方式,你可以打开用户界面(UI)上的文件夹。 以下是创建的方程式 eval 库项目:
当 Visual Studio Code 打开文件夹时,它还会再次打开上次打开的文件(这是可配置的)。你可以打开、编辑、运行和调试列出的任何文件。左侧活动栏中的资源管理器视图(Explorer view)提供文件夹中所有文件的视图,并显示当前选项卡集中有多少未保存文件。
代码测试的支持
VS Code 可以自动识别在 unittest、pytest 或 Nose 框架中编写的现有 Python 测试,但前提是在当前环境中安装了这些框架。作者在 unittest 框架中编写了一个用于方程式 eval 库的单元测试,你可以在这个例子中使用它。
若要运行项目中任何 Python 文件的现有单元测试,请单击右键并选择 Run Current Unit Test File。系统将提示指定测试框架,在项目中搜索测试的位置以及测试使用的文件名模式。
所有这些都保存为本地.vscode/settings.json 文件中的工作区设置,并可以进行修改。对于这个等式项目,你可以选择 unittest、当前文件夹和模式 *_test.py。
测试框架设置完成并显示测试后,你可以单击状态栏(Status Bar)上的 Run Tests 并从命令面板中选择一个 option 来运行所有测试:
通过在 VS Code 中打开测试文件,单击状态栏上的 Run Tests,然后选择 Run Unit Test Method 以及其他要运行的特定测试,你还可以运行单个测试。这使得解决单个测试失败并重新运行失败的测试变得很简单,从而能够节省大量时间。 测试结果显示在 Python Test Log 下的 Output 窗格中。
调试支持
即使 VS Code 是代码编辑器,直接在 VS Code 中调试 Python 也是可以的。VS Code 提供的诸多功能可以媲美好的代码调试器,包括:
-
自动变量跟踪
-
监看表达式
-
断点
-
调用堆栈检查
调试器可以控制在内置终端或外部终端实例中运行的 Python 应用程序。它可以附加到已经运行的 Python 实例中,甚至可以调试 Django 和 Flask 应用程序。
在单个 Python 文件中调试代码就像按 F5 启动调试器一样简单。你可以按 F10 和 F11 分别跳过和进入函数,并按 Shift + F5 退出调试器。 按 F9 设置断点,或者通过单击编辑器窗口中的左空白(lift margin)进行设置。
在开始调试更复杂的项目(包括 Django 或 Flask 应用程序)之前,你首先需要设置并选择调试配置。设置调试配置相对简单。从 Debug 视图中选择 Configuration 下拉列表(drop-down),然后选择 Add Configuration 和 Python:
Visual Studio Code 将在当前名为.vscode/launch.json 的文件夹下创建一个调试配置文件,它允许用户设置特定的 Python 配置以及调试 Django 和 Flask 等特定应用程序的设置。
你还可以执行远程调试,并调试 Jinja 和 Django 模板。关闭编辑器中的 launch.json 文件,然后从 Configuration 下拉列表中为应用程序选择正确的配置。
Git 集成
VS Code 不仅内置对源代码控制管理的支持,还支持 Git 和 GitHub。你可以在 VS Code 中安装对其他 SCM 的支持,并列使用它们。 用户可以从 Source Control 视图访问源代码控制:
如果你的项目文件夹包含.git 文件夹,VS Code 会自动打开所有 Git / GitHub 功能。你可以执行以下诸多任务:
-
将文件提交给 Git
-
将更改推送到远程存储库(remote repo)并从中取出更改
-
check-out 现有或创建新的分支和标签(branch and tag)
-
查看并解决合并冲突(merge conflict)
-
查看差异(view diffs)
VS Code 还可以识别编辑器外部进行的更改并且正确运作。
在 VS Code 中提交最近的更改相当简单。修改后的文件显示在 Source Control 视图中,并带有 M 标记,而新的未跟踪文件使用 U 标记。 将鼠标悬停在文件上然后单击加号(+)可以暂存更改。在视图顶部添加提交消息,然后单击复选标记来提交更改:
你也可以在 VS Code 中将本地提交(local commits)推送到 GitHub。从 Source Control 视图菜单中选择 Sync,或者单击分支指示器(branch indicator)旁边状态栏上的 Synchronize Changes。
所以在作者看来,Visual Studio Code 是最酷的通用编辑器之一,也是 Python 开发的最佳候选工具。希望你也可以在 Python 开发中尝试使用 Visual Studio Code 编辑器,相信不会令你失望的。
参考文章:
-
https://realpython.com/python-development-visual-studio-code/
-
https://devblogs.microsoft.com/commandline/introducing-windows-terminal/

WAIC 2019 开发者日 将于 8 月 31 日在上海世博中心举办,包含 1 个主单元、4 个分单元、黑客马拉松比赛和开发者诊所互动区。
届时,全球顶尖 AI 专家、技术大牛、知名企业代表以及数千名开发者将齐聚上海,围绕人工智能前沿理论技术和开发实践进行分享与解读。
点击阅读原文 ,立即报名。
