Add pathlib support to tcod.tileset and tcod.image.

Author: HexDecimal

CHANGELOG.rst

@@ -8,6 +8,8 @@ v2.0.0
 
 Unreleased
 ------------------
+Added
+ - *tcod.image* and *tcod.tileset* now support *pathlib*.
 
 12.6.2 - 2021-06-15
 -------------------

tcod/console.py

@@ -4,8 +4,8 @@
 See :ref:`getting-started` for info on how to set those up.
 """
 import os
-import pathlib
 import warnings
+from pathlib import Path
 from typing import Any, Iterable, Optional, Sequence, Tuple, Union
 
 import numpy as np
@@ -1266,7 +1266,7 @@ def recommended_size() -> Tuple[int, int]:
     return w, h
 
 
-def load_xp(path: Union[str, pathlib.Path], order: Literal["C", "F"] = "C") -> Tuple[Console, ...]:
+def load_xp(path: Union[str, Path], order: Literal["C", "F"] = "C") -> Tuple[Console, ...]:
     """Load a REXPaint file as a tuple of consoles.
 
     `path` is the name of the REXPaint file to load.
@@ -1308,7 +1308,7 @@ def load_xp(path: Union[str, pathlib.Path], order: Literal["C", "F"] = "C") -> T
 
 
 def save_xp(
-    path: Union[str, pathlib.Path],
+    path: Union[str, Path],
     consoles: Iterable[Console],
     compress_level: int = 9,
 ) -> None:

tcod/image.py

@@ -5,9 +5,8 @@
 `an alternative library for graphics rendering
 <https://wiki.python.org/moin/PythonGameLibraries>`_.
 """
-
-
-from typing import Any, Dict, Tuple
+from pathlib import Path
+from typing import Any, Dict, Tuple, Union
 
 import numpy as np
 
@@ -334,7 +333,7 @@ def _get_format_name(format: int) -> str:
     "  It's recommended to load images with a more complete image library such as python-Pillow or python-imageio.",
     category=PendingDeprecationWarning,
 )
-def load(filename: str) -> np.ndarray:
+def load(filename: Union[str, Path]) -> np.ndarray:
     """Load a PNG file as an RGBA array.
 
     `filename` is the name of the file to load.
@@ -343,7 +342,7 @@ def load(filename: str) -> np.ndarray:
 
     .. versionadded:: 11.4
     """
-    image = Image._from_cdata(ffi.gc(lib.TCOD_image_load(filename.encode()), lib.TCOD_image_delete))
+    image = Image._from_cdata(ffi.gc(lib.TCOD_image_load(str(filename).encode()), lib.TCOD_image_delete))
     array = np.asarray(image, dtype=np.uint8)
     height, width, depth = array.shape
     if depth == 3:

tcod/tileset.py

@@ -12,7 +12,8 @@
 """
 import itertools
 import os
-from typing import Any, Iterable, Optional, Tuple
+from pathlib import Path
+from typing import Any, Iterable, Optional, Tuple, Union
 
 import numpy as np
 
@@ -200,7 +201,7 @@ def set_default(tileset: Tileset) -> None:
     lib.TCOD_set_default_tileset(tileset._tileset_p)
 
 
-def load_truetype_font(path: str, tile_width: int, tile_height: int) -> Tileset:
+def load_truetype_font(path: Union[str, Path], tile_width: int, tile_height: int) -> Tileset:
     """Return a new Tileset from a `.ttf` or `.otf` file.
 
     Same as :any:`set_truetype_font`, but returns a :any:`Tileset` instead.
@@ -210,14 +211,14 @@ def load_truetype_font(path: str, tile_width: int, tile_height: int) -> Tileset:
     """
     if not os.path.exists(path):
         raise RuntimeError("File not found:\n\t%s" % (os.path.realpath(path),))
-    cdata = lib.TCOD_load_truetype_font_(path.encode(), tile_width, tile_height)
+    cdata = lib.TCOD_load_truetype_font_(str(path).encode(), tile_width, tile_height)
     if not cdata:
         raise RuntimeError(ffi.string(lib.TCOD_get_error()))
     return Tileset._claim(cdata)
 
 
 @deprecate("Accessing the default tileset is deprecated.")
-def set_truetype_font(path: str, tile_width: int, tile_height: int) -> None:
+def set_truetype_font(path: Union[str, Path], tile_width: int, tile_height: int) -> None:
     """Set the default tileset from a `.ttf` or `.otf` file.
 
     `path` is the file path for the font file.
@@ -239,11 +240,11 @@ def set_truetype_font(path: str, tile_width: int, tile_height: int) -> None:
     """
     if not os.path.exists(path):
         raise RuntimeError("File not found:\n\t%s" % (os.path.realpath(path),))
-    if lib.TCOD_tileset_load_truetype_(path.encode(), tile_width, tile_height):
+    if lib.TCOD_tileset_load_truetype_(str(path).encode(), tile_width, tile_height):
         raise RuntimeError(ffi.string(lib.TCOD_get_error()))
 
 
-def load_bdf(path: str) -> Tileset:
+def load_bdf(path: Union[str, Path]) -> Tileset:
     """Return a new Tileset from a `.bdf` file.
 
     For the best results the font should be monospace, cell-based, and
@@ -258,13 +259,13 @@ def load_bdf(path: str) -> Tileset:
     """  # noqa: E501
     if not os.path.exists(path):
         raise RuntimeError("File not found:\n\t%s" % (os.path.realpath(path),))
-    cdata = lib.TCOD_load_bdf(path.encode())
+    cdata = lib.TCOD_load_bdf(str(path).encode())
     if not cdata:
         raise RuntimeError(ffi.string(lib.TCOD_get_error()).decode())
     return Tileset._claim(cdata)
 
 
-def load_tilesheet(path: str, columns: int, rows: int, charmap: Optional[Iterable[int]]) -> Tileset:
+def load_tilesheet(path: Union[str, Path], columns: int, rows: int, charmap: Optional[Iterable[int]]) -> Tileset:
     """Return a new Tileset from a simple tilesheet image.
 
     `path` is the file path to a PNG file with the tileset.
@@ -289,7 +290,7 @@ def load_tilesheet(path: str, columns: int, rows: int, charmap: Optional[Iterabl
     mapping = []
     if charmap is not None:
         mapping = list(itertools.islice(charmap, columns * rows))
-    cdata = lib.TCOD_tileset_load(path.encode(), columns, rows, len(mapping), mapping)
+    cdata = lib.TCOD_tileset_load(str(path).encode(), columns, rows, len(mapping), mapping)
     if not cdata:
         _raise_tcod_error()
     return Tileset._claim(cdata)