Expose TileSet parsing more directly (#67)

Author: Cleptomania

pytiled_parser/__init__.py

@@ -14,7 +14,7 @@
 from .common_types import Color, OrderedPair, Size
 from .exception import UnknownFormat
 from .layer import Chunk, ImageLayer, Layer, LayerGroup, ObjectLayer, TileLayer
-from .parser import parse_map, parse_world
+from .parser import parse_map, parse_world, parse_tileset
 from .properties import Properties, Property
 from .tiled_map import TiledMap
 from .tileset import Frame, Grid, Tile, Tileset, Transformations

pytiled_parser/parser.py

@@ -1,45 +1,77 @@
-from pathlib import Path
-
-from pytiled_parser import UnknownFormat
-from pytiled_parser.parsers.json.tiled_map import parse as json_map_parse
-from pytiled_parser.parsers.tmx.tiled_map import parse as tmx_map_parse
-from pytiled_parser.tiled_map import TiledMap
-from pytiled_parser.util import check_format
-from pytiled_parser.world import World
-from pytiled_parser.world import parse_world as _parse_world
-
-
-def parse_map(file: Path) -> TiledMap:
-    """Parse the raw Tiled map into a pytiled_parser type
-
-    Args:
-        file: Path to the map file
-
-    Returns:
-        TiledMap: A parsed and typed TiledMap
-    """
-    parser = check_format(file)
-
-    # The type ignores are because mypy for some reason thinks those functions return Any
-    if parser == "tmx":
-        return tmx_map_parse(file)  # type: ignore
-    else:
-        try:
-            return json_map_parse(file)  # type: ignore
-        except ValueError:
-            raise UnknownFormat(
-                "Unknown Map Format, please use either the TMX or JSON format. "
-                "This message could also mean your map file is invalid or corrupted."
-            )
-
-
-def parse_world(file: Path) -> World:
-    """Parse the raw world file into a pytiled_parser type
-
-    Args:
-        file: Path to the world file
-
-    Returns:
-        World: A parsed and typed World
-    """
-    return _parse_world(file)
+import json
+import xml.etree.ElementTree as etree
+from pathlib import Path
+
+from pytiled_parser import UnknownFormat
+from pytiled_parser.parsers.json.tiled_map import parse as json_map_parse
+from pytiled_parser.parsers.json.tileset import parse as json_tileset_parse
+from pytiled_parser.parsers.tmx.tiled_map import parse as tmx_map_parse
+from pytiled_parser.parsers.tmx.tileset import parse as tmx_tileset_parse
+from pytiled_parser.tiled_map import TiledMap
+from pytiled_parser.tileset import Tileset
+from pytiled_parser.util import check_format
+from pytiled_parser.world import World
+from pytiled_parser.world import parse_world as _parse_world
+
+
+def parse_map(file: Path) -> TiledMap:
+    """Parse the raw Tiled map into a pytiled_parser type
+
+    Args:
+        file: Path to the map file
+
+    Returns:
+        TiledMap: A parsed and typed TiledMap
+    """
+    parser = check_format(file)
+
+    # The type ignores are because mypy for some reason thinks those functions return Any
+    if parser == "tmx":
+        return tmx_map_parse(file)  # type: ignore
+    else:
+        try:
+            return json_map_parse(file)  # type: ignore
+        except ValueError:
+            raise UnknownFormat(
+                "Unknown Map Format, please use either the TMX or JSON format. "
+                "This message could also mean your map file is invalid or corrupted."
+            )
+
+
+def parse_tileset(file: Path) -> Tileset:
+    """Parse the raw Tiled Tileset into a pytiled_parser type
+
+    Args:
+        file: Path to the map file
+
+    Returns:
+        Tileset: A parsed and typed Tileset
+    """
+    parser = check_format(file)
+
+    if parser == "tmx":
+        with open(file) as map_file:
+            raw_tileset = etree.parse(map_file).getroot()
+        return tmx_tileset_parse(raw_tileset, 1)
+    else:
+        try:
+            with open(file) as my_file:
+                raw_tileset = json.load(my_file)
+            return json_tileset_parse(raw_tileset, 1)
+        except ValueError:
+            raise UnknownFormat(
+                "Unknowm Tileset Format, please use either the TSX or JSON format. "
+                "This message could also mean your tileset file is invalid or corrupted."
+            )
+
+
+def parse_world(file: Path) -> World:
+    """Parse the raw world file into a pytiled_parser type
+
+    Args:
+        file: Path to the world file
+
+    Returns:
+        World: A parsed and typed World
+    """
+    return _parse_world(file)

tests/test_tileset.py

@@ -7,6 +7,7 @@
 
 import pytest
 
+from pytiled_parser import parse_tileset
 from pytiled_parser.common_types import OrderedPair, Size
 from pytiled_parser.parsers.json.tileset import parse as parse_json
 from pytiled_parser.parsers.tmx.tileset import parse as parse_tmx
@@ -59,12 +60,19 @@ def test_tilesets_integration(parser_type, tileset_dir):
 
     if parser_type == "json":
         raw_tileset_path = tileset_dir / "tileset.json"
-        with open(raw_tileset_path) as raw_tileset:
-            tileset_ = parse_json(json.loads(raw_tileset.read()), 1)
     elif parser_type == "tmx":
         raw_tileset_path = tileset_dir / "tileset.tsx"
-        with open(raw_tileset_path) as raw_tileset:
-            tileset_ = parse_tmx(etree.parse(raw_tileset).getroot(), 1)
+
+    tileset_ = parse_tileset(raw_tileset_path)
+
+    # if parser_type == "json":
+    #     raw_tileset_path = tileset_dir / "tileset.json"
+    #     with open(raw_tileset_path) as raw_tileset:
+    #         tileset_ = parse_json(json.loads(raw_tileset.read()), 1)
+    # elif parser_type == "tmx":
+    #     raw_tileset_path = tileset_dir / "tileset.tsx"
+    #     with open(raw_tileset_path) as raw_tileset:
+    #         tileset_ = parse_tmx(etree.parse(raw_tileset).getroot(), 1)
 
     fix_tileset(tileset_)
     fix_tileset(expected.EXPECTED)