Full pytest documentation¶

Download latest version as PDF

Start here¶

はじめに

How-to guides¶

pytest の呼び出し方法
- 実行するテストの指定
- バージョン、オプション名、環境変数に関するヘルプの取得
- テスト実行時間のプロファイリング
- プラグインの読み込みの管理
- pytest を呼び出す他の方法
テストでアサーションを記述および報告する方法
- assert ステートメントによるアサーション
- 予期される例外に関するアサーション
- 予期される警告に関するアサーション
- コンテキストに応じた比較の利用
- 失敗したアサーションのための独自の説明を定義する
- アサーションイントロスペクションの詳細
フィクスチャの使い方
- フィクスチャの「リクエスト」
- 自動使用フィクスチャ (リクエストする必要のないフィクスチャ)
- スコープ：クラス、モジュール、パッケージ、またはセッション間でフィクスチャを共有する
- 後片付け/クリーンアップ (別名フィクスチャの終了)
- 安全な後片付け
- 複数の assert ステートメントを安全に実行する
- フィクスチャはリクエストしているテストコンテキストを内省できます
- マーカーを使用してデータをフィクスチャに渡す
- フィクスチャとしてのファクトリ
- フィクスチャのパラメータ化
- パラメータ化されたフィクスチャでマークを使用する
- モジュール性：フィクスチャ関数からフィクスチャを使用する
- フィクスチャインスタンスによるテストの自動グループ化
- クラスおよびモジュールで usefixtures を使用してフィクスチャを使用する
- さまざまなレベルでフィクスチャをオーバーライドする
- 他のプロジェクトからフィクスチャを使用する
テスト関数に属性をマークする方法
- マークの登録
- 不明なマークに対するエラーの発生
フィクスチャとテスト関数をパラメータ化する方法
- @pytest.mark.parametrize：テスト関数のパラメータ化
- 基本的な pytest_generate_tests の例
- さらに例を示します
テストで一時ディレクトリとファイルを使用する方法
- tmp_path フィクスチャ
- tmp_path_factory フィクスチャ
- tmpdir および tmpdir_factory フィクスチャ
- 一時ディレクトリの場所と保持
モジュールや環境をモンキーパッチ/モックする方法
- 関数のモンキーパッチ
- 返されたオブジェクトのモンキーパッチ: モッククラスの構築
- グローバルパッチの例: リモート操作から "requests" を防ぐ
- 環境変数のモンキーパッチ
- 辞書のモンキーパッチ
- API リファレンス
doctest を実行する方法
- エンコーディング
- 'doctest' オプションの使用
- 失敗時に続行
- 出力形式
- pytest 固有の機能
- 代替案
失敗したテストを再実行し、テスト実行間で状態を維持する方法
- 使用法
- 失敗のみを再実行するか、失敗を最初に実行する
- 前回の実行でテストが失敗しなかった場合の動作
- 新しい config.cache オブジェクト
- キャッシュ内容の検査
- キャッシュ内容のクリア
- ステップワイズ
ロギングを管理する方法
- caplog フィクスチャ
- ライブログ
- 色のカスタマイズ
- リリースノート
- pytest 3.4 の非互換の変更
stdout/stderr 出力をキャプチャする方法
- デフォルトの stdout/stderr/stdin キャプチャ動作
- キャプチャ方法の設定またはキャプチャの無効化
- デバッグのために print 文を使用する
- テスト関数からキャプチャされた出力にアクセスする
警告をキャプチャする方法
- 警告の制御
- @pytest.mark.filterwarnings
- 警告サマリーの無効化
- 警告キャプチャを完全に無効にする
- DeprecationWarning と PendingDeprecationWarning
- コードが非推奨警告をトリガーすることを確認する
- warns 関数を使用して警告をアサートする
- 警告の記録
- テストにおける警告の追加使用例
- カスタム失敗メッセージ
- 内部 pytest 警告
- リソース警告
成功しないテストを処理するために skip と xfail を使用する方法
- テスト関数のスキップ
- XFail: テスト関数が失敗すると予想されることをマークする
- parametrize を使用した skip/xfail
プラグインのインストールと使用方法
- テストモジュールまたは conftest ファイルでのプラグインの要求/読み込み
- アクティブなプラグインを見つける
- 名前でプラグインを無効化/登録解除する
プラグインの作成
- ツール起動時のプラグイン発見順序
- conftest.py: ディレクトリごとのローカルプラグイン
- 独自のプラグインの作成
- 他の人がプラグインをインストールできるようにする
- アサーションの書き換え
- テストモジュールまたは conftest ファイルでのプラグインの要求/読み込み
- 名前で他のプラグインにアクセスする
- カスタムマーカーの登録
- プラグインのテスト
フック関数の記述
- フック関数の検証と実行
- firstresult：最初の None でない結果で停止
- フックラッパー：他のフックの前後で実行
- フック関数の順序 / 呼び出し例
- 新しいフックの宣言
- pytest_addoption でのフックの使用
- オプションでサードパーティプラグインのフックを使用する
- フック関数間でアイテムにデータを保存する
既存のテストスイートで pytest を使用する方法
- pytest を使用して既存のテストスイートを実行する
pytest で unittest ベースのテストを使用する方法
- すぐに使える利点
- unittest.TestCase サブクラスでの pytest 機能
- マークを使用して unittest.TestCase サブクラスに pytest フィクスチャを混在させる
- autouse フィクスチャを使用して他のフィクスチャにアクセスする
xunitスタイルのセットアップを実装する方法
- モジュールレベルのセットアップ/ティアダウン
- クラスレベルのセットアップ/ティアダウン
- メソッドおよび関数レベルのセットアップ/ティアダウン
bash 補完の設定方法

Explanation¶

Further topics¶

Release announcements