Skip to content

Home Information - Your home, your data, organized.

Python

Much refactoring of simulator models. WIP

Anthony Cassandrac1f49468fef0
diff --git a/src/hi/simulator/admin.py b/src/hi/simulator/admin.py
new file mode 100644
index 00000000..933d039b
--- /dev/null
+++ b/src/hi/simulator/admin.py
@@ -0,0 +1,38 @@
+from django.contrib import admin
+
+from . import models
+
+
[email protected](models.DbSimEntity)
+class DbSimEntityAdmin(admin.ModelAdmin):
+
+ show_full_result_count = False
+
+ list_display = (
+ 'sim_profile',
+ 'simulator_id',
+ 'entity_class_name',
+ 'entity_type_str',
+ 'editable_fields',
+ 'updated_datetime',
+ 'created_datetime',
+ )
+
+ search_fields = ['entity_class_name']
+ readonly_fields = ( 'updated_datetime', 'created_datetime', )
+
+
[email protected](models.SimProfile)
+class SimProfileAdmin(admin.ModelAdmin):
+
+ show_full_result_count = False
+
+ list_display = (
+ 'name',
+ 'last_switched_to_datetime',
+ 'created_datetime',
+ )
+
+ search_fields = ['name']
+ readonly_fields = ( 'created_datetime', 'last_switched_to_datetime', )
+
diff --git a/src/hi/simulator/forms.py b/src/hi/simulator/forms.py
index 766c5200..f66619e5 100644
--- a/src/hi/simulator/forms.py
+++ b/src/hi/simulator/forms.py
@@ -1,5 +1,10 @@
+from dataclasses import fields, MISSING
+from datetime import datetime
+from typing import Type
+
from django import forms
+from .transient_models import SimEntity
from .models import SimProfile
@@ -10,3 +15,43 @@ class SimProfileForm( forms.ModelForm ):
fields = (
'name',
)
+
+
+class SimEntityForm( forms.Form ):
+ """
+ Dynamically build a Django form from a subclass of SimEntity.
+ """
+
+ DATACLASS_TO_FORM_FIELD = {
+ str: forms.CharField,
+ int: forms.IntegerField,
+ float: forms.FloatField,
+ datetime: forms.DateTimeField,
+ bool: forms.BooleanField,
+ }
+
+ def __init__(self, sim_entity_class: Type[ SimEntity ], *args, initial = None, **kwargs):
+ super().__init__(*args, **kwargs)
+
+ self._sim_entity_class = sim_entity_class
+
+ for field in fields( sim_entity_class ):
+ field_type = field.type
+ form_field_class = self.DATACLASS_TO_FORM_FIELD.get( field_type, None )
+ if not form_field_class:
+ raise ValueError( f'Unsupported field type: {field_type}' )
+
+ default_value = None if field.default is MISSING else field.default
+ field_initial = initial.get( field.name, default_value ) if initial else default_value
+
+ self.fields[field.name] = form_field_class(
+ initial = field_initial,
+ required = field.default is MISSING,
+ label = field.name.replace("_", " ").capitalize(),
+ )
+ continue
+ return
+
+ @property
+ def sim_entity_name(self):
+ return self._sim_entity_class.__name__
diff --git a/src/hi/simulator/migrations/0004_remove_dbsimentity_extra_fields_and_more.py b/src/hi/simulator/migrations/0004_remove_dbsimentity_extra_fields_and_more.py
new file mode 100644
index 00000000..2556f4e0
--- /dev/null
+++ b/src/hi/simulator/migrations/0004_remove_dbsimentity_extra_fields_and_more.py
@@ -0,0 +1,22 @@
+# Generated by Django 4.2.15 on 2024-12-23 20:57
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ("simulator", "0003_alter_simprofile_last_switched_to_datetime"),
+ ]
+
+ operations = [
+ migrations.RemoveField(
+ model_name="dbsimentity",
+ name="extra_fields",
+ ),
+ migrations.AddField(
+ model_name="dbsimentity",
+ name="editable_fields",
+ field=models.JSONField(default=dict, verbose_name="Editable Fields"),
+ ),
+ ]
diff --git a/src/hi/simulator/migrations/0005_remove_dbsimentity_name.py b/src/hi/simulator/migrations/0005_remove_dbsimentity_name.py
new file mode 100644
index 00000000..c65d5b4c
--- /dev/null
+++ b/src/hi/simulator/migrations/0005_remove_dbsimentity_name.py
@@ -0,0 +1,17 @@
+# Generated by Django 4.2.15 on 2024-12-23 22:52
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ("simulator", "0004_remove_dbsimentity_extra_fields_and_more"),
+ ]
+
+ operations = [
+ migrations.RemoveField(
+ model_name="dbsimentity",
+ name="name",
+ ),
+ ]
diff --git a/src/hi/simulator/models.py b/src/hi/simulator/models.py
index 6f578dd4..5b86b054 100644
--- a/src/hi/simulator/models.py
+++ b/src/hi/simulator/models.py
@@ -46,18 +46,13 @@ class DbSimEntity(models.Model):
max_length = 255,
null = False, blank = False,
)
- name = models.CharField(
- 'Name',
- max_length = 255,
- null = False, blank = False,
- )
entity_type_str = models.CharField(
'Entity Type',
max_length = 32,
null = False, blank = False,
)
- extra_fields = models.JSONField(
- 'Extra Fields',
+ editable_fields = models.JSONField(
+ 'Editable Fields',
default = dict,
null = False, blank = False,
)
diff --git a/src/hi/simulator/services/hass/simulator.py b/src/hi/simulator/services/hass/simulator.py
index 63da7f4c..a78b2ad4 100644
--- a/src/hi/simulator/services/hass/simulator.py
+++ b/src/hi/simulator/services/hass/simulator.py
@@ -19,13 +19,6 @@ class HassSimulator( Simulator ):
def get_sim_entity_class_list(self) -> List[ Type[ SimEntity ]]:
return HASS_SIM_ENTITY_LIST
- def initialize( self, sim_entity_list : List[ SimEntity ] ):
- return
-
- @property
- def sim_entities(self) -> List[ SimEntity ]:
- return []
-
def set_sim_state( self, device_id : int, value : str ):
raise NotImplementedError('Subclasses must override this method.')
diff --git a/src/hi/simulator/services/hass/transient_models.py b/src/hi/simulator/services/hass/transient_models.py
index 35ce260a..d0394e04 100644
--- a/src/hi/simulator/services/hass/transient_models.py
+++ b/src/hi/simulator/services/hass/transient_models.py
@@ -6,7 +6,7 @@ import time
from typing import Dict, List
import hi.apps.common.datetimeproxy as datetimeproxy
-from hi.apps.entity.enums import EntityType, EntityStateType, EntityStateValue
+from hi.apps.entity.enums import EntityStateType, EntityStateValue, EntityType
from hi.simulator.transient_models import SimEntity, SimState
@@ -46,23 +46,32 @@ class HassState( SimState ):
}
-@dataclass
+@dataclass( frozen = True )
class HassEntity( SimEntity ):
def to_api_list(self) -> List[ HassState ]:
raise NotImplementedError('Subclasses must override this.')
-@dataclass
+@dataclass( frozen = True )
class HassInsteonEntity( HassEntity ):
insteon_address : str = None
-@dataclass
+@dataclass( frozen = True )
class HassInsteonLightSwitch( HassInsteonEntity ):
- entity_type : EntityType = EntityType.LIGHT
+ @classmethod
+ def class_label(cls):
+ return 'Insteon Light Switch'
+
+ @classmethod
+ def get_entity_type(cls) -> EntityType:
+ return EntityType.LIGHT
+
+ def get_sim_state_list(self) -> List[ SimState ]:
+ pass
def entity_list(self):
dummy_datetime_iso = datetimeproxy.now().isoformat()
@@ -100,11 +109,20 @@ class HassInsteonLightSwitch( HassInsteonEntity ):
return [ x.to_api_dict() for x in self.entity_list() ]
-@dataclass
+@dataclass( frozen = True )
class HassInsteonMotionDetector( HassInsteonEntity ):
- entity_type : EntityType = EntityType.MOTION_SENSOR
-
+ @classmethod
+ def class_label(cls):
+ return 'Insteon Motion Sensor'
+
+ @classmethod
+ def get_entity_type(cls) -> EntityType:
+ return EntityType.MOTION_SENSOR
+
+ def get_sim_state_list(self) -> List[ SimState ]:
+ pass
+
def entity_list(self):
dummy_datetime_iso = datetimeproxy.now().isoformat()
@@ -152,11 +170,20 @@ class HassInsteonMotionDetector( HassInsteonEntity ):
return [ x.to_api_dict() for x in self.entity_list() ]
-@dataclass
+@dataclass( frozen = True )
class HassInsteonOpenCloseSensor( HassInsteonEntity ):
- entity_type : EntityType = EntityType.OPEN_CLOSE_SENSOR
-
+ @classmethod
+ def class_label(cls):
+ return 'Insteon Open/Close Sensor'
+
+ @classmethod
+ def get_entity_type(cls) -> EntityType:
+ return EntityType.OPEN_CLOSE_SENSOR
+
+ def get_sim_state_list(self) -> List[ SimState ]:
+ pass
+
def entity_list(self):
dummy_datetime_iso = datetimeproxy.now().isoformat()
diff --git a/src/hi/simulator/services/zoneminder/simulator.py b/src/hi/simulator/services/zoneminder/simulator.py
index 30327a44..8bb444d2 100644
--- a/src/hi/simulator/services/zoneminder/simulator.py
+++ b/src/hi/simulator/services/zoneminder/simulator.py
@@ -3,7 +3,7 @@ from typing import List, Type
from hi.simulator.transient_models import SimEntity
from hi.simulator.simulator import Simulator
-from .transient_models import ZmMonitorEntity
+from .transient_models import ZONEMINDER_SIM_ENTITY_LIST
class ZoneMinderSimulator( Simulator ):
@@ -17,16 +17,7 @@ class ZoneMinderSimulator( Simulator ):
return 'ZoneMinder'
def get_sim_entity_class_list(self) -> List[ Type[ SimEntity ]]:
- return [
- ZmMonitorEntity,
- ]
-
- def initialize( self, sim_entity_list : List[ SimEntity ] ):
- return
-
- @property
- def sim_entities(self) -> List[ SimEntity ]:
- return []
+ return ZONEMINDER_SIM_ENTITY_LIST
def set_sim_state( self, device_id : int, value : str ):
raise NotImplementedError('Subclasses must override this method.')
diff --git a/src/hi/simulator/services/zoneminder/transient_models.py b/src/hi/simulator/services/zoneminder/transient_models.py
index 3c928f32..d449db58 100644
--- a/src/hi/simulator/services/zoneminder/transient_models.py
+++ b/src/hi/simulator/services/zoneminder/transient_models.py
@@ -8,23 +8,28 @@ from hi.apps.entity.enums import EntityType, EntityStateType, EntityStateValue
from hi.simulator.transient_models import SimEntity, SimState
-@dataclass
+@dataclass( frozen = True )
class ZmServerEntity( SimEntity ):
- pass
-
-
-@dataclass
-class ZmServerState( SimState ):
- entity_state_type : EntityStateType = EntityStateType.DISCRETE
- state_value : str = 'Modect'
+ name : str = 'ZoneMinder Server'
+ @classmethod
+ def class_label(cls):
+ return 'ZoneMinder Server'
-@dataclass
+ @classmethod
+ def get_entity_type(cls) -> EntityType:
+ return EntityType.SERVICE
+
+ def get_sim_state_list(self) -> List[ SimState ]:
+ pass
+
+
+@dataclass( frozen = True )
class ZmMonitorEntity( SimEntity ):
+ name : str
monitor_id : int = None
- entity_type : EntityType = EntityType.CAMERA
status : str = 'Connected'
type : str = 'Remote'
function : str = 'Modect'
@@ -37,6 +42,17 @@ class ZmMonitorEntity( SimEntity ):
height : str = '800'
orientation : str = 'ROTATE_0'
+ @classmethod
+ def class_label(cls):
+ return 'Camera (monitor)'
+
+ @classmethod
+ def get_entity_type(cls) -> EntityType:
+ return EntityType.CAMERA
+
+ def get_sim_state_list(self) -> List[ SimState ]:
+ pass
+
def to_api_dict(self):
return {
'Monitor': {
@@ -283,3 +299,9 @@ class ZmPagination:
'paramType': 'querystring',
'queryScope': None,
}
+
+
+ZONEMINDER_SIM_ENTITY_LIST = [
+ ZmMonitorEntity,
+ ZmServerEntity,
+]
diff --git a/src/hi/simulator/sim_view_parameters.py b/src/hi/simulator/sim_view_parameters.py
index eca9410a..5902099e 100644
--- a/src/hi/simulator/sim_view_parameters.py
+++ b/src/hi/simulator/sim_view_parameters.py
@@ -23,11 +23,7 @@ class SimViewParameters:
return SimViewParameters()
if not hasattr( request, 'session' ):
return SimViewParameters()
- try:
- simulator_id = int( request.session.get( 'simulator_id' ))
- except ( TypeError, ValueError ):
- simulator_id = None
-
+ simulator_id = request.session.get( 'simulator_id' )
return SimViewParameters(
simulator_id = simulator_id,
)
diff --git a/src/hi/simulator/simulator.py b/src/hi/simulator/simulator.py
index a4b71d60..58267263 100644
--- a/src/hi/simulator/simulator.py
+++ b/src/hi/simulator/simulator.py
@@ -2,12 +2,13 @@ from typing import List, Type
from hi.apps.common.singleton import Singleton
-from .transient_models import SimEntity
+from .transient_models import SimEntity, SimEntityClassWrapper
class Simulator( Singleton ):
def __init_singleton__( self ):
+ self._sim_entity_list = list()
return
@property
@@ -28,12 +29,20 @@ class Simulator( Singleton ):
occur at start up and if/when the simulation profile changes
(requiring a new list of SimEntity instances).
"""
- raise NotImplementedError('Subclasses must override this method.')
+ self._sim_entity_list = sim_entity_list
@property
def sim_entities(self) -> List[ SimEntity ]:
- raise NotImplementedError('Subclasses must override this method.')
+ return self._sim_entity_list
def set_sim_state( self, device_id : int, value : str ):
raise NotImplementedError('Subclasses must override this method.')
+ @property
+ def sim_entity_class_wrapper_list(self) -> List[ SimEntityClassWrapper ]:
+ return [ SimEntityClassWrapper( sim_entity_class = x )
+ for x in self.get_sim_entity_class_list() ]
+
+ def add_sim_entity( self, sim_entity : SimEntity ):
+ self._sim_entity_list.append( sim_entity )
+
diff --git a/src/hi/simulator/simulator_data.py b/src/hi/simulator/simulator_data.py
new file mode 100644
index 00000000..e63901bd
--- /dev/null
+++ b/src/hi/simulator/simulator_data.py
@@ -0,0 +1,14 @@
+from dataclasses import dataclass, field
+from typing import Dict, Type
+
+from .models import DbSimEntity
+from .simulator import Simulator
+from .transient_models import SimEntity
+
+
+@dataclass
+class SimulatorData:
+
+ simulator : Simulator
+ sim_entity_class_map : Dict[ str , Type[ SimEntity ]] = field( default_factory = dict )
+ sim_entity_instance_map : Dict[ SimEntity, DbSimEntity ] = field( default_factory = dict )
diff --git a/src/hi/simulator/simulator_manager.py b/src/hi/simulator/simulator_manager.py
index f1bb5dec..922fa4f7 100644
--- a/src/hi/simulator/simulator_manager.py
+++ b/src/hi/simulator/simulator_manager.py
@@ -11,7 +11,8 @@ from hi.apps.common.singleton import Singleton
from .models import DbSimEntity, SimProfile
from .simulator import Simulator
-from .transient_models import SimEntity
+from .simulator_data import SimulatorData
+from .transient_models import SimEntity, SimEntityClassWrapper
logger = logging.getLogger(__name__)
@@ -22,7 +23,7 @@ class SimulatorManager( Singleton ):
def __init_singleton__( self ):
self._current_sim_profile = None
- self._id_to_simulator_map : Dict[ str, Simulator ] = dict()
+ self._simulator_data_map : Dict[ str, SimulatorData ] = dict()
self._data_lock = Lock()
return
@@ -46,31 +47,56 @@ class SimulatorManager( Singleton ):
return
def get_simulator( self, simulator_id : str ) -> Simulator:
- return self._id_to_simulator_map.get( simulator_id )
+ simulator_data = self._simulator_data_map.get( simulator_id )
+ if not simulator_id:
+ raise KeyError( f'Simulator id "{simulator_id}" not found.' )
+ return simulator_data.simulator
def get_simulator_list(self):
- simulator_list = [ x for x in self._id_to_simulator_map.values() ]
+ simulator_list = [ x.simulator for x in self._simulator_data_map.values() ]
simulator_list.sort( key = lambda item : item.label )
return simulator_list
-
+
+ def add_sim_entity( self,
+ simulator : Simulator,
+ sim_entity : SimEntity ):
+ self._data_lock.acquire()
+ try:
+ simulator_data = self._simulator_data_map.get( simulator.id )
+ if not simulator_data:
+ raise KeyError( f'No data found for simulator id = {simulator.id}' )
+
+ sim_entity_class_wrapper = SimEntityClassWrapper( sim_entity_class = sim_entity.__class__ )
+
+ db_sim_entity = DbSimEntity.objects.create(
+ sim_profile = self.current_sim_profile,
+ simulator_id = simulator.id,
+ entity_class_name = sim_entity_class_wrapper.name,
+ entity_type = sim_entity_class_wrapper.entity_type,
+ editable_fields = sim_entity.to_json_dict()
+ )
+
+ simulator_data.sim_entity_instance_map[sim_entity] = db_sim_entity
+ simulator.add_sim_entity( sim_entity = sim_entity )
+
+ finally:
+ self._data_lock.release()
+
async def initialize(self) -> None:
self._data_lock.acquire()
try:
- await sync_to_async( self._load_simulator_data )()
await sync_to_async( self._initialize_sim_profile )()
+ await sync_to_async( self._discover_defined_simulators )()
+ await sync_to_async( self._discovery_sim_entity_classes )()
+ await sync_to_async( self._load_sim_entity_instances )()
await sync_to_async( self._initialize_simulators )()
finally:
self._data_lock.release()
return
- def _load_simulator_data(self) -> None:
- logger.debug("Discovering defined simulators ...")
- self._id_to_simulator_map = self._discover_defined_simulators()
- self._defined_entity_classes = self._load_defined_entity_classes()
- return
-
def _initialize_sim_profile(self):
+ logger.debug("Initialize SimProfile ...")
self._current_sim_profile = SimProfile.objects.all().first() # Default ordering by usage time
if not self._current_sim_profile:
self._current_sim_profile = SimProfile.objects.create(
@@ -79,40 +105,10 @@ class SimulatorManager( Singleton ):
)
return
- def _initialize_simulators(self):
-
- db_sim_entity_queryset = DbSimEntity.objects.prefetch_related( 'db_sim_states' ).filter(
- sim_profile = self.current_sim_profile,
- )
- simulator_id_to_entity_list = dict()
- for db_sim_entity in db_sim_entity_queryset:
- simulator_id = db_sim_entity.simulator_id
- if simulator_id not in simulator_id_to_entity_list:
- simulator_id_to_entity_list[simulator_id] = list()
-
- sim_entity_class_map = self._defined_entity_classes.get( simulator_id )
-
- class_name = db_sim_entity.entity_class_name
- entity_class = sim_entity_class_map.get( class_name )
- if not entity_class:
- logger.warning( f'Entity class "{class_name}" not found for simulator "{simulator_id}"' )
- continue
-
- sim_entity = entity_class.from_db_model( db_sim_entity )
- simulator_id_to_entity_list[simulator_id].append( sim_entity )
- continue
-
- for simulator_id, simulator in self._id_to_simulator_map.items():
- sim_entity_list = simulator_id_to_entity_list.get( simulator_id, list() )
- logger.debug( f'Initializing simulator {simulator_id} with {len(sim_entity_list)} entities.' )
- simulator.initialize( sim_entity_list = sim_entity_list )
- continue
-
- return
-
- def _discover_defined_simulators(self) -> Dict[ str, Simulator ]:
+ def _discover_defined_simulators(self):
+ logger.debug("Discovering defined simulators ...")
- simulator_id_to_simulator = dict()
+ self._simulator_data_map = dict()
for app_config in apps.get_app_configs():
if not app_config.name.startswith( 'hi.simulator.services' ):
continue
@@ -132,32 +128,64 @@ class SimulatorManager( Singleton ):
and attr is not Simulator ):
logger.debug(f'Found simulator: {attr_name}')
simulator = attr()
- simulator_id_to_simulator[simulator.id] = simulator
+ self._simulator_data_map[simulator.id] = SimulatorData(
+ simulator = simulator,
+ )
continue
except Exception as e:
logger.exception( f'Problem getting simulator for {module_name}.', e )
continue
- return simulator_id_to_simulator
+ return
- def _load_defined_entity_classes(self) -> Dict[ str, Dict[ str, Type[ SimEntity ]]]:
+ def _discovery_sim_entity_classes(self):
"""
- Query simulators to get the defined subclasses of SimEntity. Returns a
- map from simulator id, to class name, then to the (sub) class itself
- (which is used to create instances).
+ Query simulators to get the defined subclasses of SimEntity and
+ populates the SimulatorData for each simulator.
"""
-
- defined_entity_classes = dict()
- for simulator_id, simulator in self._id_to_simulator_map.items():
+ for simulator_id, simulator_data in self._simulator_data_map.items():
+ simulator = simulator_data.simulator
sim_entity_class_list = simulator.get_sim_entity_class_list()
logger.debug( f'Adding {len(sim_entity_class_list)} entity class to simulator {simulator_id}.' )
- if simulator_id not in defined_entity_classes:
- defined_entity_classes[simulator_id] = dict()
for sim_entity_class in sim_entity_class_list:
- class_name = sim_entity_class.__name__
- defined_entity_classes[class_name] = sim_entity_class
+ sim_entity_class_wrapper = SimEntityClassWrapper( sim_entity_class = sim_entity_class )
+ class_name = sim_entity_class_wrapper.name
+ simulator_data.sim_entity_class_map[class_name] = sim_entity_class
+ continue
+ continue
+ return
+
+ def _load_sim_entity_instances(self):
+
+ db_sim_entity_queryset = DbSimEntity.objects.filter(
+ sim_profile = self.current_sim_profile,
+ )
+ for db_sim_entity in db_sim_entity_queryset:
+ simulator_id = db_sim_entity.simulator_id
+ simulator_data = self._simulator_data_map.get( simulator_id )
+ if not simulator_data:
+ logger.warning( f'Instance found for non-existent simulator id = {simulator_id}' )
continue
+
+ sim_entity_class_map = simulator_data.sim_entity_class_map
+ class_name = db_sim_entity.entity_class_name
+ sim_entity_class = sim_entity_class_map.get( class_name )
+ if not sim_entity_class:
+ logger.warning( f'Entity class "{class_name}" not found for simulator "{simulator_id}"' )
+ continue
+
+ sim_entity = sim_entity_class.from_json_dict( db_sim_entity.editable_fields )
+ simulator_data.sim_entity_instance_map[sim_entity] = db_sim_entity
continue
- return defined_entity_classes
+ return
+
+ def _initialize_simulators(self):
+
+ for simulator_id, simulator_data in self._simulator_data_map.items():
+ sim_entity_list = list( simulator_data.sim_entity_instance_map.keys() )
+ logger.debug( f'Initializing simulator {simulator_id} with {len(sim_entity_list)} entities.' )
+ simulator_data.simulator.initialize( sim_entity_list = sim_entity_list )
+ continue
+ return
diff --git a/src/hi/simulator/templates/simulator/modals/add_entity.html b/src/hi/simulator/templates/simulator/modals/add_entity.html
index 61bc5c1c..e3eb0daf 100644
--- a/src/hi/simulator/templates/simulator/modals/add_entity.html
+++ b/src/hi/simulator/templates/simulator/modals/add_entity.html
@@ -1,7 +1,7 @@
{% extends "modals/action_with_cancel.html" %}
{% block preamble %}
-<form action="{% url 'simulator_add_entity' simulator_id=simulator.id %}" method="post"
+<form action="{% url 'simulator_add_entity' simulator_id=simulator.id class_name=sim_entity_class_wrapper.name %}" method="post"
class="form" data-async="modal">
{% csrf_token %}
{% endblock %}
@@ -12,37 +12,8 @@ Add {{ simulator.label }} Entity
{% block body %}
<div>
- {% for entity_fields in entity_fields_list %}
- <div>
- {{ sim_entity_class }}
- </div>
-
-
-
-
-
- {% for field in entity_fields %}
- <label for="{{ field.name }}">{{ field.name }}</label>
- <input
- type="text"
- name="{{ field.name }}"
- value="{{ field.default|default:'' }}"
- >
- {% endfor %}
-
-
-
-
-
-
-
-
-
-
-
-
-
- {% endfor %}
+ <div class="h3">{{ sim_entity_class_wrapper.label }}</div>
+ {% include "simulator/panes/sim_entity_form.html" with sim_entity_form=sim_entity_form %}
</div>
{% endblock %}
diff --git a/src/hi/simulator/templates/simulator/panes/sim_entity_form.html b/src/hi/simulator/templates/simulator/panes/sim_entity_form.html
new file mode 100644
index 00000000..c15a2641
--- /dev/null
+++ b/src/hi/simulator/templates/simulator/panes/sim_entity_form.html
@@ -0,0 +1,24 @@
+{% for hidden in sim_entity_form.hidden_fields %}
+{{ hidden }}
+{% endfor %}
+
+{% if sim_entity_form.non_field_errors %}
+<div class="non-field-errors">
+ {% for err in sim_entity_form.non_field_errors %}
+ <p class="form-error text-danger">ERROR: {{ err }}</p>
+ {% endfor %}
+</div>
+{% endif %}
+
+{% for field in sim_entity_form %}
+<div class="form-group">
+ <label for="{{ field.id_for_label }}">{{ field.label }}</label>
+ {{ field }}
+ {% if field.help_text %}
+ <small class="form-text text-muted">{{ field.help_text }}</small>
+ {% endif %}
+ {% for error in field.errors %}
+ <div class="text-danger">{{ error }}</div>
+ {% endfor %}
+</div>
+{% endfor %}
diff --git a/src/hi/simulator/templates/simulator/panes/simulator_control_tabs.html b/src/hi/simulator/templates/simulator/panes/simulator_control_tabs.html
index 9fe8ad34..8d7bd2f3 100644
--- a/src/hi/simulator/templates/simulator/panes/simulator_control_tabs.html
+++ b/src/hi/simulator/templates/simulator/panes/simulator_control_tabs.html
@@ -22,15 +22,30 @@
aria-labelledby="hi-simulator-tab-{{ simulator.id }}">
<div>
- <a id="hi-sim-entity-add-button"
- href="{% url 'simulator_add_entity' simulator_id=simulator.id %}" data-async="modal"
- class="btn btn-info">
- ADD {{ simulator.label }} ENTITY
- </a>
+ <div class="dropdown">
+ <button class="btn btn-secondary btn-control dropdown-toggle" type="button"
+ id="hi-sim-entity-{{ simulator.id }}-menu" data-toggle="dropdown">
+ ADD {{ simulator.label }} ENTITY
+ <span class="caret"></span>
+ </button>
+ <div class="dropdown-menu dropdown-menu-right"
+ role="menu" aria-labelledby="hi-sim-entity-{{ simulator.id }}-menu">
+ {% for sim_entity_class_wrapper in simulator.sim_entity_class_wrapper_list %}
+ {% if forloop.counter > 1 %}
+ <div class="dropdown-divider"></div>
+ {% endif %}
+ <a role="menuitem" class="dropdown-item plain"
+ href="{% url 'simulator_add_entity' simulator_id=simulator.id class_name=sim_entity_class_wrapper.name %} "
+ data-async="modal">
+ {{ sim_entity_class_wrapper.label }}
+ </a>
+ {% endfor %}
+ </div>
+ </div>
</div>
{% for sim_entity in simulator.sim_entities %}
- {% include "panes/sim_entity.html" with simulator=simulator sim_entity=sim_entity %}
+ {% include "simulator/panes/sim_entity.html" with simulator=simulator sim_entity=sim_entity %}
{% empty %}
<div class="alert alert-info" >No {{ simulator.label }} simulator entities defined.</div>
{% endfor %}
diff --git a/src/hi/simulator/transient_models.py b/src/hi/simulator/transient_models.py
index 1baea42f..cc81a2bc 100644
--- a/src/hi/simulator/transient_models.py
+++ b/src/hi/simulator/transient_models.py
@@ -1,7 +1,8 @@
-from dataclasses import dataclass, fields, asdict
-from typing import List
+from dataclasses import dataclass, fields, asdict, MISSING
+from datetime import datetime
+from typing import Any, Dict, List, Type
-from hi.apps.entity.enums import EntityType, EntityStateType
+from hi.apps.entity.enums import EntityStateType, EntityType
from .models import DbSimEntity
@@ -9,7 +10,6 @@ from .models import DbSimEntity
@dataclass
class SimState:
- db_id : str
name : str
entity_state_type : EntityStateType
state_value : str
@@ -28,56 +28,125 @@ class SimState:
@classmethod
def from_dict( cls, data ):
return cls( **data )
-
+
@dataclass
+class FormField:
+ name : str
+ type : Type
+ default : Any = None
+
+
+@dataclass( frozen = True )
class SimEntity:
"""
- Base class that simulators will extend to add any defaults or new fields
- that need to defined for a specific simulator entity. Simulators
- should define one or more subclasses and make those known to te
+ Base class that simulators extend to add any extra editable fields
+ needed to define for a specific simulator entity. Simulators should
+ define one or more subclasses of this and make those known to te
SimulatorManager through the get_sim_entity_class_list() method of the
Simulator class.
- The companion database DbSimEntity is used to persist the defined
- entities with conversions (below) between the two models. This class
- is view of the database model that concerns the simulators themselves
- and not the extra concerns of the SimulatorManager (e.g.., SimProfile).
+ This class is the view of the model that concerns the Simulator
+ instances themselves and not the extra concerns of the
+ SimulatorManager. The companion database model DbSimEntity is the
+ SimulatorManager's view and is used to persist the defined entities
+ with conversions (below) between the two models.
"""
- db_id : int
- name : str
- sim_state_list : List[ SimState ] # Simulators populate this as these are added (not persisted)
- entity_type : EntityType
- def validate(self):
+ name : str
+
+ @classmethod
+ def class_label(cls):
+ raise NotImplementedError('Subclasses must override this method.')
+
+ def to_json_dict(self) -> Dict[ str, Any ]:
+ """
+ Subclasses only need to override this if the field types are not
+ directly JSON serializable or lack special cases defined in this
+ method (e.g., datetime).
+ """
+ json_dict = dict()
for field in fields(self):
- value = getattr(self, field.name)
- if not isinstance(value, field.type):
- raise TypeError( f'Field {field.name} must be type {field.type}, got {type(value).__name__}' )
+ value = getattr( self, field.name )
+ if isinstance( value, datetime ):
+ value = value.isoformat()
+ json_dict[field.name] = value
continue
- return
+ return json_dict
- def to_db_model( self ) -> DbSimEntity:
+ @classmethod
+ def from_json_dict( cls, json_content : Dict[ str, Any ] ) -> 'SimEntity':
"""
- Creates a partially filled out DbSimEntity model from the
- entity-specific fields. The SimulatorManager will fill out the
- remaining DB fields (those others do not concern simulators).
+ Subclasses only need to override this if the field types are not
+ directly JSON deserializable or lack special cases defined in this
+ method (e.g., datetime).
"""
- base_field_names = { f.name for f in fields(SimEntity) }
- extra_fields = { k: v for k, v in asdict(self).items() if k not in base_field_names }
-
- return DbSimEntity(
- name = self.name,
- entity_type_str = str(self.entity_type),
- extra_fields = extra_fields,
- )
+ kwargs = dict()
+ for field in fields( cls ):
+ value = json_content.get( field.name, field.default )
+ if ( field.type == datetime ) and isinstance( value, str ):
+ value = datetime.fromisoformat( value )
+ kwargs[field.name] = value
+ continue
+ return cls( **kwargs )
+
+ def to_form_field_list( self ) -> List[ FormField ]:
+ form_field_list = list()
+ for field in fields(self):
+ form_field = FormField(
+ name = field.name,
+ type = field.type,
+ default = None if field.default is MISSING else field.default,
+ )
+ form_field_list.append( form_field )
+ continue
+ return form_field_list
@classmethod
- def from_db_model( cls, db_sim_entity : DbSimEntity ):
- data = {
- 'db_id': db_sim_entity.id,
- 'name': db_sim_entity.name,
- 'entity_type': db_sim_entity.entity_type,
- }
- data.update( db_sim_entity.extra_fields )
- return cls( **data )
+ def from_form_data( cls, form_data : Dict[ str, Any ] ) -> 'SimEntity':
+ kwargs = dict()
+ for field in fields( cls ):
+ value = form_data.get( field.name, field.default )
+ if value is MISSING:
+ raise ValueError(f'Missing required field: {field.name}')
+ kwargs[field.name] = value
+ continue
+ return cls( **kwargs )
+
+ @classmethod
+ def get_entity_type(cls) -> EntityType:
+ raise NotImplementedError('Subclasses must override this method.')
+
+ def get_sim_state_list(self) -> List[ SimState ]:
+ """
+ These are defined by the Simulator and used by the SimulatorManager to
+ know what states exists and can be simulated. The Simulator keeps track of
+ the current value of these states as provided by the SimulatorManager by
+ way of the UI or a predefined simulation script. These are not persisted.
+ """
+ raise NotImplementedError('Subclasses must override this method.')
+
+
+@dataclass
+class SimEntityData:
+
+ sim_entity : SimEntity
+ db_sim_entity : DbSimEntity = None
+
+
+@dataclass
+class SimEntityClassWrapper:
+
+ sim_entity_class : Type[ SimEntity ]
+
+ @property
+ def name(self) -> str:
+ return f'{self.sim_entity_class.__module__}.{self.sim_entity_class.__qualname__}'
+
+ @property
+ def label(self) -> str:
+ return self.sim_entity_class.class_label()
+
+ @property
+ def entity_type(self) -> EntityType:
+ return self.sim_entity_class.get_entity_type()
diff --git a/src/hi/simulator/urls.py b/src/hi/simulator/urls.py
index 07827b26..01475760 100644
--- a/src/hi/simulator/urls.py
+++ b/src/hi/simulator/urls.py
@@ -1,11 +1,13 @@
from django.apps import apps
-from django.urls import include, re_path
+from django.contrib import admin
+from django.urls import include, path, re_path
from hi.apps.common.module_utils import import_module_safe
from . import views
urlpatterns = [
+ path( 'admin/', admin.site.urls ),
re_path( r'^$',
views.HomeView.as_view(),
@@ -27,7 +29,7 @@ urlpatterns = [
views.ProfileSwitchView.as_view(),
name = 'simulator_profile_switch' ),
- re_path( r'^add-entity/(?P<simulator_id>[\w_]+)$',
+ re_path( r'^add-entity/(?P<simulator_id>[\w_\-\.\:]+)/(?P<class_name>[\w\.\_]+)$',
views.AddEntityView.as_view(),
name = 'simulator_add_entity' ),
]
diff --git a/src/hi/simulator/view_mixins.py b/src/hi/simulator/view_mixins.py
index 9a3208cf..cc35a251 100644
--- a/src/hi/simulator/view_mixins.py
+++ b/src/hi/simulator/view_mixins.py
@@ -1,9 +1,12 @@
-from typing import List
+from typing import List, Type
+from django.core.exceptions import BadRequest
from django.http import Http404, HttpRequest
from .models import SimProfile
from .simulator import Simulator
+from .simulator_manager import SimulatorManager
+from .transient_models import SimEntity
class SimulatorViewMixin:
@@ -14,18 +17,48 @@ class SimulatorViewMixin:
if not simulator_list:
return None
current_simulator_id = request.sim_view_parameters.simulator_id
- current_simulator = simulator_list[0]
for simulator in simulator_list:
if simulator.id == current_simulator_id:
- current_simulator = simulator
- break
+ return simulator
continue
- return current_simulator
+ return simulator_list[0]
+
+ def set_current_simulator( self,
+ request : HttpRequest,
+ simulator : Simulator ):
+ request.sim_view_parameters.simulator_id = simulator.id
+ request.sim_view_parameters.to_session( request )
+ return
- def get_sim_profile( self, request, *args, **kwargs):
+ def get_sim_profile( self, request, *args, **kwargs) -> SimProfile:
sim_profile_id = kwargs.get('profile_id')
try:
return SimProfile.objects.get( id = sim_profile_id )
except SimProfile.DoesNotExist:
raise Http404( 'Simulator profile does not exist.' )
+ def get_simulator( self, request, *args, **kwargs) -> Simulator:
+ simulator_id = kwargs.get('simulator_id')
+ if not simulator_id:
+ raise BadRequest( 'Missing simulator id.' )
+ simulator = SimulatorManager().get_simulator( simulator_id = simulator_id )
+ if not simulator:
+ raise Http404( 'Unknown simulator id "{simulator_id}".' )
+ self.set_current_simulator(
+ request = request,
+ simulator = simulator,
+ )
+ return simulator
+
+ def get_entity_class( self, simulator : Simulator, request, *args, **kwargs) -> Type[ SimEntity ]:
+ class_name = kwargs.get('class_name')
+ sim_entity_class = None
+ for sim_entity_class_wrapper in simulator.sim_entity_class_wrapper_list:
+ if class_name == sim_entity_class_wrapper.name:
+ sim_entity_class = sim_entity_class_wrapper.sim_entity_class
+ break
+ continue
+ if not sim_entity_class:
+ raise Http404( 'Unknown entity class name.' )
+ return sim_entity_class
+
diff --git a/src/hi/simulator/views.py b/src/hi/simulator/views.py
index 5cdcf7c0..5166cd17 100644
--- a/src/hi/simulator/views.py
+++ b/src/hi/simulator/views.py
@@ -1,7 +1,4 @@
-from dataclasses import fields, MISSING
-
-from django.core.exceptions import BadRequest
-from django.http import Http404, HttpResponseRedirect
+from django.http import HttpResponseRedirect
from django.shortcuts import render
from django.urls import reverse
from django.views.generic import View
@@ -11,7 +8,7 @@ import hi.apps.common.antinode as antinode
from . import forms
from .models import DbSimEntity
from .simulator_manager import SimulatorManager
-from .transient_models import SimEntity
+from .transient_models import SimEntity, SimEntityClassWrapper
from .view_mixins import SimulatorViewMixin
@@ -120,40 +117,46 @@ class ProfileDeleteView( View, SimulatorViewMixin ):
return antinode.refresh_response()
-class AddEntityView( View ):
+class AddEntityView( View, SimulatorViewMixin ):
- def get(self, request, *args, **kwargs):
- simulator_id = kwargs.get('simulator_id')
- if not simulator_id:
- raise BadRequest( 'Missing simulator id.' )
- simulator = SimulatorManager().get_simulator( simulator_id = simulator_id )
- if not simulator:
- raise Http404( 'Unknown simulator id "{simulator_id}".' )
-
- sim_entity_class_list = simulator.get_sim_entity_class_list()
-
- base_field_names = { f.name for f in fields(SimEntity) }
- entity_fields_list = list()
- for sim_entity_class in sim_entity_class_list:
- entity_fields = [
- { 'name': f.name,
- 'type': f.type,
- 'default': None if f.default is MISSING else f.default
- }
- for f in fields(sim_entity_class) if f.name not in base_field_names
- ]
- entity_fields_list.append( entity_fields )
- continue
-
+ MODAL_TEMPLATE_NAME = 'simulator/modals/add_entity.html'
+
+ def get( self, request, *args, **kwargs ):
+ simulator = self.get_simulator( request, *args, **kwargs)
+ sim_entity_class = self.get_entity_class( simulator, request, *args, **kwargs )
+ sim_entity_class_wrapper = SimEntityClassWrapper( sim_entity_class = sim_entity_class )
+
+ sim_entity_form = forms.SimEntityForm( sim_entity_class = sim_entity_class )
context = {
'simulator': simulator,
- 'entity_fields_list': entity_fields_list,
+ 'sim_entity_class_wrapper': sim_entity_class_wrapper,
+ 'sim_entity_form': sim_entity_form,
}
- return render( request, 'simulator/modals/add_entity.html', context )
+ return render( request, self.MODAL_TEMPLATE_NAME, context )
- def post(self, request, *args, **kwargs):
- simulator_id = kwargs.get('simulator_id')
+ def post( self, request, *args, **kwargs ):
+ simulator = self.get_simulator( request, *args, **kwargs)
+ sim_entity_class = self.get_entity_class( simulator, request, *args, **kwargs )
+ sim_entity_class_wrapper = SimEntityClassWrapper( sim_entity_class = sim_entity_class )
+
+ sim_entity_form = forms.SimEntityForm(
+ sim_entity_class,
+ request.POST,
+ )
+ if not sim_entity_form.is_valid():
+ context = {
+ 'simulator': simulator,
+ 'sim_entity_class_wrapper': sim_entity_class_wrapper,
+ 'sim_entity_form': sim_entity_form,
+ }
+ return render( request, self.MODAL_TEMPLATE_NAME, context )
- simulator = SimulatorManager().get_simulator( simulator_id = simulator_id )
- simulator.add_entity( entity_id = entity_id )
+ cleaned_data = sim_entity_form.clean()
+ print( f'\n\nCLEANED = {cleaned_data}' )
+ sim_entity = SimEntity.from_form_data( form_data = cleaned_data )
+ SimulatorManager().add_sim_entity(
+ simulator = simulator,
+ sim_entity = sim_entity,
+ )
+ return antinode.refresh_response()