VS Code 的 Python 擴充和設定

說明

整理 Visual Studio Code 與 Python 相關的設定和建議安裝的擴充功能，情勢越來越不對勁，Visual Studio Code 在編輯 Python 腳本，已經不是安裝一個 Python 擴充就能解決了，出現多種語法檢查器和格式化風格。

安裝 Python 擴充功能

第一步還是得先推薦安裝 Python 擴充功能，這是 Python 的核心。

Python 語言伺服器

語言伺服器會給予語法的提示選項和說明，例如輸入 p 之後應該會看到 print 選項，使用官方推薦的 Pylance

Python 語法檢查

這裡我推薦兩款擴充功能

1. Pylint
2. Flake8

這兩款都是安裝就能使用，而且可以一起使用，以我寫本篇文章時 Pylint Github 星星數比較多，只想安裝一款的話可以優先選擇 Pylint。

Flake8 設定

settings.json

{
  "python.linting.flake8Args": [
    // 每行字數上限
    "--max-line-length=100"
  ]
}

Python 格式化

這裡推薦兩個

1. autopep8
2. Black Formatter

autopep8 比較中規中矩主要以符合 pep8 規範，Black 會強制比較多編碼風格，因當時我看 Black Github 星星比較多就選擇 Black，如果是團隊共同開發，建議要統一格式，方便維護和閱讀。

Black Formatter 設定

settings.json

{
  "python.formatting.provider": "black",
  "[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter"
  },
}

Python 環境

按 ⇧⌘P 顯示指令面板，輸入 Python: Create Environment... 可以建立一個虛擬環境，但在我寫這篇文章時，發現用這種方法建立 Python 虛擬環境在 VS Code 內建的終端機中沒有切換相對的版本，假設你也碰到相同的狀況，你可以使用手動的方法如下。

在 VS Code 內建的終端機中下 python3 -m venv .venv 指令，如果你要用 python 3.9 版，那就是下 python3.9 -m venv .venv 指令，內建終端機預設的路徑是當前專案，你可以把它當作建立的虛擬環境是專門給當前專案使用，用 .venv 資料夾是比照 Python: Create Environment... 使用的路徑，詳細內容請參考 Using Python environments in VS Code 。

關於 python venv 其他指令可以參考我寫的 Python 建立虛擬環境 。