PyCharm进行远程服务器代码的编写与调试

一、背景

目前,pycharm是非常受欢迎的编写、调试python的IDE,那么为了方便我们在本地调试远程服务器中的代码,我们可以在pycharm中进行SSH与SFTP的连接,来进行远程服务器的文件添加、修改与删除,并且在本地编写、修改与调试代码,这让我们能够很轻松的同时使用本地与远程服务器,更加高效的进行代码的编写、修改与调试。

二、使用场景

  1. 可以直接在本机上编写代码
  2. 自动将代码同步到远程服务器上
  3. 在远程服务器上的解释器中执行代码,返回结果。和在本地使用pycharm操作是一样的感觉

三、配置过程

首先需要注意的是,Pycharm只有专业版才有这个配置远程服务器的功能,免费的社区版是没有的。永久激活PyCharm参考我之前写的文章的第三部分:https://blog.csdn.net/IT_xiao_bai/article/details/79171703 ,该操作适用于所有系统,此话题不是本文重点,就此略过,如有疑问,请留言。本文使用的PyCharm版本为2019.1.1最新版,截图会与老版本的功能界面略有不同,不过不影响配置,下面详细介绍一下配置过程。

1.配置远程服务器信息

打开pycharm,选择Tools --> Deployment --> Configuration,点右上角的“+”添加服务器信息,服务器类型选择SFTP,name自己习惯起一个就行,然后点OK。

接着配置一下连接信息,输入服务器的ip地址、用户名、密码,然后点击Autodetect自动检测一下服务器的根目录。
在这里插入图片描述
然后选择Mappings选项卡,配置Mappings,如下
在这里插入图片描述
这样,Deployment的配置就完成了。这个配置完成了之后,其实是相当于配置了一个ftp工具可以连接到服务器上,从而可以查看和修改服务器上的文件。你可以通过Tools --> Deplotment --> Browse Remote Host来打开相应的RemoteHost面板,这个面板显示的就是服务器上的文件,显示的范围是你在Deployment中的Connection选项卡下配置的Root path路径下的文件及文件夹。

你可以直接在RemoteHost面板里双击某个文件并且直接进行编辑。双击某个文件后你可以看到编辑区域的顶部有一个横条,并且横条的右边有三各按钮,分别是比较,撤销和上传操作。你在这里面编辑文件之后,可以直接点击上传按钮,就会提交到服务器了。

2、配置远程Python解释器

点击files --> setting --> project Interpreter,点击Interpreter配置页面的小齿轮按钮,然后再选择add
在这里插入图片描述
然后选择SSH Interpreter,点击Existing server configuration,在Deployment configuration的下拉列表中选择我们刚才配置的服务器名称,然后Next。
在这里插入图片描述
在新界面我们添加Python解释器
在这里插入图片描述
其中interpreter是要选择服务器上的python解释器路径,如有多个,选择你想用的那个。不知道服务器Python解释器路径的通过执行whereis python命令进行查看。

Sync folders是指定本地项目与远程项目自动同步的路径。

以上配置好了,该项目现在使用的就是远程服务器上的Python解释器了。以后的项目若不想使用该解释器,手动更改解释器即可。

3、代码自动上传服务器(选做)

点击Tools --> Deployment --> Options,在界面中找到Upload changed files automatically to the default server,在其后面的下拉列表中选择Always,此处根据个人需求更改。
在这里插入图片描述
点击OK,以上步骤都完成后,就实现本地pycharm与远程服务器主机的连接了。

四、SSH远程连接

此外,我们在运行程序是可能需要连接远程服务器,并且远程服务器的shell命令行的操作,所以我们也可以通过pycharm里面的工具进行远程服务器的终端的打开,选择Tools --> Start SSH seesion即可在pycharm中远程连接到服务器。

SSH远程连接的terminal出现乱码的解决方案:

点击Files --> Settings --> Tools --> SSH Terminal,在Default encoding选项中选择utf-8即可解决。
在这里插入图片描述

五、配置不同项目的运行环境

以上我们配置好了就可以使用远程服务器上的Python解释器了,由于不同项目需要的配置也不一样,有些程序在本地跑完全没问题,而有些程序则需要放在服务器上跑,这样我们就需要对不同项目把本地和服务器运行环境区分开,这样既可以本地测试跑程序,远程服务器也可以运行,现在我们为不同项目配置不同的运行环境。

点击Run --> Edit Configurations,打开运行配置面板,如下图:
在这里插入图片描述
其中Name可以自己随便起,在Working directory中针对不同项目配置不同的路径,Python interpreter中选择你项目需要的Python解释器,点击OK,如有多个项目,按照如上步骤分别对其他项目配置就可以了。

六、使用说明

以上都配置好了,接下来我们就试一下如何在PyCharm中使用刚才配置好的环境运行程序吧。这里分了三种情况运行。

1、在本地使用服务器环境运行

此场景可以适用于想本地使用服务器资源,但不想上传代码到服务器上运行时,这样运行的程序不会占用本地过多的资源。

本地编写完程序,在pycharm的右上方工具栏中找到下三角箭头,如下图红色圆圈处,点击并选择你远程服务器的运行环境。
在这里插入图片描述
然后本地执行程序即可,这时你执行的程序用的是远程服务器上的资源,本地可以看到输出的结果,方便本地编写修改,同时也为之后的上传代码、部署到服务器等步骤做准备。

2、本地代码上传到服务器并运行

在本地编写完程序后,点击Tools --> Deployment,选择“Upload to xxx”就可以上传代码到服务器了,“xxx”为你刚才配置远程连接服务器的名字。或者通过点击右键选择Deployment --> Upload to xxx也可以上传文件。在上传文件时,IDE下面的“File Transfer”会有相应提示。

可以通过点击右侧的Remote Host工具栏中的刷新按钮,查看对应路径上传的文件是否存在
在这里插入图片描述
上传文件成功后,我们可以通过点击Tools --> Start SSH session连接到远程服务器,接着大家应该都熟悉了,切换到代码目录,就可以执行程序了。适用于远程服务器部署。

P.S.若总是提示上传文件有问题,最后就是连接失败,解决办法是,将你pycharm安装位置的skeletons文件夹下的压缩包删除重启就可以了。

3、本地修改远程服务器上的代码

在右侧点击Remote Host,双击选择你要修改的文件并进行本地修改,完成后,IDE会自动提示“The file has been modified. Upload?”,右侧有三个按钮,第一个是对比你本地和服务器上代码有哪些修改,第二个是将代码回滚到上一个版本,第三个是上传
在这里插入图片描述
我们点击第三个按钮上传文件,上传完后,IDE会提示“The file is identical to remote one.”,证明上传成功。
在这里插入图片描述
接下来的操作就和上面一样了,SSH连接,再执行程序。

总结

以上就是通过配置PyCharm连接远程服务器,并在本地修改代码运行的全网最全教程,最后,欢迎大家转载,转载请注明出处https://blog.csdn.net/IT_xiao_bai/article/details/89054436。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章