完整 pytest 文件¶

下載最新版本為 PDF

從這裡開始¶

開始

操作指南¶

如何呼叫 pytest
- 指定要執行的測試
- 取得版本、選項名稱、環境變數的說明
- 分析測試執行時間
- 管理外掛載入
- 呼叫 pytest 的其他方式
如何在測試中撰寫和回報斷言
- 使用 assert 陳述斷言
- 關於預期例外的斷言
- 關於預期警告的斷言
- 利用情境敏感比較
- 為失敗的斷言定義你自己的說明
- 斷言內省詳細資料
如何使用固定裝置
- 「要求」固定裝置
- 自動使用固定裝置（你不需要要求的固定裝置）
- 範圍：跨類別、模組、套件或工作階段共用固定裝置
- 終止/清理（又名固定裝置完成）
- 安全終止
- 安全地執行多個 assert 陳述
- 固定裝置可以內省要求的測試情境
- 使用標記將資料傳遞給固定裝置
- 工廠作為固定裝置
- 參數化固定裝置
- 使用標記搭配參數化固定裝置
- 模組化：使用固定裝置函數中的固定裝置
- 依固定裝置實例自動分組測試
- 在類別和模組中使用 usefixtures 固定裝置
- 在不同層級覆寫固定裝置
- 使用來自其他專案的固定裝置
如何使用屬性標記測試函數
- 註冊標記
- 對未知標記引發錯誤
如何參數化固定裝置和測試函數
- @pytest.mark.parametrize：參數化測試函數
- 基本 pytest_generate_tests 範例
- 更多範例
如何在測試中使用暫存目錄和檔案
- 固定裝置 tmp_path
- 固定裝置 tmp_path_factory
- 固定裝置 tmpdir 和 tmpdir_factory
- 暫存目錄位置和保留
如何修補/模擬模組和環境
- 修補函數
- 修補回傳物件：建立模擬類別
- 全域修補範例：防止「要求」進行遠端操作
- 修補環境變數
- 修補字典
- API 參考
如何執行 doctest
- 編碼
- 使用「doctest」選項
- 失敗時繼續
- 輸出格式
- pytest 特定功能
- 替代方案
如何重新執行失敗的測試並在測試執行之間維護狀態
- 用法
- 僅重新執行失敗或優先執行失敗
- 上次執行時沒有測試失敗的行為
- 新的 config.cache 物件
- 檢查快取內容
- 清除快取內容
- 逐步執行
如何管理記錄
- caplog 固定裝置
- 即時記錄
- 自訂顏色
- 版本說明
- pytest 3.4 中不相容的變更
如何擷取 stdout/stderr 輸出
- 預設 stdout/stderr/stdin 擷取行為
- 設定擷取方法或停用擷取
- 使用列印陳述式進行除錯
- 從測試函數存取擷取的輸出
如何擷取警告
- 控制警告
- @pytest.mark.filterwarnings
- 停用警告摘要
- 完全停用警告擷取
- DeprecationWarning 和 PendingDeprecationWarning
- 確保程式碼觸發不建議使用的警告
- 使用 warns 函數宣告警告
- 記錄警告
- 測試中警告的其他使用案例
- 自訂失敗訊息
- 內部 pytest 警告
- 資源警告
如何使用 skip 和 xfail 處理無法成功的測試
- 略過測試函式
- XFail：標記預期會失敗的測試函式
- 使用 parametrize 來略過/xfail
如何安裝和使用外掛程式
- 在測試模組或 conftest 檔案中要求/載入外掛程式
- 找出哪些外掛程式處於活動狀態
- 按名稱停用/取消註冊外掛程式
撰寫外掛程式
- 工具啟動時的外掛程式偵測順序
- conftest.py：每個目錄的區域外掛程式
- 撰寫您自己的外掛程式
- 讓您的外掛程式可以供其他人安裝
- 斷言重寫
- 在測試模組或 conftest 檔案中要求/載入外掛程式
- 按名稱存取另一個外掛程式
- 註冊自訂標記
- 測試外掛程式
撰寫掛鉤函式
- 掛鉤函式驗證和執行
- firstresult：在第一個非 None 結果時停止
- 掛鉤包裝器：在其他掛鉤周圍執行
- 掛鉤函式排序/呼叫範例
- 宣告新的掛鉤
- 在 pytest_addoption 中使用掛鉤
- 選擇性地使用來自第三方外掛程式的掛鉤
- 在掛鉤函式中跨項目儲存資料
如何將 pytest 與現有的測試套件一起使用
- 使用 pytest 執行現有的測試套件
如何將基於 unittest 的測試與 pytest 一起使用
- 開箱即用的好處
- 在 unittest.TestCase 子類別中的 pytest 功能
- 使用標記將 pytest 固定裝置混合到 unittest.TestCase 子類別中
- 使用 autouse 固定裝置和存取其他固定裝置
如何實作 xunit 風格的設定
- 模組層級的設定/清除
- 類別層級的設定/清除
- 方法和函式層級的設定/清除
如何設定 bash 完成

進階主題¶

版本公告