mms-client 1.1.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

mms_client/services/base.py

@@ -10,6 +10,7 @@ from typing import Optional
 from typing import Protocol
 from typing import Tuple
 from typing import Type
+from typing import Union
 
 from mms_client.security.crypto import Certificate
 from mms_client.security.crypto import CryptoWrapper
@@ -119,7 +120,7 @@ class ClientProto(Protocol):
     def request_many(
         self,
         envelope: E,
-        data: P,
+        data: Union[P, List[P]],
         config: EndpointConfiguration,
     ) -> Tuple[MultiResponse[E, P], Dict[str, bytes]]:
         """Submit a request to the MMS server and return the multi-response.
@@ -361,7 +362,7 @@ class BaseClient:  # pylint: disable=too-many-instance-attributes
     def request_many(
         self,
         envelope: E,
-        payload: P,
+        payload: Union[P, List[P]],
         config: EndpointConfiguration[E, P],
     ) -> Tuple[MultiResponse[E, P], Dict[str, bytes]]:
         """Submit a request to the MMS server and return the multi-response.
@@ -374,13 +375,20 @@ class BaseClient:  # pylint: disable=too-many-instance-attributes
         Returns:    The multi-response from the MMS server.
         """
         # First, create the MMS request from the payload and data.
+        is_list = isinstance(payload, list)
+        data_type = type(payload[0]) if is_list else type(payload)  # type: ignore[index]
         self._logger.debug(
             (
                 f"{config.name}: Starting multi-request. Envelope: {type(envelope).__name__}, "
-                f"Data: {type(payload).__name__}"
+                f"Data: {data_type.__name__}"
             ),
         )
-        request = self._to_mms_request(config.request_type, config.service.serializer.serialize(envelope, payload))
+        serialized = (
+            config.service.serializer.serialize_multi(envelope, payload, data_type)  # type: ignore[arg-type]
+            if is_list
+            else config.service.serializer.serialize(envelope, payload)  # type: ignore[type-var]
+        )
+        request = self._to_mms_request(config.request_type, serialized)
 
         # Next, submit the request to the MMS server and get and verify the response.
         resp = self._get_wrapper(config.service).submit(request)
@@ -391,8 +399,12 @@ class BaseClient:  # pylint: disable=too-many-instance-attributes
 
         # Finally, deserialize and verify the response
         envelope_type = config.response_envelope_type or type(envelope)
-        data_type = config.response_data_type or type(payload)
-        data: MultiResponse[E, P] = config.service.serializer.deserialize_multi(resp.payload, envelope_type, data_type)
+        data_type = config.response_data_type or data_type
+        data: MultiResponse[E, P] = config.service.serializer.deserialize_multi(
+            resp.payload,
+            envelope_type,
+            data_type,  # type: ignore[arg-type]
+        )
         self._verify_multi_response(data, config)
 
         # Return the response data and any attachments

mms_client/services/market.py

@@ -54,6 +54,32 @@ class MarketClientMixin:  # pylint: disable=unused-argument
             days=days,
         )
 
+    @mms_multi_endpoint("MarketSubmit_OfferData", config, RequestType.INFO, ClientType.BSP)
+    def put_offers(
+        self: ClientProto, requests: List[OfferData], market_type: MarketType, days: int, date: Optional[Date] = None
+    ) -> List[OfferData]:
+        """Submit multiple offers to the MMS server.
+
+        This endpoint is only accessible to BSPs.
+
+        Arguments:
+        requests (List[OfferData]): The offers to submit to the MMS server.
+        market_type (MarketType):   The type of market for which the offers are being submitted.
+        days (int):                 The number of days ahead for which the offers are being submitted.
+        date (Date):                The date of the transaction in the format "YYYY-MM-DD". This value defaults to the
+                                    current date.
+
+        Returns:    A list of offers that have been registered with the MMS server.
+        """
+        # Note: the return type does not match the method definition but the decorator will return the correct type
+        return MarketSubmit(  # type: ignore[return-value]
+            date=date or Date.today(),
+            participant=self.participant,
+            user=self.user,
+            market_type=market_type,
+            days=days,
+        )
+
     @mms_multi_endpoint(
         "MarketQuery_OfferQuery", config, RequestType.INFO, resp_envelope_type=MarketSubmit, resp_data_type=OfferData
     )

mms_client/utils/serialization.py

@@ -4,6 +4,7 @@ from functools import lru_cache
 from io import BytesIO
 from pathlib import Path
 from typing import Dict
+from typing import List
 from typing import Optional
 from typing import Tuple
 from typing import Type
@@ -62,8 +63,33 @@ class Serializer:
         # First, create our payload class from the payload and data types
         payload_cls = _create_request_payload_type(
             self._payload_key,
-            type(request_envelope),  # type: ignore[arg-type]
-            type(request_data),  # type: ignore[arg-type]
+            type(request_envelope),
+            type(request_data),
+            False,  # type: ignore[arg-type]
+        )
+
+        # Next, inject the payload and data into the payload class
+        # Note: this returns a type that inherits from PayloadBase and the arguments provided to the initializer
+        # here are correct, but mypy thinks they are incorrect because it doesn't understand the the inherited type
+        payload = payload_cls(request_envelope, request_data, self._xsd.value)  # type: ignore[call-arg, misc]
+
+        # Finally, convert the payload to XML and return it
+        # Note: we provided the encoding here so this will return bytes, not a string
+        return payload.to_xml(skip_empty=True, encoding="utf-8", xml_declaration=True)  # type: ignore[return-value]
+
+    def serialize_multi(self, request_envelope: E, request_data: List[P], request_type: Type[P]) -> bytes:
+        """Serialize the envelope and data to a byte string for sending to the MMS server.
+
+        Arguments:
+        request_envelope (Envelope):    The envelope to be serialized.
+        request_data (List[Payload]):    The data to be serialized.
+        request_type (Type[Payload]):    The type of data to be serialized.
+
+        Returns:    A byte string containing the XML-formatted data to be sent to the MMS server.
+        """
+        # First, create our payload class from the payload and data types
+        payload_cls = _create_request_payload_type(
+            self._payload_key, type(request_envelope), request_type, True  # type: ignore[arg-type]
         )
 
         # Next, inject the payload and data into the payload class
@@ -439,7 +465,12 @@ def _create_response_common_type(tag_type: Type[Union[E, P]]) -> Type[ResponseCo
 
 
 @lru_cache(maxsize=None)
-def _create_request_payload_type(key: str, envelope_type: Type[E], data_type: Type[P]) -> Type[PayloadBase]:
+def _create_request_payload_type(
+    key: str,
+    envelope_type: Type[E],
+    data_type: Type[Union[P, List[P]]],
+    multi: bool,
+) -> Type[PayloadBase]:
     """Create a new payload type for the given payload and data types.
 
     This method is intended to save us the overhead of writing a new class for each payload type. Instead, we can
@@ -453,17 +484,21 @@ def _create_request_payload_type(key: str, envelope_type: Type[E], data_type: Ty
     key: str                        The tag to use for the parent element of the payload.
     envelope_type (Type[Envelope]): The type of payload to be constructed.
     data_type (Type[Payload]):      The type of data to be constructed.
+    multi (bool):                   If True, the payload will be a list; otherwise, it will be a singleton.
 
     Returns:    A new payload type that can be used for serialization.
     """  # fmt: skip
-    # First, create a wrapper for our data type that will be used to store the data in the payload
+    # First, create our data type
+    payload_type = List[data_type] if multi else data_type  # type: ignore[valid-type]
+
+    # Next, create a wrapper for our data type that will be used to store the data in the payload
     class Envelope(envelope_type):  # type: ignore[valid-type, misc]
         """Wrapper for the data type that will be used to store the data in the payload."""
 
         # The data to be stored in the payload
-        data: data_type = element(tag=get_tag(data_type))  # type: ignore[valid-type]
+        data: payload_type = element(tag=get_tag(data_type))  # type: ignore[valid-type, type-var]
 
-        def __init__(self, envelope: envelope_type, data: data_type):  # type: ignore[valid-type]
+        def __init__(self, envelope: envelope_type, data: payload_type):  # type: ignore[valid-type]
             """Create a new envelope to store payload data.
 
             Arguments:
@@ -474,14 +509,14 @@ def _create_request_payload_type(key: str, envelope_type: Type[E], data_type: Ty
             obj["data"] = data
             super().__init__(**obj)
 
-    # Next, create our payload type that actually contains all the XML data
+    # Now, create our payload type that actually contains all the XML data
     class RQPayload(PayloadBase, tag=key):  # type: ignore[call-arg]
         """The payload type that will be used for serialization."""
 
         # The payload containing our request object and any data
         envelope: Envelope = element(tag=envelope_type.__name__)
 
-        def __init__(self, envelope: envelope_type, data: data_type, schema: str):  # type: ignore[valid-type]
+        def __init__(self, envelope: envelope_type, data: payload_type, schema: str):  # type: ignore[valid-type]
             """Create a new payload containing the request object and any data.
 
             Arguments:

{mms_client-1.1.0.dist-info → mms_client-1.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mms-client
-Version: 1.1.0
+Version: 1.2.0
 Summary: API client for accessing the MMS
 Home-page: https://github.com/ElectroRoute-Japan/mms-client
 Author: Ryan Wood

{mms_client-1.1.0.dist-info → mms_client-1.2.0.dist-info}/RECORD

@@ -12,8 +12,8 @@ mms_client/security/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSu
 mms_client/security/certs.py,sha256=kNCUFmy18YIxkWKu3mdMmlxmHdft4a6BvtyJ46rA9I4,1489
 mms_client/security/crypto.py,sha256=M7aIllM3_ZwZgm9nH6QQ6Ig14XCAd6e6WGwqqUbbI1Q,2149
 mms_client/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mms_client/services/base.py,sha256=8yWBeDoBimY9BZeMOkMDV-ggvPTzZHnlqXiv9eo8fIQ,25363
-mms_client/services/market.py,sha256=kwcbXz1Op4hwXbOn_Xsx_qBNuHfvWAxBH6G2f4AWzPI,4892
+mms_client/services/base.py,sha256=mcUL-AZpaJETVkzAOoazmKfI5O3cJ0KWzIYQ5bjpNuE,25839
+mms_client/services/market.py,sha256=juYIZuSsJ10srzDK4N6s8guoGqdDuQXGohecF43WQh8,6169
 mms_client/services/omi.py,sha256=h6cM5U3-iSm0YiIaJwqYTZeI5uhLbA7FPxh_qy_3qww,521
 mms_client/services/registration.py,sha256=9pNZdgwRbJJCnmsVgESNnc3ywkn-wdQryumUhLn6Xvg,3419
 mms_client/services/report.py,sha256=HYVJNwEHo6ZC6497UqO5y1IqZ2ga3kVH5AepdxhYfug,537
@@ -28,9 +28,9 @@ mms_client/types/resource.py,sha256=_pRNAqOX8A0lUXmU8qO_8QwRtRx9BwZDdrN-w_Fnu38,
 mms_client/types/transport.py,sha256=vyosoeGSdYthqlmiyDAkZusYa8yVHUwOzfTqwZne2Ik,4407
 mms_client/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mms_client/utils/errors.py,sha256=jYdlG4OPI82s0fJcXCRNlKeEixDUSSAxjs_7C16qVL4,2306
-mms_client/utils/serialization.py,sha256=7DW-xD89DNukcwk6rgS4eBHsMP5kBdiwkvVM4kv2_F8,25438
+mms_client/utils/serialization.py,sha256=TqkucFL1rvMu49sxsWDwCZSvWMDd75Gj9kZmm1FYUzc,27203
 mms_client/utils/web.py,sha256=fcdCtdDrHBPyhIlTcyiuAk3D3TlW8HmUw-wGfpG4KTA,9653
-mms_client-1.1.0.dist-info/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
-mms_client-1.1.0.dist-info/METADATA,sha256=jb3k6RPJGTpxMiIAaJTKzGfZcgoEgrrxeOPNrSoRoUM,14742
-mms_client-1.1.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-mms_client-1.1.0.dist-info/RECORD,,
+mms_client-1.2.0.dist-info/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
+mms_client-1.2.0.dist-info/METADATA,sha256=xTwJZuKbEW7HKg_C5zw-uVYVXjnI112CiYxEPxGmoWA,14742
+mms_client-1.2.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+mms_client-1.2.0.dist-info/RECORD,,