rename contrib/games to catalog_game_files

Author: edwardchalstrey1

Makefile.am

@@ -101,151 +101,151 @@ EXTRA_DIST = \
 	src/gui/bitmaps/zoom1.xpm \
 	src/gui/bitmaps/gambitrc.rc \
 	src/README.rst \
-	src/pygambit/contrib/games/2s2x2x2.efg \
-	src/pygambit/contrib/games/2smp.efg \
-	src/pygambit/contrib/games/2x2.nfg \
-	src/pygambit/contrib/games/2x2a.nfg \
-	src/pygambit/contrib/games/2x2const.nfg \
-	src/pygambit/contrib/games/2x2x2-nau.nfg \
-	src/pygambit/contrib/games/2x2x2.efg \
-	src/pygambit/contrib/games/2x2x2.nfg \
-	src/pygambit/contrib/games/2x2x2x2.nfg \
-	src/pygambit/contrib/games/2x2x2x2x2.nfg \
-	src/pygambit/contrib/games/3x3x3.nfg \
-	src/pygambit/contrib/games/4cards.efg \
-	src/pygambit/contrib/games/5x4x3.nfg \
-	src/pygambit/contrib/games/8x2x2.nfg \
-	src/pygambit/contrib/games/8x8.nfg \
-	src/pygambit/contrib/games/artist1.efg \
-	src/pygambit/contrib/games/artist2.efg \
-	src/pygambit/contrib/games/badgame1.efg \
-	src/pygambit/contrib/games/badgame2.efg \
-	src/pygambit/contrib/games/bagwell.efg \
-	src/pygambit/contrib/games/bayes1a.efg \
-	src/pygambit/contrib/games/bayes2a.efg \
-	src/pygambit/contrib/games/bcp2.efg \
-	src/pygambit/contrib/games/bcp3.efg \
-	src/pygambit/contrib/games/bcp4.efg \
-	src/pygambit/contrib/games/bhg1.efg \
-	src/pygambit/contrib/games/bhg2.efg \
-	src/pygambit/contrib/games/bhg3.efg \
-	src/pygambit/contrib/games/bhg4.efg \
-	src/pygambit/contrib/games/bhg5.efg \
-	src/pygambit/contrib/games/caro2.efg \
-	src/pygambit/contrib/games/cent2.efg \
-	src/pygambit/contrib/games/cent2.nfg \
-	src/pygambit/contrib/games/cent3.efg \
-	src/pygambit/contrib/games/cent4.efg \
-	src/pygambit/contrib/games/cent6.efg \
-	src/pygambit/contrib/games/centcs10.efg \
-	src/pygambit/contrib/games/centcs6.efg \
-	src/pygambit/contrib/games/condjury.efg \
-	src/pygambit/contrib/games/coord2.efg \
-	src/pygambit/contrib/games/coord2.nfg \
-	src/pygambit/contrib/games/coord2ts.efg \
-	src/pygambit/contrib/games/coord3.efg \
-	src/pygambit/contrib/games/coord3.nfg \
-	src/pygambit/contrib/games/coord333.nfg \
-	src/pygambit/contrib/games/coord4.efg \
-	src/pygambit/contrib/games/coord4.nfg \
-	src/pygambit/contrib/games/cross.efg \
-	src/pygambit/contrib/games/cs.efg \
-	src/pygambit/contrib/games/csg1.nfg \
-	src/pygambit/contrib/games/csg2.nfg \
-	src/pygambit/contrib/games/csg3.nfg \
-	src/pygambit/contrib/games/csg4.nfg \
-	src/pygambit/contrib/games/deg1.nfg \
-	src/pygambit/contrib/games/deg2.nfg \
-	src/pygambit/contrib/games/e01.efg \
-	src/pygambit/contrib/games/e01.nfg \
-	src/pygambit/contrib/games/e02.efg \
-	src/pygambit/contrib/games/e02.nfg \
-	src/pygambit/contrib/games/e03.efg \
-	src/pygambit/contrib/games/e04.efg \
-	src/pygambit/contrib/games/e04.nfg \
-	src/pygambit/contrib/games/e05.efg \
-	src/pygambit/contrib/games/e06.efg \
-	src/pygambit/contrib/games/e07.efg \
-	src/pygambit/contrib/games/e07.nfg \
-	src/pygambit/contrib/games/e08.efg \
-	src/pygambit/contrib/games/e09.efg \
-	src/pygambit/contrib/games/e10.efg \
-	src/pygambit/contrib/games/e10a.efg \
-	src/pygambit/contrib/games/e13.efg \
-	src/pygambit/contrib/games/e16.efg \
-	src/pygambit/contrib/games/e17.efg \
-	src/pygambit/contrib/games/e18.efg \
-	src/pygambit/contrib/games/g1.efg \
-	src/pygambit/contrib/games/g1.nfg \
-	src/pygambit/contrib/games/g2.efg \
-	src/pygambit/contrib/games/g2.nfg \
-	src/pygambit/contrib/games/g3.efg \
-	src/pygambit/contrib/games/g3.nfg \
-	src/pygambit/contrib/games/holdout.efg \
-	src/pygambit/contrib/games/holdout7.efg \
-	src/pygambit/contrib/games/hs1.efg \
-	src/pygambit/contrib/games/jury_mr.efg \
-	src/pygambit/contrib/games/jury_un.efg \
-	src/pygambit/contrib/games/km1.efg \
-	src/pygambit/contrib/games/km2.efg \
-	src/pygambit/contrib/games/km3.efg \
-	src/pygambit/contrib/games/km6.efg \
-	src/pygambit/contrib/games/loopback.nfg \
-	src/pygambit/contrib/games/mixdom.nfg \
-	src/pygambit/contrib/games/mixdom2.nfg \
-	src/pygambit/contrib/games/montyhal.efg \
-	src/pygambit/contrib/games/my_2-1.efg \
-	src/pygambit/contrib/games/my_2-4.efg \
-	src/pygambit/contrib/games/my_2-8.efg \
-	src/pygambit/contrib/games/my_3-3a.efg \
-	src/pygambit/contrib/games/my_3-3b.efg \
-	src/pygambit/contrib/games/my_3-3c.efg \
-	src/pygambit/contrib/games/my_3-3d.efg \
-	src/pygambit/contrib/games/my_3-3e.efg \
-	src/pygambit/contrib/games/my_3-4.efg \
-	src/pygambit/contrib/games/myerson.efg \
-	src/pygambit/contrib/games/myerson_fig_4_2.efg \
-	src/pygambit/contrib/games/nim.efg \
-	src/pygambit/contrib/games/nim7.efg \
-	src/pygambit/contrib/games/oneill.nfg \
-	src/pygambit/contrib/games/palf.efg \
-	src/pygambit/contrib/games/palf2.efg \
-	src/pygambit/contrib/games/palf3.efg \
-	src/pygambit/contrib/games/pbride.efg \
-	src/pygambit/contrib/games/pd.nfg \
-	src/pygambit/contrib/games/perfect1.nfg \
-	src/pygambit/contrib/games/perfect2.nfg \
-	src/pygambit/contrib/games/perfect3.nfg \
-	src/pygambit/contrib/games/poker.efg \
-	src/pygambit/contrib/games/poker.nfg \
-	src/pygambit/contrib/games/poker2.efg \
-	src/pygambit/contrib/games/pvw.efg \
-	src/pygambit/contrib/games/pvw2.efg \
-	src/pygambit/contrib/games/sh3.efg \
-	src/pygambit/contrib/games/sh3.nfg \
-	src/pygambit/contrib/games/spence.efg \
-	src/pygambit/contrib/games/stengel.nfg \
-	src/pygambit/contrib/games/sww1.efg \
-	src/pygambit/contrib/games/sww1.nfg \
-	src/pygambit/contrib/games/sww2.efg \
-	src/pygambit/contrib/games/sww3.efg \
-	src/pygambit/contrib/games/tim.efg \
-	src/pygambit/contrib/games/todd1.nfg \
-	src/pygambit/contrib/games/todd2.nfg \
-	src/pygambit/contrib/games/todd3.nfg \
-	src/pygambit/contrib/games/ttt.efg \
-	src/pygambit/contrib/games/vd.efg \
-	src/pygambit/contrib/games/vd.nfg \
-	src/pygambit/contrib/games/w_ex1.efg \
-	src/pygambit/contrib/games/w_ex2.efg \
-	src/pygambit/contrib/games/wilson1.efg \
-	src/pygambit/contrib/games/wink3.nfg \
-	src/pygambit/contrib/games/winkels.nfg \
-	src/pygambit/contrib/games/work1.efg \
-	src/pygambit/contrib/games/work2.efg \
-	src/pygambit/contrib/games/work3.efg \
-	src/pygambit/contrib/games/yamamoto.nfg \
-	src/pygambit/contrib/games/zero.nfg
+	src/pygambit/catalog_game_files/2s2x2x2.efg \
+	src/pygambit/catalog_game_files/2smp.efg \
+	src/pygambit/catalog_game_files/2x2.nfg \
+	src/pygambit/catalog_game_files/2x2a.nfg \
+	src/pygambit/catalog_game_files/2x2const.nfg \
+	src/pygambit/catalog_game_files/2x2x2-nau.nfg \
+	src/pygambit/catalog_game_files/2x2x2.efg \
+	src/pygambit/catalog_game_files/2x2x2.nfg \
+	src/pygambit/catalog_game_files/2x2x2x2.nfg \
+	src/pygambit/catalog_game_files/2x2x2x2x2.nfg \
+	src/pygambit/catalog_game_files/3x3x3.nfg \
+	src/pygambit/catalog_game_files/4cards.efg \
+	src/pygambit/catalog_game_files/5x4x3.nfg \
+	src/pygambit/catalog_game_files/8x2x2.nfg \
+	src/pygambit/catalog_game_files/8x8.nfg \
+	src/pygambit/catalog_game_files/artist1.efg \
+	src/pygambit/catalog_game_files/artist2.efg \
+	src/pygambit/catalog_game_files/badgame1.efg \
+	src/pygambit/catalog_game_files/badgame2.efg \
+	src/pygambit/catalog_game_files/bagwell.efg \
+	src/pygambit/catalog_game_files/bayes1a.efg \
+	src/pygambit/catalog_game_files/bayes2a.efg \
+	src/pygambit/catalog_game_files/bcp2.efg \
+	src/pygambit/catalog_game_files/bcp3.efg \
+	src/pygambit/catalog_game_files/bcp4.efg \
+	src/pygambit/catalog_game_files/bhg1.efg \
+	src/pygambit/catalog_game_files/bhg2.efg \
+	src/pygambit/catalog_game_files/bhg3.efg \
+	src/pygambit/catalog_game_files/bhg4.efg \
+	src/pygambit/catalog_game_files/bhg5.efg \
+	src/pygambit/catalog_game_files/caro2.efg \
+	src/pygambit/catalog_game_files/cent2.efg \
+	src/pygambit/catalog_game_files/cent2.nfg \
+	src/pygambit/catalog_game_files/cent3.efg \
+	src/pygambit/catalog_game_files/cent4.efg \
+	src/pygambit/catalog_game_files/cent6.efg \
+	src/pygambit/catalog_game_files/centcs10.efg \
+	src/pygambit/catalog_game_files/centcs6.efg \
+	src/pygambit/catalog_game_files/condjury.efg \
+	src/pygambit/catalog_game_files/coord2.efg \
+	src/pygambit/catalog_game_files/coord2.nfg \
+	src/pygambit/catalog_game_files/coord2ts.efg \
+	src/pygambit/catalog_game_files/coord3.efg \
+	src/pygambit/catalog_game_files/coord3.nfg \
+	src/pygambit/catalog_game_files/coord333.nfg \
+	src/pygambit/catalog_game_files/coord4.efg \
+	src/pygambit/catalog_game_files/coord4.nfg \
+	src/pygambit/catalog_game_files/cross.efg \
+	src/pygambit/catalog_game_files/cs.efg \
+	src/pygambit/catalog_game_files/csg1.nfg \
+	src/pygambit/catalog_game_files/csg2.nfg \
+	src/pygambit/catalog_game_files/csg3.nfg \
+	src/pygambit/catalog_game_files/csg4.nfg \
+	src/pygambit/catalog_game_files/deg1.nfg \
+	src/pygambit/catalog_game_files/deg2.nfg \
+	src/pygambit/catalog_game_files/e01.efg \
+	src/pygambit/catalog_game_files/e01.nfg \
+	src/pygambit/catalog_game_files/e02.efg \
+	src/pygambit/catalog_game_files/e02.nfg \
+	src/pygambit/catalog_game_files/e03.efg \
+	src/pygambit/catalog_game_files/e04.efg \
+	src/pygambit/catalog_game_files/e04.nfg \
+	src/pygambit/catalog_game_files/e05.efg \
+	src/pygambit/catalog_game_files/e06.efg \
+	src/pygambit/catalog_game_files/e07.efg \
+	src/pygambit/catalog_game_files/e07.nfg \
+	src/pygambit/catalog_game_files/e08.efg \
+	src/pygambit/catalog_game_files/e09.efg \
+	src/pygambit/catalog_game_files/e10.efg \
+	src/pygambit/catalog_game_files/e10a.efg \
+	src/pygambit/catalog_game_files/e13.efg \
+	src/pygambit/catalog_game_files/e16.efg \
+	src/pygambit/catalog_game_files/e17.efg \
+	src/pygambit/catalog_game_files/e18.efg \
+	src/pygambit/catalog_game_files/g1.efg \
+	src/pygambit/catalog_game_files/g1.nfg \
+	src/pygambit/catalog_game_files/g2.efg \
+	src/pygambit/catalog_game_files/g2.nfg \
+	src/pygambit/catalog_game_files/g3.efg \
+	src/pygambit/catalog_game_files/g3.nfg \
+	src/pygambit/catalog_game_files/holdout.efg \
+	src/pygambit/catalog_game_files/holdout7.efg \
+	src/pygambit/catalog_game_files/hs1.efg \
+	src/pygambit/catalog_game_files/jury_mr.efg \
+	src/pygambit/catalog_game_files/jury_un.efg \
+	src/pygambit/catalog_game_files/km1.efg \
+	src/pygambit/catalog_game_files/km2.efg \
+	src/pygambit/catalog_game_files/km3.efg \
+	src/pygambit/catalog_game_files/km6.efg \
+	src/pygambit/catalog_game_files/loopback.nfg \
+	src/pygambit/catalog_game_files/mixdom.nfg \
+	src/pygambit/catalog_game_files/mixdom2.nfg \
+	src/pygambit/catalog_game_files/montyhal.efg \
+	src/pygambit/catalog_game_files/my_2-1.efg \
+	src/pygambit/catalog_game_files/my_2-4.efg \
+	src/pygambit/catalog_game_files/my_2-8.efg \
+	src/pygambit/catalog_game_files/my_3-3a.efg \
+	src/pygambit/catalog_game_files/my_3-3b.efg \
+	src/pygambit/catalog_game_files/my_3-3c.efg \
+	src/pygambit/catalog_game_files/my_3-3d.efg \
+	src/pygambit/catalog_game_files/my_3-3e.efg \
+	src/pygambit/catalog_game_files/my_3-4.efg \
+	src/pygambit/catalog_game_files/myerson.efg \
+	src/pygambit/catalog_game_files/myerson_fig_4_2.efg \
+	src/pygambit/catalog_game_files/nim.efg \
+	src/pygambit/catalog_game_files/nim7.efg \
+	src/pygambit/catalog_game_files/oneill.nfg \
+	src/pygambit/catalog_game_files/palf.efg \
+	src/pygambit/catalog_game_files/palf2.efg \
+	src/pygambit/catalog_game_files/palf3.efg \
+	src/pygambit/catalog_game_files/pbride.efg \
+	src/pygambit/catalog_game_files/pd.nfg \
+	src/pygambit/catalog_game_files/perfect1.nfg \
+	src/pygambit/catalog_game_files/perfect2.nfg \
+	src/pygambit/catalog_game_files/perfect3.nfg \
+	src/pygambit/catalog_game_files/poker.efg \
+	src/pygambit/catalog_game_files/poker.nfg \
+	src/pygambit/catalog_game_files/poker2.efg \
+	src/pygambit/catalog_game_files/pvw.efg \
+	src/pygambit/catalog_game_files/pvw2.efg \
+	src/pygambit/catalog_game_files/sh3.efg \
+	src/pygambit/catalog_game_files/sh3.nfg \
+	src/pygambit/catalog_game_files/spence.efg \
+	src/pygambit/catalog_game_files/stengel.nfg \
+	src/pygambit/catalog_game_files/sww1.efg \
+	src/pygambit/catalog_game_files/sww1.nfg \
+	src/pygambit/catalog_game_files/sww2.efg \
+	src/pygambit/catalog_game_files/sww3.efg \
+	src/pygambit/catalog_game_files/tim.efg \
+	src/pygambit/catalog_game_files/todd1.nfg \
+	src/pygambit/catalog_game_files/todd2.nfg \
+	src/pygambit/catalog_game_files/todd3.nfg \
+	src/pygambit/catalog_game_files/ttt.efg \
+	src/pygambit/catalog_game_files/vd.efg \
+	src/pygambit/catalog_game_files/vd.nfg \
+	src/pygambit/catalog_game_files/w_ex1.efg \
+	src/pygambit/catalog_game_files/w_ex2.efg \
+	src/pygambit/catalog_game_files/wilson1.efg \
+	src/pygambit/catalog_game_files/wink3.nfg \
+	src/pygambit/catalog_game_files/winkels.nfg \
+	src/pygambit/catalog_game_files/work1.efg \
+	src/pygambit/catalog_game_files/work2.efg \
+	src/pygambit/catalog_game_files/work3.efg \
+	src/pygambit/catalog_game_files/yamamoto.nfg \
+	src/pygambit/catalog_game_files/zero.nfg
 
 core_SOURCES = \
     src/core/core.h \

pyproject.toml

@@ -91,7 +91,7 @@ include-package-data = true
 [tool.setuptools.package-data]
 pygambit = [
     "catalog.yml",
-    "contrib/games/*",
+    "catalog_game_files/*",
 ]
 
 [tool.setuptools.dynamic]

src/pygambit/catalog.py

@@ -6,7 +6,7 @@
 
 import pygambit as gbt
 
-_GAMEFILES_DIR = files(__package__) / "contrib" / "games"
+_GAMEFILES_DIR = files(__package__) / "catalog_game_files"
 
 
 class CatalogGame:
@@ -47,24 +47,24 @@ def __init_subclass__(cls, **kwargs):
         """Extract metadata when subclass is defined (if not a file-based game)."""
         super().__init_subclass__(**kwargs)
 
-        # Skip if this is CatalogGameFromContrib or its subclasses
-        if cls.__name__ == "CatalogGameFromContrib" or issubclass(cls, CatalogGameFromContrib):
+        # Skip if this is CatalogGameFromFile or its subclasses
+        if cls.__name__ == "CatalogGameFromFile" or issubclass(cls, CatalogGameFromFile):
             return
 
         # Load game and extract metadata immediately when class is defined
         cls.game = cls._game()
         cls._extract_description(cls.game)
 
 
-class CatalogGameFromContrib(CatalogGame):
+class CatalogGameFromFile(CatalogGame):
     """
     Base class for catalog games loaded from files.
     This class serves as a template for specific games in the catalog.
     Calling any subclass will return an instance of the corresponding game.
     """
 
     game_file: str
-    """Filename of the game file in contrib/games directory."""
+    """Filename of the game file in catalog_game_files directory."""
 
     def __new__(cls) -> gbt.Game:
         if getattr(cls, "game", None) is None:
@@ -167,8 +167,8 @@ def get_all_subclasses(cls):
         all_subclasses = []
         for subclass in cls.__subclasses__():
 
-            # Don't include CatalogGameFromContrib in result
-            if subclass.__name__ in ["CatalogGameFromContrib"]:
+            # Don't include CatalogGameFromFile in result
+            if subclass.__name__ in ["CatalogGameFromFile"]:
                 all_subclasses.extend(get_all_subclasses(subclass))
                 continue
 
@@ -261,9 +261,9 @@ def _load_catalog_from_yaml() -> dict[str, dict]:
         return yaml.safe_load(f) or {}
 
 
-def _generate_contrib_game_classes(catalog: dict[str, dict]) -> None:
+def _generate_game_classes_from_catalog(catalog: dict[str, dict]) -> None:
     """
-    Dynamically generate CatalogGameFromContrib subclasses from YAML
+    Dynamically generate CatalogGameFromFile subclasses from YAML
     and attach them to this module's namespace.
     """
     module = sys.modules[__name__]
@@ -292,7 +292,7 @@ def _generate_contrib_game_classes(catalog: dict[str, dict]) -> None:
 
             cls = type(
                 class_name,
-                (CatalogGameFromContrib,),
+                (CatalogGameFromFile,),
                 class_attrs,
             )
 
@@ -313,4 +313,4 @@ def load_coded_games():
 
 # Generate classes at import time
 _catalog_data = _load_catalog_from_yaml()
-_generate_contrib_game_classes(_catalog_data)
+_generate_game_classes_from_catalog(_catalog_data)