src.plangym.api_tests
=====================

.. py:module:: src.plangym.api_tests


Classes
-------

.. autoapisummary::

   src.plangym.api_tests.TestPlanEnv
   src.plangym.api_tests.TestPlangymEnv
   src.plangym.api_tests.TestVideogameEnv


Functions
---------

.. autoapisummary::

   src.plangym.api_tests.generate_test_cases
   src.plangym.api_tests.batch_size
   src.plangym.api_tests.display
   src.plangym.api_tests.step_tuple_test
   src.plangym.api_tests.step_batch_tuple_test


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

.. py:function:: generate_test_cases(names, env_class, n_workers_values=None, render_modes=None, obs_types=None, custom_tests=None)

.. py:function:: batch_size()

.. py:function:: display()

.. py:function:: step_tuple_test(env, obs, reward, terminal, info, dt=None)

.. py:function:: step_batch_tuple_test(env, batch_size, observs, rewards, terminals, infos, dt)

.. py:class:: TestPlanEnv

   .. py:attribute:: CLASS_ATTRIBUTES
      :value: ('OBS_IS_ARRAY', 'STATE_IS_ARRAY', 'SINGLETON')



   .. py:attribute:: PROPERTIES
      :value: ('unwrapped', 'obs_shape', 'action_shape', 'name', 'frameskip', 'autoreset', 'delay_setup',...



   .. py:method:: test_init(env)


   .. py:method:: test_repr(env)


   .. py:method:: test_class_attributes(env)


   .. py:method:: test_has_properties(env)


   .. py:method:: test_name(env)


   .. py:method:: test_obs_shape(env)


   .. py:method:: test_img_shape(env)


   .. py:method:: test_action_shape(env)


   .. py:method:: test_unwrapped(env)


   .. py:method:: test_return_image(env, return_image)


   .. py:method:: test_sample_action(env)


   .. py:method:: test_get_state(env)


   .. py:method:: test_set_state(env)


   .. py:method:: test_reset(env)


   .. py:method:: test_step(env, state, return_state, dt=1)


   .. py:method:: test_step_batch(env, states, return_state, batch_size)


   .. py:method:: test_step_dt_values(env, dt=3, return_state=None)


   .. py:method:: test_step_batch_dt_values(env, dt, batch_size, states=None, return_state=None)


   .. py:method:: test_clone_and_close(env, delay_setup)


   .. py:method:: test_get_image(env)


.. py:class:: TestPlangymEnv

   .. py:attribute:: CLASS_ATTRIBUTES
      :value: ('AVAILABLE_OBS_TYPES', 'DEFAULT_OBS_TYPE')



   .. py:attribute:: PROPERTIES
      :value: ('gym_env', 'obs_shape', 'obs_type', 'observation_space', 'action_shape', 'action_space',...



   .. py:method:: test_class_attributes(env)


   .. py:method:: test_has_properties(env)


   .. py:method:: test_obs_type(env)


   .. py:method:: test_obvervation_space(env)


   .. py:method:: test_action_space(env)


   .. py:method:: test_gym_env(env)


   .. py:method:: test_reward_range(env)


   .. py:method:: test_delay_setup(env, delay_setup)


   .. py:method:: test_has_metadata(env)


   .. py:method:: test_render_mode(env)


   .. py:method:: test_remove_time_limit(env)


   .. py:method:: test_seed(env)


   .. py:method:: test_terminal(env)


   .. py:method:: test_render(env, display)


   .. py:method:: test_wrap_environment(env)


.. py:class:: TestVideogameEnv

   Test the VideogameEnv class.


   .. py:method:: test_ram(env)

      Test the ram property.