設定

この記事は、公式マニュアルから引用した 仮説設定ページの翻訳です 。

仮説は、その動作に許容可能なデフォルトを使用しようとしますが、それだけでは不十分な場合があり、設定する必要があります。

このメカニズムは、 hypothesis.settingsオブジェクトです。 設定デコレータを使用して、 @given基づいて基本的なテスト設定を変更できます。

@given呼び出しは次のとおりです。

 from hypothesis import given, settings @given(integers()) @settings(max_examples=500) def test_this_thoroughly(x): pass 

この場合、 hypothesis.settingsオブジェクトが使用され、その結果、テストは通常​​よりもはるかに多くの例のセットを受け取ります。

これは、 指定の前または後に適用できます。 これは結果に影響しません。 したがって、次の例は前の例とまったく同じです。

 from hypothesis import given, settings @settings(max_examples=500) @given(integers()) def test_this_thoroughly(x): pass 

実行するものの制御

仮説は、テストを論理的に異なる4つのフェーズに分割します。

1. provided with the @example decorator明示的な例を実行します。
2. 以前に失敗したサンプルの選択を再開して、以前に気付いたエラーを再現します。
3. 新しい例を作成します。
4. ステップ2または3で見つかった例をより管理しやすいものに圧縮する試み（明示的な例は圧縮できません）。

フェーズ設定は、それらの実行を正確に制御します。各フェーズは、 hypothesis._settings.Phase列挙の値に対応します。

1. Phase.explicitは、明示的な例の実行を制御します。
2. Phase.reuseは、前の例の再利用を管理します。
3. Phase.generateは、新しいサンプルを作成するかどうかを決定します。
4. Phase.shrinkは、サンプルの縮小を管理します。

phase引数は、それらのサブセットを持つコレクションを受け入れます。 たとえば、 settings(phases=[Phase.generate, Phase.shrink])は新しい例を生成して圧縮しますが、 settings(phases=[Phase.explicit])明示的な例を実行したり以前の失敗を再利用したりしません。明示的な例のみが実行されます。

小計を表示

Hypothesisがテストを実行している間に何が起こるかを確認するには、構成でVerbosityを有効にします。 @givenと@given両方で@givenます。

 >>> from hypothesis import find, settings, Verbosity >>> from hypothesis.strategies import lists, integers >>> find(lists(integers()), any, settings=settings(verbosity=Verbosity.verbose)) Tried non-satisfying example [] Found satisfying example [-1198601713, -67, 116, -29578] Shrunk example to [-67, 116, -29578] Shrunk example to [116, -29578] Shrunk example to [-29578] Shrunk example to [-115] Shrunk example to [115] Shrunk example to [-57] Shrunk example to [29] Shrunk example to [-14] Shrunk example to [-7] Shrunk example to [4] Shrunk example to [2] Shrunk example to [1] [1] 

4つのレベル：quiet（通常）、normal（通常）、verbose（詳細）、debug（デバッグ）。 ノーマルがデフォルトですが、クワイエットモードでは、偽造の最後の例でさえ、仮説は何も出力しません。 debugは基本的に同じ冗長ですが、もう少し詳細です。 おそらくこれは必要ありません。

pytestを使用する場合、 disable output capturing for passing testsをdisable output capturing for passing tests必要がある場合がありdisable output capturing for passing tests 。

アセンブリ設定オブジェクト

設定は、 hypothesis.settingsを使用可能な設定値のいずれかで呼び出すことで作成できます。 不足しているものはデフォルトでインストールされます。

 >>> from hypothesis import settings >>> settings().max_examples 100 >>> settings(max_examples=10).max_examples 10 

最初の引数として、オブジェクトを渡すこともできます-「親」設定、および名前付き引数として指定されていないパラメーターは、親パラメーターからコピーされます。

 >>> parent = settings(max_examples=10) >>> child = settings(parent, deadline=200) >>> parent.max_examples == child.max_examples == 10 True >>> parent.deadline not_set >>> child.deadline 200 

設定のデフォルト

いつでも、プログラムにはsettings.defaultとして利用可能な現在のデフォルト設定がありsettings.default 。 設定オブジェクト自体に加えて、他の設定に明示的に基づいていないすべての新しく作成された設定オブジェクトはデフォルト値に基づいているため、明示的に設定されていない値を継承します。

デフォルト値はプロファイルを使用して変更できます（次のセクションを参照）が、 context managerオブジェクトとしてパラメーターオブジェクトを使用してローカルで再定義することもできます。

 >>> with settings(max_examples=150): ... print(settings.default.max_examples) ... print(settings().max_examples) 150 150 >>> settings().max_examples 100 

ブロックを終了すると、デフォルト値が通常に戻ることに注意してください。

これは、コンテキストでテスト定義をネストすることで使用できます。

 from hypothesis import given, settings with settings(max_examples=500): @given(integers()) def test_this_thoroughly(x): pass 

作成されたすべての設定オブジェクトまたはブロック内で定義されたテストは、コンテキストとして使用される設定オブジェクトからデフォルト値を継承します。 もちろん、ユーザー設定を使用してそれらをオーバーライドすることもできます。

注意！：コンテキストブロック内で@givenを使用しないテスト関数の定義を使用する場合、ネストされたパラメーターは使用されません。 これは、コンテキストマネージャが定義にのみ影響し、関数の実行には影響しないためです。

設定プロファイル

環境によっては、さまざまなデフォルトパラメータが必要になる場合があります。 たとえば、開発中にサンプルの数を減らしてテストを高速化できます。 ただし、CI環境では、エラーを検出する可能性を高めるために、より多くの例が必要になる場合があります。

仮説により、さまざまなプロファイル設定を定義できます。 これらのプロファイルはいつでもダウンロードできます。

プロファイルをロードするとデフォルト設定が変更されますが、設定を明示的に変更するテストの動作は変更されません。

 >>> from hypothesis import settings >>> settings.register_profile("ci", max_examples=1000) >>> settings().max_examples 100 >>> settings.load_profile("ci") >>> settings().max_examples 1000 

プロファイルをロードしてデフォルト値をオーバーライドする代わりに、特定のテストのプロファイルを取得できます。

 >>> with settings.get_profile("ci"): ... print(settings().max_examples) ... 1000 

必要に応じて、環境変数を定義してプロファイルをロードできます。 これは、CIでテストを実行するための推奨パターンです。 以下のコードは、 conftest.pyまたはテストスイートのセットアップ/初期化セクションで実行する必要があります。 この変数が定義されていない場合、仮説によって定義されたデフォルト値がロードされます。

 >>> import os >>> from hypothesis import settings, Verbosity >>> settings.register_profile("ci", max_examples=1000) >>> settings.register_profile("dev", max_examples=10) >>> settings.register_profile("debug", max_examples=10, verbosity=Verbosity.verbose) >>> settings.load_profile(os.getenv(u'HYPOTHESIS_PROFILE', 'default')) 

仮説pytestプラグインを使用し、プロファイルがconftestに登録されている場合、コマンドラインオプション--hypothesis-profileダウンロードできます。

 $ pytest tests --hypothesis-profile 

タイムアウト

タイムアウト仮説機能は廃止され、削除されます。 現時点では、タイムアウトパラメータを引き続き割り当てることができ、1分の古いデフォルトタイムアウトが残ります。

将来コードを使用する場合は、 hypothesis.unlimitedタイムアウトを設定することで、将来の動作を評価できます。

 from hypothesis import given, settings, unlimited from hypothesis import strategies as st @settings(timeout=unlimited) @given(st.integers()) def test_something_slow(i): ... 

これにより、どれだけ時間がかかっても、典型的な仮説の例を取り上げるまでコードが実行されます。 timeout=unlimitedは、タイムアウト機能を放棄した後も有効なパラメーターのままです（ただし、独自のエージングサイクルがあります）。

ただし、現在、タイミングとヘルスチェックに関連するヘルスチェックがあります。これは、何世紀にもわたって動作する準備ができているテストをキャッチするように設計されています。 テストを永久に実行したい場合は、次のコードでこれを許可します。

 from hypothesis import given, settings, unlimited, HealthCheck from hypothesis import strategies as st @settings(timeout=unlimited, suppress_health_check=[ HealthCheck.hung_test ]) @given(st.integers()) def test_something_slow(i): ... 

戻る