Files
nuitka-mirror/misc/install-git-hooks.py
Kay Hayen 7bcd580a6d Project: Correct a few mistakes done when changing the license
* Reference the runtime exception everywhere as that is expected
  to be done, not just generally.

* Proper link to the correct version of the license file on the
  web.
2026-05-15 13:27:38 +02:00

151 lines
4.8 KiB
Python
Executable File

#!/usr/bin/env python
# Copyright 2026, Kay Hayen, mailto:kay.hayen@gmail.com find license text at end of file
"""Launcher for git hook installer tool."""
import os
import sys
# Unchanged, running from checkout, use the parent directory, the nuitka
# package ought be there.
sys.path.insert(0, os.path.normpath(os.path.join(os.path.dirname(__file__), "..")))
# isort:start
import stat
from nuitka.options.CommandLineOptionsTools import makeOptionsParser
from nuitka.tools.Basics import goHome
from nuitka.tools.release.Release import getGitDir
from nuitka.Tracing import tools_logger
from nuitka.utils.Execution import getExecutablePath
from nuitka.utils.FileOperations import (
getFileContents,
getWindowsShortPathName,
)
def _getWindowsShPath():
git_path = getExecutablePath("git")
if git_path is None:
git_path = r"C:\Program Files\Git\bin\sh.exe"
if not os.path.exists(git_path):
git_path = None
if git_path is None:
return tools_logger.sysexit("""\
Error, cannot locate 'git.exe' which we need to install git hooks. Add it to
PATH while executing this will be sufficient.""")
for candidate in (
"sh.exe",
os.path.join("..", "bin", "sh.exe"),
os.path.join("..", "..", "bin", "sh.exe"),
):
result = os.path.normpath(os.path.join(os.path.dirname(git_path), candidate))
if os.path.exists(result):
break
else:
return tools_logger.sysexit("""\
Error, cannot locate 'sh.exe' near 'git.exe' which we need to install git hooks,
please improve this script.""")
# For MinGW and #! we will need a path without spaces, so use this
# code to find the short name, that won't have it.
return getWindowsShortPathName(result)
def main():
parser = makeOptionsParser(usage="usage: %prog [options]", epilog="")
parser.add_option(
"--no-pre-commit",
action="store_false",
dest="pre_commit",
default=True,
help="Do not install the pre-commit hook.",
)
parser.add_option(
"--no-pre-push",
action="store_false",
dest="pre_push",
default=True,
help="Do not install the pre-push hook.",
)
options, _args = parser.parse_args()
goHome()
git_dir = getGitDir()
for hook in os.listdir(".githooks"):
hook_target = os.path.join(git_dir, "hooks", hook)
if hook == "pre-commit" and not options.pre_commit:
if os.path.exists(hook_target):
os.remove(hook_target)
continue
if hook == "pre-push" and not options.pre_push:
if os.path.exists(hook_target):
os.remove(hook_target)
continue
full_path = os.path.join(".githooks", hook)
hook_contents = getFileContents(full_path)
if hook_contents.startswith("#!/bin/sh"):
if os.name == "nt":
sh_path = _getWindowsShPath()
# Correct shebang for Windows git to work.
hook_contents = "#!%s\n%s" % (
sh_path.replace("\\", "/").replace(" ", r"\ "),
hook_contents[10:],
)
# Also use "sys.executable" to make sure we find Nuitka tools.
for tool_name in (
"autoformat-nuitka-source",
"check-nuitka-with-pylint",
"generate-specialized-c-code",
"generate-specialized-python-code",
):
hook_contents = hook_contents.replace(
"./bin/%s" % tool_name,
"'%s' ./bin/%s" % (sys.executable, tool_name),
)
else:
sys.exit("Error, unknown hook contents.")
with open(hook_target, "wb") as out_file:
out_file.write(hook_contents.encode("utf8"))
st = os.stat(hook_target)
os.chmod(hook_target, st.st_mode | stat.S_IEXEC)
if __name__ == "__main__":
main()
# Part of "Nuitka", an optimizing Python compiler that is compatible and
# integrates with CPython, but also works on its own.
#
# Licensed under the GNU Affero General Public License, Version 3 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.gnu.org/licenses/agpl-3.0.txt
#
# See also: "Nuitka Runtime Library Exception, Version 1.0" in file
# "LICENSE-RUNTIME.txt" for additional permissions granted under Section 7.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.