mms-client 1.10.0__py3-none-any.whl → 1.11.1__py3-none-any.whl

mms_client/types/surplus_capcity.py

@@ -0,0 +1,187 @@
+"""Contains objects for surplus capacity information."""
+
+from enum import Enum
+from typing import Optional
+
+from pendulum import Timezone
+from pydantic import field_serializer
+from pydantic import field_validator
+from pydantic_extra_types.pendulum_dt import DateTime
+from pydantic_xml import attr
+
+from mms_client.types.base import Payload
+from mms_client.types.enums import AreaCode
+from mms_client.types.fields import company_short_name
+from mms_client.types.fields import participant
+from mms_client.types.fields import power_positive
+from mms_client.types.fields import resource_name
+from mms_client.types.fields import resource_short_name
+from mms_client.types.fields import system_code
+
+
+class RejectCategory(Enum):
+    """Represents the category of the reason for rejecting a surplus capacity request."""
+
+    FUEL_RESTRICTION = "1"
+    RIVER_FLOW_RESTRICTION = "2"
+    WORK_RELATED = "3"
+    OTHER = "9"
+
+
+class OperationalRejectCategory(Enum):
+    """Represents the category of the reason for rejecting an operational request.
+
+    This include voltage adjustment, black start, over-power, peak mode or system security pump request.
+    """
+
+    EQUIPMENT_FAILURE = "1"
+    NOT_SUPPORTED = "2"
+    OTHER = "9"
+
+
+class SurplusCapacitySubmit(Payload, tag="RemainingReserveData"):
+    """Represents the base fields for a surplus capacity response."""
+
+    # The name of the resource for which the surplus capacity is being submitted
+    resource_code: str = resource_name("ResourceName")
+
+    # The DR pattern number for which the surplus capacity is being submitted
+    pattern_number: int = attr(name="DrPatternNumber", ge=1, le=20)
+
+    # The start block from when the surplus capacity should apply
+    start: DateTime = attr(name="StartTime")
+
+    # The end block until when the surplus capacity should apply
+    end: DateTime = attr(name="EndTime")
+
+    # The available surplus capacity that can be increased or dispatched when needed, such as in response to grid
+    # demand fluctuations. This should not be submitted for standalone generators.
+    upward_capacity: Optional[int] = power_positive("RemainingReserveUp", True)
+
+    # In the case where excess surplus capacity is rejected, this field will indicate the category of the reason.
+    upward_capacity_rejected: Optional[RejectCategory] = attr(default=None, name="RemainingReserveUpRejectFlag")
+
+    # If the upward dispatch is rejected, this field will indicate a specific reason.
+    upward_capacity_rejection_reason: Optional[str] = attr(
+        default=None, name="RemainingReserveUpRejectReason", min_length=1, max_length=50
+    )
+
+    # The available surplus capacity that can be decreased when needed, such as in response to grid demand fluctuations.
+    # This should not be submitted for standalone generators.
+    downward_capacity: Optional[int] = power_positive("RemainingReserveDown", True)
+
+    # In the case where excess surplus capacity is rejected, this field will indicate the category of the reason.
+    downward_capacity_rejected: Optional[RejectCategory] = attr(default=None, name="RemainingReserveDownRejectFlag")
+
+    # If the downward dispatch is rejected, this field will indicate a specific reason.
+    downward_capacity_rejection_reason: Optional[str] = attr(
+        default=None, name="RemainingReserveDownRejectReason", min_length=1, max_length=50
+    )
+
+    # If voltage adjustment is rejected, this field will indicate the category of the reason.
+    voltage_adjustment_rejected: Optional[OperationalRejectCategory] = attr(
+        default=None, name="VoltageAdjustmentRejectFlag"
+    )
+
+    # If voltage adjustment is rejected, this field will indicate a specific reason.
+    voltage_adjustment_rejection_reason: Optional[str] = attr(
+        default=None, name="VoltageAdjustmentRejectReason", min_length=1, max_length=50
+    )
+
+    # If black start is rejected, this field will indicate the category of the reason.
+    black_start_rejected: Optional[OperationalRejectCategory] = attr(default=None, name="BlackStartRejectFlag")
+
+    # If black start is rejected, this field will indicate a specific reason.
+    black_start_rejection_reason: Optional[str] = attr(
+        default=None, name="BlackStartRejectReason", min_length=1, max_length=50
+    )
+
+    # The additional reserve capacity that can be utilized in cases of excessive or "overpower" conditions, such as
+    # when demand exceeds usual levels.
+    over_power_capacity: Optional[int] = power_positive("OverPowerRemainingReserveUp", True)
+
+    # In the case where over-power capacity is rejected, this field will indicate the category of the reason.
+    over_power_rejected: Optional[OperationalRejectCategory] = attr(default=None, name="OverPowerRejectFlag")
+
+    # If over-power capacity is rejected, this field will indicate a specific reason.
+    over_power_rejection_reason: Optional[str] = attr(
+        default=None, name="OverPowerRejectReason", min_length=1, max_length=50
+    )
+
+    # The available surplus capacity that can be increased specifically during peak demand periods
+    peak_mode_capacity: Optional[int] = power_positive("PeakModeRemainingReserveUp", True)
+
+    # In the case where peak mode capacity is rejected, this field will indicate the category of the reason.
+    peak_mode_rejected: Optional[OperationalRejectCategory] = attr(default=None, name="PeakModeRejectFlag")
+
+    # If peak mode capacity is rejected, this field will indicate a specific reason.
+    peak_mode_rejection_reason: Optional[str] = attr(
+        default=None, name="PeakModeRejectReason", min_length=1, max_length=50
+    )
+
+    # Indicates whether the operation of a pumped-storage hydroelectric pump is restricted or disallowed for system
+    # security reasons.
+    system_security_pump_rejected: Optional[OperationalRejectCategory] = attr(
+        default=None, name="SystemSecurityPumpRejectFlag"
+    )
+
+    # If the operation of a pumped-storage hydroelectric pump is restricted or disallowed for system security reasons,
+    # this field will indicate a specific reason.
+    system_security_pump_rejection_reason: Optional[str] = attr(
+        default=None, name="SystemSecurityPumpRejectReason", min_length=1, max_length=50
+    )
+
+    @field_serializer("start", "end")
+    def encode_datetime(self, value: DateTime) -> str:
+        """Encode the datetime to an MMS-compliant ISO 8601 string."""
+        return value.replace(tzinfo=None).isoformat() if value else ""
+
+    @field_validator("start", "end")
+    def decode_datetime(cls, value: DateTime) -> DateTime:  # pylint: disable=no-self-argument
+        """Decode the datetime from an MMS-compliant ISO 8601 string."""
+        return value.replace(tzinfo=Timezone("Asia/Tokyo"))
+
+
+class SurplusCapacityData(SurplusCapacitySubmit, tag="RemainingReserveData"):
+    """Represents the base fields for a surplus capacity response."""
+
+    # The region in which the resource for which surplus capacity is being submitted is located
+    area: Optional[AreaCode] = attr(default=None, name="Area")
+
+    # The name of the BSP participant submitting the surplus capacity
+    participant: Optional[str] = participant("ParticipantName", True)
+
+    # The abbreviated name of the company submitting the surplus capacity
+    company: Optional[str] = company_short_name("CompanyShortName", True)
+
+    # The MMS code of the business entity to which the registration applies
+    system_code: Optional[str] = system_code("SystemCode", True)
+
+    # The abbreviated name of the resource being traded
+    resource_name: Optional[str] = resource_short_name("ResourceShortName", True)
+
+
+class SurplusCapacityQuery(Payload, tag="RemainingReserveDataQuery"):
+    """Represents the base fields for a surplus capacity query."""
+
+    # The name of the resource for which the surplus capacity is being submitted
+    resource_code: Optional[str] = resource_name("ResourceName", True)
+
+    # The DR pattern number for which the surplus capacity is being submitted
+    pattern_number: Optional[int] = attr(default=None, name="DrPatternNumber", ge=1, le=20)
+
+    # The start block from when the surplus capacity should apply
+    start: DateTime = attr(name="StartTime")
+
+    # The end block until when the surplus capacity should apply
+    end: DateTime = attr(name="EndTime")
+
+    @field_serializer("start", "end")
+    def encode_datetime(self, value: DateTime) -> str:
+        """Encode the datetime to an MMS-compliant ISO 8601 string."""
+        return value.replace(tzinfo=None).isoformat() if value else ""
+
+    @field_validator("start", "end")
+    def decode_datetime(cls, value: DateTime) -> DateTime:  # pylint: disable=no-self-argument
+        """Decode the datetime from an MMS-compliant ISO 8601 string."""
+        return value.replace(tzinfo=Timezone("Asia/Tokyo"))

mms_client/utils/serialization.py

@@ -161,7 +161,8 @@ class Serializer:
         """
         # First, convert the payload to a raw XML string
         raw: bytes = payload.to_xml(
-            skip_empty=True,
+            exclude_none=True,
+            exclude_unset=True,
             encoding="utf-8",
             xml_declaration=False,
         )  # type: ignore[assignment]
@@ -312,7 +313,9 @@ class Serializer:
         ValueError:    If the expected data type is not found in the response.
         """
         data_tags = set(node.tag for node in raw)
-        if not data_tags.issubset([data_type.__name__, data_type.__xml_tag__, "ProcessingStatistics", "Messages"]):
+        if not data_tags.issubset(
+            [data_type.__name__, data_type.__xml_tag__, "ProcessingStatistics", "Messages", "StandingData"]
+        ):
             raise DataNodeNotFoundError(method, data_type)
 
     def _from_tree_data(self, raw: Optional[Element], data_type: Type[P]) -> Optional[ResponseData[P]]:

{mms_client-1.10.0.dist-info → mms_client-1.11.1.dist-info}/METADATA

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: mms-client
-Version: 1.10.0
+Version: 1.11.1
 Summary: API client for accessing the MMS
 Home-page: https://github.com/ElectroRoute-Japan/mms-client
 Author: Ryan Wood
 Author-email: ryan.wood@electroroute.co.jp
-Requires-Python: >=3.11,<4.0
+Requires-Python: >=3.12,<4.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Pydantic :: 2
 Classifier: Framework :: Pytest
@@ -14,8 +14,8 @@ Classifier: License :: OSI Approved :: The Unlicense (Unlicense)
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
 Requires-Dist: backoff (>=2.2.1,<3.0.0)
@@ -221,12 +221,17 @@ This client is not complete. Currently, it supports the following endpoints:
 - MarketQuery_OfferQuery
 - MarketCancel_OfferCancel
 - MarketQuery_AwardResultsQuery
+- MarketQuery_SettlementResultsFileListQuery
+- MarketSubmit_BupSubmit
+- MarketQuery_BupQuery
 - RegistrationSubmit_Resource
 - RegistrationQuery_Resource
 - ReportCreateRequest
 - ReportListRequest
 - ReportDownloadRequestTrnID
 - BSP_ResourceList
+- MarketSubmit_RemainingReserveData
+- MarketQuery_RemainingReserveDataQuery
 
 We can add support for additional endpoints as time goes on, and independent contribution is, of course, welcome. However, support for attachments is currently limited because none of the endpoints we support currently require them. We have implemented attachment support up to the client level, but we haven't developed an architecture for submitting them through an endpoint yet.
 

{mms_client-1.10.0.dist-info → mms_client-1.11.1.dist-info}/RECORD

@@ -1,41 +1,45 @@
 mms_client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mms_client/client.py,sha256=qkLdhC8jXEvtXWKb-GsWJOCYoEjTtHp9x8q8eofkh78,676
 mms_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mms_client/schemas/wsdl/mi-web-service-jbms.wsdl,sha256=4qSn52d-DF6COeI-53P85sSODQy-C4_yp30yYCjeI84,10702
-mms_client/schemas/wsdl/omi-web-service.wsdl,sha256=pIEKcUWzyChzPJnQ6IpnZYyJJ0_0j3yt8M-1l_su5Q8,9894
-mms_client/schemas/xsd/mi-market.xsd,sha256=YyA-84Ha95BfvbACLaALs7m5U-idV-5yQ8GZfmZS_M8,109679
-mms_client/schemas/xsd/mi-outbnd-reports.xsd,sha256=xdQ_9jekOnqs9YPx0Dg8wsZjoxEp-HLO_ZXhzZl2Qk0,76166
-mms_client/schemas/xsd/mi-report.xsd,sha256=XEHhHCGgK4aeYsmObIrlzkvV8UhbirgoysAEOglvUW8,13276
-mms_client/schemas/xsd/mpr.xsd,sha256=QcnuKFm1WkyZfT_56cINHldZkR-3pU4nHSbFKHkIQS0,69149
-mms_client/schemas/xsd/omi.xsd,sha256=benkYeno_HF6BOIv7gAT79dWz00JccS3XilPLBCKVIU,31524
+mms_client/schemas/wsdl/mi-web-service-jbms.wsdl,sha256=4Rt54HUrWmLz5NKLzs0E1j1J4yFw5Q2Fz7MhI6hqps8,10978
+mms_client/schemas/wsdl/omi-web-service.wsdl,sha256=GjUquf1uYrQrZgW5K3l8OfU_LkvLhyBf1oW1fZTxQvA,10156
+mms_client/schemas/xsd/mi-market.xsd,sha256=o3XWk_RU9qI2JescgcPBTPXmM_t9mfrMjnqQrFqwgIQ,113065
+mms_client/schemas/xsd/mi-outbnd-reports.xsd,sha256=f6t5OV9va4TLPFUZWowmJJP-4pNRjNIDfnGJqJdWn20,80990
+mms_client/schemas/xsd/mi-report.xsd,sha256=3IHEnjVcijPcnRBVsIzfaGwFGCjiw_iYmdte_ThUiXE,13655
+mms_client/schemas/xsd/mpr.xsd,sha256=qjHOb9bPd4hWIeTlZ8oFBfgos-6yWGumYJ659c9QAx8,72480
+mms_client/schemas/xsd/omi.xsd,sha256=XOVQVcAbU_rArGZ12bJLf3nWwyG5tvu1uOActqQy0xE,37799
 mms_client/security/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mms_client/security/certs.py,sha256=Gy-CuSsdLPFeoPH_sEYhY67dI5sy6yJ8iTwlysRKT1s,3018
 mms_client/security/crypto.py,sha256=u9Z6nkAW6LbBqUzjIEbZ-CcqdkMJ9fqvdX7IXTTh1EI,2345
 mms_client/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mms_client/services/base.py,sha256=1CJ528X2TJgG3uKa1_txjRHuTOQGQxsm43iFWfrvXBs,31643
-mms_client/services/market.py,sha256=qzTQWPgXcI2uvDxC0SnYL9pyWJ4TolFGhbkgb4jS8gA,9549
-mms_client/services/omi.py,sha256=UG1zYkFz0sFsEbhE6P0CLoAOZZOyEshkZ_b7D_e3CjQ,626
+mms_client/services/base.py,sha256=jEgyjmOdqVkuD9jYthlj_Dv_bJyK2J4lkLrl7wfMy6I,31649
+mms_client/services/market.py,sha256=yMgZ2pQQU5iO41G8Aey2bQ0EjmZjuB3kX5nywiL2hyE,14984
+mms_client/services/omi.py,sha256=WIeOkvc967gBvYlIx9oHnn2sANDVms-hM5uptvWZF5U,4908
 mms_client/services/registration.py,sha256=XkXBgPK9PXFyNxo3ways_hUJ3E_vKTUlgCPgQQbDgWM,3839
 mms_client/services/report.py,sha256=hgRvjVxy8Hvbj5hQb0GMyDW0-1kMW2XFS5iKfO90YZY,6258
 mms_client/types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mms_client/types/award.py,sha256=1-CHIE3x5zFWA8WccUkGwQFBpLdsm4VQ7rk8uOoyKVc,15771
+mms_client/types/award.py,sha256=qfJ107o5deuto9SEmst9cCQwd3PSJLaVzCMeuDgK8c8,16096
 mms_client/types/base.py,sha256=Y0CZEWPQgkPXZWz_WXOpW2J8mRryCRNU7oAZEdWkqvQ,11405
+mms_client/types/bup.py,sha256=wv9ZyQ7pr9sfkoexcx_vLv5ItdRdPqAM-JApo0KlXdE,8415
 mms_client/types/enums.py,sha256=hALMuqRChLUJ1Eglll5R5mkYLpcO-ZIaEBps3MjkTg0,2534
 mms_client/types/fields.py,sha256=kPHN_5TT5sSarkic56Tvr2k-fTvf8oFj53DXGwRfrPg,14785
-mms_client/types/market.py,sha256=D5tZB97ewHfwG9gVC35bHfdlGthi5GBeMaGBk5393wY,2577
-mms_client/types/offer.py,sha256=Dtx7ftLgaJONVEetalXaXmJM4bJ65NBMFFNTGwgLF90,7960
+mms_client/types/market.py,sha256=sO4WX8Vjh6PALScCjqXUXtb5lER3wfdBy-vYAPpi_Uk,3125
+mms_client/types/offer.py,sha256=fYrmhq7_wVFLdOjLu_--ZSV23i5i8It3vUoW6Q-EqPM,8305
+mms_client/types/omi.py,sha256=lwU91nne4TDo1xQclulyxAHzyhWB2srhJBYmnoJAKYs,1058
 mms_client/types/registration.py,sha256=bPA_FQwLVIwb5CRqK8F3YqeV0dEeN04j1wMsClrV5Wc,1252
 mms_client/types/report.py,sha256=7ENst_h1V2DG342UwL9ZltdRK2TaI-P1QW26qwjb6ao,23687
 mms_client/types/reserve.py,sha256=nsFJ0oSEuoCf82CtZEFa_-1UKAj-5Ssf1gEoWTlYiCI,3296
 mms_client/types/resource.py,sha256=4WhrSKOAXGrkg04r9f8f5kC3r0XDIKLarOFtBd2f7NI,65384
+mms_client/types/settlement.py,sha256=BrbVpoiOeSQk4nJ2uKCQGVMSmjQ0xoAgteUl8pn33BI,3181
+mms_client/types/surplus_capcity.py,sha256=4ng5OtAdAUFyV-YATe8KiuG6HcfTlWZAyf2rEHOX1Gk,8771
 mms_client/types/transport.py,sha256=4iEYod4DbqBBRXMH_VBqK9ORwR2q7MxSwwfWQAeHcT4,4442
 mms_client/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mms_client/utils/errors.py,sha256=aDpAqI3Y4D3DtgsCtaaLmla_iOoIZ0SjpoYjzymCGMI,4736
 mms_client/utils/multipart_transport.py,sha256=GJvjdlmXituiT78f5XuhpPkcHdDHFtVELa-F3eqUvbk,9981
 mms_client/utils/plugin.py,sha256=_Jymcny5ta9uV4CMLGDX7O5xSQIhuu76rb-A6uhtFSY,2013
-mms_client/utils/serialization.py,sha256=xF-C8Owp5HE6xfdcT00HFZXZnF-9vljIxoWNyjPHK5U,34512
+mms_client/utils/serialization.py,sha256=ZW4NXrfzL3Sq01uzZhGqy-AFg4GuzvC6fJ2uJi3UcXY,34584
 mms_client/utils/web.py,sha256=Qk8azZpxAIEtI9suOikxBNtFQFNuWh-92DaUBU1qX8s,10927
-mms_client-1.10.0.dist-info/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
-mms_client-1.10.0.dist-info/METADATA,sha256=Z8-YF70jaXeZLzbiNcGifOYnW0aSnJqnT3I1tNkAbDU,16849
-mms_client-1.10.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-mms_client-1.10.0.dist-info/RECORD,,
+mms_client-1.11.1.dist-info/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
+mms_client-1.11.1.dist-info/METADATA,sha256=I6faf2Es8GbMJ7tZ7fT-F3vEfGC_lk46I37OCJ2D2pk,17018
+mms_client-1.11.1.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+mms_client-1.11.1.dist-info/RECORD,,