【2023年度版】VSCodeでPythonの開発環境を整えよう

はじめに

Python＋VSCodeで開発を進める上で、入れた方がいい拡張機能や、やった方がいい設定を紹介します。

※私が実際に行っている設定です

注意事項

このブログでは以下のことについては説明しません。

　・Pythonの導入方法

　・VSCodeのインストール方法

導入する拡張機能

　・Python

　　→Pythonを使用する上での基本的なことを手伝ってくれます

　　　例）仮想環境の設定、デバッグ

　・Pylance

　　→Pythonの入力補完などPythonでコーディンする際の作業を楽にしてくれます

　・Flake8

　　→PEP8（※）のルールに則ってコードのチェックを行ってくれます

　・autopep8

　　→コードをPEP8のルールに則って自動で修正してくれます

　・indent-rainbow

　　→インデントに色を付けてくれます

※PEP8とは、Python標準のコーディング規約です。

　Pythonで開発する際は、基本的にこのコーディング規約に則ってコードを書いていく事が多いです。

導入手順

■基本編

　拡張機能を導入する上での基本操作を説明します。　

　○拡張機能のインストール方法

１．拡張機能タブを開く

2.拡張機能を検索する

3.インストールする

■インストールのみで完了するもの

　以下の４つの拡張機能はインストールした時点で使用できます。

　カッコ内の拡張機能IDで検索してインストールしてください。

　・Python（ms-python.python）

　・Pylance（ms-python.vscode-pylance）

　・indent-rainbow（oderwat.indent-rainbow）

　・Flake8（ms-python.flake8）

■autopep8

　１．拡張機能でms-python.autopep8を検索してインストールする

　２．設定画面を開く（設定（左下の歯車マーク）から開けます）

　３．ワークスペースタブを選択する

　４．「editor.defaultFormatter」で検索して、Default Formatterを

　　　「autopep8(ms-python.autopep8)」に設定する

　設定画面は下記の画像を参考に設定してください。

　５．設定画面上で「editor.formatOnSave」と検索し、チェックを入れる

次回予告

　Pythonでの開発準備について説明できたらと思います。

おまけ（それぞれの拡張機能の動作）

ここではそれぞれの拡張機能のイメージを説明します。

基本的には拡張機能の説明欄にある内容と同じですので、詳しくはそちらを見るといいと思います。

・拡張機能なしの状態

・indent-rainbow

　indent-rainbowを入れるとタブがある箇所に色を付けてくれます。

・Pylance

　Pylanceを入れるとクラスや変数に色を付けてくれます。

　また、入力補完もできるようになるためタイピングが楽になります。

・Flake8

　Flake8はpep8に従っていない箇所をわかりやすくしてくれます。

　例えば、使用していないクラスがある場合は以下のように赤い波線で

　教えてくれます。

・autopep8

　autopep8はコードを自動でpep8に沿った形に修正してくれます。

　基本的にautopep8があればFlake8は必要ありませんが、

　未使用なクラスや関数などはautopep8では修正してくれません。

　ファイルを保存すると下記のように自動で整形してくれます。

↓保存