Clean up warnings

Specify specific warnings for Mypy ignores

Narrow type hints

Move image internals to image.py to avoid cyclic imports

Author: HexDecimal

tcod/__init__.py

@@ -13,7 +13,7 @@
 
 __path__ = extend_path(__path__, __name__)
 
-from tcod import bsp, color, console, context, event, image, los, map, noise, path, random, tileset
+from tcod import bsp, color, console, context, event, image, los, map, noise, path, random, tileset  # noqa: A004
 from tcod.cffi import __sdl_version__, ffi, lib
 from tcod.tcod import __getattr__  # noqa: F401
 from tcod.version import __version__

tcod/_internal.py

@@ -7,7 +7,6 @@
 import warnings
 from typing import TYPE_CHECKING, Any, AnyStr, Callable, NoReturn, SupportsInt, TypeVar
 
-import numpy as np
 from typing_extensions import Literal, LiteralString, deprecated
 
 from tcod.cffi import ffi, lib
@@ -16,17 +15,18 @@
     from pathlib import Path
     from types import TracebackType
 
-    from numpy.typing import ArrayLike, NDArray
-
-    import tcod.image
 
 FuncType = Callable[..., Any]
 F = TypeVar("F", bound=FuncType)
 T = TypeVar("T")
 
 
 def _deprecate_passthrough(
-    message: str, /, *, category: type[Warning] = DeprecationWarning, stacklevel: int = 0
+    message: str,  # noqa: ARG001
+    /,
+    *,
+    category: type[Warning] = DeprecationWarning,  # noqa: ARG001
+    stacklevel: int = 0,  # noqa: ARG001
 ) -> Callable[[F], F]:
     """Return a decorator which skips wrapping a warning onto functions. This is used for non-debug runs."""
 
@@ -51,7 +51,7 @@ def pending_deprecate(
 
 def verify_order(order: Literal["C", "F"]) -> Literal["C", "F"]:
     """Verify and return a Numpy order string."""
-    order = order.upper()  # type: ignore
+    order = order.upper()  # type: ignore[assignment]
     if order not in ("C", "F"):
         msg = f"order must be 'C' or 'F', not {order!r}"
         raise TypeError(msg)
@@ -91,7 +91,7 @@ def _check_warn(error: int, stacklevel: int = 2) -> int:
 def _unpack_char_p(char_p: Any) -> str:  # noqa: ANN401
     if char_p == ffi.NULL:
         return ""
-    return ffi.string(char_p).decode()  # type: ignore
+    return str(ffi.string(char_p), encoding="utf-8")
 
 
 def _int(int_or_str: SupportsInt | str | bytes) -> int:
@@ -171,7 +171,7 @@ def __enter__(self) -> Callable[[Any], None]:
         return self.propagate
 
     def __exit__(
-        self, type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None
+        self, _type: type[BaseException] | None, value: BaseException | None, traceback: TracebackType | None
     ) -> None:
         """If we're holding on to an exception, raise it now.
 
@@ -232,42 +232,3 @@ def _console(console: Any) -> Any:  # noqa: ANN401
             stacklevel=3,
         )
         return ffi.NULL
-
-
-class TempImage:
-    """An Image-like container for NumPy arrays."""
-
-    def __init__(self, array: ArrayLike) -> None:
-        """Initialize an image from the given array.  May copy or reference the array."""
-        self._array: NDArray[np.uint8] = np.ascontiguousarray(array, dtype=np.uint8)
-        height, width, depth = self._array.shape
-        if depth != 3:  # noqa: PLR2004
-            msg = f"Array must have RGB channels.  Shape is: {self._array.shape!r}"
-            raise TypeError(msg)
-        self._buffer = ffi.from_buffer("TCOD_color_t[]", self._array)
-        self._mipmaps = ffi.new(
-            "struct TCOD_mipmap_*",
-            {
-                "width": width,
-                "height": height,
-                "fwidth": width,
-                "fheight": height,
-                "buf": self._buffer,
-                "dirty": True,
-            },
-        )
-        self.image_c = ffi.new(
-            "TCOD_Image*",
-            {
-                "nb_mipmaps": 1,
-                "mipmaps": self._mipmaps,
-                "has_key_color": False,
-            },
-        )
-
-
-def _as_image(image: ArrayLike | tcod.image.Image) -> TempImage | tcod.image.Image:
-    """Convert this input into an Image-like object."""
-    if hasattr(image, "image_c"):
-        return image
-    return TempImage(image)

tcod/bsp.py

@@ -104,20 +104,9 @@ def __repr__(self) -> str:
         """Provide a useful readout when printed."""
         status = "leaf"
         if self.children:
-            status = "split at position=%i,horizontal=%r" % (
-                self.position,
-                self.horizontal,
-            )
-
-        return "<%s(x=%i,y=%i,width=%i,height=%i) level=%i %s>" % (
-            self.__class__.__name__,
-            self.x,
-            self.y,
-            self.width,
-            self.height,
-            self.level,
-            status,
-        )
+            status = f"split at position={self.position},horizontal={self.horizontal!r}"
+
+        return f"<{self.__class__.__name__}(x={self.x},y={self.y},width={self.width},height={self.height}) level={self.level} {status}>"
 
     def _unpack_bsp_tree(self, cdata: Any) -> None:  # noqa: ANN401
         self.x = cdata.x

tcod/cffi.py

@@ -64,8 +64,8 @@ def get_sdl_version() -> str:
 __sdl_version__ = get_sdl_version()
 
 
-@ffi.def_extern()  # type: ignore
-def _libtcod_log_watcher(message: Any, userdata: None) -> None:  # noqa: ANN401
+@ffi.def_extern()  # type: ignore[misc]
+def _libtcod_log_watcher(message: Any, _userdata: None) -> None:  # noqa: ANN401
     text = str(ffi.string(message.message), encoding="utf-8")
     source = str(ffi.string(message.source), encoding="utf-8")
     level = int(message.level)

tcod/console.py

@@ -16,6 +16,7 @@
 
 import tcod._internal
 import tcod.constants
+import tcod.image
 from tcod._internal import _check, _path_encode
 from tcod.cffi import ffi, lib
 
@@ -1444,7 +1445,7 @@ def draw_semigraphics(self, pixels: ArrayLike | tcod.image.Image, x: int = 0, y:
 
         .. versionadded:: 11.4
         """
-        image = tcod._internal._as_image(pixels)
+        image = tcod.image._as_image(pixels)
         lib.TCOD_image_blit_2x(image.image_c, self.console_c, x, y, 0, 0, -1, -1)
 
 

tcod/context.py

@@ -447,7 +447,7 @@ def __reduce__(self) -> NoReturn:
         raise pickle.PicklingError(msg)
 
 
-@ffi.def_extern()  # type: ignore
+@ffi.def_extern()  # type: ignore[misc]
 def _pycall_cli_output(catch_reference: Any, output: Any) -> None:  # noqa: ANN401
     """Callback for the libtcod context CLI.
 

tcod/event.py

@@ -1548,7 +1548,7 @@ def get_mouse_state() -> MouseState:
     return MouseState((xy[0], xy[1]), (int(tile[0]), int(tile[1])), buttons)
 
 
-@ffi.def_extern()  # type: ignore
+@ffi.def_extern()  # type: ignore[misc]
 def _sdl_event_watcher(userdata: Any, sdl_event: Any) -> int:
     callback: Callable[[Event], None] = ffi.from_handle(userdata)
     callback(_parse_event(sdl_event))

tcod/image.py

@@ -145,7 +145,7 @@ def get_alpha(self, x: int, y: int) -> int:
             int: The alpha value of the pixel.
             With 0 being fully transparent and 255 being fully opaque.
         """
-        return lib.TCOD_image_get_alpha(self.image_c, x, y)  # type: ignore
+        return int(lib.TCOD_image_get_alpha(self.image_c, x, y))
 
     def refresh_console(self, console: tcod.console.Console) -> None:
         """Update an Image created with :any:`libtcodpy.image_from_console`.
@@ -351,17 +351,6 @@ def __array_interface__(self) -> dict[str, Any]:
         }
 
 
-def _get_format_name(format: int) -> str:
-    """Return the SDL_PIXELFORMAT_X name for this format, if possible."""
-    for attr in dir(lib):
-        if not attr.startswith("SDL_PIXELFORMAT"):
-            continue
-        if getattr(lib, attr) != format:
-            continue
-        return attr
-    return str(format)
-
-
 @deprecated(
     "This function may be removed in the future."
     "  It's recommended to load images with a more complete image library such as python-Pillow or python-imageio.",
@@ -388,3 +377,42 @@ def load(filename: str | PathLike[str]) -> NDArray[np.uint8]:
             axis=2,
         )
     return array
+
+
+class _TempImage:
+    """An Image-like container for NumPy arrays."""
+
+    def __init__(self, array: ArrayLike) -> None:
+        """Initialize an image from the given array.  May copy or reference the array."""
+        self._array: NDArray[np.uint8] = np.ascontiguousarray(array, dtype=np.uint8)
+        height, width, depth = self._array.shape
+        if depth != 3:  # noqa: PLR2004
+            msg = f"Array must have RGB channels.  Shape is: {self._array.shape!r}"
+            raise TypeError(msg)
+        self._buffer = ffi.from_buffer("TCOD_color_t[]", self._array)
+        self._mipmaps = ffi.new(
+            "struct TCOD_mipmap_*",
+            {
+                "width": width,
+                "height": height,
+                "fwidth": width,
+                "fheight": height,
+                "buf": self._buffer,
+                "dirty": True,
+            },
+        )
+        self.image_c = ffi.new(
+            "TCOD_Image*",
+            {
+                "nb_mipmaps": 1,
+                "mipmaps": self._mipmaps,
+                "has_key_color": False,
+            },
+        )
+
+
+def _as_image(image: ArrayLike | Image | _TempImage) -> _TempImage | Image:
+    """Convert this input into an Image-like object."""
+    if isinstance(image, (Image, _TempImage)):
+        return image
+    return _TempImage(image)

tcod/libtcodpy.py

@@ -238,8 +238,8 @@ def set(
     def blit(
         self,
         dest: tcod.console.Console,
-        fill_fore: bool = True,
-        fill_back: bool = True,
+        fill_fore: bool = True,  # noqa: FBT001, FBT002
+        fill_back: bool = True,  # noqa: FBT001, FBT002
     ) -> None:
         """Use libtcod's "fill" functions to write the buffer to a console.
 
@@ -313,12 +313,7 @@ def nb_dices(self, value: int) -> None:
 
     def __str__(self) -> str:
         add = f"+({self.addsub})" if self.addsub != 0 else ""
-        return "%id%ix%s%s" % (
-            self.nb_dices,
-            self.nb_faces,
-            self.multiplier,
-            add,
-        )
+        return f"{self.nb_dices}d{self.nb_faces}x{self.multiplier}{add}"
 
     def __repr__(self) -> str:
         return f"{self.__class__.__name__}(nb_dices={self.nb_dices!r},nb_faces={self.nb_faces!r},multiplier={self.multiplier!r},addsub={self.addsub!r})"
@@ -3584,7 +3579,8 @@ def _unpack_union(type_: int, union: Any) -> Any:  # noqa: PLR0911
         return Dice(union.dice)
     if type_ & lib.TCOD_TYPE_LIST:
         return _convert_TCODList(union.list, type_ & 0xFF)
-    raise RuntimeError("Unknown libtcod type: %i" % type_)
+    msg = f"Unknown libtcod type: {type_}"
+    raise RuntimeError(msg)
 
 
 def _convert_TCODList(c_list: Any, type_: int) -> Any:
@@ -3607,27 +3603,27 @@ def parser_new_struct(parser: Any, name: str) -> Any:
 _parser_listener: Any = None
 
 
-@ffi.def_extern()  # type: ignore
+@ffi.def_extern()  # type: ignore[misc]
 def _pycall_parser_new_struct(struct: Any, name: str) -> Any:
     return _parser_listener.new_struct(struct, _unpack_char_p(name))
 
 
-@ffi.def_extern()  # type: ignore
+@ffi.def_extern()  # type: ignore[misc]
 def _pycall_parser_new_flag(name: str) -> Any:
     return _parser_listener.new_flag(_unpack_char_p(name))
 
 
-@ffi.def_extern()  # type: ignore
+@ffi.def_extern()  # type: ignore[misc]
 def _pycall_parser_new_property(propname: Any, type: Any, value: Any) -> Any:
     return _parser_listener.new_property(_unpack_char_p(propname), type, _unpack_union(type, value))
 
 
-@ffi.def_extern()  # type: ignore
+@ffi.def_extern()  # type: ignore[misc]
 def _pycall_parser_end_struct(struct: Any, name: Any) -> Any:
     return _parser_listener.end_struct(struct, _unpack_char_p(name))
 
 
-@ffi.def_extern()  # type: ignore
+@ffi.def_extern()  # type: ignore[misc]
 def _pycall_parser_error(msg: Any) -> None:
     _parser_listener.error(_unpack_char_p(msg))
 

tcod/noise.py

@@ -236,9 +236,8 @@ def __getitem__(self, indexes: Any) -> NDArray[np.float32]:
         if not isinstance(indexes, tuple):
             indexes = (indexes,)
         if len(indexes) > self.dimensions:
-            raise IndexError(
-                "This noise generator has %i dimensions, but was indexed with %i." % (self.dimensions, len(indexes))
-            )
+            msg = f"This noise generator has {self.dimensions} dimensions, but was indexed with {len(indexes)}."
+            raise IndexError(msg)
         indexes = list(np.broadcast_arrays(*indexes))
         c_input = [ffi.NULL, ffi.NULL, ffi.NULL, ffi.NULL]
         for i, index in enumerate(indexes):