gridappsd-python 2024.6.0__tar.gz → 2024.8.1a1__tar.gz

{gridappsd_python-2024.6.0 → gridappsd_python-2024.8.1a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gridappsd-python
-Version: 2024.6.0
+Version: 2024.8.1a1
 Summary: A GridAPPS-D Python Adapter
 Home-page: https://gridappsd.readthedocs.io
 License: BSD-3-Clause

{gridappsd_python-2024.6.0 → gridappsd_python-2024.8.1a1}/gridappsd/difference_builder.py

@@ -42,19 +42,17 @@ import calendar
 from uuid import uuid4
 import time
 
-import pytz
-
 
 class DifferenceBuilder(object):
     """ Automates the building of forward and reverse cim differences
 
     """
 
-    def __init__(self, simulation_id):
+    def __init__(self, simulation_id: str | int | None = None):
 
         self._simulation_id = simulation_id
-        self._forward = []
-        self._reverse = []
+        self._forward: list[dict] = []
+        self._reverse: list[dict] = []
 
     def add_difference(self, object_id, attribute, forward_value, reverse_value):
         """ Add forward and reverse unit for an object attribute.
@@ -67,16 +65,22 @@ class DifferenceBuilder(object):
         self._reverse.append(reverse)
 
     def clear(self):
+        """ Clear the forward and reverse differences """
         self._forward = []
         self._reverse = []
 
     def get_message(self, epoch=None):
+        """ Get the message to send to the GOSS message bus
+
+        :param epoch: The epoch time to use for the message timestamp.  If None, the current time (GMT) is used.
+        """
         if epoch is None:
             epoch = calendar.timegm(time.gmtime())
         msg = dict(command="update",
-                   input=dict(simulation_id=self._simulation_id,
-                              message=dict(timestamp=epoch,
+                   input=dict(message=dict(timestamp=epoch,
                                            difference_mrid=str(uuid4()),
                                            reverse_differences=self._reverse,
                                            forward_differences=self._forward)))
+        if self._simulation_id is not None:
+            msg['input']['simulation_id'] = self._simulation_id
         return msg.copy()

{gridappsd_python-2024.6.0 → gridappsd_python-2024.8.1a1}/gridappsd/topics.py

@@ -80,7 +80,7 @@ def platform_log_topic():
     return "/topic/{}.{}".format(BASE_TOPIC_PREFIX, "platform.log")
 
 
-def service_input_topic(service_id, simulation_id):
+def service_input_topic(service_id: str, simulation_id: int | str | None = None):
     """ Utility method for getting the input topic for a specific service.
 
     The service id should be the registered service with the platform.  One
@@ -95,11 +95,14 @@ def service_input_topic(service_id, simulation_id):
     :return:
     """
     assert service_id, "service_id cannot be empty"
-    assert simulation_id, "simulation_id cannot be empty"
-    return "{}.{}.{}.input".format(BASE_SIMULATION_TOPIC, service_id, simulation_id)
 
+    if simulation_id:
+        return f"{BASE_SIMULATION_TOPIC}.{service_id}.{simulation_id}.input"
 
-def service_output_topic(service_id, simulation_id):
+    return f"{BASE_SIMULATION_TOPIC}.{service_id}.input"
+
+
+def service_output_topic(service_id: str, simulation_id: int | str | None = None):
     """ Utility method for getting the output topic for a specific service.
 
     The service id should be the registered service with the platform.  One
@@ -114,11 +117,14 @@ def service_output_topic(service_id, simulation_id):
     :return:str: Topic to subscribe to for service specific output.
     """
     assert service_id, "Service id cannot be empty"
-    assert simulation_id, "Simulation id cannot be empty"
-    return "{}.{}.{}.output".format(BASE_SIMULATION_TOPIC, service_id, simulation_id)
 
+    if simulation_id:
+        return f"{BASE_SIMULATION_TOPIC}.{service_id}.{simulation_id}.output"
+
+    return f"{BASE_SIMULATION_TOPIC}.{service_id}.output"
 
-def application_input_topic(application_id, simulation_id):
+
+def application_input_topic(application_id: str, simulation_id: int | str | None = None):
     """ Utility method for getting the input topic for a specific application.
 
     The application_id should be the registered service with the platform.  One
@@ -130,11 +136,14 @@ def application_input_topic(application_id, simulation_id):
     :return:str: Topic to publish to for a specific application.
     """
     assert application_id, "application_id cannot be empty"
-    assert simulation_id, "simulation_id cannot be empty"
-    return "{}.{}.{}.input".format(BASE_SIMULATION_TOPIC, application_id, simulation_id)
 
+    if simulation_id:
+        return f"{BASE_SIMULATION_TOPIC}.{application_id}.{simulation_id}.input"
+
+    return f"{BASE_TOPIC}.{application_id}.input"
 
-def application_output_topic(application_id, simulation_id):
+
+def application_output_topic(application_id: str, simulation_id: int | str | None = None):
     """ Utility method for getting the output topic for a specific application.
 
     The application_id should be the registered service with the platform.  One
@@ -146,11 +155,11 @@ def application_output_topic(application_id, simulation_id):
     :return: str: Topic to subscribe to for application specific output.
     """
     assert application_id, "application_id cannot be empty"
-    #assert simulation_id, "simulation_id cannot be empty"
-    if simulation_id is None:
-        return "{}.{}.output".format(BASE_TOPIC, application_id)
-    else:
-        return "{}.{}.{}.output".format(BASE_SIMULATION_TOPIC, application_id, simulation_id)
+
+    if simulation_id:
+        return f"{BASE_SIMULATION_TOPIC}.{application_id}.{simulation_id}.output"
+
+    return f"{BASE_TOPIC}.{application_id}.output"
 
 
 def simulation_output_topic(simulation_id):

{gridappsd_python-2024.6.0 → gridappsd_python-2024.8.1a1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gridappsd-python"
-version = "2024.6.0"
+version = "2024.8.1a1"
 description = "A GridAPPS-D Python Adapter"
 authors = [
     "C. Allwardt <3979063+craig8@users.noreply.github.com>",