vscode python远程开发最佳实践

Fighting-年轻人就该张牙舞爪

已于 2023-10-19 10:23:24 修改

阅读量2.4k

点赞数 2

分类专栏： Python技术文章标签： vscode ide 编辑器

于 2022-12-22 15:25:37 首次发布

本文链接：https://blog.csdn.net/weixin_43380311/article/details/128409175

版权

Python技术专栏收录该内容

102 篇文章

订阅专栏

本文档介绍了作者从PyCharm转向VSCode进行远程SSH开发的体验，分享了安装的必备插件如remote-ssh、python和pylance，以及遇到的坑，如python类型提示失效、PYTHONPATH配置和代码格式化问题。解决方案包括定制pylance的配置以加速类型检查，设置PYTHONPATH环境变量以确保代码能正确导入，以及解决black代码格式化插件的兼容性问题。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

文章目录

- - 环境

前言
最近因为remote-ssh从pycharm转到vscode开发, 再删掉pycharm强制使用vscode摸索了一周熟练之后发现vscode其实使用起来也很爽，一些踩坑和最佳实践方案汇总

环境

插件

remote-ssh
python (python语言支持扩展)
pylance(微软提供的python language server)
Markdown Preview Enhanced(markdown 扩展增强)

踩坑

python类型提示不起作用

Enumeration of workspace source files is taking longer than 10 seconds.
其实是pylance挂了, 原因是workspace打开的文件太多了, 解决方案在 workspce下增加pyrightconfig.json，指定include某些自定义模块目录,或者exclude掉某些, 我的内容如下( 其他详细查看官网), 之后重启pylance（注: 如果pylance没有挂掉更改该配置会auto reload的不用重启）
```
{
    "include": [
        "my-model",
        "my-query",
        "my-component",
        "my-quant",
        "my-bond"
    ]
}
```
- ctrl + shift + p > Python language 查看pylance是否启动
- 查看pylance日志

配置`PYTHONPATH`

settings.json

mac

{
 "terminal.integrated.env.osx": {
   "PYTHONPATH": "${workspaceFolder}/src",
   }
}

win

{
  "terminal.integrated.env.windows": {
    "PYTHONPATH": "${workspaceFolder}/src",
   }
}

linux

{
   "terminal.integrated.env.linux": {
    "PYTHONPATH": "${workspaceFolder}/src",
  }
}

python 代码格式化无效

格式化选择的 black
手动执行发现报错 ImportError: cannot import name '_unicodefun' from 'click' (/home/rss/anaconda3/envs/venv/lib/python3.8/site-packages/click/__init__.py)
根据 github:click:issue 描述，装 click==8.0.2问题解决

workspace

{
	"folders": [
		{
			"path": "."
		},
		{
			"path": "v2_server"
		},
		{
			"path": "celery_tasks"
		}
	],
	"settings": {
		"terminal.integrated.env.linux": {
			"PYTHONPATH": "${workspaceFolder}",
		}
	},
	"launch": {
		"version": "0.2.0",
		"configurations": [
			{
				"name": "Debug_Workspace",
				"type": "python",
				"request": "launch",
				"program": "${file}",
				"console": "integratedTerminal",
				"justMyCode": false
			}
		]
	}
}

settings

format
使用black进行格式化代码，插件版本要求python <= v2023.19.12911010, 之后的版本去除了black的配置，可以安装配套的 black-formatter插件来进行格式化代码，但是这个插件black的最小版本大于项目要求(black == 21.9b0)，所以暂时还未升级python插件