trying to fix the issue after gymnasium upgrade [skip ci]

Author: BDonnot

grid2op/Chronics/multiFolder.py

@@ -357,7 +357,7 @@ def sample_next_chronics(self, probabilities=None):
         id_sel = (self._order == selected).nonzero()[0]
         self._prev_cache_id = selected - 1
         return id_sel
-
+    
     def reset(self):
         """
         Rebuilt the :attr:`Multifolder._order`. This should be called after a call to :func:`Multifolder.set_filter`

grid2op/gym_compat/gymenv.py

@@ -181,16 +181,17 @@ def _aux_reset(self,
     def _aux_reset_new(self,
                        seed: Optional[int]=None,
                        options: RESET_OPTIONS_TYPING=None) -> Tuple[ObsType,RESET_INFO_GYM_TYPING]:
-        # used for gym > 0.26
-        if (self._shuffle_chronics and 
-            isinstance(self.init_env.chronics_handler.real_data, Multifolder) and 
-            (options is not None and _TIME_SERIE_ID not in options)):
-            self.init_env.chronics_handler.sample_next_chronics()
 
         super().reset(seed=seed)  # seed gymnasium env
         if seed is not None:
             self._aux_seed_spaces()
             seed, next_seed, underlying_env_seeds = self._aux_seed_g2op(seed)
+            
+        # used for gym > 0.26
+        if (self._shuffle_chronics and 
+            isinstance(self.init_env.chronics_handler.real_data, Multifolder) and 
+            (not (options is not None and _TIME_SERIE_ID in options))):
+            self.init_env.chronics_handler.sample_next_chronics()
 
         # we don't seed grid2op with reset as it is done
         # earlier

grid2op/tests/test_issue_379.py

@@ -6,7 +6,6 @@
 # SPDX-License-Identifier: MPL-2.0
 # This file is part of Grid2Op, Grid2Op a testbed platform to model sequential decision making in power systems.
 
-import grid2op
 import unittest
 import warnings
 
@@ -17,7 +16,118 @@
 CAN_TEST_ALL = True
 if GYMNASIUM_AVAILABLE:
     from gymnasium.utils.env_checker import check_env
-    from gymnasium.utils.env_checker import check_reset_return_type, check_reset_options, check_reset_seed
+    from gymnasium.utils.env_checker import check_reset_return_type, check_reset_options
+    try:
+        from gymnasium.utils.env_checker import check_reset_seed
+    except ImportError:
+        # not present in most recent version of gymnasium, I copy pasted
+        # it from an oldest version
+        import gymnasium
+        from logging import getLogger
+        import inspect
+        from copy import deepcopy
+        import numpy as np
+        logger = getLogger()
+        
+        
+        def data_equivalence(data_1, data_2) -> bool:
+            """Assert equality between data 1 and 2, i.e observations, actions, info.
+
+            Args:
+                data_1: data structure 1
+                data_2: data structure 2
+
+            Returns:
+                If observation 1 and 2 are equivalent
+            """
+            if type(data_1) == type(data_2):
+                if isinstance(data_1, dict):
+                    return data_1.keys() == data_2.keys() and all(
+                        data_equivalence(data_1[k], data_2[k]) for k in data_1.keys()
+                    )
+                elif isinstance(data_1, (tuple, list)):
+                    return len(data_1) == len(data_2) and all(
+                        data_equivalence(o_1, o_2) for o_1, o_2 in zip(data_1, data_2)
+                    )
+                elif isinstance(data_1, np.ndarray):
+                    return data_1.shape == data_2.shape and np.allclose(
+                        data_1, data_2, atol=0.00001
+                    )
+                else:
+                    return data_1 == data_2
+            else:
+                return False
+    
+    
+        def check_reset_seed(env: gymnasium.Env):
+            """Check that the environment can be reset with a seed.
+
+            Args:
+                env: The environment to check
+
+            Raises:
+                AssertionError: The environment cannot be reset with a random seed,
+                    even though `seed` or `kwargs` appear in the signature.
+            """
+            signature = inspect.signature(env.reset)
+            if "seed" in signature.parameters or (
+                "kwargs" in signature.parameters
+                and signature.parameters["kwargs"].kind is inspect.Parameter.VAR_KEYWORD
+            ):
+                try:
+                    obs_1, info = env.reset(seed=123)
+                    assert (
+                        obs_1 in env.observation_space
+                    ), "The observation returned by `env.reset(seed=123)` is not within the observation space."
+                    assert (
+                        env.unwrapped._np_random  # pyright: ignore [reportPrivateUsage]
+                        is not None
+                    ), "Expects the random number generator to have been generated given a seed was passed to reset. Mostly likely the environment reset function does not call `super().reset(seed=seed)`."
+                    seed_123_rng = deepcopy(
+                        env.unwrapped._np_random  # pyright: ignore [reportPrivateUsage]
+                    )
+
+                    obs_2, info = env.reset(seed=123)
+                    assert (
+                        obs_2 in env.observation_space
+                    ), "The observation returned by `env.reset(seed=123)` is not within the observation space."
+                    if env.spec is not None and env.spec.nondeterministic is False:
+                        assert data_equivalence(
+                            obs_1, obs_2
+                        ), "Using `env.reset(seed=123)` is non-deterministic as the observations are not equivalent."
+                    assert (
+                        env.unwrapped._np_random.bit_generator.state  # pyright: ignore [reportPrivateUsage]
+                        == seed_123_rng.bit_generator.state
+                    ), "Mostly likely the environment reset function does not call `super().reset(seed=seed)` as the random generates are not same when the same seeds are passed to `env.reset`."
+
+                    obs_3, info = env.reset(seed=456)
+                    assert (
+                        obs_3 in env.observation_space
+                    ), "The observation returned by `env.reset(seed=456)` is not within the observation space."
+                    assert (
+                        env.unwrapped._np_random.bit_generator.state  # pyright: ignore [reportPrivateUsage]
+                        != seed_123_rng.bit_generator.state
+                    ), "Mostly likely the environment reset function does not call `super().reset(seed=seed)` as the random number generators are not different when different seeds are passed to `env.reset`."
+
+                except TypeError as e:
+                    raise AssertionError(
+                        "The environment cannot be reset with a random seed, even though `seed` or `kwargs` appear in the signature. "
+                        f"This should never happen, please report this issue. The error was: {e}"
+                    ) from e
+
+                seed_param = signature.parameters.get("seed")
+                # Check the default value is None
+                if seed_param is not None and seed_param.default is not None:
+                    logger.warning(
+                        "The default seed argument in reset should be `None`, otherwise the environment will by default always be deterministic. "
+                        f"Actual default: {seed_param.default}"
+                    )
+            else:
+                raise gymnasium.error.Error(
+                    "The `reset` method does not provide a `seed` or `**kwargs` keyword argument."
+                )
+                
+                
 elif GYM_AVAILABLE:
     from gym.utils.env_checker import check_env
     from gym.utils.env_checker import check_reset_return_type, check_reset_options, check_reset_seed