Ensure deprecated colors still work.

Author: HexDecimal

libtcodpy.py

@@ -1,9 +1,11 @@
-"""This module just an alias for tcod"""
+"""Module alias for tcod."""
 import warnings
 
+from tcod import *  # noqa: F4
+from tcod.libtcodpy import __getattr__  # noqa: F401
+
 warnings.warn(
     "'import tcod as libtcodpy' is preferred.",
     DeprecationWarning,
     stacklevel=2,
 )
-from tcod import *  # noqa: F4

pyproject.toml

@@ -99,6 +99,7 @@ filterwarnings = [
     "ignore::DeprecationWarning:tcod.libtcodpy",
     "ignore::PendingDeprecationWarning:tcod.libtcodpy",
     "ignore:This class may perform poorly and is no longer needed.::tcod.map",
+    "ignore:'import tcod as libtcodpy' is preferred.",
 ]
 
 [tool.mypy]

tcod/__init__.py

@@ -25,7 +25,7 @@
     __version__ = ""
 
 
-def __getattr__(name: str) -> color.Color:
+def __getattr__(name: str, stacklevel: int = 1) -> color.Color:
     """Mark access to color constants as deprecated."""
     value: color.Color | None = getattr(constants, name, None)
     if value is None:
@@ -34,7 +34,7 @@ def __getattr__(name: str) -> color.Color:
     warnings.warn(
         f"Color constants will be removed from future releases.\nReplace `tcod.{name}` with `{tuple(value)}`.",
         FutureWarning,
-        stacklevel=2,
+        stacklevel=stacklevel + 1,
     )
     return value
 

tcod/libtcodpy.py

@@ -4201,6 +4201,15 @@ def _atexit_verify() -> None:
         lib.TCOD_console_delete(ffi.NULL)
 
 
+def __getattr__(name: str) -> Color:
+    """Mark access to color constants as deprecated."""
+    try:
+        return tcod.__getattr__(name, stacklevel=2)  # type: ignore[call-arg]
+    except AttributeError:
+        msg = f"module {__name__!r} has no attribute {name!r}"
+        raise AttributeError(msg) from None
+
+
 __all__ = [  # noqa: F405
     "Color",
     "Bsp",

tests/test_deprecated.py

@@ -3,8 +3,10 @@
 
 import pytest
 
+import libtcodpy
 import tcod
 import tcod.event
+import tcod.libtcodpy
 
 # ruff: noqa: D103
 
@@ -13,6 +15,10 @@
 def test_deprecate_color() -> None:
     with pytest.raises(FutureWarning, match=r".*\(0, 0, 0\)"):
         _ = tcod.black
+    with pytest.raises(FutureWarning, match=r".*\(0, 0, 0\)"):
+        _ = tcod.libtcodpy.black
+    with pytest.raises(FutureWarning, match=r".*\(0, 0, 0\)"):
+        _ = libtcodpy.black
 
 
 @pytest.mark.filterwarnings("error")