configure

production、test、mockの動作モードと表示言語を部分的に更新します。既定はproductionです。不正なモードや未登録言語はValueErrorです。デコレータの動作を変える場合は対象モジュールのimport前に呼びます。

python 
configure(mode: Mode | str | None = None, language=None)

scenario

同期または非同期関数を仕様対象として登録します。productionモードなら元の関数を返します。

python 
@scenario(title)

expect.case

ケース名、任意説明、キーワード引数辞書と、戻り値または期待例外を登録します。returnsとraisesは排他的で、matchは例外メッセージの正規表現です。

python 
case(name, *, given, returns=... | raises=..., match=None, desc="")

run_tests

指定関数、または登録済みの全関数を実行し、RunResultを返します。失敗結果は例外ではなく構造化データとして保持します。

python 
run_tests(*functions) -> RunResult

conforms_to

Pydantic互換の型注釈を期待値として作成します。型期待値は固定モックには使われず、実装結果だけを検証します。

python 
conforms_to(type_hint, *, strict=False) -> TypeExpectation

register_locale

完全なメッセージカタログを登録します。既存言語の置換にはoverwrite=Trueが必要です。

python 
register_locale(locale, messages, *, overwrite=False)