Skip to content

fix: avoid dumping globals dictionary to stderr on console script exit #287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
reginaldalfret wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: avoid dumping globals dictionary to stderr on console script exit #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/shiv/bootstrap/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ def run(module): # pragma: no cover
sys.exit(module())


def _run_script(script):
"""Execute a script via runpy without returning its module dictionary to sys.exit."""
runpy.run_path(script, run_name="__main__")


@contextmanager
def current_zipfile():
"""A function to vend the current zipfile, if any"""
Expand Down Expand Up @@ -262,7 +267,7 @@ def bootstrap(): # pragma: no cover
run(import_string(env.entry_point))

elif env.script is not None:
run(partial(runpy.run_path, str(site_packages / "bin" / env.script), run_name="__main__"))
run(partial(_run_script, str(site_packages / "bin" / env.script)))

# all other options exhausted, drop into interactive mode
execute_interpreter()
Expand Down
17 changes: 17 additions & 0 deletions test/test_bootstrap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@

import pytest

from functools import partial

from shiv.bootstrap import (
_run_script,
cache_path,
current_zipfile,
ensure_no_modify,
Expand All @@ -20,13 +23,27 @@
get_first_sitedir_index,
import_string,
prepend_pythonpath,
run,
)
from shiv.bootstrap.environment import Environment
from shiv.bootstrap.filelock import FileLock
from shiv.pip import install


class TestBootstrap:
def test_run_script(self, tmp_path):
script_file = tmp_path / "myscript.py"
output_file = tmp_path / "output.txt"
script_file.write_text(f"from pathlib import Path\nPath({repr(str(output_file))}).write_text('executed')\n")

ret = _run_script(str(script_file))
assert ret is None
assert output_file.read_text() == "executed"

with mock.patch("sys.exit") as mock_exit:
run(partial(_run_script, str(script_file)))
mock_exit.assert_called_once_with(None)

def test_import_string(self):
assert import_string("site.addsitedir") == addsitedir
assert import_string("site:addsitedir") == addsitedir
Expand Down