Fix a bug in catalog update

build_support/catalog/test_update.py

@@ -147,6 +147,57 @@ def _make_image_files(catalog_dir, slug, fmt="efg"):
         (img_dir / f"{slug}.ef").touch()
 
 
+# ---------------------------------------------------------------------------
+# Tests for catalog resource selection
+# ---------------------------------------------------------------------------
+
+
+@pytest.mark.catalog_update
+class TestCatalogResourceSelection:
+    def test_catalog_games_uses_requested_catalog_dir_and_restores_resource(
+        self, tmp_path, monkeypatch
+    ):
+        stale_dir = tmp_path / "installed_catalog_data"
+        checkout_dir = tmp_path / "checkout_catalog"
+        stale_dir.mkdir()
+        checkout_dir.mkdir()
+        calls = []
+
+        def fake_games(**kwargs):
+            calls.append((update.gbt.catalog._CATALOG_RESOURCE, kwargs))
+            return _make_df(_efg_row("checkout/game1"))
+
+        monkeypatch.setattr(update.gbt.catalog, "_CATALOG_RESOURCE", stale_dir)
+        monkeypatch.setattr(update.gbt.catalog, "games", fake_games)
+
+        df = update._catalog_games(checkout_dir)
+
+        assert calls == [(checkout_dir, {"include_descriptions": True})]
+        assert stale_dir == update.gbt.catalog._CATALOG_RESOURCE
+        assert list(df["Game"]) == ["checkout/game1"]
+
+    def test_generate_rst_table_uses_requested_catalog_dir_while_rendering(
+        self, tmp_path, monkeypatch
+    ):
+        stale_dir = tmp_path / "installed_catalog_data"
+        checkout_dir = tmp_path / "checkout_catalog"
+        stale_dir.mkdir()
+        checkout_dir.mkdir()
+        observed = []
+
+        def fake_write_tree_level(*args, **kwargs):
+            observed.append(update.gbt.catalog._CATALOG_RESOURCE)
+
+        monkeypatch.setattr(update.gbt.catalog, "_CATALOG_RESOURCE", stale_dir)
+        monkeypatch.setattr(update, "load_hierarchy_labels", lambda: {})
+        monkeypatch.setattr(update, "_write_tree_level", fake_write_tree_level)
+
+        update.generate_rst_table(_make_df(), tmp_path / "out.rst", catalog_dir=checkout_dir)
+
+        assert observed == [checkout_dir]
+        assert stale_dir == update.gbt.catalog._CATALOG_RESOURCE
+
+
 # ---------------------------------------------------------------------------
 # Tests for catalog_gtdraw_settings
 # ---------------------------------------------------------------------------

build_support/catalog/update.py

@@ -1,6 +1,7 @@
 import argparse
 import shutil
 import sys
+from contextlib import contextmanager
 from pathlib import Path
 
 import pandas as pd
@@ -17,6 +18,24 @@
 SUPPORTED_GAME_FORMATS = {"efg", "nfg"}
 
 
+@contextmanager
+def _using_catalog_dir(catalog_dir: Path):
+    """Temporarily make pygambit.catalog read data from the checked-out catalog."""
+    old_resource = gbt.catalog._CATALOG_RESOURCE
+    gbt.catalog._CATALOG_RESOURCE = catalog_dir
+    try:
+        yield
+    finally:
+        gbt.catalog._CATALOG_RESOURCE = old_resource
+
+
+def _catalog_games(catalog_dir: Path | None = None) -> pd.DataFrame:
+    """Return catalog games using files from *catalog_dir*, not installed package data."""
+    catalog_dir = catalog_dir or CATALOG_DIR
+    with _using_catalog_dir(catalog_dir):
+        return gbt.catalog.games(include_descriptions=True)
+
+
 def catalog_gtdraw_settings(slug: str) -> dict:
     """Return the gtdraw settings for a given catalog slug."""
     with open(GTDRAW_SETTINGS_CONFIG, encoding="utf-8") as f:
@@ -325,7 +344,7 @@ def generate_rst_table(
     catalog_dir = catalog_dir or CATALOG_DIR
     labels = load_hierarchy_labels()
     tree = _build_slug_tree(df)
-    with open(rst_path, "w", encoding="utf-8") as f:
+    with _using_catalog_dir(catalog_dir), open(rst_path, "w", encoding="utf-8") as f:
         _write_tree_level(
             f, tree, "", labels, catalog_dir, indent="", regenerate_images=regenerate_images
         )
@@ -409,7 +428,7 @@ def update_makefile(
     args = parser.parse_args()
 
     # Create RST list-table used by doc/catalog.rst
-    df = gbt.catalog.games(include_descriptions=True)
+    df = _catalog_games()
     _warn_missing_descriptions(df)
     generate_rst_table(df, CATALOG_RST_TABLE, regenerate_images=args.regenerate_images)
     print(f"Generated {CATALOG_RST_TABLE} for use in local docs build. DO NOT COMMIT.")