106 lines
2.1 KiB
Python
106 lines
2.1 KiB
Python
# SPDX-FileCopyrightText: Florian Bruhin (The Compiler) <mail@qutebrowser.org>
|
|
#
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
|
|
"""Utility functions for scripts."""
|
|
|
|
import os
|
|
import os.path
|
|
import sys
|
|
import contextlib
|
|
|
|
|
|
# Import side-effects are an evil thing, but here it's okay so scripts using
|
|
# colors work on Windows as well.
|
|
try:
|
|
import colorama
|
|
except ImportError:
|
|
colorama = None
|
|
else:
|
|
colorama.init()
|
|
|
|
|
|
use_color = os.name != 'nt' or colorama
|
|
|
|
|
|
fg_colors = {
|
|
'reset': 0,
|
|
'bold': 1,
|
|
'black': 30,
|
|
'red': 31,
|
|
'green': 32,
|
|
'yellow': 33,
|
|
'blue': 34,
|
|
'magenta': 35,
|
|
'cyan': 36,
|
|
'white': 37,
|
|
}
|
|
|
|
|
|
bg_colors = {name: col + 10 for name, col in fg_colors.items()}
|
|
|
|
|
|
ON_CI = 'CI' in os.environ
|
|
|
|
|
|
def _esc(code):
|
|
"""Get an ANSI color code based on a color number."""
|
|
return '\033[{}m'.format(code)
|
|
|
|
|
|
def print_col(text, color, file=sys.stdout):
|
|
"""Print a colorized text."""
|
|
if use_color:
|
|
fg = _esc(fg_colors[color.lower()])
|
|
reset = _esc(fg_colors['reset'])
|
|
print(''.join([fg, text, reset]), file=file, flush=True)
|
|
else:
|
|
print(text, file=file, flush=True)
|
|
|
|
|
|
def print_error(text):
|
|
print_col(text, 'red', file=sys.stderr)
|
|
|
|
|
|
def print_title(text):
|
|
"""Print a title."""
|
|
print()
|
|
print_col("==================== {} ====================".format(text),
|
|
'yellow')
|
|
|
|
|
|
def print_subtitle(text):
|
|
"""Print a subtitle."""
|
|
print_col("------ {} ------".format(text), 'cyan')
|
|
|
|
|
|
def change_cwd():
|
|
"""Change the scripts cwd if it was started inside the script folder."""
|
|
cwd = os.getcwd()
|
|
if os.path.split(cwd)[1] == 'scripts':
|
|
os.chdir(os.path.join(cwd, os.pardir))
|
|
|
|
|
|
@contextlib.contextmanager
|
|
def gha_group(name):
|
|
"""Print a GitHub Actions group.
|
|
|
|
Gets ignored if not on CI.
|
|
"""
|
|
if ON_CI:
|
|
print('::group::' + name)
|
|
yield
|
|
print('::endgroup::')
|
|
else:
|
|
yield
|
|
|
|
|
|
def gha_error(message):
|
|
"""Print a GitHub Actions error.
|
|
|
|
Should only be called on CI.
|
|
"""
|
|
assert ON_CI
|
|
print('::error::' + message)
|