mirror of
https://github.com/Farama-Foundation/Gymnasium.git
synced 2025-08-30 01:50:19 +00:00
2ede09074f
* Allows a new RNG to be generated with seed=-1 and updated env_checker to fix bug if environment doesn't use np_random in reset
* Revert "fixed `gym.vector.make` where the checker was being applied in the opposite case than was intended to (#2871)"
This reverts commit 519dfd9117.
* Remove bad pushed commits
* Fixed spelling in core.py
* Pins pytest to the last py 3.6 version
* Allow Box automatic scalar shape
* Add test box and change default from () to (1,)
* update Box shape inference with more strict checking
* Update the box shape and add check on the custom Box shape
* Removed incorrect shape type and assert shape code
* Update the Box and associated tests
* Remove all folders and files from pyright exclude
* Revert issues
* Push RedTachyon code review
* Add Python Platform
* Remove play from pyright check
* Fixed CI issues
* remove mujoco env type hinting
* Fixed pixel observation test
* Added some new type hints
* Fixed CI errors
* Fixed CI errors
* Remove play.py from exlucde pyright
* Fixed pyright issues
57 lines
2.1 KiB
Python
57 lines
2.1 KiB
Python
"""Wrapper to enforce the proper ordering of environment operations."""
|
|
import gym
|
|
from gym.error import ResetNeeded
|
|
|
|
|
|
class OrderEnforcing(gym.Wrapper):
|
|
"""A wrapper that will produce an error if :meth:`step` is called before an initial :meth:`reset`.
|
|
|
|
Example:
|
|
>>> from gym.envs.classic_control import CartPoleEnv
|
|
>>> env = CartPoleEnv()
|
|
>>> env = OrderEnforcing(env)
|
|
>>> env.step(0)
|
|
ResetNeeded: Cannot call env.step() before calling env.reset()
|
|
>>> env.render()
|
|
ResetNeeded: Cannot call env.render() before calling env.reset()
|
|
>>> env.reset()
|
|
>>> env.render()
|
|
>>> env.step(0)
|
|
"""
|
|
|
|
def __init__(self, env: gym.Env, disable_render_order_enforcing: bool = False):
|
|
"""A wrapper that will produce an error if :meth:`step` is called before an initial :meth:`reset`.
|
|
|
|
Args:
|
|
env: The environment to wrap
|
|
disable_render_order_enforcing: If to disable render order enforcing
|
|
"""
|
|
super().__init__(env)
|
|
self._has_reset: bool = False
|
|
self._disable_render_order_enforcing: bool = disable_render_order_enforcing
|
|
|
|
def step(self, action):
|
|
"""Steps through the environment with `kwargs`."""
|
|
if not self._has_reset:
|
|
raise ResetNeeded("Cannot call env.step() before calling env.reset()")
|
|
return self.env.step(action)
|
|
|
|
def reset(self, **kwargs):
|
|
"""Resets the environment with `kwargs`."""
|
|
self._has_reset = True
|
|
return self.env.reset(**kwargs)
|
|
|
|
def render(self, *args, **kwargs):
|
|
"""Renders the environment with `kwargs`."""
|
|
if not self._disable_render_order_enforcing and not self._has_reset:
|
|
raise ResetNeeded(
|
|
"Cannot call `env.render()` before calling `env.reset()`, if this is a intended action, "
|
|
"set `disable_render_order_enforcing=True` on the OrderEnforcer wrapper."
|
|
)
|
|
return self.env.render(*args, **kwargs)
|
|
|
|
@property
|
|
def has_reset(self):
|
|
"""Returns if the environment has been reset before."""
|
|
return self._has_reset
|