デバッグとは？デバッグの意味とやり方をPythonの例で解説

2024-01-11

当サイトでは一部リンクに広告が含まれています

プログラミングにおけるデバッグとは、一見するとただのエラー修正作業のように思えますが、その中身はもっと深いものがあります。
その過程でコードの理解を深め、ソフトウェアの品質を向上させることができます。

この記事では、デバッグの意味を具体的に説明し、Pythonの例を用いて効果的なデバッグ手法を紹介します。

デバッグとは何か？

デバッグはプログラムのエラーや不具合を見つけ、修正する作業のことです。
しかし、その根本的な目的は、単にバグを修正するだけでなく、ソフトウェアの正常な動作を確保し、全体の品質を改善することです。

例えば、Pythonで書かれたプログラムが期待通りの結果を出さない場合、デバッグのプロセスを通じて問題がどこに存在するのかを見つけ出し、修正します。
これには、意図しない動作を起こす可能性のあるコードを特定し、その原因を追求することが含まれます。

Pythonでの効果的なデバッグ手法

Pythonを使用してデバッグする際には、以下の手法が役立ちます。

1. ログを活用する

Pythonのloggingモジュールを活用すると、実行時の情報を記録し、後からその情報を確認することができます。
例えば、以下のコードはエラーログを出力します。

import logging

try:
  # ポテンシャルなエラーがあるコード
  x = 1 / 0
except Exception as e:
  logging.error("Exception occurred", exc_info=True)

2. デバッガを使用する

Pythonには標準でpdbというデバッガが付属しています。
このツールを使用すれば、プログラムの中断点を設定し、その時点での変数の状態を確認したり、一行ずつ実行してみたりすることができます。

import pdb

def divide(x, y):
  pdb.set_trace()  # デバッグのブレークポイント
  return x / y

divide(1, 0)

上記のように、pdb.set_trace()を使用すると、プログラムの実行が中断され、デバッガが起動します。

上記のコードでは 1 を 0 で割ろうとしているため、ZeroDivisionErrorが発生します。
コードからすぐに原因は分かるものの、実際の開発では、このようなエラーが発生した時に、どのような状況で発生したのかを知ることが重要です。

では、デバッガを用いて、このエラーが発生した時の変数の状態を確認してみましょう。
上記のコードを実行すると、以下のようになります。

> /Users/username/Projects/debug.py(5)divide()
-> return x / y

この状態で、xとyの値を確認してみましょう。
確認するにはpコマンドを使用し、変数名を指定します。

(Pdb) p x
1
(Pdb) p y
0

このように、xとyの値が分かりました。
この状態で、cコマンドを使用すると、プログラムの実行が再開されます。

(Pdb) c
Traceback (most recent call last):
  File "/Users/username/Projects/debug.py", line 8, in <module>
    divide(1, 0)
  File "/Users/username/Projects/debug.py", line 5, in divide
    return x / y
ZeroDivisionError: division by zero

再開したことでZeroDivisionErrorが発生しました。
このように、デバッガを使用すると、プログラムの実行を中断し、その時点での変数の状態を確認することができます。

3. ユニットテストを行う

Pythonのunittestフレームワークを使用すると、ソフトウェアの各部分が想定どおりに動作するかどうかをテストすることができます。
テストがパスすれば、その部分のコードは問題なく動作していると言えます。

例：add関数のテスト

import unittest

def add(x, y):
  return x + y

class TestAdd(unittest.TestCase):
  def test_add(self):
    self.assertEqual(add(1, 2), 3)

if __name__ == '__main__':
  unittest.main()

上記のコードでは、add関数をテストしています。
add関数は、2つの引数を受け取り、それらを足し合わせた結果を返します。
テストでは、add関数に1と2を渡し、その結果が3になることを確認しています。

テストを実行するには、以下のコマンドを実行します。

$ python test_add.py
.
----------------------------------------------------------------------
Ran 1 test in 0.000s

OK

テストがパスしたことを示す.が表示されました。
テストがパスしない場合は、Fが表示されます。

$ python test_add.py
F
======================================================================
FAIL: test_add (__main__.TestAdd)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "test_add.py", line 8, in test_add
    self.assertEqual(add(1, 2), 4)
AssertionError: 3 != 4

----------------------------------------------------------------------
Ran 1 test in 0.000s

FAILED (failures=1)

上記のように、テストがパスしない場合は、どのテストがパスしなかったのかが表示されます。
このように、テストを行うことで、ソフトウェアの各部分が想定どおりに動作するかどうかを確認することができます。