Fix sys.path manipulations for isolated mode
#552
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
As these were previously written, they didn't actually prove that the
original entry added by Python when memray was run had been removed,
which is especially problematic since:
python -m memray run -m somemodule
would remove an entry added by Python and re-add that same entry. We had
no proof this was actually running the expected code and making the
expected changes.
Use `python -c ...` when running `memray run -m` to exercise this
better, since we can check that the (different) path that would be added
by the interpreter has been replaced.
Continue using `python -m memray` when running `memray run -c cmd` and
`memray run script.py`, but have the script that gets run print the
entirety of `sys.path` so we can make assertions about what isn't there
as well as what is.
Signed-off-by: Matt Wozniski <[email protected]>
`memray run` tries to match the updates to `sys.path` that are performed by the interpreter itself when it starts. When those path updates are suppressed (by the `-I` or `-P` command line flags or their corresponding environment variables), Memray's emulation winds up overwriting paths in `sys.path` that needed to be left alone. Signed-off-by: Matt Wozniski <[email protected]>
These flags disable Python's manipulation of `sys.path`, and Memray shouldn't modify `sys.path` either if one of them has been passed. Signed-off-by: Matt Wozniski <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #552 +/- ##
==========================================
+ Coverage 92.55% 92.86% +0.31%
==========================================
Files 91 91
Lines 11304 11158 -146
Branches 1581 2034 +453
==========================================
- Hits 10462 10362 -100
+ Misses 837 796 -41
+ Partials 5 0 -5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
godlygeek
force-pushed
the
fix_sys_path_manipulations_for_isolated_mode
branch
from
5d2ea4f
to
9bea3f5
Compare
pablogsal
approved these changes
Feb 22, 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.
Closes #551
I struggled to write good tests for this, and while working on it I realized that at least one of the existing tests wasn't actually proving what it set out to prove, so I restructured the existing tests as well.