Flake8の警告表記をエラー(赤い波線)からワーニング(黄色い波線)に変更する方法【VSCode Flake8】

技術

はじめに

以前VSCodeのPythonでのオススメ拡張機能を紹介しました。

その中のFlake8についてですが、コーディングルールに引っかかった時にVSCodeに表示されるハイライトが、デフォルトでは赤の波線なんですよね。(下図 コードが適当過ぎてすみません。。)

これ、エラーと間違いそうになるのですが、Flake8のエラーは「PEP8の規約に反しているという警告」なので、「構文が間違っていてPythonファイルが実行できないエラー」と「Flake8のエラー」は意味が異なります。

でも上記の異なるエラーが同じ表記(赤い波線)だと、「構文が間違っていてPythonファイルが実行できないエラー」と間違えて認識し、「すべて問題をつぶさないとPythonファイルが実行できないのでは?」と勘違いすることが度々あるため、不便に感じていました。

ですので、今回は、Flake8の警告の表現方法を変更する方法を紹介します。

Flake8の警告をエラーからワーニングに変更する方法

今回はFlake8の警告をエラー表記(赤い波線)からワーニング(黄色い波線)に変更する方法をご紹介します。

VSCodeの「設定」より「拡張機能」の「Flake8」の設定画面を開きます。

「Severity」という項目の設定を変更します。

項目「E」を「Warning」

項目「F」を「Warning」

上記に設定します。

変更出来たら設定は完了です。

実際に先ほどの画面でのFlake8の警告(E501)を確認してみると

黄色の波線に変更されていますね。

これで設定は完了です。

また、setting.jsonで変更する場合は下記コードを入力してください。

"flake8.severity": {
    "E": "Warning",
    "F": "Warning"
},
JSONC

これで設定画面で設定した内容と同じ設定ができます。

まとめ

Flake8の警告をエラー表記(赤い波線)からワーニング(黄色い波線)に変更する方法をご紹介しました。

こういう「エラー表記なのか、違うエラー表記なのか」という部分は細かい部分かもしれませんが、意外と気になってしまうのではないでしょうか。そうするとコーディング体験で毎回の微小のストレスを感じてしまいます。それは次第に「塵も積もれば山となる」となってしまうため、できるだけ細かい部分でも自分の快適な設定を目指していきたいですね。

参考になれば幸いです。