Decorate already deprecated functions

Clean up deprecation warnings in tests

Author: HexDecimal

pyproject.toml

@@ -99,8 +99,7 @@ addopts = [
 log_file_level = "DEBUG"
 faulthandler_timeout = 5
 filterwarnings = [
-    "ignore::DeprecationWarning:tcod.libtcodpy",
-    "ignore::PendingDeprecationWarning:tcod.libtcodpy",
+    "ignore:This function may be deprecated in the future:PendingDeprecationWarning",
     "ignore:This class may perform poorly and is no longer needed.::tcod.map",
     "ignore:'import tcod as libtcodpy' is preferred.",
 ]

tcod/console.py

@@ -645,6 +645,7 @@ def get_height_rect(self, x: int, y: int, width: int, height: int, string: str)
         string_ = string.encode("utf-8")
         return int(lib.TCOD_console_get_height_rect_n(self.console_c, x, y, width, height, len(string_), string_))
 
+    @deprecated("""Replace with 'console.draw_rect(x, y, width, height, ch=..., fg=..., bg=..., bg_blend=...)'""")
     def rect(  # noqa: PLR0913
         self,
         x: int,
@@ -677,6 +678,9 @@ def rect(  # noqa: PLR0913
         self.__deprecate_defaults("draw_rect", bg_blend, clear=bool(clear))
         lib.TCOD_console_rect(self.console_c, x, y, width, height, clear, bg_blend)
 
+    @deprecated(
+        """Replace with 'console.draw_rect(x, y, width=width, height=1, ch=ord("─"), fg=..., bg=..., bg_blend=...)'"""
+    )
     def hline(
         self,
         x: int,
@@ -686,7 +690,7 @@ def hline(
     ) -> None:
         """Draw a horizontal line on the console.
 
-        This always uses ord('─'), the horizontal line character.
+        This always uses ord("─"), the horizontal line character.
 
         Args:
             x (int): The x coordinate from the left.
@@ -704,6 +708,9 @@ def hline(
         self.__deprecate_defaults("draw_rect", bg_blend)
         lib.TCOD_console_hline(self.console_c, x, y, width, bg_blend)
 
+    @deprecated(
+        """Replace with 'console.draw_rect(x, y, width=1, height=height, ch=ord("│"), fg=..., bg=..., bg_blend=...)'"""
+    )
     def vline(
         self,
         x: int,
@@ -713,7 +720,7 @@ def vline(
     ) -> None:
         """Draw a vertical line on the console.
 
-        This always uses ord('│'), the vertical line character.
+        This always uses ord("│"), the vertical line character.
 
         Args:
             x (int): The x coordinate from the left.
@@ -1130,15 +1137,16 @@ def draw_frame(  # noqa: PLR0913
 
         Example::
 
+            >>> from tcod import libtcodpy
             >>> console = tcod.console.Console(12, 6)
             >>> console.draw_frame(x=0, y=0, width=3, height=3)
             >>> console.draw_frame(x=3, y=0, width=3, height=3, decoration="╔═╗║ ║╚═╝")
             >>> console.draw_frame(x=6, y=0, width=3, height=3, decoration="123456789")
             >>> console.draw_frame(x=9, y=0, width=3, height=3, decoration="/-\\| |\\-/")
             >>> console.draw_frame(x=0, y=3, width=12, height=3)
-            >>> console.print_box(x=0, y=3, width=12, height=1, string=" Title ", alignment=tcod.CENTER)
+            >>> console.print_box(x=0, y=3, width=12, height=1, string=" Title ", alignment=libtcodpy.CENTER)
             1
-            >>> console.print_box(x=0, y=5, width=12, height=1, string="┤Lower├", alignment=tcod.CENTER)
+            >>> console.print_box(x=0, y=5, width=12, height=1, string="┤Lower├", alignment=libtcodpy.CENTER)
             1
             >>> print(console)
             <┌─┐╔═╗123/-\

tcod/libtcodpy.py

@@ -410,7 +410,7 @@ def __setattr__(self, attr: str, value: Any) -> None:
     def __repr__(self) -> str:
         """Return a representation of this Key object."""
         params = []
-        params.append(f"pressed={self.pressed!r}, vk=tcod.{_LOOKUP_VK[self.vk]}")
+        params.append(f"pressed={self.pressed!r}, vk=libtcodpy.{_LOOKUP_VK[self.vk]}")
         if self.c:
             params.append(f"c=ord({chr(self.c)!r})")
         if self.text:
@@ -426,7 +426,7 @@ def __repr__(self) -> str:
         ]:
             if getattr(self, attr):
                 params.append(f"{attr}={getattr(self, attr)!r}")
-        return "tcod.Key({})".format(", ".join(params))
+        return "libtcodpy.Key({})".format(", ".join(params))
 
     @property
     def key_p(self) -> Any:
@@ -504,7 +504,7 @@ def __repr__(self) -> str:
         ]:
             if getattr(self, attr):
                 params.append(f"{attr}={getattr(self, attr)!r}")
-        return "tcod.Mouse({})".format(", ".join(params))
+        return "libtcodpy.Mouse({})".format(", ".join(params))
 
     @property
     def mouse_p(self) -> Any:
@@ -828,7 +828,8 @@ def color_gen_map(colors: Iterable[tuple[int, int, int]], indexes: Iterable[int]
         List[Color]: A list of Color instances.
 
     Example:
-        >>> tcod.color_gen_map([(0, 0, 0), (255, 128, 0)], [0, 5])
+        >>> from tcod import libtcodpy
+        >>> libtcodpy.color_gen_map([(0, 0, 0), (255, 128, 0)], [0, 5])
         [Color(0, 0, 0), Color(51, 25, 0), Color(102, 51, 0), \
 Color(153, 76, 0), Color(204, 102, 0), Color(255, 128, 0)]
     """
@@ -2667,13 +2668,13 @@ def heightmap_kernel_transform(
 
     Example:
         >>> import numpy as np
+        >>> from tcod import libtcodpy
         >>> heightmap = np.zeros((3, 3), dtype=np.float32)
         >>> heightmap[:,1] = 1
         >>> dx = [-1, 1, 0]
         >>> dy = [0, 0, 0]
         >>> weight = [0.33, 0.33, 0.33]
-        >>> tcod.heightmap_kernel_transform(heightmap, 3, dx, dy, weight,
-        ...                                 0.0, 1.0)
+        >>> libtcodpy.heightmap_kernel_transform(heightmap, 3, dx, dy, weight, 0.0, 1.0)
     """
     c_dx = ffi.new("int[]", dx)
     c_dy = ffi.new("int[]", dy)

tests/conftest.py

@@ -2,11 +2,12 @@
 
 import random
 import warnings
-from typing import Callable, Iterator, Union
+from typing import Any, Callable, Iterator, Union
 
 import pytest
 
 import tcod
+from tcod import libtcodpy
 
 # ruff: noqa: D103
 
@@ -15,6 +16,12 @@ def pytest_addoption(parser: pytest.Parser) -> None:
     parser.addoption("--no-window", action="store_true", help="Skip tests which need a rendering context.")
 
 
+@pytest.fixture(autouse=True)
+def add_tcod_to_namespace(doctest_namespace: dict[str, Any]) -> None:
+    doctest_namespace["tcod"] = tcod
+    doctest_namespace["libtcodpy"] = libtcodpy
+
+
 @pytest.fixture
 def uses_window(request: pytest.FixtureRequest) -> Iterator[None]:
     """Marks tests which require a rendering context."""
@@ -33,23 +40,23 @@ def session_console(request: pytest.FixtureRequest) -> Iterator[tcod.console.Con
     HEIGHT = 10
     TITLE = "libtcod-cffi tests"
     FULLSCREEN = False
-    RENDERER = getattr(tcod, "RENDERER_" + request.param)
+    RENDERER = getattr(libtcodpy, "RENDERER_" + request.param)
 
-    tcod.console_set_custom_font(FONT_FILE)
-    with tcod.console_init_root(WIDTH, HEIGHT, TITLE, FULLSCREEN, RENDERER, vsync=False) as con:
+    libtcodpy.console_set_custom_font(FONT_FILE)
+    with libtcodpy.console_init_root(WIDTH, HEIGHT, TITLE, FULLSCREEN, RENDERER, vsync=False) as con:
         yield con
 
 
 @pytest.fixture
 def console(session_console: tcod.console.Console) -> tcod.console.Console:
     console = session_console
-    tcod.console_flush()
+    libtcodpy.console_flush()
     with warnings.catch_warnings():
         warnings.simplefilter("ignore")
         console.default_fg = (255, 255, 255)
         console.default_bg = (0, 0, 0)
-        console.default_bg_blend = tcod.BKGND_SET
-        console.default_alignment = tcod.LEFT
+        console.default_bg_blend = libtcodpy.BKGND_SET
+        console.default_alignment = libtcodpy.LEFT
     console.clear()
     return console
 
@@ -61,13 +68,13 @@ def offscreen(console: tcod.console.Console) -> tcod.console.Console:
 
 
 @pytest.fixture
-def fg() -> tcod.Color:
-    return tcod.Color(random.randint(0, 255), random.randint(0, 255), random.randint(0, 255))
+def fg() -> libtcodpy.Color:
+    return libtcodpy.Color(random.randint(0, 255), random.randint(0, 255), random.randint(0, 255))
 
 
 @pytest.fixture
-def bg() -> tcod.Color:
-    return tcod.Color(random.randint(0, 255), random.randint(0, 255), random.randint(0, 255))
+def bg() -> libtcodpy.Color:
+    return libtcodpy.Color(random.randint(0, 255), random.randint(0, 255), random.randint(0, 255))
 
 
 def ch_ascii_int() -> int:
@@ -96,4 +103,4 @@ def ch_latin1_str() -> str:
 )
 def ch(request: pytest.FixtureRequest) -> Callable[[], Union[int, str]]:
     """Test with multiple types of ascii/latin1 characters."""
-    return globals()["ch_%s" % request.param]()  # type: ignore
+    return globals()[f"ch_{request.param}"]()  # type: ignore

tests/test_console.py

@@ -73,13 +73,17 @@ def test_console_methods() -> None:
     console.print_(0, 0, "Test")
     console.print_rect(0, 0, 2, 8, "a b c d e f")
     console.get_height_rect(0, 0, 2, 8, "a b c d e f")
-    console.rect(0, 0, 2, 2, True)
-    console.hline(0, 1, 10)
-    console.vline(1, 0, 10)
+    with pytest.deprecated_call():
+        console.rect(0, 0, 2, 2, True)
+    with pytest.deprecated_call():
+        console.hline(0, 1, 10)
+    with pytest.deprecated_call():
+        console.vline(1, 0, 10)
     console.print_frame(0, 0, 8, 8, "Frame")
     console.blit(0, 0, 0, 0, console, 0, 0)  # type: ignore
     console.blit(0, 0, 0, 0, console, 0, 0, key_color=(0, 0, 0))  # type: ignore
-    console.set_key_color((254, 0, 254))
+    with pytest.deprecated_call():
+        console.set_key_color((254, 0, 254))
 
 
 def test_console_pickle() -> None:

tests/test_random.py

@@ -4,6 +4,8 @@
 import pickle
 from pathlib import Path
 
+import pytest
+
 import tcod.random
 
 # ruff: noqa: D103
@@ -15,8 +17,10 @@ def test_tcod_random() -> None:
     rand = tcod.random.Random(tcod.random.COMPLEMENTARY_MULTIPLY_WITH_CARRY)
     assert 0 <= rand.randint(0, 100) <= 100  # noqa: PLR2004
     assert 0 <= rand.uniform(0, 100) <= 100  # noqa: PLR2004
-    rand.guass(0, 1)
-    rand.inverse_guass(0, 1)
+    with pytest.warns(FutureWarning, match=r"typo"):
+        rand.guass(0, 1)
+    with pytest.warns(FutureWarning, match=r"typo"):
+        rand.inverse_guass(0, 1)
 
 
 def test_tcod_random_copy() -> None:

tests/test_tcod.py

@@ -10,6 +10,7 @@
 
 import tcod
 import tcod.console
+from tcod import libtcodpy
 
 # ruff: noqa: D103
 
@@ -35,7 +36,7 @@ def test_tcod_bsp() -> None:
     assert not bsp.children
 
     with pytest.raises(RuntimeError):
-        tcod.bsp_traverse_pre_order(bsp, raise_Exception)
+        libtcodpy.bsp_traverse_pre_order(bsp, raise_Exception)
 
     bsp.split_recursive(3, 4, 4, 1, 1)
     for node in bsp.walk():
@@ -66,11 +67,11 @@ def test_tcod_map_set_bits() -> None:
     assert not map_.fov[:].any()
 
     map_.transparent[1, 0] = True
-    assert tcod.map_is_transparent(map_, 0, 1)
+    assert libtcodpy.map_is_transparent(map_, 0, 1)
     map_.walkable[1, 0] = True
-    assert tcod.map_is_walkable(map_, 0, 1)
+    assert libtcodpy.map_is_walkable(map_, 0, 1)
     map_.fov[1, 0] = True
-    assert tcod.map_is_in_fov(map_, 0, 1)
+    assert libtcodpy.map_is_in_fov(map_, 0, 1)
 
 
 @pytest.mark.filterwarnings("ignore:This class may perform poorly")
@@ -115,7 +116,7 @@ def test_color_class() -> None:
     assert tcod.white - tcod.white == tcod.black
     assert tcod.black + (2, 2, 2) - (1, 1, 1) == (1, 1, 1)  # noqa: RUF005
 
-    color = tcod.Color()
+    color = libtcodpy.Color()
     color.r = 1
     color.g = 2
     color.b = 3
@@ -156,7 +157,7 @@ def test_path_callback() -> None:
 
 
 def test_key_repr() -> None:
-    Key = tcod.Key
+    Key = libtcodpy.Key
     key = Key(vk=1, c=2, shift=True)
     assert key.vk == 1
     assert key.c == 2  # noqa: PLR2004
@@ -168,7 +169,7 @@ def test_key_repr() -> None:
 
 
 def test_mouse_repr() -> None:
-    Mouse = tcod.Mouse
+    Mouse = libtcodpy.Mouse
     mouse = Mouse(x=1, lbutton=True)
     mouse_copy = eval(repr(mouse))  # noqa: S307
     assert mouse.x == mouse_copy.x
@@ -188,10 +189,10 @@ def test_recommended_size(console: tcod.console.Console) -> None:
 
 @pytest.mark.filterwarnings("ignore")
 def test_context(uses_window: None) -> None:
-    with tcod.context.new_window(32, 32, renderer=tcod.RENDERER_SDL2):
+    with tcod.context.new_window(32, 32, renderer=libtcodpy.RENDERER_SDL2):
         pass
     WIDTH, HEIGHT = 16, 4
-    with tcod.context.new_terminal(columns=WIDTH, rows=HEIGHT, renderer=tcod.RENDERER_SDL2) as context:
+    with tcod.context.new_terminal(columns=WIDTH, rows=HEIGHT, renderer=libtcodpy.RENDERER_SDL2) as context:
         console = tcod.console.Console(*context.recommended_console_size())
         context.present(console)
         assert context.sdl_window_p is not None