add filter for number of players

Author: edwardchalstrey1

doc/tutorials/01_quickstart.ipynb

@@ -50,7 +50,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 2,
    "id": "2060c1ed",
    "metadata": {},
    "outputs": [
@@ -60,7 +60,7 @@
        "pygambit.gambit.Game"
       ]
      },
-     "execution_count": 1,
+     "execution_count": 2,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -83,7 +83,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 3,
    "id": "9d8203e8",
    "metadata": {},
    "outputs": [],
@@ -111,7 +111,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 4,
    "id": "61030607",
    "metadata": {},
    "outputs": [],
@@ -135,7 +135,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 5,
    "id": "caecc334",
    "metadata": {},
    "outputs": [
@@ -149,7 +149,7 @@
        "Game(title='Prisoner's Dilemma')"
       ]
      },
-     "execution_count": 4,
+     "execution_count": 5,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -189,7 +189,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 6,
    "id": "843ba7f3",
    "metadata": {},
    "outputs": [
@@ -203,7 +203,7 @@
        "Game(title='Another Prisoner's Dilemma')"
       ]
      },
-     "execution_count": 5,
+     "execution_count": 6,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -233,7 +233,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 7,
    "id": "5ee752c4",
    "metadata": {},
    "outputs": [
@@ -270,7 +270,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 8,
    "id": "a81c06c7",
    "metadata": {},
    "outputs": [
@@ -280,7 +280,7 @@
        "pygambit.nash.NashComputationResult"
       ]
      },
-     "execution_count": 7,
+     "execution_count": 8,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -300,7 +300,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 9,
    "id": "bd395180",
    "metadata": {},
    "outputs": [
@@ -310,7 +310,7 @@
        "1"
       ]
      },
-     "execution_count": 8,
+     "execution_count": 9,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -329,7 +329,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 10,
    "id": "76570ebc",
    "metadata": {},
    "outputs": [
@@ -342,7 +342,7 @@
        "[[Rational(0, 1), Rational(1, 1)], [Rational(0, 1), Rational(1, 1)]]"
       ]
      },
-     "execution_count": 9,
+     "execution_count": 10,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -354,7 +354,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 11,
    "id": "6e8cfcde",
    "metadata": {},
    "outputs": [
@@ -364,7 +364,7 @@
        "pygambit.gambit.MixedStrategyProfileRational"
       ]
      },
-     "execution_count": 10,
+     "execution_count": 11,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -385,7 +385,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": 12,
    "id": "980bf6b1",
    "metadata": {},
    "outputs": [
@@ -431,7 +431,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 5,
    "id": "701aa52a",
    "metadata": {},
    "outputs": [
@@ -441,13 +441,13 @@
        "['PrisonersDilemma', 'PrisonersDilemmaTestgame']"
       ]
      },
-     "execution_count": 3,
+     "execution_count": 5,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "gbt.catalog.games(game_type=\"nfg\")"
+    "gbt.catalog.games(game_type=\"nfg\", num_players=2)"
    ]
   },
   {
@@ -460,7 +460,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 14,
    "id": "6db7a29a",
    "metadata": {},
    "outputs": [
@@ -474,7 +474,7 @@
        "Game(title='Two person Prisoner's Dilemma game')"
       ]
      },
-     "execution_count": 3,
+     "execution_count": 14,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -500,7 +500,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 15,
    "id": "f58eaa77",
    "metadata": {},
    "outputs": [],
@@ -518,21 +518,10 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 16,
    "id": "4119a2ac",
    "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "pygambit.gambit.Game"
-      ]
-     },
-     "execution_count": 13,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
+   "outputs": [],
    "source": [
     "# gbt.read_nfg(\"prisoners_dilemma.nfg\")"
    ]

src/pygambit/catalog/catalog.py

@@ -93,7 +93,10 @@ def __init_subclass__(cls, **kwargs):
         cls._extract_metadata_from_game(cls._cached_game)
 
 
-def games(game_type: Literal["all", "nfg", "efg"] = "all") -> list[str]:
+def games(
+    game_type: Literal["all", "nfg", "efg"] = "all",
+    num_players: int | None = None,
+) -> list[str]:
     """
     Return a list of catalog game names.
 
@@ -104,6 +107,8 @@ def games(game_type: Literal["all", "nfg", "efg"] = "all") -> list[str]:
         - "all": return all games
         - "nfg": return only normal-form (strategic) games
         - "efg": return only extensive-form games
+    num_players : int | None, default None
+        If specified, only return games with the given number of players.
 
     Returns
     -------
@@ -116,6 +121,8 @@ def get_all_subclasses(cls):
         for subclass in cls.__subclasses__():
             if subclass.__name__ not in ["CatalogGameFromFile"] and (
                 game_type == "all" or subclass.game_type == game_type
+            ) and (
+                num_players is None or subclass.num_players == num_players
             ):
                 all_subclasses.append(subclass.__name__)
             all_subclasses.extend(get_all_subclasses(subclass))