Matplotlibを使用したコードへの単体テスト作成方法を徹底解説

Matplotlibで描画を行うコードに対して単体テストを作成する方法を解説します。ここでは、配列をx座標として受け取り、y = x² の曲線を描画するプロットを例に考えます。テスト時には、xデータ点に対応する y_data を抽出し、期待値と一致するかどうかを検証します。

手順

• plot_sqr_curve(x) というメソッドを作成します。このメソッドは plot() メソッドを使って x と x² を描画し、そのプロットを返します。
• テストにはPython標準ライブラリの unittest.TestCase を使用します。
• テストメソッド test_curve_sqr_plot() を作成し、以下の処理を記述します。
  • 曲線を描画するためのxデータ点を作成する。
  • xデータ点をもとにyデータ点（x²）を作成する。
  • xデータとyデータを使って曲線を描画する。
  • 描画されたプロットオブジェクトからxデータとyデータを抽出する。
  • 抽出したデータが期待値と一致しているか（式が真であるか）を検証する。

コード例

import unittest
import numpy as np
from matplotlib import pyplot as plt

def plot_sqr_curve(x):
    """
    y = x^2 となるy値でx点を描画する。
    """
    return plt.plot(x, np.square(x))

class TestSqrCurve(unittest.TestCase):
    def test_curve_sqr_plot(self):
        # xデータ点を作成
        x = np.array([1, 3, 4])
        # xデータ点からyデータ点を作成
        y = np.square(x)
        # 曲線を描画
        pt, = plot_sqr_curve(x)
        # プロットオブジェクトからyデータとxデータを抽出
        y_data = pt.get_data()[1]
        x_data = pt.get_data()[0]
        # データが一致することを検証
        self.assertTrue((y == y_data).all())
        self.assertTrue((x == x_data).all())

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

ポイント解説

pt.get_data() は、Line2Dオブジェクトが保持している実際の描画データ（x座標とy座標）をタプル形式で返します。これにより、「関数が正しいデータでプロットを生成したか」を直接検証できます。また、(y == y_data).all() のようにNumPy配列全体を一括比較することで、すべての要素が一致していることを確認しています。

実行結果

Ran 1 test in 1.587s
OK

テストが正常に完了すると「OK」が表示されます。この手法を応用すれば、グラフのタイトルやラベル、凡例の設定なども get_title() や get_xlabel() などのメソッドを使って同様に検証することが可能です。