get description from catalog

Author: edwardchalstrey1

doc/tutorials/01_quickstart.ipynb

@@ -438,11 +438,7 @@
     {
      "data": {
       "text/plain": [
-       "['Game2x2',\n",
-       " 'Game2x2a',\n",
-       " 'Game2x2const',\n",
-       " 'Game8x8',\n",
-       " 'Cent2NFG',\n",
+       "['Cent2NFG',\n",
        " 'Coord2NFG',\n",
        " 'Coord3NFG',\n",
        " 'Coord4NFG',\n",
@@ -455,14 +451,18 @@
        " 'E02NFG',\n",
        " 'E04NFG',\n",
        " 'E07NFG',\n",
+       " 'Game2x2',\n",
+       " 'Game2x2a',\n",
+       " 'Game2x2const',\n",
+       " 'Game8x8',\n",
        " 'Loopback',\n",
        " 'Mixdom',\n",
        " 'Mixdom2',\n",
        " 'Oneill',\n",
-       " 'PrisonersDilemma',\n",
        " 'Perfect1',\n",
        " 'Perfect2',\n",
        " 'PokerNFG',\n",
+       " 'PrisonersDilemma',\n",
        " 'Sh3NFG',\n",
        " 'Stengel',\n",
        " 'Sww1NFG',\n",
@@ -485,27 +485,6 @@
     "gbt.catalog.games(game_type=\"nfg\", num_players=2)"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": 15,
-   "id": "ff307b74-16bc-4889-b57c-fef3124ce5ca",
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "\"A simple implementation of a two person Prisoner's Dilemma game.\""
-      ]
-     },
-     "execution_count": 15,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "gbt.catalog.PrisonersDilemma.description"
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "a919ddf7",
@@ -516,7 +495,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 16,
+   "execution_count": 14,
    "id": "6db7a29a",
    "metadata": {},
    "outputs": [
@@ -530,7 +509,7 @@
        "Game(title='Two person Prisoner's Dilemma game')"
       ]
      },
-     "execution_count": 16,
+     "execution_count": 14,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -556,7 +535,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 17,
+   "execution_count": 15,
    "id": "f58eaa77",
    "metadata": {},
    "outputs": [],
@@ -574,7 +553,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 18,
+   "execution_count": 16,
    "id": "4119a2ac",
    "metadata": {},
    "outputs": [],

doc/tutorials/02_extensive_form.ipynb

@@ -1114,9 +1114,7 @@
     {
      "data": {
       "text/plain": [
-       "['Game2smp',\n",
-       " 'Game4cards',\n",
-       " 'Artist1',\n",
+       "['Artist1',\n",
        " 'Artist2',\n",
        " 'Badgame1',\n",
        " 'Badgame2',\n",
@@ -1152,6 +1150,8 @@
        " 'E16',\n",
        " 'E17',\n",
        " 'E18',\n",
+       " 'Game2smp',\n",
+       " 'Game4cards',\n",
        " 'Holdout',\n",
        " 'Hs1',\n",
        " 'Km1',\n",
@@ -1170,6 +1170,7 @@
        " 'Myerson_fig_4_2',\n",
        " 'Nim',\n",
        " 'Nim7',\n",
+       " 'OneShotTrust',\n",
        " 'Palf',\n",
        " 'Palf2',\n",
        " 'Palf3',\n",
@@ -1191,8 +1192,7 @@
        " 'Wilson1',\n",
        " 'Work1',\n",
        " 'Work2',\n",
-       " 'Work3',\n",
-       " 'OneShotTrust']"
+       " 'Work3']"
       ]
      },
      "execution_count": 14,
@@ -1232,7 +1232,8 @@
     }
    ],
    "source": [
-    "print(gbt.catalog.OneShotTrust.description)"
+    "g_variant = gbt.catalog.OneShotTrust(unique_NE_variant=True)\n",
+    "print(g_variant.description)"
    ]
   },
   {
@@ -1419,7 +1420,7 @@
     }
    ],
    "source": [
-    "draw_tree(gbt.catalog.OneShotTrust(unique_NE_variant=True))"
+    "draw_tree(g_variant)"
    ]
   },
   {

src/pygambit/catalog/catalog.py

@@ -17,7 +17,6 @@ class CatalogGame:
     Calling any subclass will return an instance of the corresponding game.
     """
 
-    description: str
     game: Game | None = None
 
     def __new__(cls, *args, **kwargs) -> Game:
@@ -32,12 +31,13 @@ def _game() -> Game:
         raise NotImplementedError("Subclasses must implement _game() method")
 
     @classmethod
-    def _extract_metadata_from_game(cls, game: Game) -> None:
-        """Extract metadata from the game and set as class attributes."""
+    def _extract_description(cls, game: Game) -> None:
+        """Extract game description from docstring and apply to game."""
+        cleaned_docstring = ""
         if cls.__doc__:
-            cls.description = inspect.cleandoc(cls.__doc__)
-        else:
-            cls.description = game.description
+            cleaned_docstring = inspect.cleandoc(cls.__doc__)
+        if len(cleaned_docstring) > 0:
+            game.description = cleaned_docstring
 
     def __init_subclass__(cls, **kwargs):
         """Extract metadata when subclass is defined (if not a file-based game)."""
@@ -49,7 +49,7 @@ def __init_subclass__(cls, **kwargs):
 
         # Load game and extract metadata immediately when class is defined
         cls.game = cls._game()
-        cls._extract_metadata_from_game(cls.game)
+        cls._extract_description(cls.game)
 
 
 class CatalogGameFromContrib(CatalogGame):
@@ -88,7 +88,7 @@ def __init_subclass__(cls, **kwargs):
 
         # Load game and extract metadata immediately when class is defined
         cls.game = cls._load_game()
-        cls._extract_metadata_from_game(cls.game)
+        cls._extract_description(cls.game)
 
 
 def games(

src/pygambit/catalog/coded_games.py

@@ -4,16 +4,16 @@
 
 
 class OneShotTrust(CatalogGame):
+    """
+    The unique_NE_variant makes Trust a dominant strategy, replacing the
+    non-singleton equilibrium component from the standard version of the game
+    where the Buyer plays "Not Trust" and the seller can play any mixture with
+    < 0.5 probability on Honor with a unique NE where the Buyer plays Trust and
+    the Seller plays Abuse.
+    """
 
     @staticmethod
     def _game(unique_NE_variant: bool = False):
-        """
-        The unique_NE_variant makes Trust a dominant strategy, replacing the
-        non-singleton equilibrium component from the standard version of the game
-        where the Buyer plays "Not Trust" and the seller can play any mixture with
-        < 0.5 probability on Honor with a unique NE where the Buyer plays Trust and
-        the Seller plays Abuse.
-        """
         g = Game.new_tree(
             players=["Buyer", "Seller"], title="One-shot trust game, after Kreps (1990)"
         )

tests/test_catalog.py

@@ -36,11 +36,11 @@ def test_catalog_game_not_instantiable(self):
 
     def test_custom_game_subclass_extracts_metadata(self):
         """Custom CatalogGame subclasses should extract metadata from _game()."""
-        assert ExampleGame.description == "Test game description."
+        assert ExampleGame().description == "Test game description."
 
     def test_can_get_game_description_from_docstring(self):
         """CatalogGame should get description from docstring over game description."""
-        assert ExampleGameWithDocstring.description == "Alternative test game description."
+        assert ExampleGameWithDocstring().description == "Alternative test game description."
 
     def test_catalog_py_game_with_parameters(self):
         """
@@ -57,7 +57,7 @@ def test_catalog_yml_game_instantiation(self):
     def test_catalog_yml_game_description(self):
         """Custom CatalogGame subclasses reading from catalog.yml should return Game instances."""
         assert (
-            PrisonersDilemma.description
+            PrisonersDilemma().description
             == "A simple implementation of a two person Prisoner's Dilemma game."
         )