s2-python 0.0.0__py3-none-any.whl → 0.1.0__py3-none-any.whl

s2_python-0.1.0.dist-info/METADATA

@@ -0,0 +1,99 @@
+Metadata-Version: 2.1
+Name: s2-python
+Version: 0.1.0
+Summary: S2 Protocol Python Wrapper
+Home-page: https://github.com/flexiblepower/s2-ws-json-python
+Author: Flexiblepower
+Author-email: info@info.nl
+License: APACHE
+Platform: Linux
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Description-Content-Type: text/x-rst; charset=UTF-8
+Requires-Dist: pydantic ~=1.10.7
+Requires-Dist: pytz
+Requires-Dist: click
+Provides-Extra: development
+Requires-Dist: pip-tools ; extra == 'development'
+Requires-Dist: datamodel-code-generator ; extra == 'development'
+Requires-Dist: pre-commit ; extra == 'development'
+Requires-Dist: tox ; extra == 'development'
+Provides-Extra: docs
+Requires-Dist: sphinx ; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme >=1.2 ; extra == 'docs'
+Requires-Dist: sphinx-tabs ; extra == 'docs'
+Requires-Dist: sphinx-copybutton ; extra == 'docs'
+Requires-Dist: sphinx-fontawesome ; extra == 'docs'
+Requires-Dist: sphinxcontrib.httpdomain ; extra == 'docs'
+Provides-Extra: testing
+Requires-Dist: pytest ; extra == 'testing'
+Requires-Dist: pytest-coverage ; extra == 'testing'
+Requires-Dist: pytest-timer ; extra == 'testing'
+Requires-Dist: mypy ; extra == 'testing'
+Requires-Dist: types-pytz ; extra == 'testing'
+Requires-Dist: pylint ; extra == 'testing'
+
+Python Wrapper for S2 Flexibility Protocol
+===========================================
+.. image:: https://img.shields.io/pypi/v/s2-python
+   :alt: PyPI - Version
+.. image:: https://img.shields.io/pypi/pyversions/s2-python
+   :alt: PyPI - Python Version
+.. image:: https://img.shields.io/pypi/l/s2-python
+   :alt: PyPI - License
+
+This Python package implements the message validation for the EN50491-12-2 "S2" standard for home and building energy management. This implementation
+is based on the asyncapi description of the protocol provided in the `s2-ws-json <https://github.com/flexiblepower/s2-ws-json/>`_ repository. 
+
+Currently, the package supports the *common* and *FILL RATE BASED CONTROL* types and messages.
+
+To Install
+-----------
+You can install this package using pip or any Python dependency manager that collects the packages from Pypi:
+
+.. code-block:: bash
+
+    pip install s2-python
+
+The packages on Pypi may be found `here <https://pypi.org/project/s2-python/>`_
+
+Example
+---------
+
+.. code-block:: python
+
+    from s2python.common import PowerRange, CommodityQuantity
+
+    # create s2 messages as Python objects
+    number_range = PowerRange(
+        start_of_range=4.0,
+        end_of_range=5.0,
+        commodity_quantity=CommodityQuantity.ELECTRIC_POWER_L1,
+    )
+    # serialize s2 messages
+    number_range.to_json()
+    # deserialize s2 messages
+    json_str = '{"start_of_range": 4.0, "end_of_range": 5.0, "commodity_quantity": "ELECTRIC.POWER.L1"}'
+    PowerRange.from_json(json_str)
+
+Development
+-------------
+
+For development, you can install the required dependencies using the following command:
+
+    pip install -e .[testing,development]
+
+
+The tests can be run using tox:
+
+    tox
+
+To build the package, you can use tox as well:
+
+    tox -e build,clean
+    
+
+

s2_python-0.1.0.dist-info/RECORD

@@ -0,0 +1,50 @@
+s2python/__init__.py,sha256=e5lwvqsPl-z7IfEd0hRQhLBRKBYcuw2eqrecXnMfLdg,384
+s2python/s2_parser.py,sha256=4oN4qBeW7RVNcXQ8GVib_oodK1_gszCrcXMQjPqRGUI,4088
+s2python/s2_validation_error.py,sha256=fdV2tdRhYslDStTw8Cvb3mly7PpLiCbXbrkfOe3n2_w,295
+s2python/utils.py,sha256=QX9b-mi-H_YUGTmGmJsrAbaWWM3dgaoaRLRXHHlaZDE,212
+s2python/validate_values_mixin.py,sha256=RbhxqqhfhsNoTSeRxb7msQ6nEZWwAoUH6EQKkZkzH4k,4109
+s2python/version.py,sha256=w9Iw7QVvd8lme2wKwEbCo5IgetVjSfFBOOYAcA_Q0Ns,18
+s2python/common/__init__.py,sha256=fVJ0n13kRzzAtJcOxZHz3CEDexWXnyueJMcEXGdq_88,1345
+s2python/common/duration.py,sha256=fMuftby-8wLeqpLKXd7VQqcmgTUUhTmWSW53R2b2vHM,661
+s2python/common/handshake.py,sha256=IsbA41wBN4n0jopHn-vNDf2y1HP47p2kahM3NSwxAfc,440
+s2python/common/handshake_response.py,sha256=Pa7kwRUFiecvPU84-z3D9_woxGqM4-_G9XtLgVmzMKA,496
+s2python/common/instruction_status_update.py,sha256=w3bbVZ8jF3VBLKe3Q3fhWK9WhldxkkNgSzXuXyPzklA,694
+s2python/common/number_range.py,sha256=NRND5K1-_U_6S4lVxfszI4A9o8hFYCrFQieska_ELgU,1163
+s2python/common/power_forecast.py,sha256=-i1Z4JMGpmoo4N2DfmzMYiEh7o25xxsesKkUxhSWjAw,700
+s2python/common/power_forecast_element.py,sha256=nQopGR0-uuE9jGyg2L-zusvkVACWqMJNxOyjm3PJYI4,787
+s2python/common/power_forecast_value.py,sha256=UHiP8Go64RW6VzszzmAZ3JIyaGf2WOMGyx_PTmdmBoY,375
+s2python/common/power_measurement.py,sha256=l_Na6Yw6twQveLw6j6FsX6BQh0fbmveHdHdsmnDzegs,675
+s2python/common/power_range.py,sha256=Pazitj5zPzH2rz0gnKAzinwEhM28Dftglf3z6sHjIqA,796
+s2python/common/power_value.py,sha256=xpu-MV_lkFYksfVDRRFbWiha8fA7KAF_p3CBoNNoyyg,327
+s2python/common/reception_status.py,sha256=yd3tzG8UNMCjPy3WXpgMHjYnuFW3wyCv82tnq2kgEME,512
+s2python/common/resource_manager_details.py,sha256=YOKnw7wMAX5JIt3LAnxfCvG0kTZjshHF8Yotfzyqbew,1050
+s2python/common/revoke_object.py,sha256=EWuTqHoVyaPO-eIcFSCE7zROJXyR6RWkajX60IL8aM8,567
+s2python/common/role.py,sha256=PV0noDy3D30dIodJgIWfGWcz-4hwZyBnpsWkyjc8c7g,291
+s2python/common/select_control_type.py,sha256=y6yXcuCGPsm-QKSg6jJTzfUzAbZqvMkWepMhXERVQlM,496
+s2python/common/session_request.py,sha256=bCnyAjSdeLShAC513x7ifaNRKZLAdzoJF2rU_zXxZEI,475
+s2python/common/support.py,sha256=Kbrf_KGB45Wfr8j2pqDe1lLde6CIr3nl_LYkWnilmV0,1015
+s2python/common/timer.py,sha256=-KhxxyJwK0pfVrpLBg9thYzOb2-LB5FgRBznwKCu76Y,538
+s2python/common/transition.py,sha256=pYfo4sfWdnBR2Tvn3cW34zVT53d4PZSc3Ee3mubAYAg,1096
+s2python/frbc/__init__.py,sha256=ROV3qZoldPkdgVFfMQr5Mf3GDfBzXaMfhNNCuXY6T0s,1104
+s2python/frbc/frbc_actuator_description.py,sha256=9Zzzjhii3vABsLPOIN6qGavs0YyWthNV7whjcJadyGY,6801
+s2python/frbc/frbc_actuator_status.py,sha256=xnTqGyh_h03BsBWRQfV7SMHn1yZV2KLV02FpIgojzr4,973
+s2python/frbc/frbc_fill_level_target_profile.py,sha256=0kGB-uD0mqOZPdRBn_EJ8rMrA6DfTHMk7_nsSm7icRA,896
+s2python/frbc/frbc_fill_level_target_profile_element.py,sha256=fqYwvbfEAM-e_hbUB6MN9NjGoCCdBcd-VGtmB9UyLbc,832
+s2python/frbc/frbc_instruction.py,sha256=y8hZqh1jDKWVwehweWHQnbkFiSHlY87T4Al5kxEH9rQ,809
+s2python/frbc/frbc_leakage_behaviour.py,sha256=CAuIAgaBDv82rPHmjJYchuVQilKLLjIOfI71UDnKXYk,776
+s2python/frbc/frbc_leakage_behaviour_element.py,sha256=Bvw_4zuS5PgoZu_Pwy9kFCst75JbQyGKSvxOU7owYCA,636
+s2python/frbc/frbc_operation_mode.py,sha256=bkMxQMP1pxF4rb0plUzBnFv7IG261lDq3FDf0HId0uE,2030
+s2python/frbc/frbc_operation_mode_element.py,sha256=Bc5pJDwd83SbJiFYT2GA6sTzeLtsa8ohAM8LuY3uRc4,1079
+s2python/frbc/frbc_storage_description.py,sha256=bxFVxYPhNCejMjBJtIiGjCCS7fyoOXHc3TUeWho7CYM,601
+s2python/frbc/frbc_storage_status.py,sha256=PZCs-fh43in7LlYjalygW57iRQWwBp51tVEoZemS9-Y,496
+s2python/frbc/frbc_system_description.py,sha256=RefubMI735vDV-cp6FEAEDe4bfcEYwY_EhCu5rC1oSs,991
+s2python/frbc/frbc_timer_status.py,sha256=tyhjNia_I2j6rSggFiXp8i6QcZRiqhcOkMtn_TkXQ0Q,702
+s2python/frbc/frbc_usage_forecast.py,sha256=8zWLBYpRfjiPKRz5x0QiZ2IF8HDGA8qlUgbOofAsQPA,743
+s2python/frbc/frbc_usage_forecast_element.py,sha256=OuwrN4KarVe4tq6R4qkNz5j-sQstQDzLWP4g5B6L-iw,580
+s2python/generated/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+s2python/generated/gen_s2.py,sha256=DXLCNE1gUS7XnRTgWlBpy73szr5HrHcrN0TZXvq8N_g,61928
+s2_python-0.1.0.dist-info/METADATA,sha256=-V9F_j0oh6IkAVzrcX5oFFyY7bON8FwRwc7NUsLjIM4,3257
+s2_python-0.1.0.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
+s2_python-0.1.0.dist-info/entry_points.txt,sha256=feX-xmgJZgSe5-jxMgFKPKCJz4Ys3eQcGrsXsirNZyM,61
+s2_python-0.1.0.dist-info/top_level.txt,sha256=OLFq0oDhr77Mp-EYLEcWk5P3jvooOt4IHkTI5KYJMc8,9
+s2_python-0.1.0.dist-info/RECORD,,

{s2_python-0.0.0.dist-info → s2_python-0.1.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.2)
+Generator: bdist_wheel (0.41.3)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

s2python/__init__.py

@@ -2,7 +2,7 @@ from importlib.metadata import PackageNotFoundError, version  # pragma: no cover
 
 try:
     # Change here if project is renamed and does not equal the package name
-    dist_name = "s2-python"
+    dist_name = "s2-python"  # pylint: disable=invalid-name
     __version__ = version(dist_name)
 except PackageNotFoundError:  # pragma: no cover
     __version__ = "unknown"

s2python/common/__init__.py

@@ -1,5 +1,15 @@
-from s2python.generated.gen_s2 import (RoleType, CommodityQuantity, Commodity, InstructionStatus, ReceptionStatusValues,
-                                       EnergyManagementRole, SessionRequestType, ControlType, Currency, RevokableObjects)
+from s2python.generated.gen_s2 import (
+    RoleType,
+    CommodityQuantity,
+    Commodity,
+    InstructionStatus,
+    ReceptionStatusValues,
+    EnergyManagementRole,
+    SessionRequestType,
+    ControlType,
+    Currency,
+    RevokableObjects,
+)
 
 from s2python.common.duration import Duration
 from s2python.common.role import Role

s2python/common/duration.py

@@ -2,18 +2,21 @@ from datetime import timedelta
 import math
 
 from s2python.generated.gen_s2 import Duration as GenDuration
-from s2python.validate_values_mixin import catch_and_convert_exceptions, ValidateValuesMixin
+from s2python.validate_values_mixin import (
+    catch_and_convert_exceptions,
+    S2Message,
+)
 
 
 @catch_and_convert_exceptions
-class Duration(GenDuration, ValidateValuesMixin['Duration']):
+class Duration(GenDuration, S2Message["Duration"]):
     def to_timedelta(self) -> timedelta:
         return timedelta(milliseconds=self.__root__)
 
     @staticmethod
-    def from_timedelta(duration: timedelta) -> 'Duration':
+    def from_timedelta(duration: timedelta) -> "Duration":
         return Duration(__root__=math.ceil(duration.total_seconds() * 1000))
 
     @staticmethod
-    def from_milliseconds(milliseconds: int) -> 'Duration':
+    def from_milliseconds(milliseconds: int) -> "Duration":
         return Duration(__root__=milliseconds)

s2python/common/handshake.py

@@ -1,12 +1,15 @@
 import uuid
 
 from s2python.generated.gen_s2 import Handshake as GenHandshake
-from s2python.validate_values_mixin import catch_and_convert_exceptions, ValidateValuesMixin
+from s2python.validate_values_mixin import (
+    catch_and_convert_exceptions,
+    S2Message,
+)
 
 
 @catch_and_convert_exceptions
-class Handshake(GenHandshake, ValidateValuesMixin['Handshake']):
+class Handshake(GenHandshake, S2Message["Handshake"]):
     class Config(GenHandshake.Config):
         validate_assignment = True
 
-    message_id: uuid.UUID = GenHandshake.__fields__['message_id'].field_info  # type: ignore[assignment]
+    message_id: uuid.UUID = GenHandshake.__fields__["message_id"].field_info  # type: ignore[assignment]

s2python/common/handshake_response.py

@@ -1,12 +1,15 @@
 import uuid
 
 from s2python.generated.gen_s2 import HandshakeResponse as GenHandshakeResponse
-from s2python.validate_values_mixin import catch_and_convert_exceptions, ValidateValuesMixin
+from s2python.validate_values_mixin import (
+    catch_and_convert_exceptions,
+    S2Message,
+)
 
 
 @catch_and_convert_exceptions
-class HandshakeResponse(GenHandshakeResponse, ValidateValuesMixin['HandshakeResponse']):
+class HandshakeResponse(GenHandshakeResponse, S2Message["HandshakeResponse"]):
     class Config(GenHandshakeResponse.Config):
         validate_assignment = True
 
-    message_id: uuid.UUID = GenHandshakeResponse.__fields__['message_id'].field_info  # type: ignore[assignment]
+    message_id: uuid.UUID = GenHandshakeResponse.__fields__["message_id"].field_info  # type: ignore[assignment]

s2python/common/instruction_status_update.py

@@ -1,13 +1,22 @@
 import uuid
 
-from s2python.generated.gen_s2 import InstructionStatusUpdate as GenInstructionStatusUpdate
-from s2python.validate_values_mixin import catch_and_convert_exceptions, ValidateValuesMixin
+from s2python.generated.gen_s2 import (
+    InstructionStatusUpdate as GenInstructionStatusUpdate,
+)
+from s2python.validate_values_mixin import (
+    catch_and_convert_exceptions,
+    S2Message,
+)
 
 
 @catch_and_convert_exceptions
-class InstructionStatusUpdate(GenInstructionStatusUpdate, ValidateValuesMixin['InstructionStatusUpdate']):
+class InstructionStatusUpdate(
+    GenInstructionStatusUpdate, S2Message["InstructionStatusUpdate"]
+):
     class Config(GenInstructionStatusUpdate.Config):
         validate_assignment = True
 
-    message_id: uuid.UUID = GenInstructionStatusUpdate.__fields__['message_id'].field_info  # type: ignore[assignment]
-    instruction_id: uuid.UUID = GenInstructionStatusUpdate.__fields__['instruction_id'].field_info  # type: ignore[assignment]
+    message_id: uuid.UUID = GenInstructionStatusUpdate.__fields__["message_id"].field_info  # type: ignore[assignment]
+    instruction_id: uuid.UUID = GenInstructionStatusUpdate.__fields__[
+        "instruction_id"
+    ].field_info  # type: ignore[assignment]

s2python/common/number_range.py

@@ -2,26 +2,38 @@ from typing import Any, Dict
 
 from pydantic import root_validator
 
-from s2python.validate_values_mixin import ValidateValuesMixin, catch_and_convert_exceptions
+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, ValidateValuesMixin['NumberRange']):
+class NumberRange(GenNumberRange, S2Message["NumberRange"]):
     class Config(GenNumberRange.Config):
         validate_assignment = True
 
     @root_validator(pre=False)
-    def validate_start_end_order(cls, values: Dict[str, Any]) -> Dict[str, Any]:
+    @classmethod
+    def validate_start_end_order(  # pylint: disable=duplicate-code
+        cls, values: Dict[str, Any]
+    ) -> Dict[str, Any]:
         if values.get("start_of_range", 0.0) > values.get("end_of_range", 0.0):
-            raise ValueError(cls, 'start_of_range should not be higher than end_of_range')
+            raise ValueError(
+                cls, "start_of_range should not be higher than end_of_range"
+            )
 
         return values
 
-    def __hash__(self):
-        return hash(f'{self.start_of_range}|{self.end_of_range}')
+    def __hash__(self) -> int:
+        return hash(f"{self.start_of_range}|{self.end_of_range}")
 
-    def __eq__(self, other):
+    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
-        else:
-            return False
+            return (
+                self.start_of_range == other.start_of_range
+                and self.end_of_range == other.end_of_range
+            )
+
+        return False

s2python/common/power_forecast.py

@@ -1,15 +1,20 @@
 from typing import List
 import uuid
 
-from s2python.common import PowerForecastElement
+from s2python.common.power_forecast_element import PowerForecastElement
 from s2python.generated.gen_s2 import PowerForecast as GenPowerForecast
-from s2python.validate_values_mixin import catch_and_convert_exceptions, ValidateValuesMixin
+from s2python.validate_values_mixin import (
+    catch_and_convert_exceptions,
+    S2Message,
+)
 
 
 @catch_and_convert_exceptions
-class PowerForecast(GenPowerForecast, ValidateValuesMixin['PowerForecast']):
+class PowerForecast(GenPowerForecast, S2Message["PowerForecast"]):
     class Config(GenPowerForecast.Config):
         validate_assignment = True
 
-    message_id: uuid.UUID = GenPowerForecast.__fields__['message_id'].field_info  # type: ignore[assignment]
-    elements: List[PowerForecastElement] = GenPowerForecast.__fields__['elements'].field_info  # type: ignore[assignment]
+    message_id: uuid.UUID = GenPowerForecast.__fields__["message_id"].field_info  # type: ignore[assignment]
+    elements: List[PowerForecastElement] = GenPowerForecast.__fields__[
+        "elements"
+    ].field_info  # type: ignore[assignment]

s2python/common/power_forecast_element.py

@@ -1,14 +1,20 @@
 from typing import List
 
 from s2python.generated.gen_s2 import PowerForecastElement as GenPowerForecastElement
-from s2python.validate_values_mixin import catch_and_convert_exceptions, ValidateValuesMixin
-from s2python.common import Duration, PowerForecastValue
+from s2python.validate_values_mixin import (
+    catch_and_convert_exceptions,
+    S2Message,
+)
+from s2python.common.duration import Duration
+from s2python.common.power_forecast_value import PowerForecastValue
 
 
 @catch_and_convert_exceptions
-class PowerForecastElement(GenPowerForecastElement, ValidateValuesMixin['PowerForecastElement']):
+class PowerForecastElement(GenPowerForecastElement, S2Message["PowerForecastElement"]):
     class Config(GenPowerForecastElement.Config):
         validate_assignment = True
 
-    duration: Duration = GenPowerForecastElement.__fields__['duration'].field_info  # type: ignore[assignment]
-    power_values: List[PowerForecastValue] = GenPowerForecastElement.__fields__['power_values'].field_info  # type: ignore[assignment]
+    duration: Duration = GenPowerForecastElement.__fields__["duration"].field_info  # type: ignore[assignment]
+    power_values: List[PowerForecastValue] = GenPowerForecastElement.__fields__[
+        "power_values"
+    ].field_info  # type: ignore[assignment]

s2python/common/power_forecast_value.py

@@ -1,8 +1,11 @@
 from s2python.generated.gen_s2 import PowerForecastValue as GenPowerForecastValue
-from s2python.validate_values_mixin import catch_and_convert_exceptions, ValidateValuesMixin
+from s2python.validate_values_mixin import (
+    catch_and_convert_exceptions,
+    S2Message,
+)
 
 
 @catch_and_convert_exceptions
-class PowerForecastValue(GenPowerForecastValue, ValidateValuesMixin['PowerForecastValue']):
+class PowerForecastValue(GenPowerForecastValue, S2Message["PowerForecastValue"]):
     class Config(GenPowerForecastValue.Config):
         validate_assignment = True

s2python/common/power_measurement.py

@@ -1,15 +1,18 @@
 from typing import List
 import uuid
 
-from s2python.common import PowerValue
+from s2python.common.power_value import PowerValue
 from s2python.generated.gen_s2 import PowerMeasurement as GenPowerMeasurement
-from s2python.validate_values_mixin import catch_and_convert_exceptions, ValidateValuesMixin
+from s2python.validate_values_mixin import (
+    catch_and_convert_exceptions,
+    S2Message,
+)
 
 
 @catch_and_convert_exceptions
-class PowerMeasurement(GenPowerMeasurement, ValidateValuesMixin['PowerMeasurement']):
+class PowerMeasurement(GenPowerMeasurement, S2Message["PowerMeasurement"]):
     class Config(GenPowerMeasurement.Config):
         validate_assignment = True
 
-    message_id: uuid.UUID = GenPowerMeasurement.__fields__['message_id'].field_info  # type: ignore[assignment]
-    values: List[PowerValue] = GenPowerMeasurement.__fields__['values'].field_info  # type: ignore[assignment]
+    message_id: uuid.UUID = GenPowerMeasurement.__fields__["message_id"].field_info  # type: ignore[assignment]
+    values: List[PowerValue] = GenPowerMeasurement.__fields__["values"].field_info  # type: ignore[assignment]

s2python/common/power_range.py

@@ -3,17 +3,25 @@ from typing import Any, Dict
 from pydantic import root_validator
 
 from s2python.generated.gen_s2 import PowerRange as GenPowerRange
-from s2python.validate_values_mixin import ValidateValuesMixin, catch_and_convert_exceptions
+from s2python.validate_values_mixin import (
+    S2Message,
+    catch_and_convert_exceptions,
+)
 
 
 @catch_and_convert_exceptions
-class PowerRange(GenPowerRange, ValidateValuesMixin['PowerRange']):
+class PowerRange(GenPowerRange, S2Message["PowerRange"]):
     class Config(GenPowerRange.Config):
         validate_assignment = True
 
     @root_validator(pre=False)
-    def validate_start_end_order(cls, values: Dict[str, Any]) -> Dict[str, Any]:
+    @classmethod
+    def validate_start_end_order(
+        cls, values: Dict[str, Any]
+    ) -> Dict[str, Any]:  # pylint: disable=duplicate-code
         if values.get("start_of_range", 0.0) > values.get("end_of_range", 0.0):
-            raise ValueError(cls, 'start_of_range should not be higher than end_of_range')
+            raise ValueError(
+                cls, "start_of_range should not be higher than end_of_range"
+            )
 
         return values

s2python/common/power_value.py

@@ -1,8 +1,11 @@
 from s2python.generated.gen_s2 import PowerValue as GenPowerValue
-from s2python.validate_values_mixin import catch_and_convert_exceptions, ValidateValuesMixin
+from s2python.validate_values_mixin import (
+    catch_and_convert_exceptions,
+    S2Message,
+)
 
 
 @catch_and_convert_exceptions
-class PowerValue(GenPowerValue, ValidateValuesMixin['PowerValue']):
+class PowerValue(GenPowerValue, S2Message["PowerValue"]):
     class Config(GenPowerValue.Config):
         validate_assignment = True

s2python/common/reception_status.py

@@ -1,12 +1,17 @@
 import uuid
 
 from s2python.generated.gen_s2 import ReceptionStatus as GenReceptionStatus
-from s2python.validate_values_mixin import catch_and_convert_exceptions, ValidateValuesMixin
+from s2python.validate_values_mixin import (
+    catch_and_convert_exceptions,
+    S2Message,
+)
 
 
 @catch_and_convert_exceptions
-class ReceptionStatus(GenReceptionStatus, ValidateValuesMixin['ReceptionStatus']):
+class ReceptionStatus(GenReceptionStatus, S2Message["ReceptionStatus"]):
     class Config(GenReceptionStatus.Config):
         validate_assignment = True
 
-    subject_message_id: uuid.UUID = GenReceptionStatus.__fields__['subject_message_id'].field_info  # type: ignore[assignment]
+    subject_message_id: uuid.UUID = GenReceptionStatus.__fields__[
+        "subject_message_id"
+    ].field_info  # type: ignore[assignment]

s2python/common/resource_manager_details.py

@@ -1,17 +1,27 @@
 from typing import List
 import uuid
 
-from s2python.common import Duration, Role
-from s2python.generated.gen_s2 import ResourceManagerDetails as GenResourceManagerDetails
-from s2python.validate_values_mixin import catch_and_convert_exceptions, ValidateValuesMixin
+from s2python.common.duration import Duration
+from s2python.common.role import Role
+from s2python.generated.gen_s2 import (
+    ResourceManagerDetails as GenResourceManagerDetails,
+)
+from s2python.validate_values_mixin import (
+    catch_and_convert_exceptions,
+    S2Message,
+)
 
 
 @catch_and_convert_exceptions
-class ResourceManagerDetails(GenResourceManagerDetails, ValidateValuesMixin['ResourceManagerDetails']):
+class ResourceManagerDetails(
+    GenResourceManagerDetails, S2Message["ResourceManagerDetails"]
+):
     class Config(GenResourceManagerDetails.Config):
         validate_assignment = True
 
-    instruction_processing_delay: Duration = GenResourceManagerDetails.__fields__['instruction_processing_delay'].field_info  # type: ignore[assignment]
-    message_id: uuid.UUID = GenResourceManagerDetails.__fields__['message_id'].field_info  # type: ignore[assignment]
-    resource_id: uuid.UUID = GenResourceManagerDetails.__fields__['resource_id'].field_info  # type: ignore[assignment]
-    roles: List[Role] = GenResourceManagerDetails.__fields__['roles'].field_info  # type: ignore[assignment]
+    instruction_processing_delay: Duration = GenResourceManagerDetails.__fields__[
+        "instruction_processing_delay"
+    ].field_info  # type: ignore[assignment]
+    message_id: uuid.UUID = GenResourceManagerDetails.__fields__["message_id"].field_info  # type: ignore[assignment]
+    resource_id: uuid.UUID = GenResourceManagerDetails.__fields__["resource_id"].field_info  # type: ignore[assignment]
+    roles: List[Role] = GenResourceManagerDetails.__fields__["roles"].field_info  # type: ignore[assignment]

s2python/common/revoke_object.py

@@ -1,13 +1,16 @@
 import uuid
 
 from s2python.generated.gen_s2 import RevokeObject as GenRevokeObject
-from s2python.validate_values_mixin import catch_and_convert_exceptions, ValidateValuesMixin
+from s2python.validate_values_mixin import (
+    catch_and_convert_exceptions,
+    S2Message,
+)
 
 
 @catch_and_convert_exceptions
-class RevokeObject(GenRevokeObject, ValidateValuesMixin['RevokeObject']):
+class RevokeObject(GenRevokeObject, S2Message["RevokeObject"]):
     class Config(GenRevokeObject.Config):
         validate_assignment = True
 
-    message_id: uuid.UUID = GenRevokeObject.__fields__['message_id'].field_info  # type: ignore[assignment]
-    object_id: uuid.UUID = GenRevokeObject.__fields__['object_id'].field_info  # type: ignore[assignment]
+    message_id: uuid.UUID = GenRevokeObject.__fields__["message_id"].field_info  # type: ignore[assignment]
+    object_id: uuid.UUID = GenRevokeObject.__fields__["object_id"].field_info  # type: ignore[assignment]

s2python/common/role.py

@@ -1,8 +1,11 @@
 from s2python.generated.gen_s2 import Role as GenRole
-from s2python.validate_values_mixin import ValidateValuesMixin, catch_and_convert_exceptions
+from s2python.validate_values_mixin import (
+    S2Message,
+    catch_and_convert_exceptions,
+)
 
 
 @catch_and_convert_exceptions
-class Role(GenRole, ValidateValuesMixin['Role']):
+class Role(GenRole, S2Message["Role"]):
     class Config(GenRole.Config):
         validate_assignment = True

s2python/common/select_control_type.py

@@ -1,12 +1,15 @@
 import uuid
 
 from s2python.generated.gen_s2 import SelectControlType as GenSelectControlType
-from s2python.validate_values_mixin import catch_and_convert_exceptions, ValidateValuesMixin
+from s2python.validate_values_mixin import (
+    catch_and_convert_exceptions,
+    S2Message,
+)
 
 
 @catch_and_convert_exceptions
-class SelectControlType(GenSelectControlType, ValidateValuesMixin['SelectControlType']):
+class SelectControlType(GenSelectControlType, S2Message["SelectControlType"]):
     class Config(GenSelectControlType.Config):
         validate_assignment = True
 
-    message_id: uuid.UUID = GenSelectControlType.__fields__['message_id'].field_info  # type: ignore[assignment]
+    message_id: uuid.UUID = GenSelectControlType.__fields__["message_id"].field_info  # type: ignore[assignment]

s2python/common/session_request.py

@@ -1,12 +1,15 @@
 import uuid
 
 from s2python.generated.gen_s2 import SessionRequest as GenSessionRequest
-from s2python.validate_values_mixin import catch_and_convert_exceptions, ValidateValuesMixin
+from s2python.validate_values_mixin import (
+    catch_and_convert_exceptions,
+    S2Message,
+)
 
 
 @catch_and_convert_exceptions
-class SessionRequest(GenSessionRequest, ValidateValuesMixin['SessionRequest']):
+class SessionRequest(GenSessionRequest, S2Message["SessionRequest"]):
     class Config(GenSessionRequest.Config):
         validate_assignment = True
 
-    message_id: uuid.UUID = GenSessionRequest.__fields__['message_id'].field_info  # type: ignore[assignment]
+    message_id: uuid.UUID = GenSessionRequest.__fields__["message_id"].field_info  # type: ignore[assignment]

s2python/common/support.py

@@ -1,19 +1,27 @@
 from s2python.common import CommodityQuantity, Commodity
 
 
-def commodity_has_quantity(commodity: 'Commodity', quantity: CommodityQuantity) -> bool:
+def commodity_has_quantity(commodity: "Commodity", quantity: CommodityQuantity) -> bool:
     if commodity == Commodity.HEAT:
-        return quantity in [CommodityQuantity.HEAT_THERMAL_POWER,
-                            CommodityQuantity.HEAT_TEMPERATURE,
-                            CommodityQuantity.HEAT_FLOW_RATE]
+        result = quantity in [
+            CommodityQuantity.HEAT_THERMAL_POWER,
+            CommodityQuantity.HEAT_TEMPERATURE,
+            CommodityQuantity.HEAT_FLOW_RATE,
+        ]
     elif commodity == Commodity.ELECTRICITY:
-        return quantity in [CommodityQuantity.ELECTRIC_POWER_3_PHASE_SYMMETRIC,
-                            CommodityQuantity.ELECTRIC_POWER_L1,
-                            CommodityQuantity.ELECTRIC_POWER_L2,
-                            CommodityQuantity.ELECTRIC_POWER_L3]
+        result = quantity in [
+            CommodityQuantity.ELECTRIC_POWER_3_PHASE_SYMMETRIC,
+            CommodityQuantity.ELECTRIC_POWER_L1,
+            CommodityQuantity.ELECTRIC_POWER_L2,
+            CommodityQuantity.ELECTRIC_POWER_L3,
+        ]
     elif commodity == Commodity.GAS:
-        return quantity in [CommodityQuantity.NATURAL_GAS_FLOW_RATE]
+        result = quantity in [CommodityQuantity.NATURAL_GAS_FLOW_RATE]
     elif commodity == Commodity.OIL:
-        return quantity in [CommodityQuantity.OIL_FLOW_RATE]
+        result = quantity in [CommodityQuantity.OIL_FLOW_RATE]
     else:
-        raise RuntimeError(f'Unsupported commodity {commodity}. Missing implementation.')
+        raise RuntimeError(
+            f"Unsupported commodity {commodity}. Missing implementation."
+        )
+
+    return result