gridappsd-python 2024.6.0__tar.gz → 2025.2.1__tar.gz

{gridappsd_python-2024.6.0 → gridappsd_python-2025.2.1}/PKG-INFO

@@ -1,25 +1,24 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: gridappsd-python
-Version: 2024.6.0
+Version: 2025.2.1
 Summary: A GridAPPS-D Python Adapter
-Home-page: https://gridappsd.readthedocs.io
 License: BSD-3-Clause
-Keywords: gridappsd,grid,activmq,powergrid,simulation,library
+Keywords: gridappsd,grid,activemq,powergrid,simulation,library
 Author: C. Allwardt
 Author-email: 3979063+craig8@users.noreply.github.com
-Requires-Python: >=3.7.9,<4.0
+Requires-Python: >=3.10,<4.0
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: PyYAML (>=6.0,<7.0)
 Requires-Dist: dateutils (>=0.6.7,<0.7.0)
 Requires-Dist: pytz (>=2022.7,<2023.0)
 Requires-Dist: requests (==2.28.2)
 Requires-Dist: stomp-py (==6.0.0)
+Project-URL: Homepage, https://gridappsd.readthedocs.io
 Project-URL: Repository, https://github.com/GRIDAPPSD/gridappsd-python
 Description-Content-Type: text/markdown
 

{gridappsd_python-2024.6.0 → gridappsd_python-2025.2.1}/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-2025.2.1/gridappsd/field_interface/__init__.py

@@ -0,0 +1,32 @@
+import logging
+import sys
+
+_log = logging.getLogger(__name__)
+
+try:
+    import warnings
+
+    import gridappsd_field_bus.field_interface.context as _context
+    import gridappsd_field_bus.field_interface.context_managers as _context_managers
+    import gridappsd_field_bus.field_interface as _field_interface
+    import gridappsd_field_bus.field_interface.agents as _agents
+    import gridappsd_field_bus.field_interface.field_proxy_forwarder as _field_proxy_forwarder
+    import gridappsd_field_bus.field_interface.gridappsd_field_bus as _gridappsd_field_bus
+    import gridappsd_field_bus.field_interface.interfaces as _interfaces
+
+    sys.modules['gridappsd.field_interface'] = _field_interface
+    sys.modules['gridappsd.field_interface.interfaces'] = _interfaces
+    sys.modules['gridappsd.field_interface.context_managers'] = _context_managers
+    sys.modules['gridappsd_.context_managers'] = _context_managers
+    sys.modules['gridappsd.field_interface.agents'] = _agents
+    sys.modules['gridappsd.field_interface.field_proxy_forwarder'] = _field_proxy_forwarder
+    sys.modules['gridappsd.field_interface.gridappsd_field_bus'] = _gridappsd_field_bus
+
+
+
+
+
+    warnings.warn(message="gridappsd.field_interface is deprecated and will be removed in a future release. Use gridappsd_field_bus.field_interface instead.",
+                  category=DeprecationWarning)
+except ImportError:
+    _log.error("Could not import field_interface install gridappsd-field-bus to get those functions.")

{gridappsd_python-2024.6.0 → gridappsd_python-2025.2.1}/gridappsd/goss.py

@@ -88,7 +88,8 @@ class GOSS(object):
                  attempt_connection=True,
                  override_threading=None,
                  stomp_log_level=logging.WARNING,
-                 goss_log_level=logging.INFO):
+                 goss_log_level=logging.INFO,
+                 use_auth_token=True):
 
         logging.getLogger('stomp.py').setLevel(stomp_log_level)
         logging.getLogger('goss').setLevel(goss_log_level)
@@ -97,6 +98,7 @@ class GOSS(object):
         self.__pass__ = password
         self.stomp_address = stomp_address
         self.stomp_port = stomp_port
+        self.use_auth_token = use_auth_token
 
         # Environmental variables should overrule the passed arguments.
         if os.environ.get(GRIDAPPSD_ENV_ENUM.GRIDAPPSD_USER.value):
@@ -289,7 +291,7 @@ class GOSS(object):
     def _make_connection(self):
         if self._conn is None or not self._conn.is_connected():
             _log.debug("Creating connection")
-            if not self.__token:
+            if self.use_auth_token is True and not self.__token:
 
                 # get token
                 # get initial connection
@@ -351,7 +353,10 @@ class GOSS(object):
             if self._override_thread_fc is not None:
                 self._conn.transport.override_threading(self._override_thread_fc)
             try:
-                self._conn.connect(self.__token, "", wait=True)
+                if self.use_auth_token and self.__token is not None:
+                    self._conn.connect(self.__token, "", wait=True)
+                else:
+                    self._conn.connect(self.__user__,self.__pass__, wait=True)
             except TypeError as e:
                 _log.error("TypeError: {e}".format(e=e))
             except NotConnectedException as e:

{gridappsd_python-2024.6.0 → gridappsd_python-2025.2.1}/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-2025.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gridappsd-python"
-version = "2024.6.0"
+version = "2025.02.1"
 description = "A GridAPPS-D Python Adapter"
 authors = [
     "C. Allwardt <3979063+craig8@users.noreply.github.com>",
@@ -12,7 +12,7 @@ license = "BSD-3-Clause"
 repository = "https://github.com/GRIDAPPSD/gridappsd-python"
 homepage = "https://gridappsd.readthedocs.io"
 
-keywords = ["gridappsd", "grid", "activmq", "powergrid", "simulation", "library"]
+keywords = ["gridappsd", "grid", "activemq", "powergrid", "simulation", "library"]
 
 readme = "README.md"
 
@@ -29,7 +29,7 @@ gridappsd-cli = 'gridappsd.cli:_main'
 
 
 [tool.poetry.dependencies]
-python = ">=3.7.9,<4.0"
+python = ">=3.10,<4.0"
 PyYAML = "^6.0"
 pytz = "^2022.7"
 dateutils = "^0.6.7"
@@ -37,13 +37,14 @@ stomp-py = "6.0.0"
 requests = "2.28.2"
 
 [tool.poetry.group.dev.dependencies]
-pytest = "^6.2.2"
+pytest = "^8.3.4"
 pytest-html = "^3.1.1"
 mock = "^4.0.3"
 yapf = "^0.32.0"
 mypy = "^1.3.0"
 python-on-whales = "^0.60.1"
 gitpython = "^3.1.31"
+pre-commit = "^4.1.0"
 
 [build-system]
 requires = ["poetry-core>=1.2.0"]