Source code for idmtools.utils.collections
"""
utilities for collections.
Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.
"""
import typing
from itertools import tee
from typing import Tuple, List, Mapping, Union, Iterable, Generator
from more_itertools import take
[docs]def cut_iterable_to(obj: Iterable, to: int) -> Tuple[Union[List, Mapping], int]:
"""
Cut an iterable to a certain length.
Args:
obj: The iterable to cut.
to: The number of elements to return.
Returns:
A list or dictionary (depending on the type of object) of elements and
the remaining elements in the original list or dictionary.
"""
if isinstance(obj, dict):
slice = {k: v for (k, v) in take(to, obj.items())}
else:
slice = take(to, obj)
remaining = len(obj) - to
remaining = 0 if remaining < 0 else remaining
return slice, remaining
[docs]class ExperimentParentIterator(typing.Iterator['Simulation']): # noqa F821
"""
Wraps a list of simulations with iterator that always provides parent experiment.
"""
[docs] def __init__(self, lst, parent: 'IEntity'): # noqa F821
"""
Initializes the ExperimentParentIterator.
Args:
lst: List of items(simulations) to iterator over
parent: Parent of items(Experiment)
"""
self.items = lst
self.__iter = iter(self.items) if not isinstance(self.items, (typing.Iterator, Generator)) else self.items
self.parent = parent
def __iter__(self):
"""
Iterator method returns self.
Returns:
Self
"""
return self
def __next__(self):
"""
Fetch the next items from our list.
Returns:
Next item from our list
"""
i = next(self.__iter)
i._parent = self.parent
if hasattr(i, 'parent_id') and self.parent.uid is not None:
i.parent_id = self.parent.uid
return i
def __getitem__(self, item):
"""
Get items wrapper.
Args:
item: Item to fetch
Returns:
Item from self.items
"""
return self.items[item]
def __getattr__(self, item):
"""
Get attr wrapper.
Args:
item: Item to get
Returns:
Attribute from our items
"""
return getattr(self.items, item)
def __len__(self):
"""
Returns the total simulations.
Returns:
Total simulations
Raises:
ValueError - When the underlying object is a generator, we cannot get the length of the object
"""
from idmtools.entities.templated_simulation import TemplatedSimulations
if isinstance(self.items, typing.Sized):
return len(self.items)
elif isinstance(self.items, TemplatedSimulations):
return sum([len(b) for b in self.items.builders])
raise ValueError("Cannot get the length of a generator object")
[docs] def append(self, item: 'Simulation'): # noqa F821
"""
Adds a simulation to an object.
Args:
item: Item to add
Returns:
None
Raises:
ValueError when we cannot append because the item is not a simulation or our underlying object doesn't support appending
"""
from idmtools.entities.templated_simulation import TemplatedSimulations
from idmtools.entities.simulation import Simulation
if not isinstance(item, Simulation):
raise ValueError("You can only append simulations")
if isinstance(self.items, (list, set)):
self.items.append(item)
return
elif isinstance(self.items, TemplatedSimulations):
self.items.add_simulation(item)
return
raise ValueError("Items doesn't support appending")
[docs] def extend(self, item: Union[List['Simulation'], 'TemplatedSimulations']): # noqa F821
"""
Extends object.
Args:
item: Item to extend
Returns:
None
Raises:
ValueError when the underlying data object doesn't supporting adding additional item
"""
from idmtools.entities.templated_simulation import TemplatedSimulations
if isinstance(self.items, (list, set)):
# if it is a template, try to preserve so we can user generators
if isinstance(item, TemplatedSimulations):
self.items.extend(list(item))
else:
self.items.extend(item)
return
if isinstance(self.items, TemplatedSimulations):
if isinstance(item, TemplatedSimulations):
self.items.add_simulations(list(item))
else:
self.items.add_simulations(item)
return
raise ValueError("Items doesn't support extending")
[docs]class ResetGenerator(typing.Iterator):
"""Iterator that counts upward forever."""
[docs] def __init__(self, generator_init):
"""
Initialize the ResetGenerator from generator_init.
Creates a copy of the generator using tee.
Args:
generator_init: Initialize iterator/generator to copy
"""
self.generator_init = generator_init
self.generator = generator_init()
self.generator, self.__next_gen = tee(self.generator)
def __iter__(self):
"""
Get iteror.
"""
return self
[docs] def next_gen(self):
"""
The original generator/iterator.
Returns:
original generator/iterator.
"""
return self.__next_gen
def __next__(self):
"""
Get next item.
For reset iteration, if we hit the end of our iterator/generator, we copy it and reset
Returns:
Next item
Raises:
StopIteration at the end of the iteration.
"""
try:
result = next(self.generator)
except StopIteration:
self.generator, self.__next_gen = tee(self.__next_gen)
raise StopIteration
return result
[docs]def duplicate_list_of_generators(lst: List[Generator]):
"""
Copy a list of iterators using tee.
Args:
lst: List of generators
Returns:
Tuple with duplicate of iterators
"""
new_sw = []
old_sw = []
for sw in lst:
o, n = tee(sw)
new_sw.append(n)
old_sw.append(o)
return old_sw, new_sw