VSCodeでPythonを使用する際に便利な拡張機能を紹介します。
動作環境
・Kubuntu 22.04
・Visual Studio Code 1.90.0
対象
・本記事はPythonの初学者、初級者に向けた記事になります。
Black Formatter
コードフォーマッターの拡張機能です。
コードフォーマッターというのは自動でソースコードを整形してくれる機能になります。
これがとても便利。
私はコードフォーマッターという存在を知らなかったので、この拡張機能の便利さに感動しました。
Black Formatterはある一定のルールに従って、Pythonのソースコードを自動整形してくれます。
拡張機能をインストールしたらVSCodeの設定(setting.json)に下記を設定します。
"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter",
"editor.formatOnSave": true
}上記設定を行うと、ファイルを「保存」したタイミングでBlack Formatterの処理が走り、Pyhtonコードを自動整形してくれます。
Flake8
Flake8はもともとPythonのコードチェッカーライブラリです。
このFlake8をVSCodeのリンターとして使用できるのがこの拡張機能「Flake8」です。
リンターとはソースコードを一定のルールで解析して、指摘を行うツールの呼び方です。
Pythonでは、「PEP8」と呼ばれるコーディング規約があります。
Flake8はこの「PEP8」の規約に沿ってソースコードを解析してくれるツールです。
VSCodeの拡張機能「Flake8」をインストールすれば特に設定もせず使用することができます。
PEP8のコーディング規約に準拠していなければ、下記のように波線が出ていると思います。
波線にカーソルを当てる。または、表示タブから、「問題」のウィンドウを表示すれば、警告の内容を確認することができます。
↑ 関数と関数の間には2行の改行を入れてね。という警告と、必要ない空白があるよ。という警告が出ています。
波線が出てるとエラーっぽく感じますが、エラーではないです。注意。
isort
isortはimport文の並び順をチェックするライブラリになります。
そのisortをVSCode上で使用できる拡張機能が「isort」です。
Black Formatterと合わせて下記のようにsetteing.jsonを設定すると、ファイル保存のタイミングで自動的にimport文の並び順を整頓してくれます。
"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter",
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.organizeImports": true
},
},
"isort.args":["--profile", "black"],
Mypy Type Checker
Mypy Type CheckerとはPythonのライブラリMypyをVSCode上で使用するための拡張機能です。
MypyとはFlake8やisortと同じようにPythonのライブラリで、Pyhtonコードの型チェックを行ってくれるライブラリになります。
その型チェックをVSCode上で行ってくれるのがMypy Type Checkerになります。
インストールすれば特別な設定なしに使用できます。
まとめ
今回はVSCode上で使用するPyhtonの拡張機能についてご紹介しました。
Black Formatterは早く知っておけば良かった。と思うぐらい便利です。
Pythonをたまにしか使わない自分にとっては感動を覚えるくらい便利でした。
また、今回ご紹介した拡張機能はすべてMicrosoftがリリースしているので安心感があるのもポイントです。
参考になれば幸いです。
