setastest() でテストスイートをカスタマイズ: NumPy テストの高度なテクニック

NumPy Test Support: testing.dec.setastest()解説

setastest() は以下の引数を受け取ります。

• test_mode: テストスイート全体または個々のテストケースに対して設定するテストモード
• verbosity: テスト実行時の出力レベル
• raise_warnings: テスト実行時に警告を発生させるかどうか
• collect_only: テストの実行ではなく、テストケースの収集のみを行うかどうか

各引数の詳細は以下の通りです。

test_mode

• 'full': 全てのテストケースを実行
• 'fast': 時間がかかると判断されるテストケースをスキップ
• 'slow': 通常スキップされる時間のかかるテストケースを実行
• 'skip': 全てのテストケースをスキップ

verbosity

• 0: 最小限の出力
• 1: テストスイート名とテストケース名の出力
• 2: テストスイート名、テストケース名、テスト結果の出力

raise_warnings

• True: テスト実行時に警告を発生させる
• False: テスト実行時に警告を発生させない

collect_only

• True: テストケースの収集のみを行う
• False: テストケースの収集と実行を行う

例

from numpy.testing import dec

# テストスイート全体に対してテストモードを設定
dec.setastest(mode='fast')

# 個々のテストケースに対してテストモードを設定
@dec.setastest(mode='skip')
def test_my_function():
    ...

# テスト実行時の出力レベルを設定
dec.setastest(verbosity=2)

# テスト実行時に警告を発生させる
dec.setastest(raise_warnings=True)

# テストケースの収集のみを行う
dec.setastest(collect_only=True)

setastest() は、テストスイート全体の動作を制御したり、特定のテストケースをスキップしたりするなど、様々な場面で使用できます。

例1：時間がかかると判断されるテストケースをスキップする

from numpy.testing import dec

# テストスイート全体に対してテストモードを設定
dec.setastest(mode='fast')

# 時間のかかると判断されるテストケース
def test_slow_function():
    ...

この例では、setastest() を使ってテストスイート全体に対して 'fast' モードを設定しています。これにより、時間がかかると判断されるテストケース test_slow_function はスキップされます。

例2：個々のテストケースに対してテストモードを設定する

from numpy.testing import dec

def test_my_function():
    ...

# 個々のテストケースに対してテストモードを設定
@dec.setastest(mode='skip')
def test_my_function():
    ...

この例では、dec.setastest() デコレータを使って個々のテストケース test_my_function に対して 'skip' モードを設定しています。これにより、このテストケースは実行されません。

setastest() は、NumPyテストスイートの動作を制御するための便利な関数です。テストスイート全体または個々のテストケースに対してテストモードを設定することで、テスト実行時の動作を柔軟に変更することができます。

NumPy Test Support: setastest() サンプルコード

テストスイート全体の設定

from numpy.testing import dec

# テストスイート全体に対してテストモードを設定
dec.setastest(mode='fast')

# テスト実行
import numpy.testing as npt

npt.run_module('my_module', argv=['-v'])

個々のテストケースの設定

from numpy.testing import dec

def test_my_function():
    ...

# 個々のテストケースに対してテストモードを設定
@dec.setastest(mode='skip')
def test_my_function():
    ...

# テスト実行
import numpy.testing as npt

npt.run_module('my_module', argv=['-v'])

この例では、dec.setastest() デコレータを使って個々のテストケース test_my_function に対して 'skip' モードを設定しています。

テスト実行時の出力レベルの設定

from numpy.testing import dec

# テスト実行時の出力レベルを設定
dec.setastest(verbosity=2)

# テスト実行
import numpy.testing as npt

npt.run_module('my_module', argv=['-v'])

この例では、setastest() を使ってテスト実行時の出力レベルを 2 に設定しています。

テスト実行時の警告の発生

from numpy.testing import dec

# テスト実行時の警告を発生させる
dec.setastest(raise_warnings=True)

# テスト実行
import numpy.testing as npt

npt.run_module('my_module', argv=['-v'])

この例では、setastest() を使ってテスト実行時の警告を発生させるように設定しています。

テストケースの収集のみ

from numpy.testing import dec

# テストケースの収集のみを行う
dec.setastest(collect_only=True)

# テスト実行
import numpy.testing as npt

npt.run_module('my_module', argv=['-v'])

この例では、setastest() を使ってテストケースの収集のみを行うように設定しています。

テストスイートのスキップ

setastest() を使ってテストスイート全体をスキップするには、以下のコードを使用します。

import numpy.testing as npt

npt.run_module('my_module', argv=['-s'])

個々のテストケースのスキップ

@pytest.mark.skip デコレータを使って個々のテストケースをスキップするには、以下のコードを使用します。

import pytest

def test_my_function():
    ...

# 個々のテストケースをスキップ
@pytest.mark.skip
def test_my_function():
    ...

# テスト実行
import numpy.testing as npt

npt.run_module('my_module', argv=['-v'])

NumPy Test Support: setastest() 以外の方法

テストスイートの構成ファイル

pytest.ini などのテストスイートの構成ファイルを使って、テストスイート全体の動作を設定することができます。

例

[pytest]
addopts = -m "fast"

この例では、addopts オプションを使って、テストスイート全体に対して 'fast' モードを設定しています。

テストケースのデコレータ

pytest.mark デコレータを使って、個々のテストケースの動作を設定することができます。

例

import pytest

def test_my_function():
    ...

# 個々のテストケースをスキップ
@pytest.mark.skip
def test_my_function():
    ...

# テスト実行
import numpy.testing as npt

npt.run_module('my_module', argv=['-v'])

この例では、pytest.mark.skip デコレータを使って個々のテストケース test_my_function をスキップしています。

コマンドラインオプション

pytest コマンドラインオプションを使って、テストスイートの動作を設定することができます。

例

pytest -m "fast" my_module

この例では、-m オプションを使って、テストスイート全体に対して 'fast' モードを設定しています。

setastest() 以外にも、NumPyテストスイートの動作を制御する方法はいくつかあります。それぞれの方法の特徴を理解して、状況に応じて使い分けることが重要です。