Big refactor to get catalog files from catalog dir external to pygambit

Author: edwardchalstrey1

MANIFEST.in

@@ -1,6 +1,7 @@
 recursive-include src/core *.cc *.h *.imp
 recursive-include src/games *.cc *.h *.imp
 recursive-include src/solvers *.c *.cc *.h *.imp
+recursive-include catalog *
 include src/gambit.h
 include src/pygambit/*.pxd
 include src/pygambit/*.pyx

catalog/__init__.py

@@ -0,0 +1,51 @@
+from importlib.resources import as_file, files
+
+import pandas as pd
+
+import pygambit as gbt
+
+# Use the full string path to the virtual package we created
+_CATALOG_RESOURCE = files(__name__)
+
+READERS = {
+    ".nfg": gbt.read_nfg,
+    ".efg": gbt.read_efg,
+}
+
+
+def load(slug: str) -> gbt.Game:
+    """
+    Load a game from the package catalog.
+    """
+    for suffix, reader in READERS.items():
+        resource_path = _CATALOG_RESOURCE / f"{slug}{suffix}"
+
+        if resource_path.is_file():
+            # as_file ensures we have a real filesystem path for the reader
+            with as_file(resource_path) as path:
+                return reader(str(path))
+
+    raise FileNotFoundError(f"No catalog entry called {slug}.nfg or {slug}.efg")
+
+
+def games() -> pd.DataFrame:
+    """
+    List games available in the package catalog.
+    """
+    records: list[dict[str, str]] = []
+
+    # iterdir() works directly on the Traversable object
+    for resource_path in sorted(_CATALOG_RESOURCE.iterdir()):
+        reader = READERS.get(resource_path.suffix)
+
+        if reader is not None and resource_path.is_file():
+            with as_file(resource_path) as path:
+                game = reader(str(path))
+                records.append(
+                    {
+                        "slug": resource_path.stem,
+                        "title": game.title,
+                    }
+                )
+
+    return pd.DataFrame.from_records(records, columns=["slug", "title"])

pyproject.toml

@@ -88,5 +88,12 @@ markers = [
     "slow: all time-consuming tests",
 ]
 
+[tool.setuptools]
+packages = ["pygambit", "pygambit.catalog"]
+package-dir = { "pygambit" = "src/pygambit", "pygambit.catalog" = "catalog" }
+
+[tool.setuptools.package-data]
+"pygambit.catalog" = ["*"]
+
 [tool.setuptools.dynamic]
 version = {file = "build_support/GAMBIT_VERSION"}

setup.py

@@ -103,8 +103,6 @@ def solver_library_config(library_name: str, paths: list) -> tuple:
     libraries=[cppgambit_bimatrix, cppgambit_liap, cppgambit_logit, cppgambit_simpdiv,
                cppgambit_gtracer, cppgambit_enumpoly,
                cppgambit_games, cppgambit_core],
-    package_dir={"": "src"},
-    packages=["pygambit"],
     ext_modules=Cython.Build.cythonize(libgambit,
                                        language_level="3str",
                                        compiler_directives={"binding": True})