VS Code上でPythonのコードフォーマッタが効かない時の対応方法

2021年3月6日 2022年12月29日

概要

久しぶりにVS Code上でPythonのコードを書いた際に、保存時にコードフォーマッタが効かずに困った際に対応した忘備録です。
現象としては、下記のようにPythonをCommand+Sで保存した際にコードフォーマットがされずに下記のような文言が表示されている状態となっていました。
（拡張機能 Prettier - Code Formatterはxxxx.pyをフォーマットできませんというエラーメッセージが表示。）

DMM Booksで技術書が最大75%お得なセールを実施中。オススメ&ポチった書籍の紹介

原因と対応

結論から言うと、以前下記で対応したprettierの設定のせいでした。

VS Codeでprettierの自動フォーマット保存が効かなくなっていた時の対応

VSCode上のデフォルトのフォーマッタとしてprettierを指定していますが、pythonには対応していないためフォーマッタが機能せずにエラーとなっていました。

VSCode上の設定は言語別に設定可能なため、下記のようにpythonの時にはデフォルトフォーマッタをnullに設定する事で解決。

"editor.defaultFormatter": "esbenp.prettier-vscode"
"[python]": {
 "editor.defaultFormatter": null
}

"editor.defaultFormatter": "esbenp.prettier-vscode"

"[python]": {

"editor.defaultFormatter": null

}

代わりにpython用のlinterやformatterを有効にする設定を流し込みます。
この辺りの設定は色々とお好みで。

{
    "editor.formatOnSave": true,
    "python.formatting.provider": "autopep8",
    "python.linting.enabled": true,
    "python.linting.pylintEnabled": false,
    "python.linting.flake8Enabled": true,
    "python.linting.flake8Args": ["--ignore=E402, E501, W503"],
    "python.formatting.autopep8Args": [
      "--ignore",
      "E50",
      "--max-line-length",
      "120",
      "--aggressive"
    ],
    "python.jediEnabled": false,
    "python.linting.mypyEnabled": true
}

{

"editor.formatOnSave": true,

"python.formatting.provider": "autopep8",

"python.linting.enabled": true,

"python.linting.pylintEnabled": false,

"python.linting.flake8Enabled": true,

"python.linting.flake8Args": ["--ignore=E402, E501, W503"],

"python.formatting.autopep8Args": [

"--ignore",

"E50",

"--max-line-length",

"120",

"--aggressive"

"python.jediEnabled": false,

"python.linting.mypyEnabled": true

}

参考元
https://dev.to/eegli/quick-guide-to-python-formatting-in-vs-code-2040