Allow Colour name to be overridden.

domdfcoding · domdfcoding · commit 8a5ab3e0abe3 · 2025-12-26T10:07:00.000Z
diff --git a/consolekit/terminal_colours.py b/consolekit/terminal_colours.py
@@ -213,21 +213,39 @@ class Colour(str):
 	:type stack: :class:`~typing.List`\[:class:`str`\]
 	:param reset: The escape sequence to reset the style.
 	:type reset: :class:`str`
+	:param name: A friendly name for the style.
+	:type name: :class:`str`
 
+	.. versionchanged:: 1.10.0  Added ``name`` parameter.
 	.. autosummary-widths:: 7/16
 	"""
 
-	__slots__ = ("style", "reset", "stack")
+	__slots__ = ("style", "reset", "stack", "name")
 
 	style: str
 	reset: str
 	stack: Union[Deque[str], List[str]]
+	name: str
 
-	def __new__(cls, style: str, stack: Union[Deque[str], List[str]], reset: str) -> "Colour":  # noqa: D102
+	def __repr__(self) -> str:
+		if self.name:
+			return f"<Colour({super().__repr__()}, name={self.name!r})>"
+		else:
+			return f"<Colour({super().__repr__()})>"
+
+	def __new__(  # noqa: D102
+		cls,
+		style: str,
+		stack: Union[Deque[str], List[str]],
+		reset: str,
+		*,
+		name: Optional[str] = None,
+		) -> "Colour":
 		self = super().__new__(cls, style)  # type: ignore[import]
 		self.style = style
 		self.stack = stack
 		self.reset = reset
+		self.name = name  # Friendly name
 
 		return self
 
@@ -460,7 +478,7 @@ def __init_subclass__(cls, **kwargs) -> None:  # noqa: PRM002
 		for name in dir(cls):
 			if not name.startswith('_'):
 				value = getattr(cls, name)
-				setattr(cls, name, Colour(code_to_chars(value), cls._stack, cls._reset))
+				setattr(cls, name, Colour(code_to_chars(value), cls._stack, cls._reset, name=name))
 
 	def __new__(cls: Type[_AC], *args, **kwargs) -> Type[_AC]:  # noqa: D102
 		return cls
diff --git a/tests/test_terminal_colours.py b/tests/test_terminal_colours.py
@@ -97,6 +97,14 @@ def test_from_hex(self):
 		assert yellow == "\u001b[48;2;252;186;3m"
 		assert yellow("Hello") == "\u001b[48;2;252;186;3mHello\u001b[49m"
 
+	def test_repr(self):
+		black = Colour.from_code(30)
+		assert repr(black) == "<Colour('\\x1b[30m')>"
+
+		yellow = Colour.from_hex("#fcba03", background=True)
+		yellow.name = "yellow"
+		assert repr(yellow) == "<Colour('\\x1b[48;2;252;186;3m', name='yellow')>"
+
 
 def test_print_256_colour_testpattern(
 		monkeypatch,
