.. title:: ResultBundle

lisa.tests.base.ResultBundle
============================


.. autoclass:: lisa.tests.base::ResultBundle
   :no-members:
   :no-inherited-members:
   :no-undoc-members:
   :no-private-members:
   :no-special-members:

   
   .. rubric:: Methods
   
   .. list-table::
      :align: left
   
      * - :meth:`~lisa.tests.base.ResultBundle.from_bool`
        -
         
         .. withrefctx::
            :module: lisa.tests.base
            :class: lisa.tests.base.ResultBundle
         
         
            Alternate constructor where ``ResultBundle.result`` is determined from a bool.
      * - :meth:`~lisa.tests.base.ResultBundle.raise_skip`
        -
         
         .. withrefctx::
            :module: lisa.tests.base
            :class: lisa.tests.base.ResultBundle
         
         
            Raise an :class:`ResultBundle` with the :attr:`Result.SKIPPED` result, thereby short-circuiting the rest of the test.
      * - :meth:`~lisa.tests.base.ResultBundleBase.__bool__` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.tests.base
            :class: lisa.tests.base.ResultBundleBase
         
         
            ``True`` if the ``result`` is :attr:`Result.PASSED`, ``False`` otherwise.
      * - :meth:`~lisa.tests.base.ResultBundleBase.add_metric` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.tests.base
            :class: lisa.tests.base.ResultBundleBase
         
         
            Lets you append several test :class:`TestMetric` to the bundle.
      * - :meth:`~lisa.tests.base.ResultBundleBase.display_and_exit` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.tests.base
            :class: lisa.tests.base.ResultBundleBase
      * - :meth:`~lisa.tests.base.ResultBundleBase.pretty_format` :sup:`inherited`
        -
         
         .. withrefctx::
            :module: lisa.tests.base
            :class: lisa.tests.base.ResultBundleBase
   


Methods
-------


.. automethod:: lisa.tests.base::ResultBundle.from_bool



.. automethod:: lisa.tests.base::ResultBundle.raise_skip



.. automethod:: lisa.tests.base::ResultBundle.__bool__



.. automethod:: lisa.tests.base::ResultBundle.add_metric



.. automethod:: lisa.tests.base::ResultBundle.display_and_exit



.. automethod:: lisa.tests.base::ResultBundle.pretty_format