agent0.test_fixtures.hyperdrive_fixture
=======================================

.. py:module:: agent0.test_fixtures.hyperdrive_fixture

.. autoapi-nested-parse::

   Local chain connected to a local database hosted in docker.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   agent0.test_fixtures.hyperdrive_fixture.launch_hyperdrive
   agent0.test_fixtures.hyperdrive_fixture.hyperdrive_fixture
   agent0.test_fixtures.hyperdrive_fixture.init_hyperdrive
   agent0.test_fixtures.hyperdrive_fixture.fast_hyperdrive_fixture


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

.. py:function:: launch_hyperdrive(in_chain: agent0.core.hyperdrive.interactive.LocalChain) -> agent0.core.hyperdrive.interactive.LocalHyperdrive

   
   Launches a hyperdrive pool on a given chain.

   :param in_chain: The chain object.
   :type in_chain: LocalChain

   :returns: The deployed hyperdrive object.
   :rtype: LocalHyperdrive















   ..
       !! processed by numpydoc !!

.. py:function:: hyperdrive_fixture(chain_fixture: agent0.core.hyperdrive.interactive.LocalChain) -> agent0.core.hyperdrive.interactive.LocalHyperdrive

   
   Local hyperdrive pool test fixture.
   This fixture launches a chain from scratch in a function scope.

   :param chain_fixture: Function scoped chain fixture.
   :type chain_fixture: LocalChain

   :returns: The deployed hyperdrive object.
   :rtype: LocalHyperdrive















   ..
       !! processed by numpydoc !!

.. py:function:: init_hyperdrive() -> Iterator[agent0.core.hyperdrive.interactive.LocalHyperdrive]

   
   Local hyperdrive pool test fixture.
   This fixture launches a hyperdrive pool from scratch in a session scope.

   :Yields: *LocalHyperdrive* -- The deployed hyperdrive object.















   ..
       !! processed by numpydoc !!

.. py:function:: fast_hyperdrive_fixture(init_hyperdrive: agent0.core.hyperdrive.interactive.LocalHyperdrive) -> Iterator[agent0.core.hyperdrive.interactive.LocalHyperdrive]

   
   Local hyperdrive pool test fixture.
   This fixture uses snapshot on an existing chain in a function scope.

   .. note::
       This pool is booted from an existing snapshot for speed.
       If you save a new snapshot the first will be overwritten.

   :param init_hyperdrive: Session scoped hyperdrive fixture.
   :type init_hyperdrive: LocalHyperdrive

   :Yields: *LocalHyperdrive* -- The deployed hyperdrive object.















   ..
       !! processed by numpydoc !!