Add a new tox plugin setting to do rm -r
#1118
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
Replace uses of `rm` in tox.ini with custom `rmtree` config setting, provided by the toxfile.py plugin. Advantages over using `rm`: - more concise, without the risk of forgetting `allowlist_externals` - more portable -- works on Windows Some projects have historically made themselves more portable by embedding `python -c ...` invocations in their tox config. This solves the problem of "how to do that cleanly".
sirosen
requested review from
aaschaer,
ada-globus,
derek-globus,
kurtmckee,
m1yag1 and
MaxTueckeGlobus
as code owners
sirosen
commented
Dec 15, 2024
| for name in sdk_rmtree: | ||
| path = pathlib.Path(name) | ||
| if path.exists(): | ||
| log.warning(f"globus_sdk_rmtree: {path}") |
There was a problem hiding this comment.
Oh, quick review note: logged warnings show up in tox output by default, but info logs don't.
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.
Experimental PR: I decided to see if I could solve this problem, and what the tradeoffs would be.
We should be quick to reject it if we don't like the result, after a discussion.
The basic questions I wanted to answer were:
rm, specifically?Something non-obvious about this from just seeing the PR is that it took ~1 hour to implement these very modest changes.
The tox docs for the plugin hooks and objects are lagging a bit behind best-in-class tools like
pytest, so it took some trial-and-error + reading up on existing plugins (liketox-docker) to see what they're doing.Replace uses of
rmin tox.ini with customrmtreeconfig setting, provided by the toxfile.py plugin.Advantages over using
rm:allowlist_externalsSome projects have historically made themselves more portable by embedding
python -c ...invocations in their tox config. This solves the problem of "how to do that cleanly".📚 Documentation preview 📚: https://globus-sdk-python--1118.org.readthedocs.build/en/1118/