Visual Studio Code でPythonファイルをデバッグする方法

デバッグとは

まず、デバッグとは何なのか。Wikipediaによると、

デバッグ（debug）とは、コンピュータプログラムや電気機器中のバグ・欠陥を発見および修正し、動作を仕様通りのものとするための作業である。

つまり、デバッグを行うことでコードの中の問題点をより早く修正することができます。

Visual Studio CodeでPythonファイルをデバッグする方法

拡張機能をインストール

まず、画面左のバーの中からExtentionsというボタンをクリックし(もしくはコマンドでCtrl＋ Shift＋ X)、Pythonと検索し、画像にあるPythonという拡張機能をインストールしてください。

ファイルを実行する

実行したいファイルに移動して、Runの中のStart DebuggingもしくはF5をクリックし、

Python Fileを選択してください。すると、すぐにデバッグが始まります。でもこのままではプログラムが止まることなく最後まで実行されてしまいます。それではデバッグの意味が無いので次の操作をします。

ブレークポイント(Breakpoint)を設定する

この画像の行数の左側にある赤い丸がブレークポイントです。デバッグを始めると、この行で実行を止めてくれます。設定の仕方は赤丸の位置をクリックするだけです。解除も同様にできます。また、ここで最も大事なことはブレークポイントで実行が止まりますが、その行はまだ実行されていないということです。もしの画像の状態でデバッグをすると2行目まで実行され、3行目は実行されずに止まります。

デバッグ中に出てくるバーについて

デバッグを始めると上の画像のようなバーが出てきます。左から、Continue,Step Over, Step Into, Step Out, Restart, Stopとなっています。簡単に解説すると次のようになっています。

Continue

次のブレークポイントまでプログラムを実行

Step Over

プログラムを一行だけ実行

Step Into

関数が呼ばれるとその中に入ってプログラムを実行

Step Out

入っている関数から抜け出す

Restart

一度プログラムの実行をやめて、再び実行を始める

Stop

プログラムの実行を終了する

デバッグ中に役立つ知識

このプログラムを4行目まで実行してdt_nowにカーソルを合わせると、

このようにdt_nowの中に入っている値をすべて見ることができます。
例えばここで

print(dt_now.second)

とすると46が取り出せます。
変数の中にどんな値が入っているのか調べるためにprintを使っているととても大変です。しかしデバッグをすると一発で分かってしまいます。これがデバッグを行う一番のメリットだといっても過言ではないと私は思います。

最後に

ぜひあなたがこれまでデバッグを試したことなければ、一度でいいので試してみてください。