s2-python 0.2.1__tar.gz → 0.3.0__tar.gz

{s2_python-0.2.1 → s2_python-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: s2-python
-Version: 0.2.1
+Version: 0.3.0
 Summary: S2 Protocol Python Wrapper
 Home-page: https://github.com/flexiblepower/s2-ws-json-python
 Author: Flexiblepower
@@ -17,7 +17,7 @@ Description-Content-Type: text/x-rst; charset=UTF-8
 Requires-Dist: pydantic~=2.8.2
 Requires-Dist: pytz
 Requires-Dist: click
-Requires-Dist: websockets~=13.0.1
+Requires-Dist: websockets~=13.1
 Provides-Extra: testing
 Requires-Dist: pytest; extra == "testing"
 Requires-Dist: pytest-coverage; extra == "testing"
@@ -62,6 +62,18 @@ You can install this package using pip or any Python dependency manager that col
 
 The packages on Pypi may be found `here <https://pypi.org/project/s2-python/>`_
 
+Mypy support
+------------
+s2-python uses pydantic at its core to define the various S2 messages. As such, the pydantic mypy plugin is required
+for type checking to succeed.
+
+Add to your pyproject.toml:
+
+.. code-block:: toml
+
+    [tool.mypy]
+    plugins = ['pydantic.mypy']
+
 Example
 ---------
 

{s2_python-0.2.1 → s2_python-0.3.0}/README.rst

@@ -22,6 +22,18 @@ You can install this package using pip or any Python dependency manager that col
 
 The packages on Pypi may be found `here <https://pypi.org/project/s2-python/>`_
 
+Mypy support
+------------
+s2-python uses pydantic at its core to define the various S2 messages. As such, the pydantic mypy plugin is required
+for type checking to succeed.
+
+Add to your pyproject.toml:
+
+.. code-block:: toml
+
+    [tool.mypy]
+    plugins = ['pydantic.mypy']
+
 Example
 ---------
 

{s2_python-0.2.1 → s2_python-0.3.0}/setup.cfg

@@ -8,7 +8,7 @@ license_files = LICENSE.txt
 long_description = file: README.rst
 long_description_content_type = text/x-rst; charset=UTF-8
 url = https://github.com/flexiblepower/s2-ws-json-python
-version = 0.2.1
+version = 0.3.0
 platforms = Linux
 classifiers = 
 	Development Status :: 4 - Beta
@@ -29,7 +29,7 @@ install_requires =
 	pydantic~=2.8.2
 	pytz
 	click
-	websockets~=13.0.1
+	websockets~=13.1
 
 [options.packages.find]
 where = src

{s2_python-0.2.1 → s2_python-0.3.0}/src/s2_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: s2-python
-Version: 0.2.1
+Version: 0.3.0
 Summary: S2 Protocol Python Wrapper
 Home-page: https://github.com/flexiblepower/s2-ws-json-python
 Author: Flexiblepower
@@ -17,7 +17,7 @@ Description-Content-Type: text/x-rst; charset=UTF-8
 Requires-Dist: pydantic~=2.8.2
 Requires-Dist: pytz
 Requires-Dist: click
-Requires-Dist: websockets~=13.0.1
+Requires-Dist: websockets~=13.1
 Provides-Extra: testing
 Requires-Dist: pytest; extra == "testing"
 Requires-Dist: pytest-coverage; extra == "testing"
@@ -62,6 +62,18 @@ You can install this package using pip or any Python dependency manager that col
 
 The packages on Pypi may be found `here <https://pypi.org/project/s2-python/>`_
 
+Mypy support
+------------
+s2-python uses pydantic at its core to define the various S2 messages. As such, the pydantic mypy plugin is required
+for type checking to succeed.
+
+Add to your pyproject.toml:
+
+.. code-block:: toml
+
+    [tool.mypy]
+    plugins = ['pydantic.mypy']
+
 Example
 ---------
 

{s2_python-0.2.1 → s2_python-0.3.0}/src/s2_python.egg-info/SOURCES.txt

@@ -10,6 +10,7 @@ src/s2_python.egg-info/not-zip-safe
 src/s2_python.egg-info/requires.txt
 src/s2_python.egg-info/top_level.txt
 src/s2python/__init__.py
+src/s2python/py.typed
 src/s2python/reception_status_awaiter.py
 src/s2python/s2_connection.py
 src/s2python/s2_control_type.py

{s2_python-0.2.1 → s2_python-0.3.0}/src/s2_python.egg-info/requires.txt

@@ -1,7 +1,7 @@
 pydantic~=2.8.2
 pytz
 click
-websockets~=13.0.1
+websockets~=13.1
 
 [development]
 pip-tools

s2_python-0.3.0/src/s2python/common/number_range.py

@@ -0,0 +1,22 @@
+from typing import Any
+
+from s2python.validate_values_mixin import S2Message, catch_and_convert_exceptions
+from s2python.generated.gen_s2 import NumberRange as GenNumberRange
+
+
+@catch_and_convert_exceptions
+class NumberRange(GenNumberRange, S2Message["NumberRange"]):
+    model_config = GenNumberRange.model_config
+    model_config["validate_assignment"] = True
+
+    def __hash__(self) -> int:
+        return hash(f"{self.start_of_range}|{self.end_of_range}")
+
+    def __eq__(self, other: Any) -> bool:
+        if isinstance(other, NumberRange):
+            return (
+                self.start_of_range == other.start_of_range
+                and self.end_of_range == other.end_of_range
+            )
+
+        return False

s2_python-0.3.0/src/s2python/frbc/frbc_fill_level_target_profile_element.py

@@ -0,0 +1,34 @@
+# pylint: disable=duplicate-code
+
+from typing_extensions import Self
+
+from pydantic import model_validator
+
+from s2python.common import Duration, NumberRange
+from s2python.generated.gen_s2 import (
+    FRBCFillLevelTargetProfileElement as GenFRBCFillLevelTargetProfileElement,
+)
+from s2python.validate_values_mixin import catch_and_convert_exceptions, S2Message
+
+
+@catch_and_convert_exceptions
+class FRBCFillLevelTargetProfileElement(
+    GenFRBCFillLevelTargetProfileElement, S2Message["FRBCFillLevelTargetProfileElement"]
+):
+    model_config = GenFRBCFillLevelTargetProfileElement.model_config
+    model_config["validate_assignment"] = True
+
+    duration: Duration = GenFRBCFillLevelTargetProfileElement.model_fields["duration"]  # type: ignore[assignment]
+    fill_level_range: NumberRange = GenFRBCFillLevelTargetProfileElement.model_fields[
+        "fill_level_range"
+    ]  # type: ignore[assignment]
+
+    @model_validator(mode="after")
+    def validate_start_end_order(self) -> Self:
+        if self.fill_level_range.start_of_range > self.fill_level_range.end_of_range:
+            raise ValueError(
+                self,
+                "start_of_range should not be higher than end_of_range for the fill_level_range",
+            )
+
+        return self

s2_python-0.3.0/src/s2python/frbc/frbc_leakage_behaviour_element.py

@@ -0,0 +1,30 @@
+# pylint: disable=duplicate-code
+
+from pydantic import model_validator
+from typing_extensions import Self
+
+from s2python.common import NumberRange
+from s2python.generated.gen_s2 import FRBCLeakageBehaviourElement as GenFRBCLeakageBehaviourElement
+from s2python.validate_values_mixin import catch_and_convert_exceptions, S2Message
+
+
+@catch_and_convert_exceptions
+class FRBCLeakageBehaviourElement(
+    GenFRBCLeakageBehaviourElement, S2Message["FRBCLeakageBehaviourElement"]
+):
+    model_config = GenFRBCLeakageBehaviourElement.model_config
+    model_config["validate_assignment"] = True
+
+    fill_level_range: NumberRange = GenFRBCLeakageBehaviourElement.model_fields[
+        "fill_level_range"
+    ]  # type: ignore[assignment]
+
+    @model_validator(mode="after")
+    def validate_start_end_order(self) -> Self:
+        if self.fill_level_range.start_of_range > self.fill_level_range.end_of_range:
+            raise ValueError(
+                self,
+                "start_of_range should not be higher than end_of_range for the fill_level_range",
+            )
+
+        return self

{s2_python-0.2.1 → s2_python-0.3.0}/src/s2python/s2_connection.py

@@ -1,6 +1,7 @@
 import asyncio
 import json
 import logging
+import time
 import threading
 import uuid
 from dataclasses import dataclass
@@ -180,6 +181,7 @@ class MessageHandlers:
 
 class S2Connection:  # pylint: disable=too-many-instance-attributes
     url: str
+    reconnect: bool
     reception_status_awaiter: ReceptionStatusAwaiter
     ws: Optional[WSConnection]
     s2_parser: S2Parser
@@ -195,16 +197,20 @@ class S2Connection:  # pylint: disable=too-many-instance-attributes
 
     _eventloop: asyncio.AbstractEventLoop
     _stop_event: asyncio.Event
+    _restart_connection_event: asyncio.Event
 
-    def __init__(
+    def __init__(  # pylint: disable=too-many-arguments
         self,
         url: str,
         role: EnergyManagementRole,
         control_types: List[S2ControlType],
         asset_details: AssetDetails,
+        reconnect: bool = False,
     ) -> None:
         self.url = url
+        self.reconnect = reconnect
         self.reception_status_awaiter = ReceptionStatusAwaiter()
+        self.ws = None
         self.s2_parser = S2Parser()
 
         self._handlers = MessageHandlers()
@@ -221,14 +227,13 @@ class S2Connection:  # pylint: disable=too-many-instance-attributes
         self._handlers.register_handler(HandshakeResponse, self.handle_handshake_response_as_rm)
 
     def start_as_rm(self) -> None:
-        self._thread = threading.Thread(target=self._run_eventloop, daemon=False)
-        self._thread.start()
-        logger.debug("Started eventloop thread!")
+        self._run_eventloop(self._run_as_rm())
 
-    def _run_eventloop(self) -> None:
+    def _run_eventloop(self, main_task: Awaitable[None]) -> None:
+        self._thread = threading.current_thread()
         logger.debug("Starting eventloop")
         try:
-            self._eventloop.run_until_complete(self._run_as_rm())
+            self._eventloop.run_until_complete(main_task)
         except asyncio.CancelledError:
             pass
         logger.debug("S2 connection thread has stopped.")
@@ -256,45 +261,69 @@ class S2Connection:  # pylint: disable=too-many-instance-attributes
 
     async def _run_as_rm(self) -> None:
         logger.debug("Connecting as S2 resource manager.")
-        self._received_messages = asyncio.Queue()
+
         self._stop_event = asyncio.Event()
-        await self.connect_ws()
 
-        background_tasks = []
-        background_tasks.append(self._eventloop.create_task(self._receive_messages()))
-        background_tasks.append(self._eventloop.create_task(self._handle_received_messages()))
+        first_run = True
 
-        async def wait_till_stop() -> None:
-            await self._stop_event.wait()
+        while (first_run or self.reconnect) and not self._stop_event.is_set():
+            first_run = False
+            self._restart_connection_event = asyncio.Event()
+            await self._connect_and_run()
+            time.sleep(1)
 
-        background_tasks.append(self._eventloop.create_task(wait_till_stop()))
+        logger.debug("Finished S2 connection eventloop.")
 
-        await self.connect_as_rm()
-        (done, pending) = await asyncio.wait(background_tasks, return_when=asyncio.FIRST_COMPLETED)
-        for task in done:
-            try:
-                await task
-            except asyncio.CancelledError:
-                pass
-            except websockets.ConnectionClosedError:
-                logger.info("The other party closed the websocket connection.c")
+    async def _connect_and_run(self) -> None:
+        self._received_messages = asyncio.Queue()
+        await self._connect_ws()
+        if self.ws:
 
-        for task in pending:
-            try:
-                task.cancel()
-                await task
-            except asyncio.CancelledError:
-                pass
+            async def wait_till_stop() -> None:
+                await self._stop_event.wait()
+
+            async def wait_till_connection_restart() -> None:
+                await self._restart_connection_event.wait()
+
+            background_tasks = [
+                self._eventloop.create_task(self._receive_messages()),
+                self._eventloop.create_task(wait_till_stop()),
+                self._eventloop.create_task(self._connect_as_rm()),
+                self._eventloop.create_task(wait_till_connection_restart()),
+            ]
+
+            (done, pending) = await asyncio.wait(
+                background_tasks, return_when=asyncio.FIRST_COMPLETED
+            )
+            if self._current_control_type:
+                self._current_control_type.deactivate(self)
+                self._current_control_type = None
+
+            for task in done:
+                try:
+                    await task
+                except asyncio.CancelledError:
+                    pass
+                except (websockets.ConnectionClosedError, websockets.ConnectionClosedOK):
+                    logger.info("The other party closed the websocket connection.")
+
+            for task in pending:
+                try:
+                    task.cancel()
+                    await task
+                except asyncio.CancelledError:
+                    pass
 
-        if self.ws:
             await self.ws.close()
             await self.ws.wait_closed()
-        logger.debug("Finished S2 connection eventloop.")
 
-    async def connect_ws(self) -> None:
-        self.ws = await ws_connect(uri=self.url)
+    async def _connect_ws(self) -> None:
+        try:
+            self.ws = await ws_connect(uri=self.url)
+        except (EOFError, OSError) as e:
+            logger.info("Could not connect due to: %s", str(e))
 
-    async def connect_as_rm(self) -> None:
+    async def _connect_as_rm(self) -> None:
         await self.send_msg_and_await_reception_status_async(
             Handshake(
                 message_id=uuid.uuid4(), role=self.role, supported_protocol_versions=[S2_VERSION]
@@ -302,6 +331,8 @@ class S2Connection:  # pylint: disable=too-many-instance-attributes
         )
         logger.debug("Send handshake to CEM. Expecting Handshake and HandshakeResponse from CEM.")
 
+        await self._handle_received_messages()
+
     async def handle_handshake(
         self, _: "S2Connection", message: S2Message, send_okay: Awaitable[None]
     ) -> None:
@@ -427,7 +458,11 @@ class S2Connection:  # pylint: disable=too-many-instance-attributes
 
         json_msg = s2_msg.to_json()
         logger.debug("Sending message %s", json_msg)
-        await self.ws.send(json_msg)
+        try:
+            await self.ws.send(json_msg)
+        except websockets.ConnectionClosedError as e:
+            logger.error("Unable to send message %s due to %s", s2_msg, str(e))
+            self._restart_connection_event.set()
 
     async def respond_with_reception_status(
         self, subject_message_id: str, status: ReceptionStatusValues, diagnostic_label: str
@@ -458,9 +493,17 @@ class S2Connection:  # pylint: disable=too-many-instance-attributes
             s2_msg.message_id,  # type: ignore[attr-defined]
             timeout_reception_status,
         )
-        reception_status = await self.reception_status_awaiter.wait_for_reception_status(
-            s2_msg.message_id, timeout_reception_status  # type: ignore[attr-defined]
-        )
+        try:
+            reception_status = await self.reception_status_awaiter.wait_for_reception_status(
+                s2_msg.message_id, timeout_reception_status  # type: ignore[attr-defined]
+            )
+        except TimeoutError:
+            logger.error(
+                "Did not receive a reception status on time for %s",
+                s2_msg.message_id,  # type: ignore[attr-defined]
+            )
+            self._stop_event.set()
+            raise
 
         if reception_status.status != ReceptionStatusValues.OK and raise_on_error:
             raise RuntimeError(f"ReceptionStatus was not OK but rather {reception_status.status}")

s2_python-0.2.1/src/s2python/common/number_range.py

@@ -1,32 +0,0 @@
-from typing import Any
-from typing_extensions import Self
-
-from pydantic import model_validator
-
-from s2python.validate_values_mixin import (
-    S2Message,
-    catch_and_convert_exceptions,
-)
-from s2python.generated.gen_s2 import NumberRange as GenNumberRange
-
-
-@catch_and_convert_exceptions
-class NumberRange(GenNumberRange, S2Message["NumberRange"]):
-    model_config = GenNumberRange.model_config
-    model_config["validate_assignment"] = True
-
-    @model_validator(mode="after")
-    def validate_start_end_order(self) -> Self:  # pylint: disable=duplicate-code
-        if self.start_of_range > self.end_of_range:
-            raise ValueError(self, "start_of_range should not be higher than end_of_range")
-
-        return self
-
-    def __hash__(self) -> int:
-        return hash(f"{self.start_of_range}|{self.end_of_range}")
-
-    def __eq__(self, other: Any) -> bool:
-        if isinstance(other, NumberRange):
-            return self.start_of_range == other.start_of_range and self.end_of_range == other.end_of_range
-
-        return False

s2_python-0.2.1/src/s2python/frbc/frbc_fill_level_target_profile_element.py

@@ -1,23 +0,0 @@
-from s2python.common import Duration, NumberRange
-
-from s2python.generated.gen_s2 import (
-    FRBCFillLevelTargetProfileElement as GenFRBCFillLevelTargetProfileElement,
-)
-from s2python.validate_values_mixin import (
-    catch_and_convert_exceptions,
-    S2Message,
-)
-
-
-@catch_and_convert_exceptions
-class FRBCFillLevelTargetProfileElement(
-    GenFRBCFillLevelTargetProfileElement,
-    S2Message["FRBCFillLevelTargetProfileElement"],
-):
-    model_config = GenFRBCFillLevelTargetProfileElement.model_config
-    model_config["validate_assignment"] = True
-
-    duration: Duration = GenFRBCFillLevelTargetProfileElement.model_fields["duration"]  # type: ignore[assignment]
-    fill_level_range: NumberRange = GenFRBCFillLevelTargetProfileElement.model_fields[
-        "fill_level_range"
-    ]  # type: ignore[assignment]

s2_python-0.2.1/src/s2python/frbc/frbc_leakage_behaviour_element.py

@@ -1,18 +0,0 @@
-from s2python.common import NumberRange
-from s2python.generated.gen_s2 import (
-    FRBCLeakageBehaviourElement as GenFRBCLeakageBehaviourElement,
-)
-from s2python.validate_values_mixin import (
-    catch_and_convert_exceptions,
-    S2Message,
-)
-
-
-@catch_and_convert_exceptions
-class FRBCLeakageBehaviourElement(GenFRBCLeakageBehaviourElement, S2Message["FRBCLeakageBehaviourElement"]):
-    model_config = GenFRBCLeakageBehaviourElement.model_config
-    model_config["validate_assignment"] = True
-
-    fill_level_range: NumberRange = GenFRBCLeakageBehaviourElement.model_fields[
-        "fill_level_range"
-    ]  # type: ignore[assignment]