mms-client 1.5.0__py3-none-any.whl → 1.6.0__py3-none-any.whl

mms_client/services/base.py

@@ -28,6 +28,7 @@ from mms_client.types.transport import RequestType
 from mms_client.types.transport import ResponseDataType
 from mms_client.utils.errors import AudienceError
 from mms_client.utils.errors import MMSClientError
+from mms_client.utils.errors import MMSServerError
 from mms_client.utils.errors import MMSValidationError
 from mms_client.utils.serialization import Serializer
 from mms_client.utils.web import ClientType
@@ -459,7 +460,11 @@ class BaseClient:  # pylint: disable=too-many-instance-attributes
         MMSClientError: If the response is not valid.
         """
         # Verify that the response is in the correct format. If it's not, raise an error.
-        if resp.data_type != ResponseDataType.XML:
+        # NOTE: We're disabling the no-else-raise rule here because both comparisons are on the same enum so if one is
+        # removed then the other will raise an error. This is a false positive.
+        if resp.data_type == ResponseDataType.TXT:  # pylint: disable=no-else-raise
+            raise MMSServerError(config.name, resp.payload.decode("UTF-8"))
+        elif resp.data_type != ResponseDataType.XML:
             raise MMSClientError(
                 config.name,
                 f"Invalid MMS response data type: {resp.data_type.name}. Only XML is supported.",

mms_client/services/market.py

@@ -18,6 +18,8 @@ from mms_client.types.market import MarketType
 from mms_client.types.offer import OfferCancel
 from mms_client.types.offer import OfferData
 from mms_client.types.offer import OfferQuery
+from mms_client.types.reserve import ReserveRequirement
+from mms_client.types.reserve import ReserveRequirementQuery
 from mms_client.types.transport import RequestType
 from mms_client.utils.serialization import SchemaType
 from mms_client.utils.serialization import Serializer
@@ -34,6 +36,35 @@ class MarketClientMixin:  # pylint: disable=unused-argument
     # The configuration for the market service
     config = ServiceConfiguration(Interface.MI, Serializer(SchemaType.MARKET, "MarketData"))
 
+    @mms_endpoint(
+        "MarketQuery_ReserveRequirementQuery",
+        config,
+        RequestType.INFO,
+        resp_envelope_type=MarketSubmit,
+        resp_data_type=ReserveRequirement,
+    )
+    def query_reserve_requirements(
+        self: ClientProto, request: ReserveRequirementQuery, date: Optional[Date] = None
+    ) -> List[ReserveRequirement]:
+        """Query the MMS server for reserve requirements.
+
+        This endpoint is accessible to all client types.
+
+        Arguments:
+        request (ReserveRequirementQuery):  The query to submit to the MMS server.
+        date (Date):                        The date of the transaction in the format "YYYY-MM-DD". This value defaults
+                                            to the current date.
+
+        Returns:    A list of reserve requirements that match the query.
+        """
+        # NOTE: The return type does not match the method definition but the decorator will return the correct type
+        return MarketQuery(  # type: ignore[return-value]
+            date=date or Date.today(),
+            participant=self.participant,
+            user=self.user,
+            days=1,
+        )
+
     @mms_endpoint("MarketSubmit_OfferData", config, RequestType.INFO, [ClientType.BSP])
     def put_offer(
         self: ClientProto, request: OfferData, market_type: MarketType, days: int, date: Optional[Date] = None
@@ -124,6 +155,8 @@ class MarketClientMixin:  # pylint: disable=unused-argument
         days (int):                 The number of days ahead for which the data is being cancelled.
         date (Date):                The date of the transaction in the format "YYYY-MM-DD". This value defaults to the
                                     current date.
+
+        Returns:    Data identifying the offer that was cancelled.
         """
         # NOTE: The return type does not match the method definition but the decorator will return the correct type
         return MarketCancel(  # type: ignore[return-value]

mms_client/types/reserve.py

@@ -0,0 +1,71 @@
+"""Contains objects for MMS reserve requirements."""
+
+from typing import List
+from typing import Optional
+
+from pydantic_extra_types.pendulum_dt import DateTime
+from pydantic_xml import attr
+from pydantic_xml import element
+
+from mms_client.types.base import Payload
+from mms_client.types.enums import AreaCode
+from mms_client.types.enums import Direction
+from mms_client.types.fields import power_positive
+from mms_client.types.market import MarketType
+
+
+class Requirement(Payload):
+    """Represents a reserve requirement."""
+
+    # The start block of the requirement
+    start: DateTime = attr(name="StartTime")
+
+    # The end block of the requirement
+    end: DateTime = attr(name="EndTime")
+
+    # The direction of the requirement
+    direction: Direction = attr(name="Direction")
+
+    # The primary reserve quantity in kW
+    primary_qty_kw: Optional[int] = power_positive("PrimaryReserveQuantityInKw", True)
+
+    # The first secondary reserve quantity in kW
+    secondary_1_qty_kw: Optional[int] = power_positive("Secondary1ReserveQuantityInKw", True)
+
+    # The second secondary reserve quantity in kW
+    secondary_2_qty_kw: Optional[int] = power_positive("Secondary2ReserveQuantityInKw", True)
+
+    # The first tertiary reserve quantity in kW
+    tertiary_1_qty_kw: Optional[int] = power_positive("Tertiary1ReserveQuantityInKw", True)
+
+    # The second tertiary reserve quantity in kW
+    tertiary_2_qty_kw: Optional[int] = power_positive("Tertiary2ReserveQuantityInKw", True)
+
+    # The minimum reserve of compound primary and secondary 1 in kW
+    primary_secondary_1_qty_kw: Optional[int] = power_positive("CompoundPriSec1ReserveQuantityInKw", True)
+
+    # The minimum reserve of compound primary and secondary 2 in kW
+    primary_secondary_2_qty_kw: Optional[int] = power_positive("CompoundPriSec2ReserveQuantityInKw", True)
+
+    # The minimum reserve of compound primary and tertiary 1 in kW
+    primary_tertiary_1_qty_kw: Optional[int] = power_positive("CompoundPriTer1ReserveQuantityInKw", True)
+
+
+class ReserveRequirement(Payload):
+    """Represents a set of reserve requirements."""
+
+    # The area for which the reserve requirement applies
+    area: AreaCode = attr(name="Area")
+
+    # The requirements associated with the area
+    requirements: List[Requirement] = element(tag="Requirement", min_length=1)
+
+
+class ReserveRequirementQuery(Payload):
+    """Represents a request to query reserve requirements."""
+
+    # The market type for which to query reserve requirements
+    market_type: MarketType = attr(name="MarketType")
+
+    # The area for which to query reserve requirements
+    area: Optional[AreaCode] = attr(default=None, name="Area")

mms_client/utils/auditing.py

@@ -7,6 +7,7 @@ from logging import getLogger
 from lxml.etree import _Element as Element
 from lxml.etree import tostring
 from zeep import Plugin
+from zeep.wsdl.definitions import Operation
 
 # Set the default logger for the MMS client
 logger = getLogger(__name__)
@@ -15,7 +16,7 @@ logger = getLogger(__name__)
 class AuditPlugin(ABC, Plugin):
     """Base class for audit plugins."""
 
-    def egress(self, envelope: Element, http_headers: dict, operation, binding_options):
+    def egress(self, envelope: Element, http_headers: dict, operation: Operation, binding_options):
         """Handle the MMS request before it is sent.
 
         Arguments are the same as in the egress method of the Plugin class.
@@ -25,10 +26,10 @@ class AuditPlugin(ABC, Plugin):
         dict:               The HTTP headers to send.
         """
         data = tostring(envelope, encoding="UTF-8", xml_declaration=True)
-        self.audit_request(data)
+        self.audit_request(operation.name, data)
         return envelope, http_headers
 
-    def ingress(self, envelope: Element, http_headers: dict, operation):
+    def ingress(self, envelope: Element, http_headers: dict, operation: Operation):
         """Handle the MMS response before it is processed.
 
         Arguments are the same as in the ingress method of the Plugin class.
@@ -38,21 +39,23 @@ class AuditPlugin(ABC, Plugin):
         dict:               The HTTP headers to process.
         """
         data = tostring(envelope, encoding="UTF-8", xml_declaration=True)
-        self.audit_response(data)
+        self.audit_response(operation.name, data)
         return envelope, http_headers
 
     @abstractmethod
-    def audit_request(self, mms_request: bytes) -> None:
+    def audit_request(self, operation: str, mms_request: bytes) -> None:
         """Audit an MMS request.
 
         Arguments:
+        operation (str):        The SOAP operation being called.
         mms_request (bytes):    The MMS request XML to audit.
         """
 
     @abstractmethod
-    def audit_response(self, mms_response: bytes) -> None:
+    def audit_response(self, operation: str, mms_response: bytes) -> None:
         """Audit an MMS response.
 
         Arguments:
+        operation (str):        The SOAP operation being called.
         mms_response (bytes):   The MMS response XML to audit.
         """

mms_client/utils/errors.py

@@ -38,6 +38,21 @@ class AudienceError(ValueError):
         super().__init__(self.message)
 
 
+class MMSServerError(RuntimeError):
+    """Error raised when the MMS server returns an error."""
+
+    def __init__(self, method: str, message: str):
+        """Initialize the error.
+
+        Arguments:
+        method (str):   The method that caused the error.
+        message (str):  The error message.
+        """
+        super().__init__(f"{method}: {message}")
+        self.message = message
+        self.method = method
+
+
 class MMSClientError(RuntimeError):
     """Base class for MMS client errors."""
 

mms_client/utils/web.py

@@ -200,7 +200,13 @@ class ZWrapper:
 
     @on_exception(expo, TransportError, max_tries=3, giveup=fatal_code, logger=logger)  # type: ignore[arg-type]
     def submit(self, req: MmsRequest) -> MmsResponse:
-        """Submit the given request to the MMS server and return the response."""
+        """Submit the given request to the MMS server and return the response.
+
+        Arguments:
+        req (MmsRequest):   The MMS request to submit.
+
+        Returns:    The MMS response.
+        """
         try:
             logger.debug(f"Submitting MMS request request to {self._interface.name} service")
 

{mms_client-1.5.0.dist-info → mms_client-1.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mms-client
-Version: 1.5.0
+Version: 1.6.0
 Summary: API client for accessing the MMS
 Home-page: https://github.com/ElectroRoute-Japan/mms-client
 Author: Ryan Wood
@@ -209,6 +209,7 @@ This same input allows for the user to create their own plugins and add them to
 
 # Completeness
 This client is not complete. Currently, it supports the following endpoints:
+- MarketQuery_ReserveRequirementQuery
 - MarketSubmit_OfferData
 - MarketQuery_OfferQuery
 - MarketCancel_OfferCancel

{mms_client-1.5.0.dist-info → mms_client-1.6.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=kI--NGcxYP9-cF5PHolSGOT-XtBFcjmlsRLxpd48GVE,25897
-mms_client/services/market.py,sha256=XCD49lILwf7_hpF54MpQFsO-NBK4PwmNznsoMyg23mo,7684
+mms_client/services/base.py,sha256=DavXAfWqSqcxfgbAFDj-9nj2DYL5YTMTPWHUM8aaL9s,26309
+mms_client/services/market.py,sha256=7eVqbgkfSip-GAAFnjetFbtmFILOGI6Gb8YISTiMh6w,9031
 mms_client/services/omi.py,sha256=UG1zYkFz0sFsEbhE6P0CLoAOZZOyEshkZ_b7D_e3CjQ,626
 mms_client/services/registration.py,sha256=ryj2WKJoBzRU1r6Svbl2MyGOG0H5aEYAK6HQWL9kYaA,3815
 mms_client/services/report.py,sha256=ZXYDaknPCnSYZI857QHbkzst1Pez_PrKFudVF9bQB7Q,642
@@ -25,14 +25,15 @@ mms_client/types/fields.py,sha256=pa5qvQVwEr8dh44IGHyYqgJYTYyTIeAjBW6CylXrkP0,14
 mms_client/types/market.py,sha256=IbXsH4Q5MJI-CEvGvZlzv2S36mX_Ea02U11Ik-NwSxQ,2706
 mms_client/types/offer.py,sha256=KosFiKRMnt7XwlLBUfjHUGHiWzrMJUPPhGQMxgdeepM,6791
 mms_client/types/registration.py,sha256=Nir73S3ffpk0O_fnTD2alFaqV1k67_8dcyyduXvPBI4,1381
+mms_client/types/reserve.py,sha256=pLV47w_749EIVhj0tUuJdWdHBBEl0-v10oVioccgxnU,2667
 mms_client/types/resource.py,sha256=TQnY3JLHRgQhQrG6ISquw-BQgKSr8TGuqn9ItWxWz_w,65974
 mms_client/types/transport.py,sha256=DPjWs34UW915GkUCJWKuDZmsjS6mRdRXgcGISduN_Bc,4399
 mms_client/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mms_client/utils/auditing.py,sha256=yb_8cdUeZkTCb2W48E0LLuJXv4m4SKjDH8jMX7rjNLk,1797
-mms_client/utils/errors.py,sha256=ovoJjrvoVkbMRhHcq3HR9p1uH_65QicvaGy_7wNv7JI,2579
+mms_client/utils/auditing.py,sha256=JDcvNo4ul66xPtDeeocn568yIe8fhh-jM11MWP-Kfes,2057
+mms_client/utils/errors.py,sha256=6k-NOjGZyTbTUISzN7B4JrmU2P8cwjpFFmFC7kJOQFQ,3005
 mms_client/utils/serialization.py,sha256=k0_fBm-yoRZV2AMiickSyauoDyA8i7uIPU6JjfQWx4Q,29638
-mms_client/utils/web.py,sha256=kguQ4uDFpfw2dly89WXukkvJ8RMKTDIafWGUIpmPPJo,10033
-mms_client-1.5.0.dist-info/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
-mms_client-1.5.0.dist-info/METADATA,sha256=RrGO-fZkJP0aHFEYOdT74lvi3Syzp1x9OeyhqdSsabA,15987
-mms_client-1.5.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-mms_client-1.5.0.dist-info/RECORD,,
+mms_client/utils/web.py,sha256=-abdVxSi7c6xQYsZObbj0yXwGI5VWthr5KtWDyLBCM4,10156
+mms_client-1.6.0.dist-info/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
+mms_client-1.6.0.dist-info/METADATA,sha256=FSz-AvooX7RCU5vZ8BC1nhXINBlF3EFhitTc3ZngIh8,16025
+mms_client-1.6.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+mms_client-1.6.0.dist-info/RECORD,,