【VSCode】Pythonを1行毎に変数の中身見ながらステップ実行する方法

Pythonのプログラムをステップ実行するために、VSCode(Visual Studio Code)でデバッグ環境を構築しました。VSCodeは動作も速く、手軽にステップ実行もできて効率的に開発できます。

Python自体は文法が簡潔で読みやすいので、プログラミングの入門用の言語として初心者にオススメです。また、最近流行りの人工知能（AI）や機械学習、統計に使えるライブラリが豊富に有るので、覚えておきたい言語です。

私の環境は以下の通りです。

プログラムのステップ実行とは？

冒頭のアニメーションのように、プログラムを1行ずつ（もしくは複数行）動かしては止めてを繰り返しながら、プログラムの流れを追うデバッグの方法です。

任意の行にブレークポイントを設置することで、実行中のプログラムをその行で止めることもできます。

ステップ実行ができる環境を構築すると、以下のことが可能になります。

この記事では、/private/tmpをカレントディレクトリ（作業ディレクトリ）として使用します。ターミナルアプリを開いて、cdコマンドで移動しておきます。

$ cd /private/tmp
$ pwd
/private/tmp
$

後述するコマンドは、全てこのディレクトリで実行するものとします。（基本的にコマンドを実行するディレクトリが統一されていれば、どこでもOKです。）

VSCodeのダウンロードページへアクセスして、[Download for Mac]を押すと、VSCodeのzipファイルがダウンロードできます。

ダウンロードしたzipファイルをダブルクリックすると、解凍結果としてVSCodeのappファイルが生成されます。

このまま起動しても良いですが、Macのお作法としてアプリ（.appが付いているファイル）は「アプリケーション」ディレクトリに置くのが一般的なので、後で探しやすくする意味でもそちらに移動しておきます。

アプリケーションディレクトリに移動したappファイルをダブルクリックして、VSCodeを起動します。

以下の手順で拡張機能「Python」を検索します。

拡張機能「Python」に関する情報が表示されるので、[インストール]をクリックしてインストールできます。

インストールが完了したら、[再読み込み]を押すと拡張機能が使用可能になります。

例として、以下のプログラムsample.pyを使用します。冒頭のアニメーションと同一のものです。

def plus(x, y):
  print(f"{x} + {y} =")
  return x + y

a = "Hello"
b = " World!"
c = plus(a, b)
print(c)
c = plus(2, 3)
print(c)

まず、カレントディレクトリにsample.pyを作成します。

$ touch sample.py

sample.pyをVSCodeで開いて、上記プログラムをコピペして保存（Ctrl + S）します。

ちなみに、このプログラムの出力結果は以下のようになります。

$ python sample.py
Hello +  World! =
Hello World!
2 + 3 =
5
$

メニューバーの[デバッグ] > [デバッグの開始]を選択する（もしくはF5を押す）と、プログラムが開始されて、その1行目（黄色いハイライト行）で処理が止まります。

ここでF10を押すと、1行ずつプログラムを実行できます。

以下はF10を数回押して10行目まで実行させた状態です。下部にあるデバッグコンソールには、プログラムのその行までにあるprint文が出力した結果が表示されます。

左端の[デバッグ]アイコン（上から4つ目の虫に斜線が引かれている）を押すと、宣言されている変数の一覧（変数a, b, cなど）が左側に表示されます。

また、右側のプログラム中の変数cの上にマウスポインタを置くと、これが現在5であることが確認できます。

このようにしてステップ実行することで、プログラム実行途中での変数の状態を簡単に確認することができます。

その他にも以下のショートカットキーを用いると、デバッグをより効率良く進めることができます。

ショートカットキー	名称	処理内容
F10	ステップオーバー	今いる行の次の行まで処理を進める
F11	ステップイン	今いる行にある関数の中に入る
shift + F11	ステップアウト	今いる関数を抜けるまで処理を進める
F5	続行	次のブレークポイント、もしくはプログラム終了まで処理を進める