Improve PathLike handling.

Author: HexDecimal

CHANGELOG.md

@@ -4,6 +4,8 @@ Changes relevant to the users of python-tcod are documented here.
 This project adheres to [Semantic Versioning](https://semver.org/) since version `2.0.0`.
 
 ## [Unreleased]
+### Fixed
+- Fixed handling of non-Path PathLike parameters and filepath encodings.
 
 ## [13.3.0] - 2022-01-07
 ### Added

tcod/console.py

@@ -5,9 +5,9 @@
 """
 from __future__ import annotations
 
-import os
 import warnings
 from os import PathLike
+from pathlib import Path
 from typing import Any, Iterable, Optional, Sequence, Tuple, Union
 
 import numpy as np
@@ -1300,11 +1300,12 @@ def load_xp(path: Union[str, PathLike[str]], order: Literal["C", "F"] = "C") ->
         is_transparent = (console.rgb["bg"] == KEY_COLOR).all(axis=-1)
         console.rgba[is_transparent] = (ord(" "), (0,), (0,))
     """
-    if not os.path.exists(path):
-        raise FileNotFoundError(f"File not found:\n\t{os.path.abspath(path)}")
-    layers = _check(tcod.lib.TCOD_load_xp(str(path).encode("utf-8"), 0, ffi.NULL))
+    path = Path(path)
+    if not path.exists():
+        raise FileNotFoundError(f"File not found:\n\t{path.resolve()}")
+    layers = _check(tcod.lib.TCOD_load_xp(bytes(path), 0, ffi.NULL))
     consoles = ffi.new("TCOD_Console*[]", layers)
-    _check(tcod.lib.TCOD_load_xp(str(path).encode("utf-8"), layers, consoles))
+    _check(tcod.lib.TCOD_load_xp(bytes(path), layers, consoles))
     return tuple(Console._from_cdata(console_p, order=order) for console_p in consoles)
 
 
@@ -1358,12 +1359,13 @@ def save_xp(
 
         tcod.console.save_xp("example.xp", [console])
     """
+    path = Path(path)
     consoles_c = ffi.new("TCOD_Console*[]", [c.console_c for c in consoles])
     _check(
         tcod.lib.TCOD_save_xp(
             len(consoles_c),
             consoles_c,
-            str(path).encode("utf-8"),
+            bytes(path),
             compress_level,
         )
     )

tcod/image.py

@@ -8,6 +8,7 @@
 from __future__ import annotations
 
 from os import PathLike
+from pathlib import Path
 from typing import Any, Dict, Tuple, Union
 
 import numpy as np
@@ -345,7 +346,7 @@ def load(filename: Union[str, PathLike[str]]) -> NDArray[np.uint8]:
 
     .. versionadded:: 11.4
     """
-    image = Image._from_cdata(ffi.gc(lib.TCOD_image_load(str(filename).encode()), lib.TCOD_image_delete))
+    image = Image._from_cdata(ffi.gc(lib.TCOD_image_load(bytes(Path(filename))), lib.TCOD_image_delete))
     array: NDArray[np.uint8] = np.asarray(image, dtype=np.uint8)
     height, width, depth = array.shape
     if depth == 3:

tcod/tileset.py

@@ -13,8 +13,8 @@
 from __future__ import annotations
 
 import itertools
-import os
 from os import PathLike
+from pathlib import Path
 from typing import Any, Iterable, Optional, Tuple, Union
 
 import numpy as np
@@ -258,9 +258,10 @@ def load_truetype_font(path: Union[str, PathLike[str]], tile_width: int, tile_he
 
     This function is provisional.  The API may change.
     """
-    if not os.path.exists(path):
-        raise RuntimeError("File not found:\n\t%s" % (os.path.realpath(path),))
-    cdata = lib.TCOD_load_truetype_font_(str(path).encode(), tile_width, tile_height)
+    path = Path(path)
+    if not path.exists():
+        raise RuntimeError(f"File not found:\n\t{path.resolve()}")
+    cdata = lib.TCOD_load_truetype_font_(bytes(path), tile_width, tile_height)
     if not cdata:
         raise RuntimeError(ffi.string(lib.TCOD_get_error()))
     return Tileset._claim(cdata)
@@ -287,9 +288,10 @@ def set_truetype_font(path: Union[str, PathLike[str]], tile_width: int, tile_hei
         This function does not support contexts.
         Use :any:`load_truetype_font` instead.
     """
-    if not os.path.exists(path):
-        raise RuntimeError("File not found:\n\t%s" % (os.path.realpath(path),))
-    if lib.TCOD_tileset_load_truetype_(str(path).encode(), tile_width, tile_height):
+    path = Path(path)
+    if not path.exists():
+        raise RuntimeError(f"File not found:\n\t{path.resolve()}")
+    if lib.TCOD_tileset_load_truetype_(bytes(path), tile_width, tile_height):
         raise RuntimeError(ffi.string(lib.TCOD_get_error()))
 
 
@@ -306,9 +308,10 @@ def load_bdf(path: Union[str, PathLike[str]]) -> Tileset:
 
     .. versionadded:: 11.10
     """  # 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(str(path).encode())
+    path = Path(path)
+    if not path.exists():
+        raise RuntimeError(f"File not found:\n\t{path.resolve()}")
+    cdata = lib.TCOD_load_bdf(bytes(path))
     if not cdata:
         raise RuntimeError(ffi.string(lib.TCOD_get_error()).decode())
     return Tileset._claim(cdata)
@@ -335,12 +338,13 @@ def load_tilesheet(
 
     .. versionadded:: 11.12
     """
-    if not os.path.exists(path):
-        raise RuntimeError("File not found:\n\t%s" % (os.path.realpath(path),))
+    path = Path(path)
+    if not path.exists():
+        raise RuntimeError(f"File not found:\n\t{path.resolve()}")
     mapping = []
     if charmap is not None:
         mapping = list(itertools.islice(charmap, columns * rows))
-    cdata = lib.TCOD_tileset_load(str(path).encode(), columns, rows, len(mapping), mapping)
+    cdata = lib.TCOD_tileset_load(bytes(path), columns, rows, len(mapping), mapping)
     if not cdata:
         _raise_tcod_error()
     return Tileset._claim(cdata)