popgym.core.wrapper
===================

.. py:module:: popgym.core.wrapper


Classes
-------

.. autoapisummary::

   popgym.core.wrapper.POPGymWrapper


Module Contents
---------------

.. py:class:: POPGymWrapper(env: popgym.core.env.POPGymEnv)

   Bases: :py:obj:`gymnasium.Wrapper`, :py:obj:`popgym.core.env.POPGymEnv`


   Wraps a :class:`gymnasium.Env` to allow a modular transformation of the :meth:`step` and :meth:`reset` methods.

   This class is the base class of all wrappers to change the behavior of the underlying environment.
   Wrappers that inherit from this class can modify the :attr:`action_space`, :attr:`observation_space`
   and :attr:`metadata` attributes, without changing the underlying environment's attributes.
   Moreover, the behavior of the :meth:`step` and :meth:`reset` methods can be changed by these wrappers.

   Some attributes (:attr:`spec`, :attr:`render_mode`, :attr:`np_random`) will point back to the wrapper's environment
   (i.e. to the corresponding attributes of :attr:`env`).

   Note:
       If you inherit from :class:`Wrapper`, don't forget to call ``super().__init__(env)``


   .. py:property:: state_space
      :type: gymnasium.spaces.Space


      Returns the observation space of the environment.



   .. py:method:: get_state() -> gymnasium.core.ObsType

      Returns the underlying hidden Markov state