Skip to content

Pick a better python shebang for hook executable #893

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

Merged
asottile merged 1 commit into from
Dec 26, 2018
Merged

Pick a better python shebang for hook executable #893

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
13 changes: 13 additions & 0 deletions pre_commit/commands/install_uninstall.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

from pre_commit import git
from pre_commit import output
from pre_commit.languages import python
from pre_commit.repository import repositories
from pre_commit.util import cmd_output
from pre_commit.util import make_executable
Expand Down Expand Up @@ -43,6 +44,16 @@ def is_our_script(filename):
return any(h in contents for h in (CURRENT_HASH,) + PRIOR_HASHES)


def shebang():
if sys.platform == 'win32':
py = 'python'
else:
py = python.get_default_version()
if py == 'default':
py = 'python'
return '#!/usr/bin/env {}'.format(py)


def install(
runner, store, overwrite=False, hooks=False, hook_type='pre-commit',
skip_on_missing_conf=False,
Expand Down Expand Up @@ -84,6 +95,8 @@ def install(
before, rest = contents.split(TEMPLATE_START)
to_template, after = rest.split(TEMPLATE_END)

before = before.replace('#!/usr/bin/env python', shebang())

hook_file.write(before + TEMPLATE_START)
for line in to_template.splitlines():
var = line.split()[0]
Expand Down
20 changes: 20 additions & 0 deletions tests/commands/install_uninstall_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
from pre_commit.commands.install_uninstall import install_hooks
from pre_commit.commands.install_uninstall import is_our_script
from pre_commit.commands.install_uninstall import PRIOR_HASHES
from pre_commit.commands.install_uninstall import shebang
from pre_commit.commands.install_uninstall import uninstall
from pre_commit.languages import python
from pre_commit.runner import Runner
from pre_commit.util import cmd_output
from pre_commit.util import make_executable
Expand Down Expand Up @@ -45,6 +47,24 @@ def test_is_previous_pre_commit(tmpdir):
assert is_our_script(f.strpath)


def test_shebang_windows():
with mock.patch.object(sys, 'platform', 'win32'):
assert shebang() == '#!/usr/bin/env python'


def test_shebang_otherwise():
with mock.patch.object(sys, 'platform', 'posix'):
assert 'default' not in shebang()


def test_shebang_returns_default():
with mock.patch.object(sys, 'platform', 'posix'):
with mock.patch.object(
python, 'get_default_version', return_value='default',
):
assert shebang() == '#!/usr/bin/env python'


def test_install_pre_commit(tempdir_factory, store):
path = git_dir(tempdir_factory)
runner = Runner(path, C.CONFIG_FILE)
Expand Down