基于 VSCode 的 Python 开发环境

本文记录电脑中基于 VSCode 进行 Python 开发环境的流程。初上手 Python 时,Pycharm 是一个非常便利的 IDE,随着使用频率的增加,愈发被 Pycharm 超慢的启动速度困扰,于是转入 VSCode。VSCode 定位是一个文本编辑器,并不是跟 Pycharm 一样的 IDE,得益于丰富的插件支持,可以自定义出一套满足自己需求的开发环境。

Python 安装

安装 Python 有两种途径,一种是去 Python 官网下载单独的 Python 安装包,另一种是使用 Anaconda 包管理器。目前使用的是 Anaconda 方法,在安装的同时也会附带更多的常用库,免得自己再逐个安装,并外还能够很方便的生成不同的虚拟环境,以应对不同的开发需求。如果只需要虚拟环境,不需要那么多的库,可以使用 miniconda。

Anconda 的安装包可以从清华大学的镜像中下载,安装时需要注意设定到环境变量,否则 VSCode 中的终端无法执行 Python 程序。安装之后需要设定 conda 和 pip 的国内镜像源,提升下载速度,方法如下

清华 Anaconda 镜像帮助连接: https://mirrors.tuna.tsinghua.edu.cn/help/anaconda/

各系统都可以通过修改用户目录下的 .condarc 文件。Windows 用户无法直接创建名为 .condarc 的文件,可先执行 conda config --set show_channel_urls yes 生成该文件之后再修改。

channels:
  - defaults
show_channel_urls: true
channel_alias: https://mirrors.tuna.tsinghua.edu.cn/anaconda
default_channels:
  - https://mirrors.tuna.tsinghua.edu.cn/anaconda/pkgs/main
  - https://mirrors.tuna.tsinghua.edu.cn/anaconda/pkgs/free
  - https://mirrors.tuna.tsinghua.edu.cn/anaconda/pkgs/r
  - https://mirrors.tuna.tsinghua.edu.cn/anaconda/pkgs/pro
  - https://mirrors.tuna.tsinghua.edu.cn/anaconda/pkgs/msys2
custom_channels:
  conda-forge: https://mirrors.tuna.tsinghua.edu.cn/anaconda/cloud
  msys2: https://mirrors.tuna.tsinghua.edu.cn/anaconda/cloud
  bioconda: https://mirrors.tuna.tsinghua.edu.cn/anaconda/cloud
  menpo: https://mirrors.tuna.tsinghua.edu.cn/anaconda/cloud
  pytorch: https://mirrors.tuna.tsinghua.edu.cn/anaconda/cloud
  simpleitk: https://mirrors.tuna.tsinghua.edu.cn/anaconda/cloud
# 设置 pip 的源
pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple

VSCode 安装

VSCode 是一个全平台通用的文本编辑器,在官网下载安装即可。

插件安装

Chinese (Simplified) Language Pack for Visual Studio Code / 中文语言包

将软件的语言设置为中文。

Python

VSCode 的 Python 扩展,使 VSCode 拥有调用 Python 解释器的功能。安装成功之后可以新建一个 .py 文件,然后在窗口的左下角选择 Python 解释器,VSCode 会自动搜索系统中的 Python 环境。然后可以 print('hello world') 检查一下是否有问题。

Bracket Pair Colorizer 2 / 彩色括号

将不同的括号用不同的颜色标识,方便区分。

Dracula Official / 主题

VSCode 支持设置各种各样的主题,在扩展库搜索 Theme 即可出现所有可用主题。

Material Icon Theme / 图标主题

扁平化图标主题,颜值才是第一生产力。

Jupyter

VSCode 现在已经支持了 Jupyter Notebook,装个插件就可以了。

Remote-SSH / 远程开发

可以让通过SSH连接远程服务器作为本地的开发环境,连接远程服务器最好使用 SSH key,不建议使用密码,否则会不停地在输入密码。

settings.json / 设置

VSCode 的 GUI 设置并不完善,更多还是直接操作 settings.jsonCtrl+Shift+P 可以搜索 settings.json 打开,前面设置的主题、图标等都会在这里看到,另外还可以在这里设置字体等格式。

"workbench.iconTheme": "material-icon-theme",
"workbench.colorTheme": "Dracula",
"editor.fontSize": 18,
"editor.lineHeight": 26,
"editor.fontFamily": "Sarasa mono SC",
"terminal.integrated.fontSize": 16,
"terminal.integrated.lineHeight": 1.5,

自动补全与格式

Pylance

Pylance 是微软新推出的 Python 语言服务器, 可以在插件库中安装,提供自动补全等功能。

yapf / 代码格式化

YAPF 是Google开源的一个用来格式化Python代码的工具,使用 pip install yapf 进行安装,首次在 VSCode 中按下快捷键 Shift+Alt+F 会弹窗选择格式化工具,之后可直接使用快捷键进行代码格式化,主要是注意代码缩进与 import 语句顺序等问题。

flake8 / 语法检查

语法检查工具有很多,包括 flake8,pylint 等,同样使用 pip install flake8 进行安装。默认的语法要求太过严格,可以在 settings.json 中进行设置

"python.linting.flake8Enabled": true,
"python.linting.flake8Args": [
    "--max-line-length=120",
    "--ignore=E401 E402,F841,F401,F403,E302,E305,W504",
]

未完待续...