VSCodeでPythonの開発を行う際には、リアルタイムにコードチェックを行う設定が可能です。この記事では、その設定方法を詳しく説明します。
Pythonのコードチェックツール
Pythonのコードチェックにはいくつかの種類があります。VSCodeで設定できるものだけでも以下の通りです。
- bandit
- flake8
- mypy
- prospector
- pycodestyle
- pydocstyle
- pylama
- pylint (default)
それぞれの特徴などはこの記事では詳しく説明しませんが、今回はflake8を使用します。
flake8とは
flake8はPythonのための静的解析ツールです。VSCode用にcornflakes-linterというプラグインがあり、導入することで入力に合わせてリアルタイムにコードチェックを走らせることができます。
flake8のインストール方法
flake8をインストールするには、以下のコマンドを実行します。
pip install flake8
cornflakes-linterプラグインのインストール
VSCodeのMarketplaceからcornflakes-linterをインストールします。
VSCodeでの設定方法
VSCodeでflake8とcornflakes-linterを設定する方法を以下に示します。
- ファイル＞ユーザ設定＞設定で設定画面を開く
- cornflake等のキーワードで検索するとCornflakes>Linterの項目が出てくるので、設定する
- flake8のインストール先パス
- コードチェックのタイミング（今回はリアルタイムにしたいので onType を選択）
以上で設定は完了です。これで.pyファイルを編集すると、コードチェックが動作するようになっているはずです。
まとめ
VSCodeでPythonのコードチェックをリアルタイムに行う設定方法を説明しました。これにより、誤った入力（変数名のタイポなど）をしたときにすぐ気づけたり、書きながら「あ、こういう書き方駄目なのか」とすぐフィードバックが得られたりとメリットも多いです。PythonでWeb開発をされている方にはぜひ一度お試しいただきたいです。