1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
#!/usr/bin/env python
#
# terminal_colours.py
"""
Functions for adding colours to terminal print statements.
This module generates ANSI character codes to printing colors to terminals.
See: http://en.wikipedia.org/wiki/ANSI_escape_code
"""
#
# Copyright © 2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
# MA 02110-1301, USA.
#
# Based on colorama
# https://github.com/tartley/colorama
# Copyright Jonathan Hartley 2013
# Distributed under the BSD 3-Clause license.
# | Redistribution and use in source and binary forms, with or without
# | modification, are permitted provided that the following conditions are met:
# |
# | * Redistributions of source code must retain the above copyright notice, this
# | list of conditions and the following disclaimer.
# |
# | * Redistributions in binary form must reproduce the above copyright notice,
# | this list of conditions and the following disclaimer in the documentation
# | and/or other materials provided with the distribution.
# |
# | * Neither the name of the copyright holders, nor those of its contributors
# | may be used to endorse or promote products derived from this software without
# | specific prior written permission.
# |
# | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# | ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# Includes modifications to colorama made by Bram Geelen in
# https://github.com/tartley/colorama/pull/141/files
#
# resolve_color_default, _ansi_re and strip_ansi based on
# https://github.com/pallets/click
# Copyright 2014 Pallets
# Distributed under the BSD 3-Clause license.
#
# stdlib
from abc import ABC
from typing import Deque, List, Optional, Type, TypeVar, Union
# 3rd party
from typing_extensions import Final
ColourTrilean = Optional[bool]
CSI: Final[str]
OSC: Final[str]
BEL: Final[str]
fore_stack: Deque[str]
back_stack: Deque[str]
style_stack: Deque[str]
def resolve_color_default(color: Optional[bool] = ...) -> Optional[bool]: ...
def code_to_chars(code: Union[str, int]) -> str: ...
def set_title(title: str) -> str: ...
# def clear_screen(mode: int = ...) -> str: ...
def clear_line(mode: int = ...) -> str: ...
def strip_ansi(value: str) -> str: ...
_C = TypeVar("_C", bound="Colour")
_AC = TypeVar("_AC", bound="AnsiCodes")
class Colour(str):
style: str
reset: str
stack: Union[Deque[str], List[str]]
def __new__(cls, style: str, stack: Union[Deque[str], List[str]], reset: str) -> "Colour": ...
def __enter__(self) -> None: ...
def __exit__(self, exc_type, exc_val, exc_tb) -> None: ...
def __call__(self, text) -> str: ... # noqa: MAN001
@classmethod
def from_code(cls: Type[_C], code: Union[str, int], background: bool = ...) -> _C: ...
@classmethod
def from_256_code(cls: Type[_C], code: Union[str, int], background: bool = ...) -> _C: ...
@classmethod
def from_rgb(
cls: Type[_C],
r: Union[str, int],
g: Union[str, int],
b: Union[str, int],
background: bool = ...
) -> _C: ...
@classmethod
def from_hex(cls: Type[_C], hex_colour: str, background: bool = ...) -> _C: ...
def print_256_colour_testpattern() -> None: ...
class AnsiCodes(ABC):
_stack: Union[Deque[str], List[str]]
_reset: str
def __new__(cls: Type[_AC], *args, **kwargs) -> Type[_AC]: ... # type: ignore[misc]
class AnsiCursor:
def UP(self, n: int = ...) -> str: ...
def DOWN(self, n: int = ...) -> str: ...
def FORWARD(self, n: int = ...) -> str: ...
def BACK(self, n: int = ...) -> str: ...
def POS(self, x: int = ..., y: int = ...) -> str: ...
def HIDE(self) -> str: ...
def SHOW(self) -> str: ...
class AnsiFore(AnsiCodes):
BLACK: Colour
RED: Colour
GREEN: Colour
YELLOW: Colour
BLUE: Colour
MAGENTA: Colour
CYAN: Colour
WHITE: Colour
RESET: Colour
# These are fairly well supported, but not part of the standard.
LIGHTBLACK_EX: Colour
LIGHTRED_EX: Colour
LIGHTGREEN_EX: Colour
LIGHTYELLOW_EX: Colour
LIGHTBLUE_EX: Colour
LIGHTMAGENTA_EX: Colour
LIGHTCYAN_EX: Colour
LIGHTWHITE_EX: Colour
class AnsiBack(AnsiCodes):
_stack: List[str]
_reset: str
BLACK: Colour
RED: Colour
GREEN: Colour
YELLOW: Colour
BLUE: Colour
MAGENTA: Colour
CYAN: Colour
WHITE: Colour
RESET: Colour
# These are fairly well supported, but not part of the standard.
LIGHTBLACK_EX: Colour
LIGHTRED_EX: Colour
LIGHTGREEN_EX: Colour
LIGHTYELLOW_EX: Colour
LIGHTBLUE_EX: Colour
LIGHTMAGENTA_EX: Colour
LIGHTCYAN_EX: Colour
LIGHTWHITE_EX: Colour
class AnsiStyle(AnsiCodes):
_stack: List[str]
_reset: str
BRIGHT: Colour
DIM: Colour
NORMAL: Colour
RESET_ALL: Colour
Fore = AnsiFore
Back = AnsiBack
Style = AnsiStyle
Cursor = AnsiCursor()
|
