Cleanup pass of examples directory.

Switch samples_tcod to use Path objects.

Author: HexDecimal

.vscode/settings.json

@@ -145,6 +145,7 @@
         "fmean",
         "fontx",
         "fonty",
+        "freetype",
         "frombuffer",
         "fullscreen",
         "fwidth",

examples/distribution/PyInstaller/main.py

@@ -3,20 +3,22 @@
 # copyright and related or neighboring rights for the "hello world" PyInstaller
 # example script.  This work is published from: United States.
 # https://creativecommons.org/publicdomain/zero/1.0/
-import os.path
+"""PyInstaller main script example."""
 import sys
+from pathlib import Path
 
 import tcod
 
 WIDTH, HEIGHT = 80, 60
 
 # The base directory, this is sys._MEIPASS when in one-file mode.
-BASE_DIR = getattr(sys, "_MEIPASS", ".")
+BASE_DIR = Path(getattr(sys, "_MEIPASS", "."))
 
-FONT_PATH = os.path.join(BASE_DIR, "data/terminal8x8_gs_ro.png")
+FONT_PATH = BASE_DIR / "data/terminal8x8_gs_ro.png"
 
 
 def main() -> None:
+    """Entry point function."""
     tileset = tcod.tileset.load_tilesheet(FONT_PATH, 16, 16, tcod.tileset.CHARMAP_CP437)
     with tcod.context.new(columns=WIDTH, rows=HEIGHT, tileset=tileset) as context:
         while True:

examples/distribution/cx_Freeze/main.py

@@ -1,11 +1,13 @@
 #!/usr/bin/env python3
+"""cx_Freeze main script example."""
 import tcod
 
 WIDTH, HEIGHT = 80, 60
 console = None
 
 
 def main() -> None:
+    """Entry point function."""
     tileset = tcod.tileset.load_tilesheet("data/terminal8x8_gs_ro.png", 16, 16, tcod.tileset.CHARMAP_CP437)
     with tcod.context.new(columns=WIDTH, rows=HEIGHT, tileset=tileset) as context:
         while True:

examples/eventget.py

@@ -3,8 +3,7 @@
 # copyright and related or neighboring rights for this example.  This work is
 # published from: United States.
 # https://creativecommons.org/publicdomain/zero/1.0/
-"""An demonstration of event handling using the tcod.event module.
-"""
+"""An demonstration of event handling using the tcod.event module."""
 from typing import List, Set
 
 import tcod
@@ -15,8 +14,7 @@
 
 
 def main() -> None:
-    """Example program for tcod.event"""
-
+    """Example program for tcod.event."""
     event_log: List[str] = []
     motion_desc = ""
     tcod.sdl.joystick.init()

examples/framerate.py

@@ -3,8 +3,7 @@
 # copyright and related or neighboring rights for this example.  This work is
 # published from: United States.
 # https://creativecommons.org/publicdomain/zero/1.0/
-"""A system to control time since the original libtcod tools are deprecated.
-"""
+"""A system to control time since the original libtcod tools are deprecated."""
 import statistics
 import time
 from collections import deque
@@ -23,6 +22,7 @@ class Clock:
     """
 
     def __init__(self) -> None:
+        """Initialize this object with empty data."""
         self.last_time = time.perf_counter()  # Last time this was synced.
         self.time_samples: Deque[float] = deque()  # Delta time samples.
         self.max_samples = 64  # Number of fps samples to log.  Can be changed.
@@ -138,7 +138,7 @@ def main() -> None:
                 context.convert_event(event)  # Set tile coordinates for event.
                 if isinstance(event, tcod.event.Quit):
                     raise SystemExit()
-                elif isinstance(event, tcod.event.MouseWheel):
+                if isinstance(event, tcod.event.MouseWheel):
                     desired_fps = max(1, desired_fps + event.y)
 
 

examples/samples_tcod.py

@@ -7,12 +7,12 @@
 
 import copy
 import math
-import os
 import random
 import sys
 import time
 import warnings
-from typing import Any, List
+from pathlib import Path
+from typing import Any
 
 import numpy as np
 from numpy.typing import NDArray
@@ -21,19 +21,15 @@
 import tcod.render
 import tcod.sdl.render
 
+# ruff: noqa: S311
+
 if not sys.warnoptions:
     warnings.simplefilter("default")  # Show all warnings.
 
+DATA_DIR = Path(__file__).parent / "../libtcod/data"
+"""Path of the samples data directory."""
 
-def get_data(path: str) -> str:
-    """Return the path to a resource in the libtcod data directory,"""
-    SCRIPT_DIR = os.path.dirname(__file__)
-    DATA_DIR = os.path.join(SCRIPT_DIR, "../libtcod/data")
-    assert os.path.exists(DATA_DIR), (
-        "Data directory is missing," " did you forget to run `git submodule update --init`?"
-    )
-    return os.path.join(DATA_DIR, path)
-
+assert DATA_DIR.exists(), "Data directory is missing, did you forget to run `git submodule update --init`?"
 
 WHITE = (255, 255, 255)
 GREY = (127, 127, 127)
@@ -45,7 +41,7 @@ def get_data(path: str) -> str:
 SAMPLE_SCREEN_HEIGHT = 20
 SAMPLE_SCREEN_X = 20
 SAMPLE_SCREEN_Y = 10
-FONT = get_data("fonts/dejavu10x10_gs_tc.png")
+FONT = DATA_DIR / "fonts/dejavu10x10_gs_tc.png"
 
 # Mutable global names.
 context: tcod.context.Context
@@ -564,10 +560,9 @@ def draw_ui(self) -> None:
             1,
             1,
             "IJKL : move around\n"
-            "T : torch fx %s\n"
-            "W : light walls %s\n"
-            "+-: algo %s"
-            % (
+            "T : torch fx {}\n"
+            "W : light walls {}\n"
+            "+-: algo {}".format(
                 "on " if self.torch else "off",
                 "on " if self.light_walls else "off",
                 FOV_ALGO_NAMES[self.algo_num],
@@ -1032,9 +1027,9 @@ class ImageSample(Sample):
     def __init__(self) -> None:
         self.name = "Image toolkit"
 
-        self.img = tcod.image_load(get_data("img/skull.png"))
+        self.img = tcod.image_load(DATA_DIR / "img/skull.png")
         self.img.set_key_color(BLACK)
-        self.circle = tcod.image_load(get_data("img/circle.png"))
+        self.circle = tcod.image_load(DATA_DIR / "img/circle.png")
 
     def on_draw(self) -> None:
         sample_console.clear()
@@ -1068,7 +1063,7 @@ def __init__(self) -> None:
 
         self.motion = tcod.event.MouseMotion()
         self.mouse_left = self.mouse_middle = self.mouse_right = 0
-        self.log: List[str] = []
+        self.log: list[str] = []
 
     def on_enter(self) -> None:
         tcod.mouse_move(320, 200)
@@ -1141,15 +1136,15 @@ def __init__(self) -> None:
 
         self.curset = 0
         self.delay = 0.0
-        self.names: List[str] = []
-        self.sets: List[str] = []
+        self.names: list[str] = []
+        self.sets: list[str] = []
 
     def on_draw(self) -> None:
         if not self.sets:
             # parse all *.cfg files in data/namegen
-            for file in os.listdir(get_data("namegen")):
-                if file.find(".cfg") > 0:
-                    tcod.namegen_parse(get_data(os.path.join("namegen", file)))
+            for file in (DATA_DIR / "namegen").iterdir():
+                if file.suffix == ".cfg":
+                    tcod.namegen_parse(file)
             # get the sets list
             self.sets = tcod.namegen_get_sets()
             print(self.sets)
@@ -1254,7 +1249,7 @@ def on_enter(self) -> None:
         self.frac_t: float = RES_V - 1
         self.abs_t: float = RES_V - 1
         # light and current color of the tunnel texture
-        self.lights: List[Light] = []
+        self.lights: list[Light] = []
         self.tex_r = 0.0
         self.tex_g = 0.0
         self.tex_b = 0.0

examples/termbox/termbox.py

@@ -1,5 +1,4 @@
-"""
-Implementation of Termbox Python API in tdl.
+"""Implementation of Termbox Python API in tdl.
 
 See README.md for details.
 """
@@ -18,10 +17,10 @@
 
 
 class TermboxException(Exception):
-    def __init__(self, msg):
+    def __init__(self, msg) -> None:
         self.msg = msg
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.msg
 
 
@@ -153,7 +152,7 @@ def __str__(self):
 
 
 class Event:
-    """Aggregate for Termbox Event structure"""
+    """Aggregate for Termbox Event structure."""
 
     type = None
     ch = None
@@ -169,10 +168,11 @@ def gettuple(self):
 
 
 class Termbox:
-    def __init__(self, width=132, height=60):
+    def __init__(self, width=132, height=60) -> None:
         global _instance
         if _instance:
-            raise TermboxException("It is possible to create only one instance of Termbox")
+            msg = "It is possible to create only one instance of Termbox"
+            raise TermboxException(msg)
 
         try:
             self.console = tdl.init(width, height)
@@ -183,7 +183,7 @@ def __init__(self, width=132, height=60):
 
         _instance = self
 
-    def __del__(self):
+    def __del__(self) -> None:
         self.close()
 
     def __exit__(self, *args):  # t, value, traceback):
@@ -289,5 +289,6 @@ def poll_event(self):
             if e.type == "KEYDOWN":
                 self.e.key = e.key
                 return self.e.gettuple()
+        return None
 
         # return (e.type, uch, e.key, e.mod, e.w, e.h, e.x, e.y)

examples/termbox/termboxtest.py

@@ -1,5 +1,4 @@
 #!/usr/bin/python
-# -*- encoding: utf-8 -*-
 
 import termbox
 
@@ -17,8 +16,8 @@ def print_line(t, msg, y, fg, bg):
         t.change_cell(x + i, y, c, fg, bg)
 
 
-class SelectBox(object):
-    def __init__(self, tb, choices, active=-1):
+class SelectBox:
+    def __init__(self, tb, choices, active=-1) -> None:
         self.tb = tb
         self.active = active
         self.choices = choices

examples/thread_jobs.py

@@ -42,7 +42,7 @@ def test_fov_single(maps: List[tcod.map.Map]) -> None:
 
 
 def test_fov_threads(executor: concurrent.futures.Executor, maps: List[tcod.map.Map]) -> None:
-    for result in executor.map(test_fov, maps):
+    for _result in executor.map(test_fov, maps):
         pass
 
 
@@ -57,7 +57,7 @@ def test_astar_single(maps: List[tcod.map.Map]) -> None:
 
 
 def test_astar_threads(executor: concurrent.futures.Executor, maps: List[tcod.map.Map]) -> None:
-    for result in executor.map(test_astar, maps):
+    for _result in executor.map(test_astar, maps):
         pass
 
 
@@ -66,8 +66,7 @@ def run_test(
     single_func: Callable[[List[tcod.map.Map]], None],
     multi_func: Callable[[concurrent.futures.Executor, List[tcod.map.Map]], None],
 ) -> None:
-    """Run a function designed for a single thread and compare it to a threaded
-    version.
+    """Run a function designed for a single thread and compare it to a threaded version.
 
     This prints the results of these tests.
     """

examples/ttf.py

@@ -59,6 +59,7 @@ def load_ttf(path: str, size: Tuple[int, int]) -> tcod.tileset.Tileset:
 
 
 def main() -> None:
+    """True-type font example script."""
     console = tcod.Console(16, 12, order="F")
     with tcod.context.new(
         columns=console.width,