Visual Studio CodeでPythonスクリプトを効率的にデバッグする方法

環境

専用の拡張機能をインストールするだけです。

Pythonと検索し、表示される下図の拡張機能をインストールします

実行したいPythonファイルを開き、ブレークポイントを設定しておきます。ブレークポイントを設置した行には赤い点が表示されます

ブレークポイントとは、デバッグの処理を止めたい箇所のことです。ブレークポイントを設定した行の処理は実行されません。設定したい行をクリックするだけブレークポイントを設置可能です

実行とデバックをクリックします

Python Fileを選択すると次画面でデバックが開始します

vscodeのパネル領域のターミナルタブには新しくPython Debug Consoleが開かれて、そこにプログラムを実行した結果が表示されます

下図のように、ブレークポイントを設置した行で処理が止まり、それ以前の処理で使った変数の中身が画面左側に表示されます

print文を使用して変数の中にどんな値が入っているのか調べるよりも圧倒的に効率的です。また、ソースコード上の変数にカーソールをホバーさせるだけでも変数の中身が表示され、確認可能です。

デバッグを始めると下図のようなバーが出てきます。

左から、Continue,Step Over, Step Into, Step Out, Restart, Stopです。ContinueとStopだけでも最低限デバックができます

項目	内容
Continue(続行)	次のブレークポイントまでプログラムを実行。ブレークポイントが複数ある場合、最初のブレークポイントで処理が停止するが、続けて次のブレークポイントまで処理を進める(ブレークポイントがなければ最後まで実行)
Step Over	後続のプログラムを一行だけ実行する
Step Into	ブレークポイントしているところから、行ごとにステップ実行します。関数が呼ばれるとその中に入ってプログラムを実行(関数が呼ばれているところにくると、その関数の中に入ってステップ実行)
Step Out	ブレークポイントしているところから、行ごとにステップ実行します。ステップ実行しているところが、関数の中であった場合、関数が呼ばれているところまで実行して関数を抜けます
Restart(再起動)	一度プログラムの実行をやめて、再び実行を始める
Stop	デバックの停止

エディターのサイドメニューのブレークポイントのエリアから、プロジェクト内でブレークポイントを設置している箇所の一覧が確認でき、チェックを外すとブレークポイントも解除できます

いかがでしたでしょうか。本記事では、Visual Studio CodeでPythonスクリプトを効率的にデバッグする方法について紹介しています。拡張機能を入れるだけですぐにデバックできるようになりますので、ぜひ試してみてください。