# Copyright (C) 2022. Huawei Technologies Co., Ltd. All rights reserved.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
from typing import Any, Dict, Iterator, Tuple
import gymnasium as gym
from smarts.core.utils.episodes import EpisodeLog, EpisodeLogs
Action = Any
[docs]class EpisodeLogger(gym.Wrapper):
"""Wraps a gym environment with simple episode logging capabilities."""
def __init__(self, env: gym.Env, col_width: int = 18):
super(EpisodeLogger, self).__init__(env)
self._current_episode = None
self._closed = False
self._log_iter = self._episode_logs(col_width)
[docs] def step(self, action: Action):
"""Mark a step for logging."""
step_vals = super().step(action)
self._current_episode.record_step(*step_vals)
return step_vals
[docs] def reset(self) -> Tuple[Any, Dict[str, Any]]:
"""Mark an episode reset for logging."""
out = super().reset()
self._current_episode: EpisodeLog = next(self._log_iter)
self._current_episode.record_scenario(self.scenario_log)
return out
[docs] def close(self):
"""Cap off the episode logging."""
self._closed = True
try:
next(self._log_iter)
except:
pass
return super().close()
def _episode_logs(self, col_width) -> Iterator[EpisodeLog]:
with EpisodeLogs(col_width) as episode_logs:
while not self._closed:
yield episode_logs.reset()
episode_logs.reset()