VS Code之Python环境配置
一、配置本地的python环境
1、安装Anaconda3
在Anaconda官网下载最新版的Anaconda3版本并安装,网址在这里。
直接安装Anaconda3有一个好处就是,Anaconda3中集成了VS Code,只需要在安装Anaconda3的时候勾选即可,需要注意的是,安装过程中必须选择导入环境变量,这样就免去了自己添加环境变量的步骤。
详细步骤可以参考:https://blog.csdn.net/ychgyyn/article/details/82119201
2、配置VS Code环境
安装Python插件
首先,打开VS Code,进入插件页面,下载并安装微软官方的Python插件,具体如下图所示。
选择Python解释器
然后,按F1 选择Python 查看解释器项,如图中红圈标记所示。
点击后会出现解释器的版本选项(下图所示),如果只安装了一个python的话就只会出现一个,如果什么都没有出现,那就是环境变量为设置好。
配置launch.json文件
依次点击VS Code界面左上角 调试 =》打开配置,进入launch.json配置界面,输入下列配置信息。注意:"pythonPath"需要设置为你自己的本地python环境路径
{
// 使用 IntelliSense 了解相关属性。
// 悬停以查看现有属性的描述。
// 欲了解更多信息,请访问: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Python3",
"type": "python",
"request": "launch",
"stopOnEntry": false,
"pythonPath": "F:\\Anaconda3\\python.exe", //python3的安装路径
"program": "${file}",
"cwd": "${workspaceFolder}",
"env": {},
"envFile": "${workspaceFolder}/.env",
// "debugOptions": [
// "RedirectOutput"
// ]
},
{
"name": "Python: Terminal (external)",
"type": "python",
"request": "launch",
"stopOnEntry": false,
"pythonPath": "F:\\Anaconda3\\python.exe",
"program": "${file}",
"cwd": "",
"console": "externalTerminal",
"env": {},
"envFile": "${workspaceFolder}/.env",
// "debugOptions": []
},
{
"name": "Python: Django",
"type": "python",
"request": "launch",
"stopOnEntry": true,
"pythonPath": "F:\\Anaconda3\\python.exe",
"program": "${workspaceFolder}/manage.py",
"cwd": "${workspaceFolder}",
"args": [
"runserver",
"--noreload",
"--nothreading"
],
"env": {},
"envFile": "${workspaceFolder}/.env",
// "debugOptions": [
// "RedirectOutput",
// "Django"
//]
},
]
}
配置task.json文件
依次点击VS Code界面左上角 终端 =》配置任务界面,进入task.json配置界面,输入下列配置信息。注意:"pythonPath"需要设置为你自己的本地python环境路径
{
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [
{
"label": "echo",
"type": "shell",
"command": "F:\\Anaconda3\\python.exe",
"args": [
"${file}"
],
"group": {
"kind": "build",
"isDefault": true
}
}
]
}
3、测试环境是否配置成功
创建一个python文件,输入测试代码,若出现图中红圈所显示的内容,则为配置成功,当然也可以使用万能的Hello World来进行测试。
按ctrl + shift + B即可运行文件
二、连接远程服务器进行开发调试
1、下载相关插件
安装下图所示的全部插件,选择安装Remote Development插件可以安装下面所示的全部插件
2、配置SSH密钥
step1:检查本地计算机上是否已有SSH密钥。公钥通常位于~/.ssh/id_rsa.pubmacOS / Linux和%USERPROFILE%.ssh\id_rsa.pubWindows上。
若没有,请在本地终端/命令提示符下运行以下命令以生成SSH密钥对:
ssh-keygen -t rsa -b 4096
没有ssh-keygen?安装支持的SSH客户端。
step2:将本地公钥(id_rsa.pub文件)的内容添加到SSH主机authorized_keys上的相应文件中。
在macOS / Linux上,在本地终端中运行以下命令,根据需要替换用户名和主机名。
ssh-copy-id your-user-name-on-host@host-fqdn-or-ip-goes-here
在Windows上,在本地命令提示符中运行以下命令,替换REMOTEHOST适当的值。
SET REMOTEHOST=your-user-name-on-host@host-fqdn-or-ip-goes-here
scp %USERPROFILE%\.ssh\id_rsa.pub %REMOTEHOST%:~/tmp.pub
ssh %REMOTEHOST% "mkdir -p ~/.ssh && chmod 700 ~/.ssh && cat ~/tmp.pub >> ~/.ssh/authorized_keys && chmod 600 ~/.ssh/authorized_keys && rm -f ~/tmp.pub"
3、使用专用密钥提高安全性
虽然在所有SSH主机上使用单个SSH密钥可以很方便,但如果有人可以访问您的私钥,他们也可以访问所有主机。您可以通过为开发主机创建单独的SSH密钥来防止这种情况。只需按以下步骤操作
step1:在另一个文件中生成单独的SSH密钥。
在macOS / Linux上,在本地终端中运行以下命令:
ssh-keygen -t rsa -b 4096 -f ~/.ssh/id_rsa-remote-ssh
在Windows上,在本地命令提示符中运行以下命令:
ssh-keygen -t rsa -b 4096 -f %USERPROFILE%\.ssh\id_rsa-remote-ssh
step2:在VS Code中,运行Remote-SSH:打开配置文件...在命令选项板(F1)中,选择SSH配置文件,然后添加(或修改)主机条目,如下所示:
Host name-of-ssh-host-here
User your-user-name-on-host
HostName host-fqdn-or-ip-goes-here
IdentityFile ~/.ssh/id_rsa-remote-ssh
切入到VS Code界面,按F1,选择下图红圈所示内容,进入Remote-ssh配置文件路劲,这里选择第一个路径即可,根据实际情况将上面的内容填入配置文件中即可:
step3:将步骤1中生成的本地 id_rsa-remote-ssh.pub文件的内容添加到SSH主机authorized_keys上的相应文件中。
在macOS / Linux上,在本地终端中运行以下命令,替换name-of-ssh-host-here为步骤2中SSH配置文件中的主机名:
ssh-copy-id -i ~/.ssh/id_rsa-remote-ssh.pub name-of-ssh-host-here
在Windows上,在本地命令提示符中运行以下命令,替换name-of-ssh-host-here为步骤2中SSH配置文件中的主机名。
SET REMOTEHOST=name-of-ssh-host-here
SET PATHOFIDENTITYFILE=%USERPROFILE%\.ssh\id_rsa-remote-ssh.pub
scp %PATHOFIDENTITYFILE% %REMOTEHOST%:~/tmp.pub
ssh %REMOTEHOST% "mkdir -p ~/.ssh && chmod 700 ~/.ssh && cat ~/tmp.pub >> ~/.ssh/authorized_keys && chmod 600 ~/.ssh/authorized_keys && rm -f ~/tmp.pub"
关于这方面的内容可以查看微软官方的教程:官方配置教程
4、检测是否配置成功
上面所有步骤完成且无误后,就可从VS Code中看到如下界面,若未配置成功,红圈部分是不会先显示此类内容的。
注意:连接过程中会要求输入相关账户远程服务的密码进行登陆
右键点击上图红圈里面的选项选择在新窗口打开,出现下面红圈的内容(内容一般为远程服务器端的主机名)即表示以及安装成功。
到了这里还没有结束,这里只是成功连接到了远程服务器而已。
5、配置远程服务器端的python环境
这一步的操作与第一部分配置本地的python环境中的配置VS Code环境一致,直接参考即可。
关于插件的安装:
在VS Code上,本地安装的插件与远程服务器的插件是不共享的,因此需要安装两份插件。
在连接远程服务器端的VS Code界面会显示远程端和本地端所安装的插件
测试步骤依旧参考第一部分内容中的步骤。
三、参考链接
vscode 配置 python3开发环境:https://blog.csdn.net/weixin_40528417/article/details/81141567
配置SSH密钥:https://code.visualstudio.com/docs/remote/troubleshooting#_configuring-key-based-authentication
使用SSH在远程服务器上进行开发:https://code.visualstudio.com/docs/remote/ssh#_getting-started