Remove color_filter module (Moving to Telix) (jquast#132)

This feature will be moved into https://github.com/jquast/telix

Author: jquast

docs/api/color_filter.rst

@@ -1,5 +1,14 @@
 History
 =======
+4.0.0
+  * removed: ``telnetlib3.color_filter``. ``ColorFilter``, ``ColorConfig``, ``PALETTES``,
+    ``PetsciiColorFilter``, and ``AtasciiControlFilter`` have all been moved to the downstream
+    `Telix <https://github.com/jquast/Telix>`_ project, recommended for connecting to legacy `BBSs
+    <https://bbs.modem.xyz/>`_ systems requiring color correction.
+
+    ``telnetlib3-client`` CLI args ``--colormatch``, ``--color-brightness``, ``--color-contrast``,
+    ``--background-color``, ``--ice-colors`` removed.
+
 3.0.3
   * bugfix: server and client now correctly complete LINEMODE negotiation when prompted to.
   * new: ``--logfile-mode {append,rewrite}`` and ``--typescript-mode`` CLI flags
@@ -124,7 +133,7 @@ History
     art) as surrogates instead of replacing them with U+FFFD.
 
 2.4.0
-  * new: :mod:`telnetlib3.color_filter` module — translates 16-color ANSI SGR
+  * new: ``telnetlib3.color_filter`` module — translates 16-color ANSI SGR
     codes to 24-bit RGB from hardware palettes (EGA, CGA, VGA, xterm).
     Enabled by default.  New client CLI options: ``--colormatch``,
     ``--color-brightness``, ``--color-contrast``, ``--background-color``,

docs/history.rst

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "telnetlib3"
-version = "3.0.3"  # Keep in sync with telnetlib3/accessories.py::get_version !
+version = "4.0.0"  # Keep in sync with telnetlib3/accessories.py::get_version !
 description = " Python Telnet server and client CLI and Protocol library"
 readme = "README.rst"
 license = "ISC"

pyproject.toml

@@ -16,7 +16,6 @@
 from . import stream_reader
 from . import client_base
 from . import client_shell
-from . import color_filter
 from . import client
 from . import telopt
 from . import mud

telnetlib3/__init__.py

@@ -31,7 +31,6 @@ def __init__(self) -> None:
         self.raw_mode: Optional[bool] = None
         self.ascii_eol: bool = False
         self.input_filter: Optional[Any] = None
-        self.color_filter: Optional[Any] = None
         self.autoreply_engine: Optional[Any] = None
         self.autoreply_wait_fn: Optional[Callable[..., Awaitable[None]]] = None
         self.typescript_file: Optional[IO[str]] = None

telnetlib3/_session_context.py

@@ -42,7 +42,7 @@
 
 def get_version() -> str:
     """Return the current version of telnetlib3."""
-    return "3.0.3"  # keep in sync with pyproject.toml !
+    return "4.0.0"  # keep in sync with pyproject.toml !
 
 
 def encoding_from_lang(lang: str) -> Optional[str]:

telnetlib3/accessories.py

@@ -685,56 +685,7 @@ def _patched_connection_made(transport: asyncio.BaseTransport) -> None:
 
     client_factory: Optional[Callable[..., client_base.BaseClient]] = _client_factory
 
-    # Wrap the shell callback to inject color filter when enabled
-    colormatch: str = args["colormatch"]
     shell_callback = args["shell"]
-    if colormatch.lower() != "none":
-        from .color_filter import (
-            PALETTES,
-            ColorConfig,
-            ColorFilter,
-            PetsciiColorFilter,
-            AtasciiControlFilter,
-        )
-
-        # Auto-select encoding-specific filters
-        encoding_name: str = args.get("encoding", "") or ""
-        is_petscii = encoding_name.lower() in ("petscii", "cbm", "commodore", "c64", "c128")
-        is_atascii = encoding_name.lower() in ("atascii", "atari8bit", "atari_8bit")
-        if colormatch == "petscii":
-            colormatch = "c64"
-        if is_petscii and colormatch != "c64":
-            colormatch = "c64"
-
-        if colormatch not in PALETTES:
-            print(
-                f"Unknown palette {colormatch!r}," f" available: {', '.join(sorted(PALETTES))}",
-                file=sys.stderr,
-            )
-            sys.exit(1)
-        color_config = ColorConfig(
-            palette_name=colormatch,
-            brightness=args["color_brightness"],
-            contrast=args["color_contrast"],
-            background_color=args["background_color"],
-            ice_colors=args["ice_colors"],
-        )
-        if is_petscii or colormatch == "c64":
-            color_filter_obj: object = PetsciiColorFilter(color_config)
-        elif is_atascii:
-            color_filter_obj = AtasciiControlFilter()
-        else:
-            color_filter_obj = ColorFilter(color_config)
-        original_shell = shell_callback
-
-        async def _color_shell(
-            reader: Union[TelnetReader, TelnetReaderUnicode],
-            writer_arg: Union[TelnetWriter, TelnetWriterUnicode],
-        ) -> None:
-            writer_arg.ctx.color_filter = color_filter_obj
-            await original_shell(reader, writer_arg)
-
-        shell_callback = _color_shell
 
     # Wrap shell to inject raw_mode flag and input translation for retro encodings
     raw_mode_val: Optional[bool] = args.get("raw_mode", False)
@@ -894,44 +845,6 @@ def _get_argument_parser() -> argparse.ArgumentParser:
         metavar="OPT",
         help="always send DO for this option (name like GMCP or number, repeatable)",
     )
-    parser.add_argument(
-        "--colormatch",
-        default="vga",
-        metavar="PALETTE",
-        help=(
-            "translate basic 16-color ANSI codes to exact 24-bit RGB values"
-            " from a named hardware palette, bypassing the terminal's custom"
-            " palette to preserve intended MUD/BBS artwork colors"
-            " (vga, xterm, none)"
-        ),
-    )
-    parser.add_argument(
-        "--color-brightness",
-        default=1.0,
-        type=float,
-        metavar="FLOAT",
-        help="color brightness scale [0.0..1.0], where 1.0 is original",
-    )
-    parser.add_argument(
-        "--color-contrast",
-        default=1.0,
-        type=float,
-        metavar="FLOAT",
-        help="color contrast scale [0.0..1.0], where 1.0 is original",
-    )
-    parser.add_argument(
-        "--background-color",
-        default="#000000",
-        metavar="#RRGGBB",
-        help="forced background color as hex RGB (near-black by default)",
-    )
-    parser.add_argument(
-        "--ice-colors",
-        action=argparse.BooleanOptionalAction,
-        default=True,
-        help="treat SGR 5 (blink) as bright background (iCE colors)"
-        " for BBS/ANSI art (default: enabled)",
-    )
     parser.add_argument(
         "--ascii-eol",
         action="store_true",
@@ -1013,20 +926,6 @@ def _parse_option_arg(value: str) -> bytes:
         return bytes([int(value)])
 
 
-def _parse_background_color(value: str) -> Tuple[int, int, int]:
-    """
-    Parse hex color string to RGB tuple.
-
-    :param value: Color string like ``"#RRGGBB"`` or ``"RRGGBB"``.
-    :returns: (R, G, B) tuple with values 0-255.
-    :raises ValueError: When *value* is not a valid hex color.
-    """
-    h = value.lstrip("#")
-    if len(h) != 6:
-        raise ValueError(f"invalid hex color: {value!r}")
-    return (int(h[0:2], 16), int(h[2:4], 16), int(h[4:6], 16))
-
-
 def _transform_args(args: argparse.Namespace) -> Dict[str, Any]:
     # Auto-enable force_binary for any non-ASCII encoding that uses high-bit bytes.
     from .encodings import FORCE_BINARY_ENCODINGS
@@ -1075,11 +974,6 @@ def _transform_args(args: argparse.Namespace) -> Dict[str, Any]:
         "send_environ": tuple(v.strip() for v in args.send_environ.split(",") if v.strip()),
         "always_will": {_parse_option_arg(v) for v in args.always_will},
         "always_do": {_parse_option_arg(v) for v in args.always_do},
-        "colormatch": args.colormatch,
-        "color_brightness": args.color_brightness,
-        "color_contrast": args.color_contrast,
-        "background_color": _parse_background_color(args.background_color),
-        "ice_colors": args.ice_colors,
         "raw_mode": raw_mode,
         "ascii_eol": args.ascii_eol,
         "ansi_keys": args.ansi_keys,

telnetlib3/client.py

@@ -568,17 +568,14 @@ def _transform_output(
         out: str, writer: Union[TelnetWriter, TelnetWriterUnicode], in_raw_mode: bool
     ) -> str:
         r"""
-        Apply color filter, ASCII EOL substitution, and CRLF normalization.
+        Apply ASCII EOL substitution and CRLF normalization.
 
         :param out: Server output text to transform.
-        :param writer: Telnet writer (``ctx`` provides color filter and ascii_eol).
+        :param writer: Telnet writer (``ctx`` provides ascii_eol).
         :param in_raw_mode: When ``True``, normalize line endings to ``\r\n``.
         :returns: Transformed output string.
         """
         ctx: TelnetSessionContext = writer.ctx
-        cf = ctx.color_filter
-        if cf is not None:
-            out = cf.filter(out)
         if ctx.ascii_eol:
             out = out.replace(_ATASCII_CR_CHAR, "\r").replace(_ATASCII_LF_CHAR, "\n")
         if in_raw_mode:
@@ -634,16 +631,6 @@ def _get_raw_mode(writer: Union[TelnetWriter, TelnetWriterUnicode]) -> "bool | N
         """Return the writer's ``ctx.raw_mode`` (``None``, ``True``, or ``False``)."""
         return writer.ctx.raw_mode
 
-    def _flush_color_filter(
-        writer: Union[TelnetWriter, TelnetWriterUnicode], stdout: asyncio.StreamWriter
-    ) -> None:
-        """Flush any pending color filter output to stdout."""
-        cf = writer.ctx.color_filter
-        if cf is not None:
-            flush = cf.flush()
-            if flush:
-                stdout.write(flush.encode())
-
     def _ensure_autoreply_engine(
         telnet_writer: Union[TelnetWriter, TelnetWriterUnicode],
     ) -> "Optional[Any]":
@@ -856,7 +843,6 @@ async def _wait_for_prompt_raw() -> None:
             stdout.write(f"Escape character is '{escape_name}'.{banner_sep}".encode())
 
             def _handle_close(msg: str) -> None:
-                _flush_color_filter(telnet_writer, stdout)
                 stdout.write(f"\033[m{linesep}{msg}{linesep}".encode())
                 tty_shell.cleanup_winch()