VS Code で Python の開発環境を用意する【デバッグ編】

こんにちは、ロジカル・アーツの笹原です。

今回は、VS Code を使用した Python コードのデバッグ方法を紹介したいと思います。

はじめに
デバッグ
おわりに
参考

はじめに

コードを書きはじめの頃は、デバッグする際に一時的に print 関数を追加して変数の中身などを確認していましたが、都度追加や削除する必要があり、手間がかかっていました。次第に面倒になってきたので、本腰を入れて VS Code でのデバッグ方法を調べました。最近はそれなりに使っていて、かなり便利だと思います。

以下の手順で扱う環境は次の通りです：

OS は Windows 10
Python のバージョンは 3.7.4
VS Code のバージョンは 1.71.0
Python の拡張パッケージをインストール済み

デバッグ

この記事ではブレークポイントを打ち、ステップ実行する方法を紹介します。

サンプルコードについて

デバッグコードのサンプルとして、以下を使用します。

def collatz(n):
    """与えられた数を初期値として Collatz 数列を計算する。

    Args:
        n (int): 初期値。

    Raises:
        NotPositiveNumberError: 初期値が0以下の場合に発生する。

    Returns:
        tuple: 数列の長さと最大値のタプル。
    """
    seq = [n]
    if n <= 0:
        raise NotPositiveNumberError

    while n > 1:
        if is_even(n):
            n //= 2
        else:
            n = 3 * n + 1
        seq.append(n)
    return len(seq), max(seq)


def is_even(n):
    """与えられた数が偶数かどうか判定する。

    Args:
        n (int): 整数。

    Returns:
        bool: 偶数であれば `True` を返す。
    """
    return n % 2 == 0


class NotPositiveNumberError(Exception):
    """正の整数でない例外クラス。"""

    pass


if __name__ == "__main__":
    n = input("数字を入力してください：")
    try:
        length, max_num = collatz(int(n, base=10))
        print(f"数列の長さ：{length}")
        print(f"数列の最大値：{max_num}")
    except (NotPositiveNumberError, ValueError):
        print("正の整数を入力してください。")

このサンプルコードでは Collatz 予想に出てくるアルゴリズムを実装してます。すなわち、与えられた正の整数に対して偶数であれば 2 で割り、奇数であれば 3 倍して 1 を足すという操作を繰り返し行います*1。コード中の collatz 関数は入力が 1 に到達したときの数列の長さと、取り得る値の最大値を返します。

例えば、入力が 13 のとき Collatz 数列は

$\displaystyle 13\to40\to20\to10\to5\to16\to8\to4\to2\to1$

となり、数列の長さは 10、最大値は 40 です。

デバッグ設定ファイルの作成

サイドバーのデバッグアイコンをクリックし、create a launch.json file の箇所をクリックします。

Python ファイルを選択します。

以下のような launch.json ファイルが作成されていると思います。

.vscode/launch.json

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: 現在のファイル",
            "type": "python",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal",
            "justMyCode": true
        }
    ]
}