Source code for openrl.envs.gymnasium

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Copyright 2023 The OpenRL Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

""""""
import copy
from typing import Callable, List, Optional, Union

import gymnasium as gym
from gymnasium import Env

from openrl.envs.common import build_envs


def make_gym_envs(
    id: str,
    env_num: int = 1,
    render_mode: Optional[Union[str, List[str]]] = None,
    **kwargs,
) -> List[Callable[[], Env]]:
    from openrl.envs.wrappers import (  # AutoReset,; DictWrapper,
        RemoveTruncated,
        Single2MultiAgentWrapper,
    )

    env_wrappers = copy.copy(kwargs.pop("env_wrappers", []))
    env_wrappers += [
        # DictWrapper,
        Single2MultiAgentWrapper,
        # AutoReset,
        RemoveTruncated,
    ]

    env_fns = build_envs(
        make=gym.envs.registration.make,
        id=id,
        env_num=env_num,
        render_mode=render_mode,
        wrappers=env_wrappers,
        **kwargs,
    )
    return env_fns


def make_old_gym_envs(
    id: str,
    env_num: int = 1,
    render_mode: Optional[Union[str, List[str]]] = None,
    **kwargs,
):
    ids_split = id.split(":")
    assert len(ids_split) == 2, (
        "id must be in the format of 'GymV21Environment-v0:env_id' or"
        " 'GymV26Environment-v0:env_id'"
    )
    env_id = ids_split[1]
    id = ids_split[0]
    kwargs["env_id"] = env_id
    env_fns = make_gym_envs(id=id, env_num=env_num, render_mode=render_mode, **kwargs)
    return env_fns