s2-python 0.0.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

s2python/message.py

@@ -0,0 +1,47 @@
+from typing import Union
+
+from pydantic import BaseModel  # pylint: disable=no-name-in-module, unused-import; ignore E0611 and W0611
+
+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,
+)
+
+S2Message = Union[
+    FRBCActuatorStatus,
+    FRBCFillLevelTargetProfile,
+    FRBCInstruction,
+    FRBCLeakageBehaviour,
+    FRBCStorageStatus,
+    FRBCSystemDescription,
+    FRBCTimerStatus,
+    FRBCUsageForecast,
+    Handshake,
+    HandshakeResponse,
+    InstructionStatusUpdate,
+    PowerForecast,
+    PowerMeasurement,
+    ReceptionStatus,
+    ResourceManagerDetails,
+    RevokeObject,
+    SelectControlType,
+    SessionRequest,
+]

s2python/s2_parser.py

@@ -0,0 +1,112 @@
+import json
+import logging
+from typing import Dict, Optional, Type, TypeVar, Union
+
+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.s2_validation_error import S2ValidationError
+from s2python.validate_values_mixin import S2Message
+
+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,10 +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):
+from typing import Generator, List, Tuple, 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])
+        yield arr[i], arr[i + 1]

s2python/validate_values_mixin.py

@@ -1,45 +1,50 @@
 from typing import (
-    TypeVar,
+    AbstractSet,
+    Any,
+    Callable,
+    Dict,
     Generic,
+    List,
+    Mapping,
+    Optional,
     Protocol,
     Type,
-    Tuple,
-    Optional,
-    Callable,
-    cast,
-    Any,
+    TypeVar,
     Union,
-    AbstractSet,
-    Mapping,
-    List,
-    Dict,
 )
 
-from pydantic import BaseModel, StrBytes, Protocol as PydanticProtocol, ValidationError
+from pydantic import BaseModel  # pylint: disable=no-name-in-module; ignore E0611
+from pydantic import Protocol as PydanticProtocol  # pylint: disable=no-name-in-module
+from pydantic import StrBytes, ValidationError  # pylint: disable=no-name-in-module; ignore E0611
+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_dict(self) -> Dict:
+        ...
+
+    @classmethod
+    def from_json(cls, json_str: str) -> B_co:
         ...
 
     @classmethod
-    def from_json(cls, json_str: str) -> B:
+    def from_dict(cls, json_dict: Dict) -> B_co:
         ...
 
     # Pydantic methods
-    def json(
+    def json(  # pylint: disable=too-many-arguments
         self,
         *,
         include: Optional[Union["AbstractSetIntStr", "MappingIntStrAny"]] = None,
@@ -55,7 +60,7 @@ class SupportsValidation(Protocol[B]):
     ) -> str:
         ...
 
-    def dict(
+    def dict(  # pylint: disable=too-many-arguments
         self,
         *,
         include: Optional[Union["AbstractSetIntStr", "MappingIntStrAny"]] = None,
@@ -69,7 +74,7 @@ class SupportsValidation(Protocol[B]):
         ...
 
     @classmethod
-    def parse_raw(
+    def parse_raw(  # pylint: disable=too-many-arguments
         cls,
         b: StrBytes,
         *,
@@ -77,7 +82,11 @@ class SupportsValidation(Protocol[B]):
         encoding: str = ...,
         proto: PydanticProtocol = ...,
         allow_pickle: bool = ...,
-    ) -> B:
+    ) -> B_co:
+        ...
+
+    @classmethod
+    def parse_obj(cls, obj: Any) -> "B_co":
         ...
 
 
@@ -101,15 +110,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 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__
@@ -118,8 +136,8 @@ def convert_to_s2exception(f: Callable) -> Callable:
 
 
 def catch_and_convert_exceptions(
-    input_class: Type[SupportsValidation[B]],
-) -> Type[SupportsValidation[B]]:
+    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]

s2_python-0.0.1.dist-info/RECORD

@@ -1,49 +0,0 @@
-s2python/__init__.py,sha256=aLCMCipFsPGFEsc8ritsDiYDSUBTW5kA34N_3po08p8,352
-s2python/s2_validation_error.py,sha256=Veij_ReS0VCTC8fCRhxTgmZVVMCUiBu2VmtzYjJ6NBc,266
-s2python/utils.py,sha256=YJw3-i4fD_ud7rbm68VWE3PRjp-EgsnS_YtMxf6UnhA,102
-s2python/validate_values_mixin.py,sha256=CfRXeSkAOBBcS8zy4eNl3dx-01Sm6Wgn0bgTEhsdZks,3448
-s2python/version.py,sha256=w9Iw7QVvd8lme2wKwEbCo5IgetVjSfFBOOYAcA_Q0Ns,18
-s2python/common/__init__.py,sha256=fVJ0n13kRzzAtJcOxZHz3CEDexWXnyueJMcEXGdq_88,1345
-s2python/common/duration.py,sha256=-0_llJYXD5Z6Sx96XgY_unH3vcyCfhddxERAM7-8CGg,681
-s2python/common/handshake.py,sha256=v1JoZaYIk1faZFCAuf8sINq0xR_W03RaHhjkLODYLg4,460
-s2python/common/handshake_response.py,sha256=0o7miKQCWJ8cXFtvblQM81nUznyxZ2zrNrI22XAzTJg,516
-s2python/common/instruction_status_update.py,sha256=AzhgyIdcgtwbCAqNtUamFDttrMbyoMEqGD3qB-bFAgc,714
-s2python/common/number_range.py,sha256=b9KQ2XDyrcyqiHzN2rI7ldG-rsNk3b5os1BLDZOqTf4,1115
-s2python/common/power_forecast.py,sha256=zrFzR7Apg8OBkP_GQo4kseT2ZMjlinYRnh_KXe1e8vw,697
-s2python/common/power_forecast_element.py,sha256=MU6ndeMAkubJDrLfFON4IwyykCWHHqloQ_GvZp1Y-bo,756
-s2python/common/power_forecast_value.py,sha256=UP3IoyZVpkVhYrpN4CZvQHC8EQq7H_Q_S9BTs5us1KU,401
-s2python/common/power_measurement.py,sha256=Tiyb8ROub8m-tGCBQuZ8JTYV3d4HlyhqapP5Upvssms,683
-s2python/common/power_range.py,sha256=EQgFppktiusyZ6Ib7CKhx1-C167YQddgvVeu49xVY7o,751
-s2python/common/power_value.py,sha256=rqKXBrBwNCRpF13fl8zVhacxUQYPYPC2WbeP0OXZwdM,347
-s2python/common/reception_status.py,sha256=Vkj6ZzTkl-WYprszRStBuHIyKfoJW-gYp6NK6MuEwRo,532
-s2python/common/resource_manager_details.py,sha256=tDbR8hfaQ4Nz8po954HNm0YSJW95C7JomwTW1t5q33A,1029
-s2python/common/revoke_object.py,sha256=0KHb8klzsREE5oB1XwdXxBP_MIb3cQUDAz8V-Uv3moQ,587
-s2python/common/role.py,sha256=Vk732JKk05jOb6wPkG18me34kFT1MngKnLg1a8VWq5I,311
-s2python/common/select_control_type.py,sha256=bgZw9oePLBLAN7TEWwNsqMvO2zQMj3PdFUZ-KuqZfJk,516
-s2python/common/session_request.py,sha256=iDjW5HwDbAuwaJmpJROQAW3vqgNJddsLOKejWDPdbVc,495
-s2python/common/support.py,sha256=L08puzgMLvslKRqVQAnXH_Q5YRT5HTOPj8vDDNyzNYc,988
-s2python/common/timer.py,sha256=o2L48hefqC8cu6FAgjavjWMMnI8OxOHizP5zfL1abHY,558
-s2python/common/transition.py,sha256=k34bSvf8eU1Ys9SZkZKSye-NcxdSAqKjoWCNiT-8uxM,1107
-s2python/frbc/__init__.py,sha256=ROV3qZoldPkdgVFfMQr5Mf3GDfBzXaMfhNNCuXY6T0s,1104
-s2python/frbc/frbc_actuator_description.py,sha256=v2pWCUSGaw4IftMhNOjeLXE8B86XZNCyiZr3dQkziuo,6699
-s2python/frbc/frbc_actuator_status.py,sha256=Y8VUF0AA52tCG32qVb6jn93DMq0GPeaA9T5UPOm3m1c,999
-s2python/frbc/frbc_fill_level_target_profile.py,sha256=s-SqjWCEFc9oDm4zUW4RiFEnyWXh6HNlZgSF5P9kHHc,868
-s2python/frbc/frbc_fill_level_target_profile_element.py,sha256=0R2rJ8-rm-2igLgIdZI0SXMt450Ah0i54CBzehVxyI0,852
-s2python/frbc/frbc_instruction.py,sha256=uXKec7nUsQBmAkS6slBiyZ_1lo2i6cpuljRC_eV7LK8,829
-s2python/frbc/frbc_leakage_behaviour.py,sha256=4TnFHsP-wdtHGpWJ1xauE3H2Q_N5FLflG6YJvuKYpcA,771
-s2python/frbc/frbc_leakage_behaviour_element.py,sha256=Z7d8rELLnQDx-qGAVVtuoNnWHyj1CUYG_FOliBOpqwk,656
-s2python/frbc/frbc_operation_mode.py,sha256=DlQa4cRQKmPRoWmabpa9j3A8U0dBQRkEQHG5r7Y4VoM,2023
-s2python/frbc/frbc_operation_mode_element.py,sha256=8Cfp7sTHT4n0KQmFdnWCdzUgPW09NDUm3NL3RBBl2Uc,1099
-s2python/frbc/frbc_storage_description.py,sha256=AMuVZpRk5Pvxx6SnKg9WyELD8kqRJbAmJ1JL5tT0gdk,621
-s2python/frbc/frbc_storage_status.py,sha256=zMgdLYrAgv6Jne5oKWgGMFhUIbJegX501Rskaz_a5-g,516
-s2python/frbc/frbc_system_description.py,sha256=SGxtRNTlBw3-SU5A8J6Y2cxdYLSZiztR2RdrstUwCSc,935
-s2python/frbc/frbc_timer_status.py,sha256=RxbnLzAFJy-OXwwFbQ0QpzRcJ2awmysLcapzjDEU0K8,722
-s2python/frbc/frbc_usage_forecast.py,sha256=-bm6XSDq_wkbGeBj_d1i-C1RdaZpIfD1yJqZ6mWX4bw,735
-s2python/frbc/frbc_usage_forecast_element.py,sha256=bgFG01udYSizOyoGZPIPom0vj_dB3qokffU8hZ7BbC8,600
-s2python/generated/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-s2python/generated/gen_s2.py,sha256=DXLCNE1gUS7XnRTgWlBpy73szr5HrHcrN0TZXvq8N_g,61928
-s2_python-0.0.1.dist-info/METADATA,sha256=7PixoPcZdw86h9LfGGX2ithyEEhyipz2IlP0-b3LWmw,2855
-s2_python-0.0.1.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-s2_python-0.0.1.dist-info/entry_points.txt,sha256=feX-xmgJZgSe5-jxMgFKPKCJz4Ys3eQcGrsXsirNZyM,61
-s2_python-0.0.1.dist-info/top_level.txt,sha256=OLFq0oDhr77Mp-EYLEcWk5P3jvooOt4IHkTI5KYJMc8,9
-s2_python-0.0.1.dist-info/RECORD,,