p59342861
/
monkey
forked from p15670423/monkey
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Island: Add docstrings to {get,save}_simulation()

This commit is contained in:
Mike Salvatore 2022-07-01 10:00:56 -04:00
parent c58bbb3f8a
commit d2906ef23b
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
monkey/monkey_island/cc/repository/i_simulation_repository.py
View File

@ -7,10 +7,22 @@ from monkey_island.cc.services.mode.mode_enum import IslandModeEnum
class ISimulationRepository(ABC): class ISimulationRepository(ABC):
@abstractmethod @abstractmethod
def save_simulation(self, simulation: Simulation): def save_simulation(self, simulation: Simulation):
"""
Save the simulation state
:param simulation: The simulation state
:raises StorageError: If the simulation states could not be saved
"""
pass pass
@abstractmethod @abstractmethod
def get_simulation(self) -> Simulation: def get_simulation(self) -> Simulation:
"""
Get the simulation state
:raises RetrievalError: If the simulation state could not be retrieved
"""
pass pass
@abstractmethod @abstractmethod