-
Notifications
You must be signed in to change notification settings - Fork 1.1k
[ENH] Add test to validate execution of README Python examples#713
Merged
fkiraly merged 3 commits intoPyPortfolio:mainfrom Mar 8, 2026
Merged
[ENH] Add test to validate execution of README Python examples#713fkiraly merged 3 commits intoPyPortfolio:mainfrom
fkiraly merged 3 commits intoPyPortfolio:mainfrom
Conversation
Contributor
Adds a pytest that parses README.md and executes all python code blocks to ensure examples remain valid.
Closes #669
- Uses regex to extract Python blocks
- Executes them sequentially in a shared namespace (since examples are stateful)
- Runs from repo root so relative paths like
tests/resources/...resolve correctly - Adds repo root to
sys.pathsopypfoptcan be imported without installation
This verifies that README examples run as documented and helps prevent regressions in imports or usage.
Contributor
Author
|
The extra file changes occurred when I started working on the CI failure issue, as Ruff auto-formatting modified some files. and as it's not any logic break or any particular change so I added them here. |
fkiraly
approved these changes
Mar 8, 2026
Contributor
Author
|
Thanks @fkiraly |
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
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.