feat: "Lazy load" VCR to reduce plugin overhead #146
Merged
Conversation
This file contains 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
Defer importing `_vcr` in `plugin.py` until the `vcr` fixture is invoked with a vcr-marked test. Move `merge_kwargs` helper to utils so it can be imported independently of VCR modules required by `_vcr.py`. Guard VCR object type hints using `if TYPE_CHECKING`.
Stranger6667
approved these changes
Jul 9, 2024
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.
Description
This PR defers importing
_vcrinplugin.pyuntil thevcrfixture is invoked with a vcr-marked test. Themerge_kwargshelper has been moved toutils.pyto allow importing it independently of the VCR modules required by_vcr.py. VCR object imports are now guarded usingif TYPE_CHECKING.To verify the performance improvement, I compared the results of running the same dummy test case with and without the vcr mark. I averaged results from running pytest 20 times, removing
__pycache__and.pytest_cachebetween runs. Here is a summary of the results:pytest_recordingversion@pytest.mark.vcrRuntimeThe results show a significant improvement in the runtime of unmarked tests, while the runtime of tests marked with
@pytest.mark.vcrremains comparable to the previous version.Checklist