Source code for idmtools.entities.suite

Defines our Suite object.

The Suite object can be thought as a metadata object. It represents a container object for Experiments. All Suites should have one or more experiments.

Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.
from typing import NoReturn, Type, TYPE_CHECKING, Dict
from abc import ABC
from dataclasses import dataclass, field, fields
from idmtools.core.interfaces.iitem import IItem
from idmtools.core.interfaces.inamed_entity import INamedEntity
from idmtools.core import ItemType, EntityContainer
from idmtools.core.interfaces.irunnable_entity import IRunnableEntity

if TYPE_CHECKING:  # pragma: no cover
    from idmtools.entities.iplatform import IPlatform
    from idmtools.entities.experiment import Experiment

[docs]@dataclass(repr=False) class Suite(INamedEntity, ABC, IRunnableEntity): """ Class that represents a generic suite (a collection of experiments). Args: experiments: The child items of this suite. """ experiments: EntityContainer = field( default_factory=lambda: EntityContainer(), compare=False, metadata={"pickle_ignore": True} ) item_type: ItemType = field(default=ItemType.SUITE, compare=False, init=False) description: str = field(default=None, compare=False)
[docs] def add_experiment(self, experiment: 'Experiment') -> 'NoReturn': # noqa: F821 """ Add an experiment to the suite. Args: experiment: the experiment to be linked to suite """ ids = [exp.uid for exp in self.experiments] if experiment.uid in ids: return # Link the suite to the experiment. Assumes the experiment suite setter adds the experiment to the suite. experiment.suite = self
[docs] def display(self): """ Display workflowitem. Returns: None """ from idmtools.utils.display import display, suite_table_display display(self, suite_table_display)
[docs] def pre_creation(self, platform: 'IPlatform'): """ Pre Creation of IWorkflowItem. Args: platform: Platform we are creating item on Returns: None """ IItem.pre_creation(self, platform)
[docs] def post_creation(self, platform: 'IPlatform'): """ Post Creation of IWorkflowItem. Args: platform: Platform Returns: None """ IItem.post_creation(self, platform)
def __repr__(self): """ String representation of suite. """ return f"<Suite {self.uid} - {len(self.experiments)} experiments>" @property def done(self): """ Return if an suite has finished executing. Returns: True if all experiments have ran, False otherwise """ return all([s.done for s in self.experiments]) @property def succeeded(self) -> bool: """ Return if an suite has succeeded. An suite is succeeded when all experiments have succeeded. Returns: True if all experiments have succeeded, False otherwise """ return all([s.succeeded for s in self.experiments])
[docs] def to_dict(self) -> Dict: """ Converts suite to a dictionary. Returns: Dictionary of suite. """ result = dict() for f in fields(self): if not"_") and not in ['parent']: result[] = getattr(self, result['_uid'] = self.uid return result
ISuiteClass = Type[Suite]