iterator_class.py

Go to the documentation of this file.

 
 
from abc import ABC, abstractmethod
from typing import Any
 
 
class ItemPair:
 
    
    def __init__(self, key = "", value = "") -> None:
        self.Key = key
        self.Value = value
 
    
 
 
 
 
 
 
class IIterator(ABC):
 
    
    @abstractmethod
    def Reset(self) -> None:
        pass
 
    
    def Next(self) -> Any:
        pass
 
 
 
 
 
 
class Iterator(IIterator):
 
    
    def __init__(self, items : list, numItems: int) -> None:
        self._items = items.copy()
        self._numItems = numItems
        self._index = 0
 
    
 
    
    def Next(self) -> Any:
        retrieved_item = None
        if self._index < self._numItems:
            retrieved_item = self._items[self._index]
            self._index += 1
        return retrieved_item
 
    
    def Reset(self) -> None:
        self._index = 0
 
 
 
 
 
 
class IteratorContainer_Class:
    # Hardcoded data to be iterated over.
    # The number of keys must match the number of values.
 
    
    _keys = [ "One", "Two", "Three" ]
 
    
    _values = [ "Value 1", "Value 2", "Value 3" ]
 
    
    def GetItems(self) -> IIterator:
        items = [] # type:list[ItemPair]
 
        numItems = len(IteratorContainer_Class._keys)
        for index in range(0, numItems):
            items.append(ItemPair(IteratorContainer_Class._keys[index],
                                  IteratorContainer_Class._values[index]))
 
        return Iterator(items, len(items))
 
 
    
    def GetKeys(self) -> IIterator:
        return Iterator(IteratorContainer_Class._keys, len(IteratorContainer_Class._keys))
 
 
    
    def GetValues(self) -> IIterator:
        return Iterator(IteratorContainer_Class._values, len(IteratorContainer_Class._values))