VSCode上でPythonのコードを実行＆デバッグする方法について解説します。
拡張機能「Python」について
VSCode（Visual Studio Code）には、エディタの機能を拡張したり追加したりできる「拡張機能」というものがあります。VSCode上でPythonのプログラムを扱う場合、拡張機能「Python」をインストールするのが一般的で、Pythonプログラムのコード補完（自動入力補助）、デバッグ機能、コードフォーマット、統合ターミナルでの実行などの機能があります。
解説動画
拡張機能「Python」のインストール
「Python」拡張機能をインストールする方法は以下のとおりです。
① VSCodeを開きます。
② 左のアクティビティバーにある「拡張機能」アイコン（四角いアイコン）をクリックします。
③ 検索バーに Python と入力します。
④ 「Python」拡張機能（Microsoft提供）を見つけ、「インストール」をクリックします。
プログラムの作成と実行
① VSCodeの上部メニューバーの「ファイル」からフォルダを開く」をクリックします。そして、プログラムファイルを格納するフォルダを選択し、「フォルダの選択」をクリックします。
（※フォルダをVSCodeにドラッグ＆ドロップしてもOKです）
② 「このフォルダー内のファイル作成者を信頼しますか？」というポップアップが表示されます。チェックボックスにチェックを入れ、「作成者を信頼します」ボタンをクリックします。
settings.jsonに対して以下のように設定すると、上記ポップアップは表示されなくなります。
“security.workspace.trust.enabled”: false
③ 「ようこそ」タブは邪魔なので閉じ、エクスプローラーの「新しいファイル」アイコンをクリックします。
④ 新しいファイル名の入力欄があるので、ファイル名を入力し、Enterを押してプログラムファイルを作成します、
（※ファイル名の例：test.py）
⑤ コード編集画面にプログラムを記述し、ショートカット（Ctrl + S）でファイルに保存します。
【コードの例】
x = 10
y = 2
z = x + y
print("x+y=")
print(z)
print("以上")
⑥ 右上の「▶（実行）」ボタンをクリックします。
⑦ ターミナルに結果が表示されたら成功です。
部分実行
部分実行とは、例えば10行あるコードのうち、5-6行目に記述されているコードのみ実行することです。
実行したいコードを範囲選択して、Shift + Enterキーで部分実行できます。
部分実行をやめる場合は、ターミナルのゴミ箱アイコンをクリックして強制終了します。
インタープリターの変更
「インタープリター」とはPythonコードを実行するプログラムのことです。拡張機能「Python」の導入後、VSCodeでPythonファイルを開いたら、Pythonインタープリターを選択し、プログラムの実行を行うことができるようになります。
Pythonインタープリターを選択して実行する具体的な手順は以下のとおりです。
① VSCodeの右下に表示されているPythonのバージョン番号（3.x.x）をクリックします。
② 使用するPython環境を選択します。
コマンドパレットを用いて選択することもできます。
① ショートカット（`Ctrl + Shift + P`）を押してコマンドパレットを開きます。
② `Python: Select Interpreter` を検索して選択します。
③ 使用するPython環境を選択します。
デバッグ
デバッグ（debug）とは、プログラムの中にある間違い（バグ）を見つけて直す作業です。つまり、プログラムが思った通りに動かないとき、どこがおかしいのか調べて、その原因を突き止めて修正します。デバッグの基本手順は以下のとおりです。
【手順】
① コードの停止したい行の左端（行番号の左）をクリックすると赤丸が表示されます。これを「ブレークポイント」といいます。ブレークポイントで指定した行は実行される直前に停止します。
② 画面右上の実行ボタン（▶）の横にある「v」をクリックし、「Pythonデバッカー：Pythonファイルのデバッグ」をクリックします。
③ デバッグが開始されます。デバッグ中は上部にツールバーが表示されます。それぞれのボタンを押すことで、様々なステップ実行を行うことができます。
| ボタン | 動作 |
|---|---|
| ▶️ 続行（F5） | 次のブレークポイントまで実行 |
| ⏭ ステップオーバー（F10） | 1行ずつ実行（関数の中には入らない） |
| ⏬ ステップイン（F11） | 関数の中に入って実行 |
| ⏮ ステップアウト（Shift+F11） | 関数の中から抜け出して元の呼び出し元に戻る |
| 🔁 再起動（Ctrl+Shift+F5） | デバッグを一旦終了して、最初からやり直す |
| ⏹ 停止（Shift+F5） | デバッグ終了 |
- ステップアウトは、関数内でステップインして細かく追っていたけど、もう深追いしたくないときに使います。関数の残りの処理を一気に終わらせて、呼び出し元の位置まで戻ります。
- 再起動は、デバッグの流れをもう一度最初から確認したいときに使います。値の変化やブレークポイントの位置を変えて検証するときにも役立ちます。
使用例
① 例えば、以下のコードを普通に実行すると、「ZeroDivisionError: division by zero」というエラーになります。これは、0で割り算すると生じるゼロ除算エラー（ZeroDivisionError）です。
def divide(a, b):
result = a / b # ← この行にブレークポイントを設定
return result
x = 10
y = 0 # ← エラーの原因になる値
print(divide(x, y))
② 割り算で生じているエラーなので、割り算を行っているresult = a / b の行にブレークポイントを置き、F5キーを押してデバッグを開始します。
③ 画面左の「変数」ウィンドウで a と b の値を確認します。すると、b = 0 となっているので、これがエラーの原因であると特定できます。
④ 例えば、以下のように条件分岐でbの値が0のときは割り算を行わないようコードを修正します。
def divide(a, b):
if b == 0:
return "割り算できません" # エラーを回避
result = a / b
return result
関連ページ
コメント