NumPy Test Support: testing.assert_warns() を使いこなしてテストを強化しよう！

NumPy Test Supportにおけるtesting.assert_warns()解説

使い方

testing.assert_warns()関数は以下の形式で使用します。

testing.assert_warns(warn_type, message, func, *args, **kwargs)

引数

• warn_type: 期待される警告の種類を表す型オブジェクト。UserWarningなど
• message: 期待される警告メッセージの文字列
• func: テスト対象の関数
• args: funcに渡される引数
• kwargs: funcに渡されるキーワード引数

例

以下の例は、np.logaddexp()関数がRuntimeWarning警告を発することを検証するテストコードです。

import numpy as np
from numpy.testing import assert_warns

def test_logaddexp():
  with assert_warns(RuntimeWarning):
    np.logaddexp(np.inf, np.inf)

このコードを実行すると、RuntimeWarning警告が表示され、テストが成功します。

補足

• testing.assert_warns()関数は、複数の警告メッセージを検証するために使用できます。その場合は、message引数にリストを渡します。
• 警告メッセージの一部のみを検証したい場合は、message引数に正規表現を使用できます。
• 警告メッセージが表示されないことを検証したい場合は、assert_no_warnings()関数を使用します。

• 上記の説明で不明な点があれば、遠慮なく質問してください。

NumPy Test Supportにおけるtesting.assert_warns()のサンプルコード

import numpy as np
from numpy.testing import assert_warns

def test_multiple_warnings():
  with assert_warns(RuntimeWarning):
    np.logaddexp(np.inf, np.inf)
    np.logaddexp(np.nan, np.nan)

このコードは、np.logaddexp()関数が2つのRuntimeWarning警告を発することを検証します。

警告メッセージの一部のみの検証

import numpy as np
from numpy.testing import assert_warns

def test_partial_message():
  with assert_warns(RuntimeWarning, r'overflow encountered in exp'):
    np.logaddexp(np.inf, np.inf)

このコードは、np.logaddexp()関数が'overflow encountered in exp'という部分を含むRuntimeWarning警告を発することを検証します。

警告メッセージが表示されないことの検証

import numpy as np
from numpy.testing import assert_no_warnings

def test_no_warnings():
  with assert_no_warnings():
    np.add(1, 1)

このコードは、np.add()関数が警告メッセージを発しないことを検証します。

コンテキストマネージャーの使用

import numpy as np
from numpy.testing import assert_warns

def test_context_manager():
  with assert_warns(RuntimeWarning):
    np.logaddexp(np.inf, np.inf)

  # 警告はコンテキストマネージャーの外では発生しない
  np.logaddexp(1, 1)

このコードは、assert_warns()関数をコンテキストマネージャーとして使用する方法を示しています。

テスト対象の関数が警告メッセージを返す場合

import numpy as np
from numpy.testing import assert_warns

def my_func():
  warnings.warn('This is a warning', RuntimeWarning)

def test_my_func():
  with assert_warns(RuntimeWarning):
    my_func()

このコードは、my_func()関数がRuntimeWarning警告を発することを検証します。

テスト対象の関数が警告メッセージを返さない場合

import numpy as np
from numpy.testing import assert_no_warnings

def my_func():
  pass

def test_my_func():
  with assert_no_warnings():
    my_func()

このコードは、my_func()関数が警告メッセージを発しないことを検証します。

例外処理

import numpy as np
from numpy.testing import assert_warns

def test_exception():
  with assert_warns(RuntimeWarning):
    np.logaddexp(np.inf, np.inf)
    raise ValueError('This is an error')

このコードは、np.logaddexp()関数がRuntimeWarning警告を発し、その後ValueError例外が発生することを検証します。

その他のオプション

testing.assert_warns()関数には、match、err_msg、moduleなどのオプションがあります。詳細はNumPy Test Support documentationを参照してください。

テストコード内で警告メッセージの発生を検証するその他の方法

warningsモジュールは、警告メッセージの処理を制御するための機能を提供します。テストコード内で警告メッセージが発生したかどうかを検証するには、以下の方法を使用できます。

import warnings

def test_warnings():
  warnings.warn('This is a warning', RuntimeWarning)

  # 警告メッセージの数を取得
  num_warnings = len(warnings.catch_warnings())

  # 警告メッセージの内容を確認
  assert warnings.catch_warnings()[0].message == 'This is a warning'

このコードは、warnings.warn()関数を使用して警告メッセージを発生させ、warnings.catch_warnings()を使用して警告メッセージの数を取得し、内容を確認しています。

loggingモジュールは、ログメッセージの出力と処理を制御するための機能を提供します。テストコード内で警告メッセージが発生したかどうかを検証するには、以下の方法を使用できます。

import logging

def test_logging():
  logger = logging.getLogger(__name__)

  logger.warning('This is a warning')

  # ログメッセージの数を取得
  num_warnings = len(logger.handlers[0].buffer)

  # ログメッセージの内容を確認
  assert logger.handlers[0].buffer[0].message == 'This is a warning'

このコードは、logging.warning()関数を使用して警告メッセージを発生させ、logger.handlers[0].bufferを使用してログメッセージの数を取得し、内容を確認しています。

自作の関数

上記の方法以外にも、自作の関数を使用して警告メッセージの発生を検証することもできます。

def assert_warns(message, func, *args, **kwargs):
  """
  テスト対象の関数が警告メッセージを発生させることを検証する関数

  Args:
      message: 期待される警告メッセージ
      func: テスト対象の関数
      *args: funcに渡される引数
      **kwargs: funcに渡されるキーワード引数

  Returns:
      None
  """

  warnings.warn('This is a warning', RuntimeWarning)

  # テスト対象の関数を呼び出す
  func(*args, **kwargs)

  # 警告メッセージの内容を確認
  assert warnings.catch_warnings()[0].message == message

このコードは、assert_warns()という自作の関数を使用して、テスト対象の関数がRuntimeWarning警告を発し、その内容がmessageと一致することを検証しています。

• 簡単なテストの場合は、warningsモジュールのcatch_warnings()関数を使用するのが最も簡単です。
• ログメッセージの詳細な情報を取得したい場合は、loggingモジュールを使用するのが良いでしょう。
• より複雑なテストの場合は、自作の関数を作成するのが良いでしょう。