Pact Python

<div align="center"> <b>快速、简单、可靠地测试您的 API 和微服务。</b> </div> <div align="center"><table> <tr> <td>包</td> <td> <a href="https://pypi.python.org/pypi/pact-python"><img src="https://yellow-cdn.veclightyear.com/2b54e442/0d11b4a7-7ce0-4f13-a102-d28813c66430.svg" alt="版本"></a> <a href="https://pypi.python.org/pypi/pact-python"><img src="https://yellow-cdn.veclightyear.com/2b54e442/57de9e98-71ec-47c6-82a0-8830793e2803.svg" alt="Python 版本"></a> <a href="https://pypi.python.org/pypi/pact-python"><img src="https://yellow-cdn.veclightyear.com/2b54e442/b2a5eddf-2587-4328-8dd5-8ddf3e07b304.svg" alt="下载量"></a> </td> </tr> <tr> <td>CI/CD</td> <td> <a href="https://github.com/pact-foundation/pact-python/actions/workflows/test.yml"><img src="https://img.shields.io/github/actions/workflow/status/pact-foundation/pact-python/test.yml?branch=master&label=测试" alt="测试状态"></a> <a href="https://github.com/pact-foundation/pact-python/actions/workflows/build.yml"><img src="https://img.shields.io/github/actions/workflow/status/pact-foundation/pact-python/build.yml?branch=master&label=构建" alt="构建状态"></a> <a href="https://github.com/pact-foundation/pact-python/actions/workflows/docs.yml"><img src="https://img.shields.io/github/actions/workflow/status/pact-foundation/pact-python/docs.yml?branch=master&label=文档" alt="构建状态"></a> </td> </tr> <tr> <td>元数据</td> <td> <a href="https://github.com/pypa/hatch"><img src="https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg" alt="Hatch 项目"></a> <a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/badge/ruff-ruff?label=代码检查&color=%23261230" alt="代码检查 - Ruff"></a> <a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/badge/ruff-ruff?label=代码风格&color=%23261230" alt="代码风格 - Ruff"></a> <a href="https://github.com/python/mypy"><img src="https://img.shields.io/badge/类型-Mypy-blue.svg" alt="类型 - Mypy"></a> <a href="https://pypi.python.org/pypi/ruff"><img src="https://img.shields.io/pypi/l/pact-python.svg" alt="许可证"></a> </td> </tr> <tr> <td>社区</td> <td> <a href="http://slack.pact.io"><img src="https://slack.pact.io/badge.svg" alt="Slack"></a> <a href="https://stackoverflow.com/questions/tagged/pact"><img src="https://img.shields.io/badge/stackoverflow-pact-orange.svg" alt="Stack Overflow"></a> <a href="https://twitter.com/pact_up"><img src="https://img.shields.io/twitter/follow/pact_up?style=social" alt="Twitter"></a> </td> </tr> </table></div> <div align="center"><table><tr><td> <b>Pact</b> 是事实上的 API 契约测试工具。用快速、可靠且易于调试的单元测试替代昂贵且脆弱的端到端集成测试。 <ul style="list-style-type: none"> <li>⚡ 闪电般快速</li> <li>🎈 轻松实现全栈集成测试 - 从前端到后端</li> <li>🔌 支持 HTTP/REST 和事件驱动系统</li> <li>🛠️ 可配置的模拟服务器</li> <li>😌 强大的匹配规则防止测试变得脆弱</li> <li>🤝 与 Pact Broker / PactFlow 集成，实现强大的 CI/CD 工作流</li> <li>🔡 支持 12 种以上的编程语言</li> </ul>

<b>为什么使用 Pact？</b> 使用 Pact 进行契约测试可以让您：

<ul style="list-style-type: none"> <li>⚡ 本地测试</li> <li>🚀 更快部署</li> <li>⬇️ 减少变更的交付时间</li> <li>💰 降低 API 集成测试的成本</li> <li>💥 防止破坏性变更</li> <li>🔎 了解系统使用情况</li> <li>📃 免费记录您的 API</li> <li>🗄 无需复杂的数据夹具</li> <li>🤷‍♂️ 减少对复杂测试环境的依赖</li> </ul>

观看我们的<a href="https://www.youtube.com/playlist?list=PLwy9Bnco-IpfZ72VQ7hce8GicVZs7nm0i">系列视频</a>，了解端到端集成测试的问题以及契约测试如何帮助解决这些问题。

</td></tr></table></div>

文档

本自述文件提供了 Pact Python 库的高级概述。有关详细文档，请参阅 完整的 Pact Python 文档。有关 Pact 和整个生态系统的更一般概述，请参阅 Pact 文档。

• 安装
• 消费者测试
• 提供者测试
• 示例

API 文档是从代码中的文档字符串生成的，您可以在这里查看。请注意，目前只有 [pact.v3 模块][pact.v3] 有详细的文档。

需要帮助

• 加入 我们的社区 Slack 工作区。
• Stack Overflow 是提问的好地方。
• 在 Twitter 上说 👋：@pact_up
• 在 GitHub Discussions 上加入讨论 💬
• 在 GitHub 上提出问题

V3 预览版

Pact Python 目前正在进行重大重写，将在 3.0.0 版本中发布。这次重写将用 Rust 后端替换现有的 Ruby 后端，这将带来显著的性能提升，并允许我们在未来支持更多功能。您可以在 GitHub 上的这个跟踪问题 中找到有关此重写的更多信息。

您可以通过使用 [pact.v3 模块][pact.v3] 来预览新版本。新版本尚未功能完备，可能会发生变化。尽管如此，我们非常希望得到您对新版本的反馈：

• 如果您发现任何问题，请在 GitHub 上提出问题。
• 如果您有任何反馈，请在 GitHub Discussions 或 Pact Foundation Slack 的 #pact-python 频道中加入讨论。

安装

可以从 PyPi 安装最新版本的 Pact Python：

pip install pact-python
# 🚀 现在开始编写一些测试！

要求

Pact Python 尝试支持 Python 软件基金会仍在支持的所有 Python 版本。较旧的 Python 版本可能可以工作，但不受官方支持。

为了支持最广泛的用例，Pact Python 尽量对其使用的库版本施加最少的限制。

不跟踪

为了获得更好的统计数据，了解谁在使用 Pact，我们有一个匿名跟踪事件，在首次安装 Pact 时触发。我们跟踪的只有您的操作系统类型和正在安装的包的版本信息。此请求不会发送任何个人身份信息。您可以通过设置环境变量 PACT_DO_NOT_TRACK=1 来禁用跟踪：

贡献

我们欢迎以多种形式对 Pact Python 库做出贡献。有很多方法可以提供帮助，从编写代码，提供新示例，编写文档，到测试库和提供反馈。有关更多信息，请参阅贡献指南。