pre-commit/pre_commit/color.py

import os
import sys

terminal_supports_color = True
if sys.platform == 'win32':  # pragma: no cover (windows)
    from pre_commit.color_windows import enable_virtual_terminal_processing
    try:
        enable_virtual_terminal_processing()
    except OSError:
        terminal_supports_color = False

RED = '\033[41m'
GREEN = '\033[42m'
YELLOW = '\033[43;30m'
TURQUOISE = '\033[46;30m'
SUBTLE = '\033[2m'
NORMAL = '\033[0m'


class InvalidColorSetting(ValueError):
    pass


def format_color(text: str, color: str, use_color_setting: bool) -> str:
    """Format text with color.

    Args:
        text - Text to be formatted with color if `use_color`
        color - The color start string
        use_color_setting - Whether or not to color
    """
    if not use_color_setting:
        return text
    else:
        return f'{color}{text}{NORMAL}'


COLOR_CHOICES = ('auto', 'always', 'never')


def use_color(setting: str) -> bool:
    """Choose whether to use color based on the command argument.

    Args:
        setting - Either `auto`, `always`, or `never`
    """
    if setting not in COLOR_CHOICES:
        raise InvalidColorSetting(setting)

    return (
        setting == 'always' or (
            setting == 'auto' and
            sys.stdout.isatty() and
            terminal_supports_color and
            os.getenv('TERM') != 'dumb'
        )
    )