Revert using consolekit for terminal_colours and coloured_diff

Author: domdfcoding

domdf_python_tools/terminal_colours.py

@@ -64,29 +64,14 @@
 #  Distributed under the BSD 3-Clause license.
 #
 
+# stdlib
+import re
+from abc import ABC
+from typing import List, Pattern
+
 # 3rd party
-from consolekit.terminal_colours import (
-		BEL,
-		CSI,
-		OSC,
-		AnsiBack,
-		AnsiCodes,
-		AnsiCursor,
-		AnsiFore,
-		AnsiStyle,
-		Back,
-		Colour,
-		Cursor,
-		Fore,
-		Style,
-		back_stack,
-		clear_line,
-		code_to_chars,
-		fore_stack,
-		set_title,
-		strip_ansi,
-		style_stack
-		)
+from colorama import init  # type: ignore
+from typing_extensions import Final
 
 __all__ = [
 		"CSI",
@@ -109,6 +94,289 @@
 		"strip_ansi",
 		]
 
+init()
+
+CSI: Final[str] = "\u001b["
+OSC: Final[str] = "\u001b]"
+BEL: Final[str] = '\x07'
+
+fore_stack: List[str] = []
+back_stack: List[str] = []
+style_stack: List[str] = []
+
+
+def code_to_chars(code) -> str:
+	return CSI + str(code) + 'm'
+
+
+def set_title(title: str) -> str:
+	return OSC + "2;" + title + BEL
+
 
 def clear_screen(mode: int = 2) -> str:
 	return CSI + str(mode) + 'J'
+
+
+def clear_line(mode: int = 2) -> str:
+	return CSI + str(mode) + 'K'
+
+
+_ansi_re: Pattern[str] = re.compile(r"\033\[[;?0-9]*[a-zA-Z]")
+
+
+def strip_ansi(value: str) -> str:
+	"""
+	Strip ANSI colour codes from the given string to return a plaintext output.
+
+	:param value:
+
+	:rtype:
+
+	.. versionadded:: 1.1.0
+	"""
+
+	return _ansi_re.sub('', value)
+
+
+class Colour(str):
+	r"""
+	An ANSI escape sequence representing a colour.
+
+	The colour can be used as a context manager, a string, or a function.
+
+	:param style: Escape sequence representing the style.
+	:type style: :class:`str`
+	:param stack: The stack to place the escape sequence on.
+	:type stack: :class:`~typing.List`\[:class:`str`\]
+	:param reset: The escape sequence to reset the style.
+	:type reset: :class:`str`
+	"""
+
+	style: str
+	reset: str
+	stack: List[str]
+
+	def __new__(cls, style: str, stack: List[str], reset: str) -> "Colour":  # noqa D102
+		color = super().__new__(cls, style)  # type: ignore
+		color.style = style
+		color.stack = stack
+		color.reset = reset
+
+		return color
+
+	def __enter__(self) -> None:
+		print(self.style, end='')
+		self.stack.append(self.style)
+
+	def __exit__(self, exc_type, exc_val, exc_tb) -> None:
+		if self.style == self.stack[-1]:
+			self.stack.pop()
+			print(self.stack[-1], end='')
+
+	def __call__(self, text) -> str:
+		"""
+		Returns the given text in this colour.
+		"""
+
+		return f"{self}{text}{self.reset}"
+
+
+class AnsiCodes(ABC):
+	"""
+	Abstract base class for ANSI Codes.
+	"""
+
+	_stack: List[str]
+	_reset: str
+
+	def __init__(self) -> None:
+		"""
+		The subclasses declare class attributes which are numbers.
+
+		Upon instantiation we define instance attributes, which are the same
+		as the class attributes but wrapped with the ANSI escape sequence.
+		"""
+
+		for name in dir(self):
+			if not name.startswith('_'):
+				value = getattr(self, name)
+				setattr(self, name, Colour(code_to_chars(value), self._stack, self._reset))
+
+
+class AnsiCursor:
+
+	def UP(self, n: int = 1) -> str:
+		"""
+
+		:param n:
+		"""
+
+		return f"{CSI}{str(n)}A"
+
+	def DOWN(self, n: int = 1) -> str:
+		"""
+
+		:param n:
+		"""
+
+		return f"{CSI}{str(n)}B"
+
+	def FORWARD(self, n: int = 1) -> str:
+		"""
+
+		:param n:
+		"""
+
+		return f"{CSI}{str(n)}C"
+
+	def BACK(self, n: int = 1) -> str:
+		"""
+
+		:param n:
+		"""
+
+		return f"{CSI}{str(n)}D"
+
+	def POS(self, x: int = 1, y: int = 1) -> str:
+		"""
+
+		:param x:
+		:param y:
+		"""
+
+		return f"{CSI}{str(y)};{str(x)}H"
+
+
+class AnsiFore(AnsiCodes):
+	"""
+	ANSI Colour Codes for foreground colour.
+
+	The colours can be used as a context manager, a string, or a function.
+
+	Valid values are:
+
+	* BLACK
+	* RED
+	* GREEN
+	* YELLOW
+	* BLUE
+	* MAGENTA
+	* CYAN
+	* WHITE
+	* RESET
+	* LIGHTBLACK_EX
+	* LIGHTRED_EX
+	* LIGHTGREEN_EX
+	* LIGHTYELLOW_EX
+	* LIGHTBLUE_EX
+	* LIGHTMAGENTA_EX
+	* LIGHTCYAN_EX
+	* LIGHTWHITE_EX
+	"""
+
+	_stack = fore_stack
+	_reset = "\u001b[39m"
+
+	BLACK = 30
+	RED = 31
+	GREEN = 32
+	YELLOW = 33
+	BLUE = 34
+	MAGENTA = 35
+	CYAN = 36
+	WHITE = 37
+	RESET = 39
+
+	# These are fairly well supported, but not part of the standard.
+	LIGHTBLACK_EX = 90
+	LIGHTRED_EX = 91
+	LIGHTGREEN_EX = 92
+	LIGHTYELLOW_EX = 93
+	LIGHTBLUE_EX = 94
+	LIGHTMAGENTA_EX = 95
+	LIGHTCYAN_EX = 96
+	LIGHTWHITE_EX = 97
+
+
+class AnsiBack(AnsiCodes):
+	"""
+	ANSI Colour Codes for background colour.
+
+	The colours can be used as a context manager, a string, or a function.
+
+	Valid values are:
+
+	* BLACK
+	* RED
+	* GREEN
+	* YELLOW
+	* BLUE
+	* MAGENTA
+	* CYAN
+	* WHITE
+	* RESET
+	* LIGHTBLACK_EX
+	* LIGHTRED_EX
+	* LIGHTGREEN_EX
+	* LIGHTYELLOW_EX
+	* LIGHTBLUE_EX
+	* LIGHTMAGENTA_EX
+	* LIGHTCYAN_EX
+	* LIGHTWHITE_EX
+	"""
+
+	_stack = back_stack
+	_reset = "\u001b[49m"
+
+	BLACK = 40
+	RED = 41
+	GREEN = 42
+	YELLOW = 43
+	BLUE = 44
+	MAGENTA = 45
+	CYAN = 46
+	WHITE = 47
+	RESET = 49
+
+	# These are fairly well supported, but not part of the standard.
+	LIGHTBLACK_EX = 100
+	LIGHTRED_EX = 101
+	LIGHTGREEN_EX = 102
+	LIGHTYELLOW_EX = 103
+	LIGHTBLUE_EX = 104
+	LIGHTMAGENTA_EX = 105
+	LIGHTCYAN_EX = 106
+	LIGHTWHITE_EX = 107
+
+
+class AnsiStyle(AnsiCodes):
+	"""
+	ANSI Colour Codes for text style.
+
+	Valid values are:
+
+	* BRIGHT
+	* DIM
+	* NORMAL
+
+	Additionally, ``AnsiStyle.RESET_ALL`` can be used to reset the
+	foreground and background colours as well as the text style.
+	"""
+
+	_stack = style_stack
+	_reset = "\u001b[22m"
+
+	BRIGHT = 1
+	DIM = 2
+	NORMAL = 22
+	RESET_ALL = 0
+
+
+Fore = AnsiFore()
+Back = AnsiBack()
+Style = AnsiStyle()
+Cursor = AnsiCursor()
+
+fore_stack.append(Fore.RESET)
+back_stack.append(Back.RESET)
+style_stack.append(Style.NORMAL)