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

s2python/s2_parser.py

@@ -0,0 +1,113 @@
+import json
+import logging
+from typing import Optional, TypeVar, Union, Type, Dict
+
+from s2python.common import (
+    Handshake,
+    HandshakeResponse,
+    InstructionStatusUpdate,
+    PowerForecast,
+    PowerMeasurement,
+    ReceptionStatus,
+    ResourceManagerDetails,
+    RevokeObject,
+    SelectControlType,
+    SessionRequest,
+)
+from s2python.frbc import (
+    FRBCActuatorStatus,
+    FRBCFillLevelTargetProfile,
+    FRBCInstruction,
+    FRBCLeakageBehaviour,
+    FRBCStorageStatus,
+    FRBCSystemDescription,
+    FRBCTimerStatus,
+    FRBCUsageForecast,
+)
+from s2python.validate_values_mixin import S2Message
+from s2python.s2_validation_error import S2ValidationError
+
+
+LOGGER = logging.getLogger(__name__)
+S2MessageType = str
+
+M = TypeVar("M", bound=S2Message)
+
+
+# May be generated with development_utilities/generate_s2_message_type_to_class.py
+TYPE_TO_MESSAGE_CLASS: Dict[str, Type[S2Message]] = {
+    "FRBC.ActuatorStatus": FRBCActuatorStatus,
+    "FRBC.FillLevelTargetProfile": FRBCFillLevelTargetProfile,
+    "FRBC.Instruction": FRBCInstruction,
+    "FRBC.LeakageBehaviour": FRBCLeakageBehaviour,
+    "FRBC.StorageStatus": FRBCStorageStatus,
+    "FRBC.SystemDescription": FRBCSystemDescription,
+    "FRBC.TimerStatus": FRBCTimerStatus,
+    "FRBC.UsageForecast": FRBCUsageForecast,
+    "Handshake": Handshake,
+    "HandshakeResponse": HandshakeResponse,
+    "InstructionStatusUpdate": InstructionStatusUpdate,
+    "PowerForecast": PowerForecast,
+    "PowerMeasurement": PowerMeasurement,
+    "ReceptionStatus": ReceptionStatus,
+    "ResourceManagerDetails": ResourceManagerDetails,
+    "RevokeObject": RevokeObject,
+    "SelectControlType": SelectControlType,
+    "SessionRequest": SessionRequest,
+}
+
+
+class S2Parser:
+    @staticmethod
+    def _parse_json_if_required(unparsed_message: Union[dict, str]) -> dict:
+        if isinstance(unparsed_message, str):
+            return json.loads(unparsed_message)
+        return unparsed_message
+
+    @staticmethod
+    def parse_as_any_message(unparsed_message: Union[dict, str]) -> S2Message:
+        """Parse the message as any S2 python message regardless of message type.
+
+        :param unparsed_message: The message as a JSON-formatted string or as a json-parsed dictionary.
+        :raises: S2ValidationError, json.JSONDecodeError
+        :return: The parsed S2 message if no errors were found.
+        """
+        message_json = S2Parser._parse_json_if_required(unparsed_message)
+        message_type = S2Parser.parse_message_type(message_json)
+
+        if message_type not in TYPE_TO_MESSAGE_CLASS:
+            raise S2ValidationError(
+                message_json,
+                f"Unable to parse {message_type} as an S2 message. Type unknown.",
+            )
+
+        return TYPE_TO_MESSAGE_CLASS[message_type].parse_obj(message_json)
+
+    @staticmethod
+    def parse_as_message(unparsed_message: Union[dict, str], as_message: Type[M]) -> M:
+        """Parse the message to a specific S2 python message.
+
+        :param unparsed_message: The message as a JSON-formatted string or as a JSON-parsed dictionary.
+        :param as_message: The type of message that is expected within the `message`
+        :raises: S2ValidationError, json.JSONDecodeError
+        :return: The parsed S2 message if no errors were found.
+        """
+        message_json = S2Parser._parse_json_if_required(unparsed_message)
+        return as_message.from_dict(message_json)
+
+    @staticmethod
+    def parse_message_type(
+        unparsed_message: Union[dict, str]
+    ) -> Optional[S2MessageType]:
+        """Parse only the message type from the unparsed message.
+
+        This is useful to call before `parse_as_message` to retrieve the message type and allows for strictly-typed
+        parsing.
+
+        :param unparsed_message: The message as a JSON-formatted string or as a JSON-parsed dictionary.
+        :raises: json.JSONDecodeError
+        :return: The parsed S2 message type if no errors were found.
+        """
+        message_json = S2Parser._parse_json_if_required(unparsed_message)
+
+        return message_json.get("message_type")

s2python/s2_validation_error.py

@@ -1,9 +1,12 @@
+from typing import Union
+
 from pydantic import ValidationError
 
+
 class S2ValidationError(Exception):
     obj: object
     msg: str
-    pydantic_validation_error: 'ValidationError | TypeError | None'
+    pydantic_validation_error: Union[ValidationError, TypeError, None]
 
     def __init__(self, obj: object, msg: str):
         self.obj = obj

s2python/utils.py

@@ -1,3 +1,8 @@
-def pairwise(arr : list):
-    for i in range(max(len(arr) - 1,0)):
-        yield (arr[i], arr[i+1])
+from typing import Generator, Tuple, List, TypeVar
+
+P = TypeVar("P")
+
+
+def pairwise(arr: List[P]) -> Generator[Tuple[P, P], None, None]:
+    for i in range(max(len(arr) - 1, 0)):
+        yield arr[i], arr[i + 1]

s2python/validate_values_mixin.py

@@ -1,28 +1,57 @@
-from typing import TypeVar, Generic, Protocol, Type, Tuple, Optional, Callable, cast, Any, Union, AbstractSet, Mapping, List, Dict
-
-from pydantic import BaseModel, StrBytes, Protocol as PydanticProtocol, ValidationError
+from typing import (
+    TypeVar,
+    Generic,
+    Protocol,
+    Type,
+    Optional,
+    Callable,
+    Any,
+    Union,
+    AbstractSet,
+    Mapping,
+    List,
+    Dict,
+)
+
+from pydantic import (  # pylint: disable=no-name-in-module
+    BaseModel,
+    StrBytes,
+    Protocol as PydanticProtocol,
+    ValidationError,
+)
+from pydantic.error_wrappers import display_errors  # pylint: disable=no-name-in-module
 
 from s2python.s2_validation_error import S2ValidationError
 
-B = TypeVar('B', bound=BaseModel, covariant=True)
+B_co = TypeVar("B_co", bound=BaseModel, covariant=True)
 
 IntStr = Union[int, str]
 AbstractSetIntStr = AbstractSet[IntStr]
 MappingIntStrAny = Mapping[IntStr, Any]
 
-class SupportsValidation(Protocol[B]):
+
+class SupportsValidation(Protocol[B_co]):
     # ValidateValuesMixin methods
-    def to_json(self) -> str: ...
-    def to_dict(self) -> dict: ...
+    def to_json(self) -> str:
+        ...
+
+    def to_dict(self) -> Dict:
+        ...
 
     @classmethod
-    def from_json(cls, json_str: str) -> B: ...
+    def from_json(cls, json_str: str) -> B_co:
+        ...
+
+    @classmethod
+    def from_dict(cls, json_dict: Dict) -> B_co:
+        ...
 
     # Pydantic methods
-    def json(self,
+    def json(  # pylint: disable=too-many-arguments
+        self,
         *,
-        include: Optional[Union['AbstractSetIntStr', 'MappingIntStrAny']] = None,
-        exclude: Optional[Union['AbstractSetIntStr', 'MappingIntStrAny']] = None,
+        include: Optional[Union["AbstractSetIntStr", "MappingIntStrAny"]] = None,
+        exclude: Optional[Union["AbstractSetIntStr", "MappingIntStrAny"]] = None,
         by_alias: bool = False,
         skip_defaults: Optional[bool] = None,
         exclude_unset: bool = False,
@@ -31,31 +60,40 @@ class SupportsValidation(Protocol[B]):
         encoder: Optional[Callable[[Any], Any]] = None,
         models_as_dict: bool = True,
         **dumps_kwargs: Any,
-    ) -> str: ...
-
-    def dict(
-            self,
-            *,
-            include: Optional[Union['AbstractSetIntStr', 'MappingIntStrAny']] = None,
-            exclude: Optional[Union['AbstractSetIntStr', 'MappingIntStrAny']] = None,
-            by_alias: bool = False,
-            skip_defaults: Optional[bool] = None,
-            exclude_unset: bool = False,
-            exclude_defaults: bool = False,
-            exclude_none: bool = False,
-    ) -> Dict[str, Any]: ...
+    ) -> str:
+        ...
+
+    def dict(  # pylint: disable=too-many-arguments
+        self,
+        *,
+        include: Optional[Union["AbstractSetIntStr", "MappingIntStrAny"]] = None,
+        exclude: Optional[Union["AbstractSetIntStr", "MappingIntStrAny"]] = None,
+        by_alias: bool = False,
+        skip_defaults: Optional[bool] = None,
+        exclude_unset: bool = False,
+        exclude_defaults: bool = False,
+        exclude_none: bool = False,
+    ) -> Dict[str, Any]:
+        ...
 
     @classmethod
-    def parse_raw(cls,
-                  b: StrBytes,
-                  *,
-                  content_type: str = ...,
-                  encoding: str = ...,
-                  proto: PydanticProtocol = ...,
-                  allow_pickle: bool = ...) -> B: ...
+    def parse_raw(  # pylint: disable=too-many-arguments
+        cls,
+        b: StrBytes,
+        *,
+        content_type: str = ...,
+        encoding: str = ...,
+        proto: PydanticProtocol = ...,
+        allow_pickle: bool = ...,
+    ) -> B_co:
+        ...
 
+    @classmethod
+    def parse_obj(cls, obj: Any) -> "B_co":
+        ...
 
-C = TypeVar('C', bound='SupportsValidation')
+
+C = TypeVar("C", bound="SupportsValidation")
 
 
 class ValidateValuesMixin(Generic[C]):
@@ -63,7 +101,9 @@ class ValidateValuesMixin(Generic[C]):
         try:
             return self.json(by_alias=True, exclude_none=True)
         except (ValidationError, TypeError) as e:
-            raise S2ValidationError(self, 'Pydantic raised a format validation error.') from e
+            raise S2ValidationError(
+                self, "Pydantic raised a format validation error."
+            ) from e
 
     def to_dict(self: C) -> dict:
         return self.dict()
@@ -73,13 +113,24 @@ class ValidateValuesMixin(Generic[C]):
         gen_model: C = cls.parse_raw(json_str)
         return gen_model
 
+    @classmethod
+    def from_dict(cls: Type[C], json_dict: dict) -> C:
+        gen_model: C = cls.parse_obj(json_dict)
+        return gen_model
+
+
+class S2Message(Generic[C], ValidateValuesMixin[C], BaseModel):
+    pass
 
-def convert_to_s2exception(f : Callable) -> Callable:
+
+def convert_to_s2exception(f: Callable) -> Callable:
     def inner(*args: List[Any], **kwargs: Dict[str, Any]) -> Any:
         try:
             return f(*args, **kwargs)
-        except (ValidationError, TypeError) as e:
-            raise S2ValidationError(args, 'Pydantic raised a format validation error.') from e
+        except ValidationError as e:
+            raise S2ValidationError(args, display_errors(e.errors())) from e
+        except TypeError as e:
+            raise S2ValidationError(args, str(e)) from e
 
     inner.__doc__ = f.__doc__
     inner.__annotations__ = f.__annotations__
@@ -87,7 +138,9 @@ def convert_to_s2exception(f : Callable) -> Callable:
     return inner
 
 
-def catch_and_convert_exceptions(input_class: Type[SupportsValidation[B]]) -> Type[SupportsValidation[B]]:
+def catch_and_convert_exceptions(
+    input_class: Type[SupportsValidation[B_co]],
+) -> Type[SupportsValidation[B_co]]:
     input_class.__init__ = convert_to_s2exception(input_class.__init__)  # type: ignore[method-assign]
     input_class.__setattr__ = convert_to_s2exception(input_class.__setattr__)  # type: ignore[method-assign]
     input_class.parse_raw = convert_to_s2exception(input_class.parse_raw)  # type: ignore[method-assign]

s2python/version.py

@@ -1 +1 @@
-VERSION = '0.2.0'
+VERSION = "0.2.0"

s2_python-0.0.0.dist-info/METADATA

@@ -1,50 +0,0 @@
-Metadata-Version: 2.1
-Name: s2-python
-Version: 0.0.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
-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: pylint ; extra == 'testing'
-
-Python Wrapper for S2 Flexibility Protocol
-===========================================
-
-
-Install for development:
-
-    pip install -e .[testing,development]
-
-
-Run tests:
-    pip install -e .[testing,development]
-    tox
-
-Build
-    tox -e build,clean
-    

s2_python-0.0.0.dist-info/RECORD

@@ -1,49 +0,0 @@
-s2python/__init__.py,sha256=aLCMCipFsPGFEsc8ritsDiYDSUBTW5kA34N_3po08p8,352
-s2python/s2_validation_error.py,sha256=AordALh8VENfP9Mrva49OtwaejhG6uxV3AAYp3ZbTeA,265
-s2python/utils.py,sha256=FiPSJcu2uaizPXgrsIzvNyq7tvQpBDV4Vkn_BzWMJMA,100
-s2python/validate_values_mixin.py,sha256=hNZoPyKzhEX0V8LY29E-9HA3tG3gtVEwzyDa0hoZ958,3343
-s2python/version.py,sha256=Te87yKMugWziDTANt72vxbLxpfD405Ve4s9uS1gESGU,18
-s2python/common/__init__.py,sha256=4MDCbNpUhFTEKD0LYfCjRgJsObybaDM6He41LUmtVVc,1341
-s2python/common/duration.py,sha256=UzZZo3iEB-fJOg4wzbQgniEvb4IjOld2vRWQLqOSrrQ,668
-s2python/common/handshake.py,sha256=DboFxNv-yKSdrV3v3_o7i_U6TXCS9isCUHnuOpwxiew,447
-s2python/common/handshake_response.py,sha256=9Du70SEO1uuAj2vcujR8utuwXfj3MEKqSbspfdr3zCU,503
-s2python/common/instruction_status_update.py,sha256=2_N0Xb0Efw_CZ9LS6Q722pcpsSbGPzZfeRx1bZeLeBQ,672
-s2python/common/number_range.py,sha256=81dJWm0uQac9uK22ZvSxIsLnOjvvCnIWXD-2TJVqpKc,1023
-s2python/common/power_forecast.py,sha256=xNujNZACtsyYK0k7lk-qbnSfTbv6CE6Ear9YBGipBQg,670
-s2python/common/power_forecast_element.py,sha256=D_NRNSprzkZ4k7q1XCfn6GVUylPc28mCzzXRXH_b9i8,723
-s2python/common/power_forecast_value.py,sha256=TzvMpgjE8llbR3OjN8SV0VRoLJ07C5fX1861FmjH1Bc,382
-s2python/common/power_measurement.py,sha256=aj9AxR1Exsgn-oPV8gQdw5OE5WLSStrRTIXr9hRMsxY,670
-s2python/common/power_range.py,sha256=PBbn0oqhdE8xbhjRgWRMbEMflPY0z0lhbtW1Jxdz9_I,708
-s2python/common/power_value.py,sha256=-sl-AdrA9Rw_x4laoj7BuDgsCXCDRhEA2yLjjApbDcE,334
-s2python/common/reception_status.py,sha256=BA535UhrZC_Uq5g8YLDipAlEAdmjjjrdh11NMhJJmFo,505
-s2python/common/resource_manager_details.py,sha256=bdxZUN4Ngzr8_tPKJ9hgWzdz8e01zU5AU2r-tuyfuj8,987
-s2python/common/revoke_object.py,sha256=ySM5cHrCt7mFvdVmxol6cHj-t-SOlgOR_t3k2iYTRk0,574
-s2python/common/role.py,sha256=grW98IKir4kIe4UROOv1wKoQt9N3_n-ZpqXFrStMiXg,298
-s2python/common/select_control_type.py,sha256=1xCM75Pn77B5izQJI8TSufb7CW4bnSrGt2Y7MF2ewf0,503
-s2python/common/session_request.py,sha256=pKYUNnstQO1WccG5ilIz-mDkX6AkzuZ6lPXqufb_AhY,481
-s2python/common/support.py,sha256=OvOGXz3zPUy-kFmYwBRn2hcM81I8I-BuHBxPfahTXIo,1000
-s2python/common/timer.py,sha256=ekS15yp0F-cQ1kWUksQRmLxwcfxvb2auc27QmoDScrU,545
-s2python/common/transition.py,sha256=v2L-omP3XPKiP8N3cwolNyQLuGBBCgSavUSJXIGbQUU,1066
-s2python/frbc/__init__.py,sha256=vOgcsODtqo5ojg9brRKeDCdS-WI4Mn_WOJIayGe6gP0,1095
-s2python/frbc/frbc_actuator_description.py,sha256=h4cxlOSBaEZdYv6t_MGvIo2558W0dJ5yTvKrY6LQXGU,6077
-s2python/frbc/frbc_actuator_status.py,sha256=FXwpeLnMq52l2sQ8myDSESP4T6y045Ul5ap7FDWZB3g,952
-s2python/frbc/frbc_fill_level_target_profile.py,sha256=JqJ3CxSQfOS3ylmadbJvGys7Bl6t5dxu6ShsEL28PgE,798
-s2python/frbc/frbc_fill_level_target_profile_element.py,sha256=73uZWePP9Lgo95H1ZaxONpvGzTMo3TCHUceQIr4N-8c,791
-s2python/frbc/frbc_instruction.py,sha256=2MH_axt5PPVtRbE39IcyR3EHiz5KDgznHYK7BhXFvuA,817
-s2python/frbc/frbc_leakage_behaviour.py,sha256=yC9OoE5RJ8pco4pm4CRcmlTy62hGXBsPFstN9g6RCAU,738
-s2python/frbc/frbc_leakage_behaviour_element.py,sha256=ZFChN7OITRQ22ayqKfk_W8UupfugWCmPsYiJIDVOk4Q,614
-s2python/frbc/frbc_operation_mode.py,sha256=ETK8ZHILZ8yWVu9iRhYruJxrvCfAciaei_dZZfADX4s,1847
-s2python/frbc/frbc_operation_mode_element.py,sha256=nzKRHtouZaJBsE1DRW2t026pyUWWM-7knjrY_Tx22rk,1029
-s2python/frbc/frbc_storage_description.py,sha256=liP59YnT68Tdr-9I6PKqtMuW10BjWbT54Hq5WUGNleU,579
-s2python/frbc/frbc_storage_status.py,sha256=btFuwqebbVo0R8Evc22tfl6omrMD7LuUMkTAkDX6z6U,503
-s2python/frbc/frbc_system_description.py,sha256=dPdaRcEUsYMbp-tJq8uVpb5BY6oed-OHAXOAMphrC8o,888
-s2python/frbc/frbc_timer_status.py,sha256=a0ILHtugiIrMUJTybOe0KVLI_X3Y8RZn7s3TcnLzPkc,709
-s2python/frbc/frbc_usage_forecast.py,sha256=r4m0kB9k8B9ppT9FwSg9SS4uxRiOJRB4-OWBEqyouss,708
-s2python/frbc/frbc_usage_forecast_element.py,sha256=WAXdAbyRFWuyrZx4MLkbOpGp82XeNMWIz8xCdBsjiq4,572
-s2python/generated/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-s2python/generated/gen_s2.py,sha256=6CGPuVnK-6OgmxOhPWKQxgCwbF1LWMlBB_gooa6yaCE,61928
-s2_python-0.0.0.dist-info/METADATA,sha256=59s-SoyBxwko5KGq_6_IVzWz9enzuF9IhdkFO09dflA,1513
-s2_python-0.0.0.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-s2_python-0.0.0.dist-info/entry_points.txt,sha256=feX-xmgJZgSe5-jxMgFKPKCJz4Ys3eQcGrsXsirNZyM,61
-s2_python-0.0.0.dist-info/top_level.txt,sha256=OLFq0oDhr77Mp-EYLEcWk5P3jvooOt4IHkTI5KYJMc8,9
-s2_python-0.0.0.dist-info/RECORD,,