Jupyter NotebookでPythonのunittestを使用する方法

Jupyter NotebookはPythonの学習に便利なツールで、Pythonを始める人には非常におすすめです。しかし、Jupyter Notebookでunittestを使う方法は一見すると分かりにくいかもしれません。ここでは、その方法を説明します。

関数のテスト

Pythonの標準的なテストツールであるdoctestやunittestは、Jupyter Notebookでも直接使用することができます。例えば、次のように関数とそのテストケースをdocstringに書くことができます。

def add(a, b):
    '''
    This is a test:
    >>> add(2, 2)
        5
    '''
    return a + b

そして、次のようにdoctestを実行することで、docstring内のテストケースを実行することができます。

import doctest
doctest.testmod(verbose=True)

Jupyter Notebookでのunittestの使用

unittestをJupyter Notebookで使用するためには、テストクラスを作成し、次のように実行します。

if __name__ == '__main__':
    unittest.main(argv=['first-arg-is-ignored'], exit=False)

これにより、Jupyter Notebook内でunittestを実行することができます。

以上が、Jupyter NotebookでPythonのunittestを使用する方法です。これにより、コードの品質を保つためのテストを、Jupyter Notebook内で簡単に行うことができます。