Coverage for birdplan/console/colors.py: 89%
9 statements
« prev ^ index » next coverage.py v7.4.4, created at 2024-04-23 03:27 +0000
« prev ^ index » next coverage.py v7.4.4, created at 2024-04-23 03:27 +0000
1#
2# SPDX-License-Identifier: GPL-3.0-or-later
3#
4# Copyright (c) 2019-2024, AllWorldIT
5#
6# This program is free software: you can redistribute it and/or modify
7# it under the terms of the GNU General Public License as published by
8# the Free Software Foundation, either version 3 of the License, or
9# (at your option) any later version.
10#
11# This program is distributed in the hope that it will be useful,
12# but WITHOUT ANY WARRANTY; without even the implied warranty of
13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14# GNU General Public License for more details.
15#
16# You should have received a copy of the GNU General Public License
17# along with this program. If not, see <http://www.gnu.org/licenses/>.
19"""Commandline colors."""
21import sys
23import click
25__all__ = ["colored"]
27# Check if we should use colors or not
28USE_COLORS = sys.stdout.isatty()
31def colored(text: str, color: str) -> str:
32 """
33 Display colored text.
35 Parameters
36 ----------
37 text : str
38 Text to color.
40 color : str
41 Colorama Fore color.
43 """
45 if USE_COLORS:
46 return click.style(text, fg=color)
47 return text