Jupyter notebookでPythonのテストコードを書く

インストールから実行まで

使用するライブラリ：ipytest (PyPIページ)

インストールコマンド

pip install ipytest

インポート

import ipytest
ipytest.autoconfig()

実行例

%%ipytest -qq

def test_example():
    assert [1, 2, 3] == [1, 2, 3]

%%ipytest -qqは、過去に定義されたテスト（他のセルや同一セルの過去の実行で登録されたテスト）を削除してからテストを実行するコマンドです。
ipytest.clean() 関数を使用することでも、以前に定義されたテストを削除できます。

テストコードの最低限の書き方

関数名に「test_」をつける（test_で始まる関数名をテストとして自動検出します）
assert に続けて「TRUE/FALSEの真偽値を返す表現・比較式」を書く

assertはPython組み込みの構文で、条件式がFalseの場合にAssertionErrorを発生させます。

グローバルの状態について

以前に定義されたテストを削除する意味

Pytestの仕様として、一度定義したテストは記憶され続けます。
そのため古いテストが意図せず残ったままになり、同名テストが重複したり、削除したはずのテストが再び実行されるなど、予期せぬ動作が発生する可能性があります。
このような問題を防ぐために、%%ipytestやipytest.clean()で「実行前に過去のテストを削除する」という手順が推奨されています。

モジュールの再ロード

Python のモジュールシステムはインポートをキャッシュするため、グローバル状態として機能します。
モジュールの最新バージョンをテストするには、都度モジュールを再ロードする必要があります。
そのため ipytest は ipytest.force_reload() 関数を提供します。または IPython の自動再ロード拡張機能も役立つかもしれません。
ローカルパッケージをテストするには、開発パッケージとしてインストールすることをお勧めします (例: pip install -e ..)。

別のスレッドでのテストの実行

非同期コードの場合、IPython は現在のスレッドでイベントループを作成します。
この設定は、非同期テストに干渉する可能性があります。
そのため ipytest は別のスレッドでのテストの実行をサポートしています。
ipytest.autoconfig(run_in_thread=True) と設定するだけです。