kaggle-environments 1.17.2__py2.py3-none-any.whl → 1.17.5__py2.py3-none-any.whl

kaggle_environments/envs/open_spiel/proxy.py

@@ -0,0 +1,139 @@
+"""OpenSpiel Game and State proxies.
+
+Proxies that act as a pyspiel.State/Game by wrapping the original object and
+forwarding calls. Subclassing allows to override specific methods or add
+additional functionality, or payload to the State/Game object.
+
+WARNING: Serialization of proxy games and states is not supported.
+"""
+
+from typing import Any
+
+from . import observation
+import pyspiel
+
+
+class State(pyspiel.State):
+  """Base class for a pyspiel.State proxy."""
+
+  def __init__(self, wrapped: pyspiel.State, game: 'Game'):
+    super().__init__(game)
+    self.__wrapped__ = wrapped
+
+  def current_player(self) -> int:
+    return self.__wrapped__.current_player()
+
+  def _legal_actions(self, player: int) -> list[int]:
+    return self.__wrapped__.legal_actions(player)
+
+  def _apply_action(self, action: int) -> None:
+    return self.__wrapped__.apply_action(action)
+
+  def _action_to_string(self, player: int, action: int) -> str:
+    return self.__wrapped__.action_to_string(player, action)
+
+  def chance_outcomes(self) -> list[tuple[int, float]]:
+    return self.__wrapped__.chance_outcomes()
+
+  def is_terminal(self) -> bool:
+    return self.__wrapped__.is_terminal()
+
+  def returns(self) -> list[float]:
+    return self.__wrapped__.returns()
+
+  def rewards(self) -> list[float]:
+    return self.__wrapped__.rewards()
+
+  def __str__(self) -> str:
+    return self.__wrapped__.__str__()
+
+  def to_string(self) -> str:
+    return self.__wrapped__.to_string()
+
+  def __getattr__(self, name: str) -> Any:
+    # Escape hatch when proxying Python implementations that have attributes
+    # that need to be accessed, e.g. TicTacToeState.board from its observer.
+    return object.__getattribute__(self.__wrapped__, name)
+
+
+class Game(pyspiel.Game):
+  """Base class for a pyspiel.Game proxy."""
+
+  def __init__(self, wrapped: pyspiel.Game, **kwargs):
+    # TODO(hennes): Add serialization.
+    game_info = pyspiel.GameInfo(
+        num_distinct_actions=wrapped.num_distinct_actions(),
+        max_chance_outcomes=wrapped.max_chance_outcomes(),
+        num_players=wrapped.num_players(),
+        min_utility=wrapped.min_utility(),
+        max_utility=wrapped.max_utility(),
+        utility_sum=wrapped.utility_sum(),
+        max_game_length=wrapped.max_game_length(),
+    )
+    super().__init__(
+        _game_type(wrapped.get_type(), **kwargs),
+        game_info,
+        wrapped.get_parameters(),
+    )
+    self.__wrapped__ = wrapped
+
+  def new_initial_state(self, from_string: str | None = None) -> State:
+    args = () if from_string is None else (from_string)
+    return State(wrapped=self.__wrapped__.new_initial_state(*args), game=self)
+
+  def max_chance_nodes_in_history(self) -> int:
+    return self.__wrapped__.max_chance_nodes_in_history()
+
+  def make_py_observer(
+      self,
+      iig_obs_type: pyspiel.IIGObservationType | None = None,
+      params: dict[str, Any] | None = None,
+  ) -> pyspiel.Observer:
+    return _Observation(
+        observation.make_observation(self.__wrapped__, iig_obs_type, params)
+    )
+
+
+class _Observation(observation._Observation):  # pylint: disable=protected-access
+  """_Observation proxy that passes the wrapped state to the observation."""
+
+  def __init__(self, wrapped: observation._Observation):
+    self.__wrapped__ = wrapped
+    self.dict = self.__wrapped__.dict
+    self.tensor = self.__wrapped__.tensor
+
+  def set_from(self, state: State, player: int):
+    self.__wrapped__.set_from(state.__wrapped__, player)
+
+  def string_from(self, state: State, player: int) -> str | None:
+    return self.__wrapped__.string_from(state.__wrapped__, player)
+
+  def compress(self) -> Any:
+    return self.__wrapped__.compress()
+
+  def decompress(self, compressed_observation: Any):
+    self.__wrapped__.decompress(compressed_observation)
+
+
+def _game_type(game_type: pyspiel.GameType, **overrides) -> pyspiel.GameType:
+  """Returns a GameType with the given overrides."""
+  kwargs = dict(
+      short_name=game_type.short_name,
+      long_name=game_type.long_name,
+      dynamics=game_type.dynamics,
+      chance_mode=game_type.chance_mode,
+      information=game_type.information,
+      utility=game_type.utility,
+      reward_model=game_type.reward_model,
+      max_num_players=game_type.max_num_players,
+      min_num_players=game_type.min_num_players,
+      provides_information_state_string=game_type.provides_information_state_string,
+      provides_information_state_tensor=game_type.provides_information_state_tensor,
+      provides_observation_string=game_type.provides_observation_string,
+      provides_observation_tensor=game_type.provides_observation_tensor,
+      parameter_specification=game_type.parameter_specification,
+      default_loadable=game_type.default_loadable,
+      provides_factored_observation_string=game_type.provides_factored_observation_string,
+  )
+  kwargs.update(**overrides)
+  return pyspiel.GameType(**kwargs)

kaggle_environments/envs/open_spiel/proxy_test.py

@@ -0,0 +1,64 @@
+"""Proxy tests."""
+
+from . import proxy
+from absl.testing import absltest
+from absl.testing import parameterized
+import pyspiel
+
+
+def make_game() -> proxy.Game:
+  return proxy.Game(pyspiel.load_game('tic_tac_toe()'))
+
+
+class TestState(proxy.State):
+
+  def __str__(self) -> str:
+    return 'TestState: ' + super().__str__()
+
+
+class TestGame(proxy.Game):
+
+  def new_initial_state(self, *args, **kwargs) -> TestState:
+    return TestState(
+        self.__wrapped__.new_initial_state(*args, **kwargs), game=self
+    )
+
+
+class ProxiesTest(parameterized.TestCase):
+
+  def test_types(self):
+    game = make_game()
+    self.assertIsInstance(game, pyspiel.Game)
+    state = game.new_initial_state()
+    self.assertIsInstance(state, pyspiel.State)
+
+  def test_get_game(self):
+    game = make_game()
+    state = game.new_initial_state()
+    self.assertIsInstance(state.get_game(), proxy.Game)
+    new_state = state.get_game().new_initial_state()
+    self.assertIsInstance(new_state, proxy.State)
+    self.assertIsNot(new_state, state)
+
+  def test_clone(self):
+    game = make_game()
+    state = game.new_initial_state()
+    state.apply_action(state.legal_actions()[0])
+    clone = state.clone()
+    self.assertIsInstance(clone, proxy.State)
+    self.assertEqual(state.history(), clone.history())
+    clone.apply_action(clone.legal_actions()[0])
+    self.assertEqual(state.history(), clone.history()[:-1])
+
+  def test_subclassing(self):
+    game = TestGame(pyspiel.load_game('tic_tac_toe()'))
+    state = game.new_initial_state()
+    self.assertIsInstance(state, TestState)
+    self.assertIsInstance(state.clone(), TestState)
+    self.assertIsInstance(state.get_game(), TestGame)
+    wrapped_state = state.__wrapped__  # type: ignore
+    self.assertEqual(str(state), 'TestState: ' + str(wrapped_state))
+
+
+if __name__ == '__main__':
+  absltest.main()

kaggle_environments/envs/open_spiel/test_open_spiel.py

@@ -1,18 +1,33 @@
+from absl.testing import absltest
 import sys
 from kaggle_environments import make
-import open_spiel as open_spiel_env
+import pyspiel
+from . import open_spiel as open_spiel_env
 
 
-def test_envs_load():
-    envs = open_spiel_env._register_open_spiel_envs()
-    print(len(envs))
+# Expected that not all pyspiel registered games can be registered as Kaggle
+# envs (e.g. does not yet support simultaneous move games), but should register
+# at least this many
+_REGISTERED_GAMES_THRESHOLD = 50
 
 
-def test_tic_tac_toe_playthrough():
-    envs = open_spiel_env._register_open_spiel_envs(["tic_tac_toe"])
+class OpenSpielEnvTest(absltest.TestCase):
+
+  def test_envs_load(self):
+    envs = open_spiel_env._register_game_envs(
+        [game_type.short_name for game_type in pyspiel.registered_games()]
+    )
+    self.assertTrue(len(envs) > _REGISTERED_GAMES_THRESHOLD)
+
+  def test_tic_tac_toe_playthrough(self):
+    envs = open_spiel_env._register_game_envs(["tic_tac_toe"])
     print(envs)
     env = make("open_spiel_tic_tac_toe", debug=True)
     env.run(["random", "random"])
     json = env.toJSON()
-    assert json["name"] == "open_spiel_tic_tac_toe"
-    assert all([status == "DONE" for status in json["statuses"]])
+    self.assertEqual(json["name"], "open_spiel_tic_tac_toe")
+    self.assertTrue(all([status == "DONE" for status in json["statuses"]]))
+
+
+if __name__ == '__main__':
+  absltest.main()

{kaggle_environments-1.17.2.dist-info → kaggle_environments-1.17.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kaggle-environments
-Version: 1.17.2
+Version: 1.17.5
 Summary: Kaggle Environments
 Home-page: https://github.com/Kaggle/kaggle-environments
 Author: Kaggle
@@ -21,7 +21,7 @@ Requires-Dist: transformers>=4.33.1
 Requires-Dist: scipy>=1.11.2
 Requires-Dist: shimmy>=1.2.1
 Requires-Dist: Chessnut>=0.4.1
-Requires-Dist: open_spiel>=1.5.0
+Requires-Dist: open_spiel>=1.6.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: description

{kaggle_environments-1.17.2.dist-info → kaggle_environments-1.17.5.dist-info}/RECORD

@@ -1,4 +1,4 @@
-kaggle_environments/__init__.py,sha256=gfZpgAMb07ABEi0ZWy18VtUqHEaY-tBcrDkSitkbcwM,2189
+kaggle_environments/__init__.py,sha256=NFCwapaNv9MXVBKTTm7AgYLswbUKb7RPELyxidmJqxs,2175
 kaggle_environments/agent.py,sha256=j9rLnCK_Gy0eRIuvlJ9vcMh3vxn-Wvu-pjCpannOolc,6703
 kaggle_environments/api.py,sha256=eLBKqr11Ku4tdsMUdUqy74FIVEA_hdV3_QUpX84x3Z8,798
 kaggle_environments/core.py,sha256=IrEkN9cIA2djBAxI8Sz1GRpGNKjhqbnBdV6irAeTm8Q,27851
@@ -188,8 +188,29 @@ kaggle_environments/envs/mab/agents.py,sha256=vPHNN5oRcbTG3FaW9iYmoeQjufXFJMjYOL
 kaggle_environments/envs/mab/mab.js,sha256=zsKGVRL9qFyUoukRj-ES5dOh8Wig7UzNf0z5Potw84E,3256
 kaggle_environments/envs/mab/mab.json,sha256=VAlpjJ7_ytYO648swQW_ICjC5JKTAdmnShuGggeSX4A,2077
 kaggle_environments/envs/mab/mab.py,sha256=bkSIxkstS98Vr3eOA9kxQkseDqa1MlG2Egfzeaf-8EA,5241
-kaggle_environments/envs/open_spiel/open_spiel.py,sha256=eGoV9EpOz2v_41NSZ6mJMGcwF29Y-0fZA3IuoOd8Psk,11812
-kaggle_environments/envs/open_spiel/test_open_spiel.py,sha256=ZDzXa8te8MCdgJ7d-8IdC8al72r3YPxYIJ7Gjhk-NkM,534
+kaggle_environments/envs/open_spiel/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kaggle_environments/envs/open_spiel/html_playthrough_generator.py,sha256=qzvi9wMZKz1WfpaIpBxP5LPlVYKAk9npEtdKLXYHMWo,950
+kaggle_environments/envs/open_spiel/observation.py,sha256=yrJ_iZ9sBUTB6YOyEpKNwYiQEWmsPPtaDYtL4zsw1Ko,4834
+kaggle_environments/envs/open_spiel/open_spiel.py,sha256=kJDOApsaSPJ53MVcG9vKXuMW-MJNx093gn32vj2TFKw,15304
+kaggle_environments/envs/open_spiel/proxy.py,sha256=8Shane4KWYKvbP9nV3l8VQfAFOfFSUrS78h_4xQthVM,4881
+kaggle_environments/envs/open_spiel/proxy_test.py,sha256=QkmRo_uS0DgDDm2pbU2vwal5KOMCWKw92rC2_g3MziM,1837
+kaggle_environments/envs/open_spiel/test_open_spiel.py,sha256=YhmEyyxc68JmjzmsdoIUEO-ds1O8HiICsiCKkMFth5s,1033
+kaggle_environments/envs/open_spiel/games/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kaggle_environments/envs/open_spiel/games/chess/chess.js,sha256=XoX0R7zYqPGh4EYnxUJCXPBb44fbLAVsDLQ8p9oibhA,12547
+kaggle_environments/envs/open_spiel/games/connect_four/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kaggle_environments/envs/open_spiel/games/connect_four/connect_four.js,sha256=sT8rVfjkyY_DUQSHpZUP7I7QEoJwa7Oq9H82wD7vnbQ,15440
+kaggle_environments/envs/open_spiel/games/connect_four/connect_four_proxy.py,sha256=2otG99felDYhNhWpsadbM9YUaHtrXqhV1GFNEHhuPwA,2348
+kaggle_environments/envs/open_spiel/games/connect_four/connect_four_proxy_test.py,sha256=vYn-QDPyRRigL8XdaHMN4FTO9zc1T9YB096HDGQH_T4,1870
+kaggle_environments/envs/open_spiel/games/go/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kaggle_environments/envs/open_spiel/games/go/go.js,sha256=cmwq64L77iVjYJpMKCKaRDfNXDaO7R7PJT78xu60Qwg,23756
+kaggle_environments/envs/open_spiel/games/go/go_proxy.py,sha256=f5jaS6O7mngq8LHRkxfyf_M57BTb_3yxb7FjELR2aqg,3146
+kaggle_environments/envs/open_spiel/games/tic_tac_toe/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kaggle_environments/envs/open_spiel/games/tic_tac_toe/tic_tac_toe.js,sha256=_W7zGtpnKlqw3ghZspwwXYe3sdOdL3h_yYzo9wHAnzA,17345
+kaggle_environments/envs/open_spiel/games/tic_tac_toe/tic_tac_toe_proxy.py,sha256=3Imu-0-lMNUF9FQQ4V3Y3NnkS-9_-IhbSprlWgecTLA,2771
+kaggle_environments/envs/open_spiel/games/universal_poker/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kaggle_environments/envs/open_spiel/games/universal_poker/universal_poker.js,sha256=eDtjUYtt1a26zQXOk-BhgcIsYfTCD0OLSZikC2Z5YKQ,21822
+kaggle_environments/envs/open_spiel/games/universal_poker/universal_poker_proxy.py,sha256=WKFgbdES3JGyL5Su5wi6jE8yrSJaBCvXL3z_IgmWJLs,5219
+kaggle_environments/envs/open_spiel/games/universal_poker/universal_poker_proxy_test.py,sha256=YHWaVVO8fA9NKrTMM7VpAH_U94yh5d0Z-gNhXX4A7sA,1531
 kaggle_environments/envs/rps/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kaggle_environments/envs/rps/agents.py,sha256=iBtBjPbutWickm-K1EzBEYvLWj5fvU3ks0AYQMYWgEI,2140
 kaggle_environments/envs/rps/helpers.py,sha256=NUqhJafNSzlC_ArwDIYzbLx15pkmBpzfVuG8Iv4wX9U,966
@@ -203,9 +224,9 @@ kaggle_environments/envs/tictactoe/tictactoe.js,sha256=NZDT-oSG0a6a-rso9Ldh9qkJw
 kaggle_environments/envs/tictactoe/tictactoe.json,sha256=zMXZ8-fpT7FBhzz2FFBvRLn4XwtngjEqOieMvI6cCj8,1121
 kaggle_environments/envs/tictactoe/tictactoe.py,sha256=uq3sTHWNMg0dxX2v9pTbJAKM7fwerxQt7OQjCX96m-Y,3657
 kaggle_environments/static/player.html,sha256=XyVoe0XxMa2MO1fTDY_rjyjzPN-JZgbVwJIDoLSnlw0,23016
-kaggle_environments-1.17.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-kaggle_environments-1.17.2.dist-info/METADATA,sha256=FeHjMl4YWtcFWOflJV9P6vToQ6ZGJ0n8CZ6ijFsfr-E,10955
-kaggle_environments-1.17.2.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
-kaggle_environments-1.17.2.dist-info/entry_points.txt,sha256=HbVC-LKGQFV6lEEYBYyDTtrkHgdHJUWQ8_qt9KHGqz4,70
-kaggle_environments-1.17.2.dist-info/top_level.txt,sha256=v3MMWIPMQFcI-WuF_dJngHWe9Bb2yH_6p4wat1x4gAc,20
-kaggle_environments-1.17.2.dist-info/RECORD,,
+kaggle_environments-1.17.5.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+kaggle_environments-1.17.5.dist-info/METADATA,sha256=6E3MWC0cXRLQJrMBbBdxnmSCNBTYIM49xS68wmIYTzE,10955
+kaggle_environments-1.17.5.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
+kaggle_environments-1.17.5.dist-info/entry_points.txt,sha256=HbVC-LKGQFV6lEEYBYyDTtrkHgdHJUWQ8_qt9KHGqz4,70
+kaggle_environments-1.17.5.dist-info/top_level.txt,sha256=v3MMWIPMQFcI-WuF_dJngHWe9Bb2yH_6p4wat1x4gAc,20
+kaggle_environments-1.17.5.dist-info/RECORD,,