在Visual Studio Code中設定Python的自動格式化


我正在寫Python代碼,並遇到了格式化問題。這些格式問題可能會使代碼審查變得複雜,並對使用自動工具來檢測這些問題產生影響。幸運的是,當你將格式化工具集成到您的代碼編輯器中以在保存時自動修復這些問題時,生活會變得容易許多。這就是如何做的:

  1. 首先,安裝Google的yapf格式化工具:

    pip install yapf
    
  2. 接著,打開你的Visual Studio Code編輯器。如果你使用的是Mac,按“Command + Shift + P”,如果你在Linux上,按“Ctrl + Shift + P”。在搜索欄中輸入”Open settings (JSON)“並添加以下行:

    "python.formatting.provider": "yapf"
    
  3. 如果你希望你的代碼在保存時自動格式化,而不僅僅是在編輯器內部接收提示,也可以添加這個設置:

    "editor.formatOnSave": true
    
  4. 如果你希望使用你的項目的.style.yapf而不是全局樣式,則添加以下行:

    "python.formatting.yapfArgs": ["--style", ".style.yapf"]
    

現在你可以測試自動格式化功能。例如,如果你的Python文件末尾沒有新行,然後你保存它,格式化工具將自動為你修正這個問題。