chore(examples): start examples overhaul #1166
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR starts a comprehensive overhaul of the Pact Python examples, focusing on modernizing the structure and improving pedagogical value. The main change is the introduction of a new aiohttp + Flask example with comprehensive documentation. Additionally, dependencies are simplified by removing redundant testing packages and parallelization that caused issues with the broker-dependent test ordering.
- Complete replacement of v2 examples with a new http/aiohttp_and_flask example
- Removal of pytest-xdist, pytest-rerunfailures, and coverage dependencies to simplify testing
- Addition of comprehensive documentation and standalone example structure
Reviewed Changes
Copilot reviewed 21 out of 22 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Removes redundant testing dependencies across multiple dependency groups |
| mkdocs.yml | Adds aiohttp and Flask documentation links for cross-referencing |
| examples/v2/ | Complete removal of old v2 example files (consumer, provider tests and implementations) |
| examples/http/aiohttp_and_flask/ | New comprehensive example with consumer, provider, tests, and documentation |
| examples/conftest.py | Simplifies configuration by removing broker setup and xdist warnings |
| examples/README.md | Updates to reflect new example structure and improved organization |
| examples/.ruff.toml | Reorganizes linting rules for better test file handling |
JP-Ellis
force-pushed
the
chore/examples-overhaul
branch
6 times, most recently
from
f69a983 to
c097058
Compare
Adapt the old v2 HTTP example to one using `aiohttp` and `flask`. Signed-off-by: JP-Ellis <josh@jpellis.me>
- `coverage` is included by `pytest-cov` - `pytest-rerunfailures` won't be needed when the broker has been removed. - `pytest-xdist` testing going back to single threads Signed-off-by: JP-Ellis <josh@jpellis.me>
Run each example in its own standalone venv. Signed-off-by: JP-Ellis <josh@jpellis.me>
So that they are in line with the updated Ruff linting rules. Signed-off-by: JP-Ellis <josh@jpellis.me>
Signed-off-by: JP-Ellis <josh@jpellis.me>
JP-Ellis
force-pushed
the
chore/examples-overhaul
branch
from
c097058 to
58691ef
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Summary
Main change is an overhaul of one of the examples. This it the first example to be adapted and more will be adapted.
In addition, the dependencies were simplified:
coverageis included bypytest-covpytest-rerunfailureswon't be needed when the broker has been removed.pytest-xdisttesting going back to single threads🚨 Breaking Changes🔥 Motivation
To eventually create a comprehensive and pedagogical set of examples.
🔨 Test Plan
CI
🔗 Related issues/PRs