.. title:: AggregatedResultBundle

lisa.tests.base.AggregatedResultBundle
======================================


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

   
   .. rubric:: Properties
   
   .. list-table::
      :align: left
   
      * - :attr:`~lisa.tests.base.AggregatedResultBundle.context`
        -
         
         .. withrefctx::
            :module: lisa.tests.base
            :class: lisa.tests.base.AggregatedResultBundle
         
         
            Merge the context of all the aggregated bundles, with priority given to last in the list.
      * - :attr:`~lisa.tests.base.AggregatedResultBundle.metrics`
        -
         
         .. withrefctx::
            :module: lisa.tests.base
            :class: lisa.tests.base.AggregatedResultBundle
      * - :attr:`~lisa.tests.base.AggregatedResultBundle.result`
        -
         
         .. withrefctx::
            :module: lisa.tests.base
            :class: lisa.tests.base.AggregatedResultBundle
      * - :attr:`~lisa.tests.base.AggregatedResultBundle.utc_datetime`
        -
         
         .. withrefctx::
            :module: lisa.tests.base
            :class: lisa.tests.base.AggregatedResultBundle
         
         
            Use the earliest ``utc_datetime`` among the aggregated bundles.
   
   
   .. rubric:: Methods
   
   .. list-table::
      :align: left
   
      * - :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
   


Properties
----------


.. autoproperty:: lisa.tests.base::AggregatedResultBundle.context



.. autoproperty:: lisa.tests.base::AggregatedResultBundle.metrics



.. autoproperty:: lisa.tests.base::AggregatedResultBundle.result



.. autoproperty:: lisa.tests.base::AggregatedResultBundle.utc_datetime



Methods
-------


.. automethod:: lisa.tests.base::AggregatedResultBundle.__bool__



.. automethod:: lisa.tests.base::AggregatedResultBundle.add_metric



.. automethod:: lisa.tests.base::AggregatedResultBundle.display_and_exit



.. automethod:: lisa.tests.base::AggregatedResultBundle.pretty_format