xref: /aosp_15_r20/tools/external_updater/color.py (revision 3c875a214f382db1236d28570d1304ce57138f32)
1#
2# Copyright (C) 2018 The Android Open Source Project
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8#      http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15
16import enum
17import sys
18
19USE_COLOR = sys.stdout.isatty()
20
21
22@enum.unique
23class Color(enum.Enum):
24    """Colors for output to console."""
25    FRESH = '\x1b[32m'
26    STALE = '\x1b[31;1m'
27    ERROR = '\x1b[31m'
28
29
30END_COLOR = '\033[0m'
31
32
33def color_string(string: str, color: Color) -> str:
34    """Changes the color of a string when print to terminal."""
35    if not USE_COLOR:
36        return string
37    return color.value + string + END_COLOR
38