Repository navigation
fix: avoid dumping globals dictionary to stderr on console script exit - #287
Open
reginaldalfret wants to merge 1 commit into
Open
reginaldalfret wants to merge 1 commit into
reginaldalfret wants to merge 1 commit into
Conversation
When executing a console script with env.script, shiv previously passed partial(runpy.run_path, ...) directly to run(), which calls sys.exit(module()). Because runpy.run_path returns the executed module's globals dictionary, passing a dict to sys.exit() caused Python to print the string representation of the dictionary to stderr and terminate with exit status 1. Introduce _run_script helper that invokes runpy.run_path without returning its globals dict so that sys.exit receives None, cleanly exiting with code 0. Add regression unit test in test_bootstrap.py. Resolves linkedin#240 Signed-off-by: reginaldalfret <reginaldalfret@gmail.com>
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
1 participant
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 of Changes
When executing a console script via \env.script, \shiv\ previously passed \partial(runpy.run_path, ...)\ directly to
un(), which invokes \sys.exit(module()).
Because
unpy.run_path\ returns the module globals dictionary upon completion, passing this dictionary directly to \sys.exit(d)\ causes Python to print the string representation of the dictionary to \stderr\ and exit with code 1.
This PR introduces a _run_script\ helper that executes
unpy.run_path\ without returning the globals dictionary, ensuring that \sys.exit(None)\ is invoked on normal script completion (exiting with code 0 cleanly).
Verification
Resolves #240