Remove obsolete mocks needed for doc generation.

The new doc generator can install tcod, so these mocks now just get in
the way of maintenance.

Author: HexDecimal

build_libtcod.py

@@ -248,7 +248,7 @@ def find_sdl_attrs(prefix: str) -> Iterator[tuple[str, int | str | Any]]:
 
     `prefix` is used to filter out which names to copy.
     """
-    from tcod._libtcod import lib  # type: ignore
+    from tcod._libtcod import lib
 
     if prefix.startswith("SDL_"):
         name_starts_at = 4

pyproject.toml

@@ -141,6 +141,9 @@ ignore_missing_imports = true
 module = "tcod.version"
 ignore_missing_imports = true
 
+[[tool.mypy.overrides]]
+module = "tcod._libtcod"
+ignore_missing_imports = true
 
 [tool.ruff]
 # https://beta.ruff.rs/docs/rules/

tcod/__init__.py

@@ -18,11 +18,7 @@
 from tcod.constants import *  # noqa: F403
 from tcod.libtcodpy import *  # noqa: F403
 from tcod.loader import __sdl_version__, ffi, lib
-
-try:
-    from tcod.version import __version__
-except ImportError:  # Gets imported without version.py by ReadTheDocs
-    __version__ = ""
+from tcod.version import __version__
 
 
 def __getattr__(name: str, stacklevel: int = 1) -> color.Color:

tcod/loader.py

@@ -57,34 +57,10 @@ def get_sdl_version() -> str:
     os.environ["PATH"] = f"""{Path(__file__).parent / get_architecture()}{os.pathsep}{os.environ["PATH"]}"""
 
 
-class _Mock:
-    """Mock object needed for ReadTheDocs."""
+verify_dependencies()
+from tcod._libtcod import ffi, lib  # noqa
 
-    @staticmethod
-    def def_extern() -> Any:
-        """Pass def_extern call silently."""
-        return lambda func: func
-
-    def __getattr__(self, attr: str) -> None:
-        """Return None on any attribute."""
-
-    def __bool__(self) -> bool:
-        """Allow checking for this mock object at import time."""
-        return False
-
-
-lib: Any = None
-ffi: Any = None
-
-if os.environ.get("READTHEDOCS"):
-    # Mock the lib and ffi objects needed to compile docs for readthedocs.io
-    # Allows an import without building the cffi module first.
-    lib = ffi = _Mock()
-else:
-    verify_dependencies()
-    from tcod._libtcod import ffi, lib  # type: ignore
-
-    __sdl_version__ = get_sdl_version()
+__sdl_version__ = get_sdl_version()
 
 
 @ffi.def_extern()  # type: ignore
@@ -96,8 +72,7 @@ def _libtcod_log_watcher(message: Any, userdata: None) -> None:
     logger.log(level, "%s:%d:%s", source, lineno, text)
 
 
-if lib:
-    lib.TCOD_set_log_callback(lib._libtcod_log_watcher, ffi.NULL)
-    lib.TCOD_set_log_level(0)
+lib.TCOD_set_log_callback(lib._libtcod_log_watcher, ffi.NULL)
+lib.TCOD_set_log_level(0)
 
-__all__ = ["ffi", "lib"]
+__all__ = ["ffi", "lib", "__sdl_version__"]

tcod/sdl/_internal.py

@@ -89,12 +89,6 @@ def _check_p(result: Any) -> Any:
     return result
 
 
-if lib._sdl_log_output_function:
-    lib.SDL_LogSetOutputFunction(lib._sdl_log_output_function, ffi.NULL)
-    if __debug__:
-        lib.SDL_LogSetAllPriority(lib.SDL_LOG_PRIORITY_VERBOSE)
-
-
 def _compiled_version() -> tuple[int, int, int]:
     return int(lib.SDL_MAJOR_VERSION), int(lib.SDL_MINOR_VERSION), int(lib.SDL_PATCHLEVEL)
 
@@ -124,3 +118,8 @@ def replacement(*_args: Any, **_kwargs: Any) -> Any:
         raise RuntimeError(msg)
 
     return lambda x: replacement  # type: ignore[return-value]
+
+
+lib.SDL_LogSetOutputFunction(lib._sdl_log_output_function, ffi.NULL)
+if __debug__:
+    lib.SDL_LogSetAllPriority(lib.SDL_LOG_PRIORITY_VERBOSE)

tcod/sdl/joystick.py

@@ -15,69 +15,69 @@
 from tcod.sdl._internal import _check, _check_p
 
 _HAT_DIRECTIONS: dict[int, tuple[Literal[-1, 0, 1], Literal[-1, 0, 1]]] = {
-    lib.SDL_HAT_CENTERED or 0: (0, 0),
-    lib.SDL_HAT_UP or 0: (0, -1),
-    lib.SDL_HAT_RIGHT or 0: (1, 0),
-    lib.SDL_HAT_DOWN or 0: (0, 1),
-    lib.SDL_HAT_LEFT or 0: (-1, 0),
-    lib.SDL_HAT_RIGHTUP or 0: (1, -1),
-    lib.SDL_HAT_RIGHTDOWN or 0: (1, 1),
-    lib.SDL_HAT_LEFTUP or 0: (-1, -1),
-    lib.SDL_HAT_LEFTDOWN or 0: (-1, 1),
+    int(lib.SDL_HAT_CENTERED): (0, 0),
+    int(lib.SDL_HAT_UP): (0, -1),
+    int(lib.SDL_HAT_RIGHT): (1, 0),
+    int(lib.SDL_HAT_DOWN): (0, 1),
+    int(lib.SDL_HAT_LEFT): (-1, 0),
+    int(lib.SDL_HAT_RIGHTUP): (1, -1),
+    int(lib.SDL_HAT_RIGHTDOWN): (1, 1),
+    int(lib.SDL_HAT_LEFTUP): (-1, -1),
+    int(lib.SDL_HAT_LEFTDOWN): (-1, 1),
 }
 
 
 class ControllerAxis(enum.IntEnum):
     """The standard axes for a game controller."""
 
-    INVALID = lib.SDL_CONTROLLER_AXIS_INVALID or -1
-    LEFTX = lib.SDL_CONTROLLER_AXIS_LEFTX or 0
+    INVALID = int(lib.SDL_CONTROLLER_AXIS_INVALID)
+    LEFTX = int(lib.SDL_CONTROLLER_AXIS_LEFTX)
     """"""
-    LEFTY = lib.SDL_CONTROLLER_AXIS_LEFTY or 1
+    LEFTY = int(lib.SDL_CONTROLLER_AXIS_LEFTY)
     """"""
-    RIGHTX = lib.SDL_CONTROLLER_AXIS_RIGHTX or 2
+    RIGHTX = int(lib.SDL_CONTROLLER_AXIS_RIGHTX)
     """"""
-    RIGHTY = lib.SDL_CONTROLLER_AXIS_RIGHTY or 3
+    RIGHTY = int(lib.SDL_CONTROLLER_AXIS_RIGHTY)
     """"""
-    TRIGGERLEFT = lib.SDL_CONTROLLER_AXIS_TRIGGERLEFT or 4
+    TRIGGERLEFT = int(lib.SDL_CONTROLLER_AXIS_TRIGGERLEFT)
     """"""
-    TRIGGERRIGHT = lib.SDL_CONTROLLER_AXIS_TRIGGERRIGHT or 5
+    TRIGGERRIGHT = int(lib.SDL_CONTROLLER_AXIS_TRIGGERRIGHT)
     """"""
 
 
 class ControllerButton(enum.IntEnum):
     """The standard buttons for a game controller."""
 
-    INVALID = lib.SDL_CONTROLLER_BUTTON_INVALID or -1
-    A = lib.SDL_CONTROLLER_BUTTON_A or 0
+    INVALID = int(lib.SDL_CONTROLLER_BUTTON_INVALID)
+    A = int(lib.SDL_CONTROLLER_BUTTON_A)
     """"""
-    B = lib.SDL_CONTROLLER_BUTTON_B or 1
+    B = int(lib.SDL_CONTROLLER_BUTTON_B)
     """"""
-    X = lib.SDL_CONTROLLER_BUTTON_X or 2
+    X = int(lib.SDL_CONTROLLER_BUTTON_X)
     """"""
-    Y = lib.SDL_CONTROLLER_BUTTON_Y or 3
+    Y = int(lib.SDL_CONTROLLER_BUTTON_Y)
     """"""
-    BACK = lib.SDL_CONTROLLER_BUTTON_BACK or 4
+    BACK = int(lib.SDL_CONTROLLER_BUTTON_BACK)
     """"""
-    GUIDE = lib.SDL_CONTROLLER_BUTTON_GUIDE or 5
+    GUIDE = int(lib.SDL_CONTROLLER_BUTTON_GUIDE)
     """"""
-    START = lib.SDL_CONTROLLER_BUTTON_START or 6
+    START = int(lib.SDL_CONTROLLER_BUTTON_START)
     """"""
-    LEFTSTICK = lib.SDL_CONTROLLER_BUTTON_LEFTSTICK or 7
+    LEFTSTICK = int(lib.SDL_CONTROLLER_BUTTON_LEFTSTICK)
     """"""
-    RIGHTSTICK = lib.SDL_CONTROLLER_BUTTON_RIGHTSTICK or 8
+    RIGHTSTICK = int(lib.SDL_CONTROLLER_BUTTON_RIGHTSTICK)
     """"""
-    LEFTSHOULDER = lib.SDL_CONTROLLER_BUTTON_LEFTSHOULDER or 9
+    LEFTSHOULDER = int(lib.SDL_CONTROLLER_BUTTON_LEFTSHOULDER)
     """"""
-    RIGHTSHOULDER = lib.SDL_CONTROLLER_BUTTON_RIGHTSHOULDER or 10
+    RIGHTSHOULDER = int(lib.SDL_CONTROLLER_BUTTON_RIGHTSHOULDER)
     """"""
-    DPAD_UP = lib.SDL_CONTROLLER_BUTTON_DPAD_UP or 11
+    DPAD_UP = int(lib.SDL_CONTROLLER_BUTTON_DPAD_UP)
     """"""
-    DPAD_DOWN = lib.SDL_CONTROLLER_BUTTON_DPAD_DOWN or 12
+    DPAD_DOWN = int(lib.SDL_CONTROLLER_BUTTON_DPAD_DOWN)
     """"""
-    DPAD_LEFT = lib.SDL_CONTROLLER_BUTTON_DPAD_LEFT or 13
+    DPAD_LEFT = int(lib.SDL_CONTROLLER_BUTTON_DPAD_LEFT)
     """"""
-    DPAD_RIGHT = lib.SDL_CONTROLLER_BUTTON_DPAD_RIGHT or 14
+    DPAD_RIGHT = int(lib.SDL_CONTROLLER_BUTTON_DPAD_RIGHT)
     """"""
     MISC1 = 15
     """"""
@@ -100,19 +100,19 @@ class Power(enum.IntEnum):
         :any:`Joystick.get_current_power`
     """
 
-    UNKNOWN = lib.SDL_JOYSTICK_POWER_UNKNOWN or -1
+    UNKNOWN = int(lib.SDL_JOYSTICK_POWER_UNKNOWN)
     """Power state is unknown."""
-    EMPTY = lib.SDL_JOYSTICK_POWER_EMPTY or 0
+    EMPTY = int(lib.SDL_JOYSTICK_POWER_EMPTY)
     """<= 5% power."""
-    LOW = lib.SDL_JOYSTICK_POWER_LOW or 1
+    LOW = int(lib.SDL_JOYSTICK_POWER_LOW)
     """<= 20% power."""
-    MEDIUM = lib.SDL_JOYSTICK_POWER_MEDIUM or 2
+    MEDIUM = int(lib.SDL_JOYSTICK_POWER_MEDIUM)
     """<= 70% power."""
-    FULL = lib.SDL_JOYSTICK_POWER_FULL or 3
+    FULL = int(lib.SDL_JOYSTICK_POWER_FULL)
     """<= 100% power."""
-    WIRED = lib.SDL_JOYSTICK_POWER_WIRED or 4
+    WIRED = int(lib.SDL_JOYSTICK_POWER_WIRED)
     """"""
-    MAX = lib.SDL_JOYSTICK_POWER_MAX or 5
+    MAX = int(lib.SDL_JOYSTICK_POWER_MAX)
     """"""
 
 

tcod/sdl/sys.py

@@ -17,7 +17,7 @@ class Subsystem(enum.IntFlag):
     GAMECONTROLLER = 0x00002000
     EVENTS = 0x00004000
     SENSOR = 0x00008000
-    EVERYTHING = lib.SDL_INIT_EVERYTHING or 0
+    EVERYTHING = int(lib.SDL_INIT_EVERYTHING)
 
 
 def init(flags: int = Subsystem.EVERYTHING) -> None:

tcod/sdl/video.py

@@ -35,49 +35,49 @@ class WindowFlags(enum.IntFlag):
         https://wiki.libsdl.org/SDL_WindowFlags
     """
 
-    FULLSCREEN = lib.SDL_WINDOW_FULLSCREEN or 0
+    FULLSCREEN = int(lib.SDL_WINDOW_FULLSCREEN)
     """"""
-    FULLSCREEN_DESKTOP = lib.SDL_WINDOW_FULLSCREEN_DESKTOP or 0
+    FULLSCREEN_DESKTOP = int(lib.SDL_WINDOW_FULLSCREEN_DESKTOP)
     """"""
-    OPENGL = lib.SDL_WINDOW_OPENGL or 0
+    OPENGL = int(lib.SDL_WINDOW_OPENGL)
     """"""
-    SHOWN = lib.SDL_WINDOW_SHOWN or 0
+    SHOWN = int(lib.SDL_WINDOW_SHOWN)
     """"""
-    HIDDEN = lib.SDL_WINDOW_HIDDEN or 0
+    HIDDEN = int(lib.SDL_WINDOW_HIDDEN)
     """"""
-    BORDERLESS = lib.SDL_WINDOW_BORDERLESS or 0
+    BORDERLESS = int(lib.SDL_WINDOW_BORDERLESS)
     """"""
-    RESIZABLE = lib.SDL_WINDOW_RESIZABLE or 0
+    RESIZABLE = int(lib.SDL_WINDOW_RESIZABLE)
     """"""
-    MINIMIZED = lib.SDL_WINDOW_MINIMIZED or 0
+    MINIMIZED = int(lib.SDL_WINDOW_MINIMIZED)
     """"""
-    MAXIMIZED = lib.SDL_WINDOW_MAXIMIZED or 0
+    MAXIMIZED = int(lib.SDL_WINDOW_MAXIMIZED)
     """"""
-    MOUSE_GRABBED = lib.SDL_WINDOW_INPUT_GRABBED or 0
+    MOUSE_GRABBED = int(lib.SDL_WINDOW_INPUT_GRABBED)
     """"""
-    INPUT_FOCUS = lib.SDL_WINDOW_INPUT_FOCUS or 0
+    INPUT_FOCUS = int(lib.SDL_WINDOW_INPUT_FOCUS)
     """"""
-    MOUSE_FOCUS = lib.SDL_WINDOW_MOUSE_FOCUS or 0
+    MOUSE_FOCUS = int(lib.SDL_WINDOW_MOUSE_FOCUS)
     """"""
-    FOREIGN = lib.SDL_WINDOW_FOREIGN or 0
+    FOREIGN = int(lib.SDL_WINDOW_FOREIGN)
     """"""
-    ALLOW_HIGHDPI = lib.SDL_WINDOW_ALLOW_HIGHDPI or 0
+    ALLOW_HIGHDPI = int(lib.SDL_WINDOW_ALLOW_HIGHDPI)
     """"""
-    MOUSE_CAPTURE = lib.SDL_WINDOW_MOUSE_CAPTURE or 0
+    MOUSE_CAPTURE = int(lib.SDL_WINDOW_MOUSE_CAPTURE)
     """"""
-    ALWAYS_ON_TOP = lib.SDL_WINDOW_ALWAYS_ON_TOP or 0
+    ALWAYS_ON_TOP = int(lib.SDL_WINDOW_ALWAYS_ON_TOP)
     """"""
-    SKIP_TASKBAR = lib.SDL_WINDOW_SKIP_TASKBAR or 0
+    SKIP_TASKBAR = int(lib.SDL_WINDOW_SKIP_TASKBAR)
     """"""
-    UTILITY = lib.SDL_WINDOW_UTILITY or 0
+    UTILITY = int(lib.SDL_WINDOW_UTILITY)
     """"""
-    TOOLTIP = lib.SDL_WINDOW_TOOLTIP or 0
+    TOOLTIP = int(lib.SDL_WINDOW_TOOLTIP)
     """"""
-    POPUP_MENU = lib.SDL_WINDOW_POPUP_MENU or 0
+    POPUP_MENU = int(lib.SDL_WINDOW_POPUP_MENU)
     """"""
-    VULKAN = lib.SDL_WINDOW_VULKAN or 0
+    VULKAN = int(lib.SDL_WINDOW_VULKAN)
     """"""
-    METAL = getattr(lib, "SDL_WINDOW_METAL", None) or 0x20000000  # SDL >= 2.0.14
+    METAL = int(getattr(lib, "SDL_WINDOW_METAL", 0x20000000))  # SDL >= 2.0.14
     """"""