xgparse 0.1.2__tar.gz → 0.1.3__tar.gz

{xgparse-0.1.2 → xgparse-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: xgparse
-Version: 0.1.2
+Version: 0.1.3
 Summary: parser for eXtreme Gammon files
 Author: Gergely Elias
 Author-email: Gergely Elias <gergely.elias@gmail.com>

{xgparse-0.1.2 → xgparse-0.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "xgparse"
-version = "0.1.2"
+version = "0.1.3"
 authors = [
   { name="Gergely Elias", email="gergely.elias@gmail.com" },
 ]

xgparse-0.1.3/src/xgparse/__init__.py

@@ -0,0 +1,3 @@
+from xgparse.convertxg import convert_xg_to_text
+from xgparse.convertxg import convert_xg_to_py_dataclasses
+from xgparse.extractxgdata import main as extract_xg_data

xgparse-0.1.2/src/xgparse/convertxg2txt.py → xgparse-0.1.3/src/xgparse/convertxg.py

@@ -1,5 +1,5 @@
 #
-#   convertxg2txt.py - XG data to text conversion tool
+#   convertxg.py - XG data to text conversion tool
 #   Copyright (C) 2026  Gergely Elias <gergely.elias@gmail.com>
 #
 #   This program is free software: you can redistribute it and/or modify
@@ -19,15 +19,23 @@
 from __future__ import annotations
 
 import pprint
+from collections.abc import Generator
 
 from . import xgimport
 from . import xgstruct
 
 
-def convert_xg_to_text(path: str) -> bytes:
-    """Convert XG data to text format, returning the text as bytes."""
+def convert_xg_to_py_dataclasses(
+    path: str,
+) -> Generator[xgstruct.GameRecord | xgstruct.RolloutContextEntry, None, None]:
+    """Yield parsed records from an XG file as dataclass objects.
+
+    Produces the same sequence as :func:`convert_xg_to_text` but returns
+    live dataclass instances instead of a text dump.  :class:`~xgstruct.UnimplementedEntry`
+    records are skipped (matching the text-dump behaviour).  Rollout records
+    are yielded after all game records.
+    """
     importer = xgimport.Import(path)
-    output = []
     file_version = -1
 
     for segment in importer.get_file_segments():
@@ -40,7 +48,7 @@ def convert_xg_to_text(path: str) -> bytes:
                 if isinstance(rec, xgstruct.HeaderMatchEntry):
                     file_version = rec.version
                 if not isinstance(rec, xgstruct.UnimplementedEntry):
-                    output.append(pprint.pformat(rec, width=160))
+                    yield rec
 
         elif segment.seg_type is xgimport.SegmentType.XG_ROLLOUTS:
             segment.fd.seek(0)
@@ -48,6 +56,10 @@ def convert_xg_to_text(path: str) -> bytes:
                 rec = xgstruct.read_rollout_record(segment.fd)
                 if rec is None:
                     break
-                output.append(pprint.pformat(rec, width=160))
+                yield rec
 
+
+def convert_xg_to_text(path: str) -> bytes:
+    """Convert XG data to text format, returning the text as bytes."""
+    output = [pprint.pformat(rec, width=160) for rec in convert_xg_to_py_dataclasses(path)]
     return "\n".join(output).encode("utf-8")

{xgparse-0.1.2 → xgparse-0.1.3}/src/xgparse/xgstruct.py

@@ -31,12 +31,20 @@ import struct
 import uuid
 from dataclasses import dataclass, field
 from enum import IntEnum
-from typing import BinaryIO
+from typing import BinaryIO, TypeAlias
 
 from . import xgutils
 
 # Convenience alias used throughout: a 26-element signed-byte board position.
-Position = tuple[int, ...]
+Position: TypeAlias = tuple[
+    int, int, int, int, int, int, int, int, int, int,
+    int, int, int, int, int, int, int, int, int, int,
+    int, int, int, int, int, int
+]
+
+# An 8-element move tuple: up to 4 checker moves encoded as (src1, dst1, src2, dst2, ...),
+# padded with -1 sentinels for unused slots.
+MoveTuple: TypeAlias = tuple[int, int, int, int, int, int, int, int]
 
 
 # ---------------------------------------------------------------------------

xgparse-0.1.2/src/xgparse/__init__.py

@@ -1,2 +0,0 @@
-from xgparse.convertxg2txt import convert_xg_to_text
-from xgparse.extractxgdata import main as extract_xg_data