:py:mod:`mock.env`
==================

.. py:module:: mock.env

.. autoapi-nested-parse::

   Submodule to mock Env.



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

Classes
~~~~~~~

.. autoapisummary::

   mock.env.MockEnvConfig



Functions
~~~~~~~~~

.. autoapisummary::

   mock.env.mock_env



.. py:class:: MockEnvConfig


   Bases: :py:obj:`TypedDict`

   Config for MockEnv.

   .. py:attribute:: name
      :type: str

      Mocked platform name


   .. py:attribute:: version
      :type: typing_extensions.NotRequired[str]

      Mocked system version


   .. py:attribute:: machine
      :type: typing_extensions.NotRequired[str]

      Mocked name of the target machine


   .. py:attribute:: mode
      :type: typing_extensions.NotRequired[str]

      Mocked name of the mode



.. py:function:: mock_env(config: MockEnvConfig | None = None) -> collections.abc.Iterator[e3.env.Env]

   Mock e3.env.Env as a context or decorator.

   :param config: config for the mock
   :return: yield an Env iterator