面向 Python 開發人員的高級 Visual Studio 代碼

目錄

掌握 Visual Studio Code 用戶界面

鍵盤快捷鍵

自定義用戶界面

設置您的終端

團隊設置與個人設置

整理和格式化

設置 Pylance

在保存時設置格式和 Lint

在 Visual Studio Code 中測試 Python 代碼

配置測試集成

執行測試

使用 Visual Studio Code 任務系統

使用任務編譯輪子

使用 Django 任務

鏈接任務

使用任務運行 Tox

使用任務資源管理器擴展

在 Visual Studio Code 中調試 Python 腳本

設置手表

配置啟動文件

掌握遠程開發

使用容器進行遠程開發

使用 SSH 進行遠程開發

使用 WSL 進行遠程開發

使用數據科學工具

安裝 Jupyter Notebook 擴展

在 VS Code 中開始使用 Jupyter Notebook

使用數據查看器

使用 Rainbow CSV 擴展

向 Visual Studio Code 添加獎勵擴展

代碼拼寫檢查器

碼頭工人

迅雷客戶端

VS Code Pets

結論

Visual Studio Code，簡稱VS Code，是微軟提供的免費開源代碼編輯器。您可以將 VS Code 作為輕量級代碼編輯器進行快速更改，也可以通過使用第三方擴展將其配置為集成開發環境 (IDE)。在本教程中，您將了解如何充分利用 VS Code 進行 Python 開發。

在本教程中，您將學習如何配置、擴展和優化VS Code，以獲得更有效的 Python 開發環境。完成本教程后，您將擁有各種工具來幫助您更高效地使用 VS Code。它可以成為快速 Python 開發的強大工具。

在本教程中，您將學習如何：

自定義您的用戶界面

運行和監控Python 測試

自動整理和格式化您的代碼

利用類型注釋和Pylance以更高的精度更快地編寫代碼

配置和利用本地和遠程調試

設置數據科學工具

像往常一樣，本教程充滿了鏈接、提示和技巧，可以幫助您繼續前進。

如果您尚未安裝Visual Studio Code或Python 擴展，則本教程將需要兩者。如果您剛剛開始使用 VS Code，您可能需要先查看 Jon Fincher 的Visual Studio Code 中的 Python 開發教程，然后再繼續本教程。

掌握 Visual Studio Code 用戶界面

默認情況下，VS Code 的用戶界面是為所有人設計的——無論您是編寫 C++、使用 JavaScript 和 CSS 進行前端開發，還是使用 Jupyter Notebooks 等數據科學工具。在第一部分中，您將探索如何定制 VS Code 以支持您的工作方式。

鍵盤快捷鍵

對于您在 VS Code 中所做的幾乎所有事情，您都可以直接從鍵盤上完成。您可以將 VS Code 中的所有活動（無論它們是內置的還是通過擴展提供的）映射到鍵盤快捷鍵。

一小部分內置命令已經映射到鍵盤快捷鍵中。如果您想了解這些默認快捷方式，請打印適用于Windows、macOS或Linux的 PDF?，并將其固定在您的顯示器旁邊。

作為 Python 開發人員，您將在 Visual Studio Code 中使用的許多命令都是從擴展中提供的，類似于您已經安裝的 Python 擴展。這些默認情況下沒有映射的快捷鍵，但您可以使用 VS Code 的鍵盤快捷鍵編輯器配置它們。

在 macOS 上，通過轉至文件 → 首選項 → 鍵盤快捷鍵或代碼 → 首選項 → 鍵盤快捷鍵，打開鍵盤快捷鍵編輯器：

在此編輯器中，您可以看到所有現有快捷方式的列表及其詳細信息：

命令：要運行的命令或操作

Keybinding：按下以觸發此命令的鍵序列，空白表示沒有映射

When：此鍵綁定工作需要滿足的條件，帶有減號 (?-) 表示沒有要求

Source：配置此綁定的位置，由Default、User或Extension定義，最后一個表示您通過安裝鍵盤映射擴展來提供它

要覆蓋現有綁定，請右鍵單擊現有操作并單擊更改鍵綁定。要將鍵綁定分配給沒有綁定的命令，請雙擊它。如果您按下的按鍵序列已分配給其他東西，VS Code 將通過鏈接警告您，以查看哪些命令映射到此按鍵綁定。

例如，python create terminal在頂部的搜索框中鍵入。如果沒有結果出現，請確保安裝了 Python 擴展。按Enter指定按鍵綁定，就像Ctrl+?Alt+T，然后打Enter一次。

要指定該快捷方式僅在您編輯 Python 代碼時起作用，請右鍵單擊該快捷方式并選擇Change When Expression。輸入表達式editorLangId == 'python'：

如果您需要更具體的內容，還有更多條件運算符可供選擇。以下是一些幫助您入門的示例：

使用resourceFilename == '__init__.py'時，該文件你是編輯__init__.py

使用editorLangId == 'python'與Python工作時。如果需要，您還可以替換'python'為其他語言標識符。

使用editorHasSelection的，當你在編輯器中。

一旦你配置了這個擴展，在編輯器中打開一個 Python 文件，通過按你新分配的鍵盤快捷鍵Ctrl+?Alt+T打開一個 Python 終端來嘗試它。

在本教程中，您將多次參考命令面板。VS Code 中的大部分功能都可以通過 UI 從上下文菜單訪問，但您不會在那里找到所有內容。可以在核心編輯器中或通過擴展完成的任何事情都可以在命令面板中使用。您可以通過按以下鍵盤快捷鍵之一進入命令面板：

macOS:?F1或Cmd+?Shift+P

Windows 或 Linux：?F1或Ctrl+?Shift+P

要運行命令，請鍵入其描述性名稱，例如Python: Run All Tests.?命令面板啟動并且您想要的命令位于菜單頂部后，單擊右側的齒輪以分配鍵盤快捷鍵：

一旦您開始定期使用命令面板，您可能會發現有五到十個命令是您經常運行的。為這些命令分配一些快捷方式，以節省一些額外的擊鍵次數。

如果您已經在其他編輯器或 IDE 中工作了一段時間，您可能會將常用的 鍵盤快捷鍵用于肌肉記憶。

您會在Vim、IntelliJ 和 PyCharm、Sublime Text、Notepad++、Emacs和Atom 的擴展中找到有用的鍵盤映射。

如果您以前的編輯器不在此列表中，您可能會發現其他人為您創建了映射擴展。Keymaps是VS Code 擴展市場上的一個有用的類別。

安裝鍵盤映射擴展后，您還可以找到其他選項來自定義默認設置之外的它。例如，您可以使用 Vim 鍵盤映射擴展來配置 Vim 功能，例如是否以插入模式啟動。

自定義用戶界面

跳上汽車駕駛座時，首先要做的就是調整座椅、調整后視鏡、將轉向柱調到合適的高度。代碼編輯器也不例外。它們帶有默認布局，對每個人都適用，但對任何人都不是特別好。你不想伸展到踏板。讓我們設置適合您的 VS Code 環境，并讓它在運行過程中看起來很棒。

首先，VS Code 左側的活動欄是在用于查看文件的資源管理器視圖、源代碼控制視圖、搜索視圖、運行和調試視圖以及擴展視圖之間切換的主要導航工具.?您不僅限于這些選項。許多擴展帶有默認隱藏的視圖。右鍵單擊活動欄以控制您看到的視圖：

您還可以使用此菜單隱藏您從不使用的任何視圖。請記住，您不僅限于列表中的視圖。如果主視圖中有一些面板——例如，您可以找到一些嵌套在Explorer視圖中的附加面板——您可以將它們拖到活動欄中以創建永久快捷方式：

將此功能用于您一直使用的視圖。

Python 的風格指南PEP 8傾向于較短的行長度。對于寬屏幕，這會留下很多未使用的屏幕空間。

當您發現自己需要在兩個或多個文件之間切換時，請使用拆分面板功能一次顯示多個編輯器區域。您可以使用命令通過命令面板訪問此功能View: Split Editor。

或者，您可以使用相關的鍵盤快捷鍵：

macOS：?Cmd+\

Windows 或 Linux：?Ctrl+\

您還可以通過轉到“查看”→“編輯器布局”或右鍵單擊文件選項卡來打開拆分編輯器功能：

當使用左側的測試代碼和右側的模塊編寫單元測試時，此設置非常有用。

某些文件類型（例如 Markdown）具有您可以使用的預覽區域。使用Markdown: Open Preview to the Side命令打開預覽編輯器。

如果您需要在 VS Code 中將注意力完全集中在單個文件或任務上，請通過轉到“視圖”→“外觀”→“Zen 模式”來使用 Zen 模式，以顯示僅包含編輯器的全屏窗口：

此功能對于屏蔽嘈雜的干擾和通知特別有用，這樣您就可以專注于完成當前的任務。

VS Code 在VS Code Marketplace 中有一個巨大的主題庫。一些最流行的主題是Material Theme、Winter is Coming、Dracula、Noctis和Monokai Pro。

讓我們專注于Material 主題，因為它提供了廣泛的配色方案以滿足多種口味。您可以從擴展視圖安裝擴展。安裝后，您可以通過Preferences: Color Theme在命令面板中運行來選擇顏色主題。

Material Theme 最好使用自定義圖標主題。圖標主題是獨立于顏色主題的擴展，因此您必須安裝第二個擴展。pkief.material-icon-theme在擴展視圖中搜索以找到最流行的主題材質圖標包。安裝后，VS Code 會提示你切換圖標包。

這是帶有 Palenight 顏色主題和 Material 圖標包的 Material 主題：

您可以隨時從命令面板更改圖標主題，方法是使用命令Preferences: File Icon Theme然后從列表中選擇圖標主題之一。

編程字體是一組特殊的字體，通常帶有稱為monospace 的固定寬度字符。ProgrammingFonts.org上有一長串可用字體可供瀏覽：

選擇字體后，請轉到Nerd Fonts下載它并在您的操作系統上安裝該字體。Nerd Fonts 的下載是等寬字體的副本，支持字形，也稱為圖標，您可以在終端提示中使用。

安裝所選字體后，您需要將editor.fontFamily設置更改為新字體的名稱。您可以通過導航到代碼 → 首選項 → 設置，然后在導航下拉列表中選擇文本編輯器 → 字體來實現。您可以通過在字體系列設置的第一個字段中添加新字體的名稱來更改編輯器將使用的字體。

設置您的終端

您將在 shell 終端中花費大部分 Python 開發時間。您可以使用單獨的應用程序，例如 iTerm2 或 Windows 終端，但 VS Code 已經具有強大的內置終端窗口。

因為 VS Code 確實需要一些配置才能使其與專用終端應用程序一樣強大，所以您現在就可以進行設置。

您可以將終端窗口重新配置為具有多個配置文件。當您生成新終端時，這些配置文件形成下拉列表。

VS Code 允許您配置多個終端配置文件。您無法在設置 UI 中編輯終端配置文件，因此您需要使用Preferences: Open Settings (JSON)命令面板中的命令打開settings.json文件。您會注意到鍵值對構成了設置文件。每個鍵代表 VS Code 或其擴展之一的配置設置。

共有三種終端配置文件設置，它們的名稱如下：

輸入名稱后，編輯器會自動將默認配置文件填充到 JSON 文件中。

請注意，默認設置中沒有 Python REPL 配置文件。您可以將帶有密鑰"python3-repl"的配置文件添加到集成配置文件 JSON 文件中，以便 VS Code 將其作為配置文件選項提供，并將您直接帶到 REPL 提示：

"python3-repl": { "path": "python3", "args": ["-q"] }

該-q標志是一個 Python 命令行標志，用于停止顯示版本標頭。您可以將任何額外的 Python 命令行標志添加到"args".

配置后，您的配置文件應如下所示，具體取決于您的操作系統：

"terminal.integrated.profiles.osx": { "bash": { "path": "bash", "icon": "terminal-bash", }, "zsh": { "path": "zsh" }, "pwsh": { "path": "pwsh", "icon": "terminal-powershell", }, "python3-repl": { "path": "python3", "args": ["-q"] } },

VS Code 有兩種終端啟動模式：集成和外部。配置配置文件后，您可以通過設置以下值來為集成終端設置默認配置文件"terminal.integrated.defaultProfile.osx"：

"terminal.integrated.defaultProfile.osx": "zsh",

如果某些內容在外部終端中啟動，它將使用您操作系統的默認 shell。如果您更喜歡不同的終端應用程序，例如適用于 macOS 的iTerm 2或適用于 Windows 的Windows Terminal，您也可以更改默認的外部終端：

"terminal.external.osxExec": "iTerm.app",

例如，對于 macOS 的此設置，您是說 VS Code 每次啟動外部終端窗口時都應該啟動 iTerm 應用程序。

您可以在 VS Code 中更改更多有關終端的設置。例如，您可以讓 VS Code 在您打開新的終端窗口時自動激活您的虛擬環境，并且您可以通過添加自定義提示來自定義終端的外觀。您將在本教程中探索如何做到這兩點。

虛擬環境對于跨 Python 項目管理多個依賴項非常重要。一旦選擇了解釋器，Visual Studio Code 將激活任何Python 虛擬環境。如果您已有虛擬環境，請Python: Select Interpreter從命令面板運行以選擇 Python 解釋器虛擬環境。

如果您沒有，請在終端內創建一個。如果虛擬環境路徑命名為、 或.venv/，VS Code 可以自動選取它。env/venv/

設置解釋器后，當您在 VS Code 中啟動一個新的終端窗口時，您將自動激活虛擬環境：

如果您已經打開了一個終端，您可以通過單擊垃圾桶圖標來銷毀它。

您在終端內運行的任何命令，例如python -m pip install，都將用于激活的虛擬環境。

在上面的屏幕截圖中，您可以看到使用 Oh My Posh 提示工具包的自定義命令提示符。在下一部分中，您將安裝和配置 Oh My Posh。Oh My Posh 是可選的，特別是如果您已經安裝了自定義命令提示符。

Oh My Posh是用于自定義終端命令提示符的眾多庫之一。它適用于 Linux、macOS 和 Windows。它還適用于所有 shell，如 Bash、Zsh、Fish 和 powershell。您可以安裝 Oh My Posh 來為您的終端增添趣味。

如果您使用的是 macOS 并使用 Bash，請運行以下命令來安裝 Oh My Posh：

$ brew tap jandedobbeleer/oh-my-posh $ brew install oh-my-posh $ curl https://github.com/JanDeDobbeleer/oh-my-posh/raw/main/themes/tonybaloney.omp.json -sLo ~/.mytheme.omp.json $ echo "eval \"$(oh-my-posh --init --shell bash --config ~/.mytheme.omp.json)\"" >> ~/.profile $ . ~/.profile

如果您使用的是 macOS 并使用 Zsh，請運行以下命令來安裝 Oh My Posh：

$ brew tap jandedobbeleer/oh-my-posh $ brew install oh-my-posh $ curl https://github.com/JanDeDobbeleer/oh-my-posh/raw/main/themes/tonybaloney.omp.json -sLo ~/.mytheme.omp.json $ echo "eval \"$(oh-my-posh --init --shell bash --config ~/.mytheme.omp.json)\"" >> ~/.zprofile $ . ~/.zprofile

如果您使用的是 Windows 并使用 PowerShell，請運行以下命令來安裝 Oh My Posh：

PS C:\> Install-Module oh-my-posh -Scope CurrentUser PS C:\> Add-Content $PROFILE "`nSet-PoshPrompt -Theme tonybaloney"

最后，如果您使用的是 Linux 并使用 Bash，請運行以下命令來安裝 Oh My Posh：

$ sudo wget https://github.com/JanDeDobbeleer/oh-my-posh/releases/latest/download/posh-linux-amd64 -O /usr/local/bin/oh-my-posh $ sudo chmod +x /usr/local/bin/oh-my-posh $ curl https://github.com/JanDeDobbeleer/oh-my-posh/raw/main/themes/tonybaloney.omp.json -sLo ~/.mytheme.omp.json $ echo "eval \"$(oh-my-posh --init --shell bash --config ~/.mytheme.omp.json)\"" >> ~/.bashrc $ . ~/.bashrc

當你在 VS Code 中打開一個新終端時，你會得到這樣的提示：

終端上的組件是文件夾、Git 分支和 Python 版本。查看主題列表以了解其他一些選項。

注意：如果您使用自定義終端提示，如Oh My Posh或Oh My Zsh，則必須選擇已安裝的Nerd 字體之一，以便在 VS Code 中正確呈現字形。

默認情況下，終端將使用您為編輯器配置的相同字體，editor.fontFamily.?您可以通過為terminal.integrated.fontFamily標識符定義不同的字體系列來覆蓋它。您還需要更新您使用的任何外部終端應用程序。

團隊設置與個人設置

VS Code 有兩個級別的設置：

用戶設置，適用于所有項目

工作區設置，僅適用于該工作區

如果在兩者中都聲明了設置，則工作區設置將覆蓋用戶設置。

VS Code 的工作區配置及其所有擴展都位于.vscode/工作區根目錄中。

將與項目無關的設置放入用戶設置，將特定于項目的設置放入.vscode/.?通過將您的個人用戶設置與項目設置分開，您和從事該項目的任何其他開發人員都可以更有效。

默認情況下，Visual Studio Code 的 Python 擴展有一個非常基本的配置。許多功能（如 linting、格式化和安全檢查）被禁用，因為您需要安裝 Black、Pylint 和 Bandit 等第三方工具才能使用它們。

您可以使用pipx或安裝這些工具并使它們可用于每個虛擬環境pip install --user。pipx更可取，pip install --user因為它將為該包創建和維護一個虛擬環境，使您的全局站點包更小并降低打包沖突的風險。

一旦你已經安裝了pipx，你可以安裝常用工具：

$ pipx install pylint && \ pipx install black && \ pipx install poetry && \ pipx install pipenv && \ pipx install bandit && \ pipx install mypy && \ pipx install flake8

或者，使用python3 -m pip install --user安裝常用工具：

$ python3 -m pip install --user pylint black poetry pipenv bandit mypy flake8

安裝基本工具后，從命令面板中打開用戶設置Preferences: Open Settings (JSON)。為要應用于所有項目的首選項添加設置：

1"python.pipenvPath": "${env:HOME}/.local/bin/pipenv", 2"python.poetryPath": "${env:HOME}/.local/bin/poetry", 3"python.condaPath": "${env:HOME}/.local/bin/conda", 4"python.linting.enabled": true, 5"python.linting.banditPath": "${env:HOME}/.local/bin/bandit", 6"python.linting.banditEnabled": true, 7"python.linting.pylintPath": "${env:HOME}/.local/bin/pylint", 8"python.linting.mypyPath": "${env:HOME}/.local/bin/mypy", 9"python.linting.flake8Path": "${env:HOME}/.local/bin/flake8", 10"python.formatting.blackPath": "${env:HOME}/.local/bin/black",

使用這些設置，您已經成功完成了一些對跨多個項目的開發工作流有用的事情：

行1至3啟用項目包發現啟用pipenv，poetry和conda。

第 4 行啟用 Python linting。

第 5 到 6 行啟用并將路徑設置為bandit.

線7至10啟用的Python格式化和路徑設定為一個全局安裝的實例pylint，mypy，flake8，和black。

在每個絕對路徑中，您可以使用宏自動替換您的主文件夾${env:HOME}。

在用戶設置之外，您可以使用.vscode/工作區內的目錄來配置一些特定于項目的設置：

運行哪些命令來執行項目

如何測試和調試項目

其中棉短絨和格式來使用和任何項目特定參數

以下文件包含 VS Code 首選項：

VS Code 的大部分設置，以及擴展的設置，都在這三個文件中。

在工作區首選項中，支持以下預定義變量：

使用這些變量將使項目設置與環境無關，因此您可以將它們提交到 Git。

作為使用這些設置的示例，如果您想使用 Black 作為此項目的默認代碼格式化程序，您可以.vscode/settings.json使用以下配置創建文件：

{ "python.formatting.provider": "black", }

任何簽出此項目的人現在都將自動使用 Black 作為 Python 文件的格式化程序。您將在有關設置 format 和 lint on save的部分中看到此設置如何影響自動格式化選項。

如果您在多臺計算機上使用 VS Code，則可以啟用設置、鍵盤快捷鍵、用戶代碼段、擴展和 UI 狀態的自動同步。如果您之前未使用過設置同步，則需要啟用它：

Settings Sync: Turn On在您的命令面板中運行。

按照 VS Code 提示的設置步驟進行操作。您可以使用 GitHub 進行身份驗證。

設置完成后，Settings Sync: Configure從命令面板運行。

選擇要同步的內容。

在安裝了 VS Code 的所有計算機上配置了 Settings Sync 后，您可以通過Settings Sync: Show Synced Data從 Command Palette運行來查看每個同步設置的狀態，它們將顯示在Synced Machines 下：

此視圖顯示每個設置的上次同步時間以及同步的機器。

整理和格式化

IDE Python Visual Studio

版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。

版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。