from collections import OrderedDict
import pandas as pd
from powersimdata.data_access.context import Context
from powersimdata.data_access.execute_list import ExecuteListManager
from powersimdata.data_access.fs_helper import get_scenario_fs
from powersimdata.data_access.scenario_list import ScenarioListManager
from powersimdata.scenario.analyze import Analyze
from powersimdata.scenario.create import Create, _Builder
from powersimdata.scenario.execute import Execute
pd.set_option("display.max_colwidth", None)
[docs]class Scenario:
"""Handles scenario.
:param int/str descriptor: scenario name or index. If None, default to a Scenario
in Create state.
:raises TypeError: if descriptor is not int or str
"""
_setattr_allowlist = {
"data_access",
"state",
"status",
"info",
"_scenario_list_manager",
"_execute_list_manager",
}
_default_info = [
("plan", ""),
("name", ""),
("state", "create"),
("grid_model", ""),
("interconnect", ""),
("base_demand", ""),
("base_hydro", ""),
("base_solar", ""),
("base_wind", ""),
("change_table", ""),
("start_date", ""),
("end_date", ""),
("interval", ""),
("engine", ""),
]
def __init__(self, descriptor=None):
"""Constructor."""
if isinstance(descriptor, int):
descriptor = str(descriptor)
if descriptor is not None and not isinstance(descriptor, str):
raise TypeError("Descriptor must be a string or int (for a Scenario ID)")
self.data_access = Context.get_data_access(get_scenario_fs)
self._scenario_list_manager = ScenarioListManager(self.data_access)
self._execute_list_manager = ExecuteListManager(self.data_access)
if not descriptor:
self.info = OrderedDict(self._default_info)
self.status = None
self.state = Create(self)
else:
self._set_info(descriptor)
try:
state = self.info["state"]
self._set_status()
if state == "execute":
self.state = Execute(self)
elif state == "analyze":
self.state = Analyze(self)
except AttributeError:
pass
def __getattr__(self, name):
if name in self.state.exported_methods:
return getattr(self.state, name)
elif hasattr(self.state, "__getattr__"):
return self.state.__getattr__(name)
else:
raise AttributeError(
f"Scenario object in {self.state.name} state "
f"has no attribute {name}"
)
def __setattr__(self, name, value):
if name in self._setattr_allowlist:
super().__setattr__(name, value)
elif isinstance(self.state, Create) and name in _Builder.exported_methods:
raise AttributeError(
f"{name} is exported from Scenario.state.builder, "
"edit it there if necessary"
)
elif name in self.state.exported_methods:
raise AttributeError(
f"{name} is exported from Scenario.state, edit it there if necessary"
)
super().__setattr__(name, value)
def __dir__(self):
return sorted(super().__dir__() + list(self.state.exported_methods))
def _set_info(self, descriptor):
"""Sets scenario information.
:param str descriptor: scenario descriptor.
"""
info = self._scenario_list_manager.get_scenario(descriptor)
if info is None:
raise ValueError(
f"{descriptor} not found in Scenario List. "
"See available scenarios with Scenario().get_scenario_table()"
)
self.info = info
def _set_status(self):
"""Sets execution status of scenario."""
scenario_id = self.info["id"]
self.status = self._execute_list_manager.get_status(scenario_id)
[docs] def get_scenario_table(self):
"""Get scenario table
:return: (*pandas.DataFrame*) -- scenario table
"""
return self._scenario_list_manager.get_scenario_table()
[docs] def change(self, state):
"""Changes state.
:param class state: One of :class:`.Analyze` :class:`.Create`,
:class:`.Execute` or :class:`.Delete`.
"""
self.state.switch(state)
