文章目錄
- 一、配置遠程連接
- 二、安裝並配置 SSH 工具(可選步驟)
- 三、通過 SSH 連接遠程主機
- 四、編輯遠程文件
- 一、安裝 Python 相關插件
- 二、選擇Python解釋器
- 三、Python 代碼編輯、運行與調試
摘要: 本文詳細介紹了使用VSCode Remote-SSH進行Python遠程開發的全流程。內容包括: SSH配置:通過修改~/.ssh/config文件設置遠程主機信息; SSH工具安裝(可選):Windows環境需手動配置OpenSSH路徑; 遠程連接與文件編輯:通過VSCode直接操作遠程文件; Python開發環境搭建:離線安裝Python插件(含Pylance等依賴)並選擇遠程解釋器; 調試技巧:支持代碼補全、運行及調試,並解決常見補全失效問題。 適用於離線服務器開發場景
大家好,這裏是[編程實踐錄]。專注於分享各種編程實踐技術。
如果你覺得這篇文章對你有幫助,不妨點個關注 👍,我會持續更新更多能讓你“準時下班”的硬核乾貨。
你的關注,是我持續創作的最大動力!
上一篇已經寫了離線安裝VSCode Remote-SSH的方法:
VS Code Remote-SSH 離線安裝詳解(含 VSIX 插件包下載與安裝步驟)
這篇接着寫VSCode Remote-SSH和Python遠程編輯和調試的方法。
這篇文章,將從遠程連接、文件操作,到Python編輯和調試,提供一個完整的使用指南。
一、配置遠程連接
打開 VSCode,按 Ctrl+Shift+P,輸入 Remote-SSH,即可看到一系列相關命令。
其中 Remote-SSH: Open SSH Configuration File... 是用來配置遠程主機的命令的,通過它可以設置遠程主機的 IP、端口、用户名等信息。
點擊後,系統會讓你選擇配置文件,選擇當前用户下的 SSH 配置文件(Windows 默認路徑為 C:\Users\用户名\.ssh\config)。打開後,你會看到類似下面的默認配置:
默認配置需要根據實際情況手動修改。
Host:為當前遠程主機起的名字,建議只使用英文和數字,以避免意外。HostName:遠程主機的 IP 地址。User:登錄遠程主機的用户名。Port:如果遠程服務器的端口不是默認的 22,需要添加該配置。
按照服務器實際情況修改後,即完成遠程連接的基礎配置。
二、安裝並配置 SSH 工具(可選步驟)
建議使用OpenSSH作為遠程連接工具。它是最常用的 SSH 客户端,支持加密遠程登錄和安全文件傳輸,兼容性好,幾乎在所有操作系統上都能使用。在 Windows 10(1809 及以上)、Windows 11 、Windows Server 2019和Windows Server 2022中,OpenSSH已經內置,通常只需啓用即可;在舊版本或特定環境中,可以手動下載安裝使用。
我的環境是Windows Server 2016,因此需要手動下載並安裝OpenSSH。
點擊這裏訪問OpenSSH官方網站
點擊這裏訪問微軟官方説明文檔
點擊這裏訪問Windows 官方下載(預編譯版本)鏈接
下載後,將壓縮包解壓到指定目錄,然後配置 SSH 路徑:
- 在
VSCode中按Ctrl+Shift+P,輸入Remote-SSH: Settings。 - 修改
Remote.SSH: Path,填寫OpenSSH的絕對路徑,要寫到ssh.exe。
完成後,VSCode 就能正確調用本地的 SSH 客户端進行遠程連接。
三、通過 SSH 連接遠程主機
在 VSCode 中,按 Ctrl+Shift+P,點擊 Remote-SSH: Connect to Host...,然後選擇之前配置好的遠程服務器。根據實際情況選擇服務器操作系統(Linux / Windows / macOS),輸入密碼後即可成功登錄。
四、編輯遠程文件
連接遠程服務器後,點擊 Open Folder...,即可打開服務器上的指定目錄,並直接編輯其中的文件,就像在本地操作一樣。
到這裏,VSCode Remote-SSH 的遠程連接和文件編輯部分就完成了。接下來,説一下如何在 VSCode 中指定遠程服務器的 Python 解釋器,以及如何更方便地編輯、運行和調試 Python 代碼。
一、安裝 Python 相關插件
需要特別注意的是:這些插件必須安裝在遠程服務器端。
如果服務器能夠聯網,直接在 VSCode 中搜索並安裝 Python 插件即可(會自動安裝 Python Environments、Python Debugger、Pylance 等依賴)。
這裏重點介紹 離線服務器 的安裝方法。整體準備和流程與上一篇《VS Code Remote-SSH 離線安裝詳解(含 VSIX 插件包下載與安裝步驟)》類似。
- 在聯網設備上下載插件
在聯網的 Windows 設備 A 上打開 VSCode,安裝 Python 插件。安裝完成後,會同時安裝 Python Environments、Python Debugger、Pylance。
選中 Python 插件,查看已安裝的版本號。
點擊右下角的小齒輪,選擇 Download Specific Version VSIX...。選擇與安裝版本一致的版本號,再選擇目標服務器對應的操作系統(例如 Linux x64),即可開始下載。
⚠️ 下載過程中可能因為網絡原因失敗,遇到這種情況多嘗試幾次即可。
依次將其他幾個插件(Python Environments、Python Debugger、Pylance)的相應平台版本也下載下來。
- 將插件拷貝到離線設備
把下載好的 .vsix文件一併拷貝到離線的 Windows 設備B。
- 在離線服務器上安裝插件
- 通過 Windows 設備B 的
VSCode,使用Remote-SSH登錄遠程Linux服務器。 - 按
Ctrl+Shift+P,輸入並選擇Extensions: Install from VSIX... - 點擊
Show Local,依次選擇剛才下載的幾個插件進行安裝。 - 這樣,在沒有網絡的環境下,順利完成了Python 插件的安裝。
二、選擇Python解釋器
使用VSCode Remote-SSH連接到遠程服務器後,按Ctrl+Shift+P->Python: Select Interpreter,即可選擇遠程服務器上的 Python 解釋器。
三、Python 代碼編輯、運行與調試
到這裏,就可以在 VSCode 中開始編輯 Python 代碼了。
由於遠程服務器上已經安裝了 Pylance,輸入代碼時會自動補全。
編碼完成後,可以通過以下方式運行或調試:
- 菜單欄
Run → Start Debugging(調試運行) - 菜單欄
Run → Run Without Debugging(直接運行) - 使用快捷鍵
F5(調試)、Ctrl+F5(運行)。
⚠️ 如果沒有自動補全,可以檢查以下幾點:
Pylance是否安裝在遠程服務器
只有安裝在遠程環境中,補全功能才會生效。- 是否選擇了正確的
Python解釋器
確認窗口右下角顯示的Python版本與實際環境一致。 - 是否需要重啓
VSCode窗口
按Ctrl+Shift+P輸入Reload Window,重新加載即可。
我自己在一開始也遇到過沒有補全的問題,最終通過執行第 3 步(Reload Window)就解決了。
還有一點小提醒:
使用 Remote-SSH 時,文件會實時保存到遠程服務器,不需要藉助額外的同步工具,非常省心。
至此,本篇的主要內容就分享完了。聊了 Python,自然也少不了 C++ ——關於 SSH 環境下C/C++的可視化編碼和調試方案,下一篇就寫這個。
下一篇,打算寫下怎麼使用Remote-SSH遠程,以及怎麼用它更方便的編輯運行python代碼,會涉及相關工具的安裝和使用。