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。

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