Pythonでの開発で使用しているVSCode拡張機能

はじめに

Pythonを使ってVSCodeで開発を始めてから数カ月のPython初心者です。
数か月の中で、VSCodeのPythonに関連する拡張機能を様々使ってみて、タイプミスに気付きやすくなったり、効率化が出来るなどの拡張機能もあり、開発が非常に進めやすくなりました。
本記事では「これからVSCodeにてPythonで開発をしたいと思っている方」を対象として、よりPythonで開発が進めやすくなるVSCodeの拡張機能を紹介します。

開発環境
・WSL2/Ubuntu環境
・Python: 3.10.12

※WSL2/Ubuntu環境で以下codeコマンドを実行することで、VSCodeを起動しています。

code .

Pythonでの開発で使用しているVSCode拡張機能

Japanese Language Pack for Visual Studio Code

VSCodeで「メニュー」・「設定」などを日本語表示できる拡張機能です。

Python・Pylance

「Python」をインストールすると、「Pylance」もインストールされます。
インデントミスや文法ミスなどをチェックし、ミスがあれば「エラー」や「警告」として画面上に表示するなどの機能を持ち、Pythonの開発をサポートする拡張機能です。

Error Lens

「Pylance」などのツールで検出した「エラー」や「警告」をコード上に表示する拡張機能です。コード上で確認できるので、視覚的にわかりやすい利点があります。

Python Extension Pack

複数のPython拡張機能を含んだ拡張機能です。
後述する「Black Formatter」と「Flake8」は本拡張機能に依存しています。

Black Formatter

Pythonのコードフォーマッタ「Black」の拡張機能です。
この拡張機能を使用するまでは、コマンドライン上でblackコマンドを実行し、手動でフォーマットしていましたが、本拡張機能を使用することで「ファイルを保存した時にBlackを自動で実行する」ことができるようになり、非常に便利です。

Flake8

PythonのLinter「Flake8」の拡張機能です。
「Black」と同様に、これまでコマンドラインでflake8コマンドを実行していましたが、本拡張機能を使用することで、Flake8の実行をVSCode上で行うため、開発が効率的になりました。

参考）settings.jsonの設定

「Flake8」と「Black Formatter」についての設定を以下「settings.json」に記載します。

settings.json

{
    "flake8.args": [
        "--max-line-length=88"
    ],
    "[python]": {
        "editor.defaultFormatter": "ms-python.black-formatter",
        "editor.formatOnSave": true
    }
}

おわりに

本記事では、よりPythonで開発が進めやすくなるVSCodeの拡張機能を紹介しました。
本記事の内容が少しでも何かの役に立てば幸いです。

参考文献

本記事は以下情報を参考にして執筆しました。