shapeshifter-uftp 2.2.0__tar.gz → 2.3.0__tar.gz

{shapeshifter_uftp-2.2.0 → shapeshifter_uftp-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shapeshifter_uftp
-Version: 2.2.0
+Version: 2.3.0
 Summary: Implementation of the Shapeshifter (UFTP) protocol
 Project-URL: Repository, https://github.com/shapeshifter/shapeshifter-library-python
 Project-URL: Documentation, https://github.com/shapeshifter/shapeshifter-library-python/README.md
@@ -9,8 +9,8 @@ Project-URL: Changelog, https://github.com/shapeshifter/shapeshifter-library-pyt
 Requires-Python: <3.15,>=3.11
 Description-Content-Type: text/x-rst
 Requires-Dist: xsdata[lxml]<27.0,>=25.0
-Requires-Dist: pynacl==1.5.0
-Requires-Dist: dnspython==2.7.0
+Requires-Dist: pynacl==1.6.2
+Requires-Dist: dnspython==2.8.0
 Requires-Dist: fastapi<0.128,>=0.110
 Requires-Dist: fastapi-xml<2.0.0,>=1.1.1
 Requires-Dist: requests

{shapeshifter_uftp-2.2.0 → shapeshifter_uftp-2.3.0}/pyproject.toml

@@ -1,11 +1,11 @@
 [project]
 name = "shapeshifter_uftp"
-version = "2.2.0"
+version = "2.3.0"
 description = "Implementation of the Shapeshifter (UFTP) protocol"
 dependencies = [
     "xsdata[lxml]>=25.0,<27.0",
-    "pynacl==1.5.0",
-    "dnspython==2.7.0",
+    "pynacl==1.6.2",
+    "dnspython==2.8.0",
     "fastapi>=0.110,<0.128",
     "fastapi-xml>=1.1.1,<2.0.0",
     "requests",
@@ -71,3 +71,13 @@ packages = [
     "shapeshifter_uftp.uftp",
     "shapeshifter_uftp.uftp.messages"
 ]
+
+[tool.ruff.lint]
+select = [
+    "I",
+    "W191",
+    "W291",
+    "W292",
+    "W293",
+    "F401",
+]

{shapeshifter_uftp-2.2.0 → shapeshifter_uftp-2.3.0}/shapeshifter_uftp/__init__.py

@@ -1,144 +1,145 @@
-from .client import (
-    ShapeshifterAgrCroClient,
-    ShapeshifterAgrDsoClient,
-    ShapeshifterCroAgrClient,
-    ShapeshifterCroDsoClient,
-    ShapeshifterDsoAgrClient,
-    ShapeshifterDsoCroClient,
-)
-from .oauth import OAuthClient
-from .service import (
-    ShapeshifterAgrService,
-    ShapeshifterCroService,
-    ShapeshifterDsoService,
-)
-from .uftp import (
-    AcceptedRejected,
-    AgrPortfolioQuery,
-    AgrPortfolioQueryResponse,
-    AgrPortfolioQueryResponseCongestionPoint,
-    AgrPortfolioQueryResponseConnection,
-    AgrPortfolioQueryResponseDSOPortfolio,
-    AgrPortfolioQueryResponseDSOView,
-    AgrPortfolioUpdate,
-    AgrPortfolioUpdateConnection,
-    AgrPortfolioUpdateResponse,
-    ContractSettlement,
-    ContractSettlementISP,
-    ContractSettlementPeriod,
-    DPrognosis,
-    DPrognosisISP,
-    DPrognosisResponse,
-    DsoPortfolioQuery,
-    DsoPortfolioQueryCongestionPoint,
-    DsoPortfolioQueryConnection,
-    DsoPortfolioQueryResponse,
-    DsoPortfolioUpdate,
-    DsoPortfolioUpdateCongestionPoint,
-    DsoPortfolioUpdateConnection,
-    DsoPortfolioUpdateResponse,
-    FlexMessage,
-    FlexOffer,
-    FlexOfferOption,
-    FlexOfferOptionISP,
-    FlexOfferResponse,
-    FlexOfferRevocation,
-    FlexOfferRevocationResponse,
-    FlexOrder,
-    FlexOrderISP,
-    FlexOrderResponse,
-    FlexOrderSettlement,
-    FlexOrderSettlementISP,
-    FlexOrderSettlementStatus,
-    FlexOrderStatus,
-    FlexRequest,
-    FlexRequestISP,
-    FlexRequestResponse,
-    FlexReservationUpdate,
-    FlexReservationUpdateISP,
-    FlexReservationUpdateResponse,
-    FlexSettlement,
-    FlexSettlementResponse,
-    Metering,
-    MeteringISP,
-    MeteringProfile,
-    MeteringProfileEnum,
-    MeteringResponse,
-    MeteringUnit,
-    PayloadMessage,
-    PayloadMessageResponse,
-    SignedMessage,
-    TestMessage,
-    TestMessageResponse,
-    UsefRole,
-)
-
-__all__ = [
-    "ShapeshifterAgrCroClient",
-    "ShapeshifterAgrDsoClient",
-    "ShapeshifterCroAgrClient",
-    "ShapeshifterCroDsoClient",
-    "ShapeshifterDsoAgrClient",
-    "ShapeshifterDsoCroClient",
-    "ShapeshifterAgrService",
-    "ShapeshifterDsoService",
-    "ShapeshifterCroService",
-    "AcceptedRejected",
-    "AgrPortfolioQuery",
-    "AgrPortfolioQueryResponse",
-    "AgrPortfolioQueryResponseCongestionPoint",
-    "AgrPortfolioQueryResponseConnection",
-    "AgrPortfolioQueryResponseDSOPortfolio",
-    "AgrPortfolioQueryResponseDSOView",
-    "AgrPortfolioUpdate",
-    "AgrPortfolioUpdateConnection",
-    "AgrPortfolioUpdateResponse",
-    "ContractSettlement",
-    "ContractSettlementISP",
-    "ContractSettlementPeriod",
-    "DPrognosis",
-    "DPrognosisISP",
-    "DPrognosisResponse",
-    "DsoPortfolioQuery",
-    "DsoPortfolioQueryCongestionPoint",
-    "DsoPortfolioQueryConnection",
-    "DsoPortfolioQueryResponse",
-    "DsoPortfolioUpdate",
-    "DsoPortfolioUpdateCongestionPoint",
-    "DsoPortfolioUpdateConnection",
-    "DsoPortfolioUpdateResponse",
-    "FlexMessage",
-    "FlexOffer",
-    "FlexOfferOption",
-    "FlexOfferOptionISP",
-    "FlexOfferResponse",
-    "FlexOfferRevocation",
-    "FlexOfferRevocationResponse",
-    "FlexOrder",
-    "FlexOrderISP",
-    "FlexOrderResponse",
-    "FlexOrderSettlement",
-    "FlexOrderSettlementISP",
-    "FlexOrderSettlementStatus",
-    "FlexOrderStatus",
-    "FlexRequest",
-    "FlexRequestISP",
-    "FlexRequestResponse",
-    "FlexReservationUpdate",
-    "FlexReservationUpdateISP",
-    "FlexReservationUpdateResponse",
-    "FlexSettlement",
-    "FlexSettlementResponse",
-    "Metering",
-    "MeteringISP",
-    "MeteringProfile",
-    "MeteringProfileEnum",
-    "MeteringResponse",
-    "MeteringUnit",
-    "PayloadMessage",
-    "PayloadMessageResponse",
-    "SignedMessage",
-    "TestMessage",
-    "TestMessageResponse",
-    "UsefRole",
-]
+from .client import (
+    ShapeshifterAgrCroClient,
+    ShapeshifterAgrDsoClient,
+    ShapeshifterCroAgrClient,
+    ShapeshifterCroDsoClient,
+    ShapeshifterDsoAgrClient,
+    ShapeshifterDsoCroClient,
+)
+from .oauth import OAuthClient
+from .service import (
+    ShapeshifterAgrService,
+    ShapeshifterCroService,
+    ShapeshifterDsoService,
+)
+from .uftp import (
+    AcceptedRejected,
+    AgrPortfolioQuery,
+    AgrPortfolioQueryResponse,
+    AgrPortfolioQueryResponseCongestionPoint,
+    AgrPortfolioQueryResponseConnection,
+    AgrPortfolioQueryResponseDSOPortfolio,
+    AgrPortfolioQueryResponseDSOView,
+    AgrPortfolioUpdate,
+    AgrPortfolioUpdateConnection,
+    AgrPortfolioUpdateResponse,
+    ContractSettlement,
+    ContractSettlementISP,
+    ContractSettlementPeriod,
+    DPrognosis,
+    DPrognosisISP,
+    DPrognosisResponse,
+    DsoPortfolioQuery,
+    DsoPortfolioQueryCongestionPoint,
+    DsoPortfolioQueryConnection,
+    DsoPortfolioQueryResponse,
+    DsoPortfolioUpdate,
+    DsoPortfolioUpdateCongestionPoint,
+    DsoPortfolioUpdateConnection,
+    DsoPortfolioUpdateResponse,
+    FlexMessage,
+    FlexOffer,
+    FlexOfferOption,
+    FlexOfferOptionISP,
+    FlexOfferResponse,
+    FlexOfferRevocation,
+    FlexOfferRevocationResponse,
+    FlexOrder,
+    FlexOrderISP,
+    FlexOrderResponse,
+    FlexOrderSettlement,
+    FlexOrderSettlementISP,
+    FlexOrderSettlementStatus,
+    FlexOrderStatus,
+    FlexRequest,
+    FlexRequestISP,
+    FlexRequestResponse,
+    FlexReservationUpdate,
+    FlexReservationUpdateISP,
+    FlexReservationUpdateResponse,
+    FlexSettlement,
+    FlexSettlementResponse,
+    Metering,
+    MeteringISP,
+    MeteringProfile,
+    MeteringProfileEnum,
+    MeteringResponse,
+    MeteringUnit,
+    PayloadMessage,
+    PayloadMessageResponse,
+    SignedMessage,
+    TestMessage,
+    TestMessageResponse,
+    UsefRole,
+)
+
+__all__ = [
+    "ShapeshifterAgrCroClient",
+    "ShapeshifterAgrDsoClient",
+    "ShapeshifterCroAgrClient",
+    "ShapeshifterCroDsoClient",
+    "ShapeshifterDsoAgrClient",
+    "ShapeshifterDsoCroClient",
+    "ShapeshifterAgrService",
+    "ShapeshifterDsoService",
+    "ShapeshifterCroService",
+    "AcceptedRejected",
+    "AgrPortfolioQuery",
+    "AgrPortfolioQueryResponse",
+    "AgrPortfolioQueryResponseCongestionPoint",
+    "AgrPortfolioQueryResponseConnection",
+    "AgrPortfolioQueryResponseDSOPortfolio",
+    "AgrPortfolioQueryResponseDSOView",
+    "AgrPortfolioUpdate",
+    "AgrPortfolioUpdateConnection",
+    "AgrPortfolioUpdateResponse",
+    "ContractSettlement",
+    "ContractSettlementISP",
+    "ContractSettlementPeriod",
+    "DPrognosis",
+    "DPrognosisISP",
+    "DPrognosisResponse",
+    "DsoPortfolioQuery",
+    "DsoPortfolioQueryCongestionPoint",
+    "DsoPortfolioQueryConnection",
+    "DsoPortfolioQueryResponse",
+    "DsoPortfolioUpdate",
+    "DsoPortfolioUpdateCongestionPoint",
+    "DsoPortfolioUpdateConnection",
+    "DsoPortfolioUpdateResponse",
+    "FlexMessage",
+    "FlexOffer",
+    "FlexOfferOption",
+    "FlexOfferOptionISP",
+    "FlexOfferResponse",
+    "FlexOfferRevocation",
+    "FlexOfferRevocationResponse",
+    "FlexOrder",
+    "FlexOrderISP",
+    "FlexOrderResponse",
+    "FlexOrderSettlement",
+    "FlexOrderSettlementISP",
+    "FlexOrderSettlementStatus",
+    "FlexOrderStatus",
+    "FlexRequest",
+    "FlexRequestISP",
+    "FlexRequestResponse",
+    "FlexReservationUpdate",
+    "FlexReservationUpdateISP",
+    "FlexReservationUpdateResponse",
+    "FlexSettlement",
+    "FlexSettlementResponse",
+    "Metering",
+    "MeteringISP",
+    "MeteringProfile",
+    "MeteringProfileEnum",
+    "MeteringResponse",
+    "MeteringUnit",
+    "OAuthClient",
+    "PayloadMessage",
+    "PayloadMessageResponse",
+    "SignedMessage",
+    "TestMessage",
+    "TestMessageResponse",
+    "UsefRole",
+]

{shapeshifter_uftp-2.2.0 → shapeshifter_uftp-2.3.0}/shapeshifter_uftp/client/agr_cro_client.py

@@ -1,4 +1,8 @@
-from ..uftp import AgrPortfolioQuery, AgrPortfolioUpdate, PayloadMessageResponse
+from ..uftp import (
+    AgrPortfolioQuery,
+    AgrPortfolioUpdate,
+    UsefRole,
+)
 from .base_client import ShapeshifterClient
 
 
@@ -7,17 +11,17 @@ class ShapeshifterAgrCroClient(ShapeshifterClient):
     Client that allows the Aggregator to connect to the CRO.
     """
 
-    sender_role = "AGR"
-    recipient_role = "CRO"
+    sender_role = UsefRole.AGR
+    recipient_role = UsefRole.CRO
 
-    def send_agr_portfolio_update(self, message: AgrPortfolioUpdate) -> PayloadMessageResponse:
+    def send_agr_portfolio_update(self, message: AgrPortfolioUpdate) -> None:
         """
         The AGRPortfolioUpdate is used by the AGR to indicate on which
         Connections it represents prosumers.
         """
         return self._send_message(message)
 
-    def send_agr_portfolio_query(self, message: AgrPortfolioQuery) -> PayloadMessageResponse:
+    def send_agr_portfolio_query(self, message: AgrPortfolioQuery) -> None:
         """
         The AGRPortfolioQuery is used by the AGR to retrieve additional
         information on the connections.

{shapeshifter_uftp-2.2.0 → shapeshifter_uftp-2.3.0}/shapeshifter_uftp/client/agr_dso_client.py

@@ -7,7 +7,7 @@ from ..uftp import (
     FlexReservationUpdateResponse,
     FlexSettlementResponse,
     Metering,
-    PayloadMessageResponse,
+    UsefRole,
 )
 from .base_client import ShapeshifterClient
 
@@ -17,10 +17,10 @@ class ShapeshifterAgrDsoClient(ShapeshifterClient):
     Client that allows the Aggregator to connect to the DSO.
     """
 
-    sender_role = "AGR"
-    recipient_role = "DSO"
+    sender_role = UsefRole.AGR
+    recipient_role = UsefRole.DSO
 
-    def send_d_prognosis(self, message: DPrognosis) -> PayloadMessageResponse:
+    def send_d_prognosis(self, message: DPrognosis) -> None:
         """
         D-Prognosis messages are used to communicate D-prognoses between AGRs
         and DSOs. D-Prognosis messages always contain data for all ISPs for the
@@ -31,7 +31,7 @@ class ShapeshifterAgrDsoClient(ShapeshifterClient):
         """
         return self._send_message(message)
 
-    def send_flex_request_response(self, message: FlexRequestResponse) -> PayloadMessageResponse:
+    def send_flex_request_response(self, message: FlexRequestResponse) -> None:
         """
         Upon receiving and processing a FlexRequest message, the receiving
         implementation must reply with a FlexRequestResponse, indicating
@@ -39,7 +39,7 @@ class ShapeshifterAgrDsoClient(ShapeshifterClient):
         """
         return self._send_message(message)
 
-    def send_flex_offer(self, message: FlexOffer) -> PayloadMessageResponse:
+    def send_flex_offer(self, message: FlexOffer) -> None:
         """
         FlexOffer messages are used by AGRs to make DSOs an offer for provision
         of flexibility. A FlexOffer message contains a list of ISPs and, for
@@ -52,24 +52,24 @@ class ShapeshifterAgrDsoClient(ShapeshifterClient):
         sure that it can actually provide the flexibility offered across all of
         its FlexOffers.
         """
-        return self._send_message(message)
+        self._send_message(message)
 
-    def send_flex_offer_revocation(self, message: FlexOfferRevocation) -> PayloadMessageResponse:
+    def send_flex_offer_revocation(self, message: FlexOfferRevocation) -> None:
         """
         The FlexOfferRevocation message is used by the AGR to revoke a FlexOffer
         previously sent to a DSO. It voids the FlexOffer, even if its validity
         time has not yet expired. Revocation is not allowed for FlexOffers that
         already have associated accepted FlexOrders.
         """
-        return self._send_message(message)
+        self._send_message(message)
 
-    def send_flex_order_response(self, message: FlexOrderResponse) -> PayloadMessageResponse:
+    def send_flex_order_response(self, message: FlexOrderResponse) -> None:
         """
         Confirm the flex order.
         """
-        return self._send_message(message)
+        self._send_message(message)
 
-    def send_flex_settlement_response(self, message: FlexSettlementResponse) -> PayloadMessageResponse:
+    def send_flex_settlement_response(self, message: FlexSettlementResponse) -> None:
         """
         Upon receiving and processing a FlexSettlement message, the AGR must
         reply with a FlexSettlementResponse, indicating whether the initial
@@ -77,16 +77,16 @@ class ShapeshifterAgrDsoClient(ShapeshifterClient):
         rejected, the DSO should consider all FlexOrderSettlement elements of
         that message related to potential dispute.
         """
-        return self._send_message(message)
+        self._send_message(message)
 
-    def send_flex_reservation_update_response(self, message: FlexReservationUpdateResponse) -> PayloadMessageResponse:
+    def send_flex_reservation_update_response(self, message: FlexReservationUpdateResponse) -> None:
         """
         Confirm the flex reservation update.
         """
-        return self._send_message(message)
+        self._send_message(message)
 
-    def send_metering(self, message: Metering) -> PayloadMessageResponse:
+    def send_metering(self, message: Metering) -> None:
         """
         Send metering data to the DSO.
         """
-        return self._send_message(message)
+        self._send_message(message)

{shapeshifter_uftp-2.2.0 → shapeshifter_uftp-2.3.0}/shapeshifter_uftp/client/base_client.py

@@ -11,7 +11,13 @@ from .. import transport
 from ..exceptions import ClientTransportException
 from ..logging import logger
 from ..oauth import OAuthClient, PassthroughOAuthClient
-from ..uftp import PayloadMessage, PayloadMessageResponse, SignedMessage
+from ..uftp import (
+    PayloadMessage,
+    SignedMessage,
+    TestMessage,
+    TestMessageResponse,
+    UsefRole,
+)
 
 
 class ShapeshifterClient:
@@ -19,8 +25,8 @@ class ShapeshifterClient:
     Basis for all Shapeshifter client.
     """
 
-    sender_role: str
-    recipient_role: str
+    sender_role: UsefRole
+    recipient_role: UsefRole
     num_outgoing_workers = 10
     num_delivery_attempts = 10
     request_timeout = 30
@@ -32,9 +38,9 @@ class ShapeshifterClient:
         sender_domain: str,
         signing_key: str,
         recipient_domain: str,
-        recipient_endpoint: str = None,
-        recipient_signing_key: str = None,
-        oauth_client: OAuthClient = None,
+        recipient_endpoint: str | None = None,
+        recipient_signing_key: str | None = None,
+        oauth_client: OAuthClient | None = None,
         version: str = "3.1.0"
     ):
         """
@@ -80,7 +86,19 @@ class ShapeshifterClient:
         else:
             self.oauth_client = PassthroughOAuthClient()
 
-    def _send_message(self, message: PayloadMessage) -> PayloadMessageResponse:
+    # ------------------------------------------------------------ #
+    #                        Test Messages                         #
+    # ------------------------------------------------------------ #
+    def send_test_message(self, message: TestMessage | None = None):
+        if message is None:
+            message = TestMessage()
+
+        return self._send_message(message)
+
+    def send_test_message_response(self, message: TestMessageResponse):
+        return self._send_message(message)
+
+    def _send_message(self, message: PayloadMessage) -> None:
         """
         Perform an operation. This will take the message object, pack
         it up into a SignedMessage, sign and seal it, and send it to
@@ -101,7 +119,6 @@ class ShapeshifterClient:
         # properties can be calculated in the framework anyway.
         message.version = self.version
         message.sender_domain = self.sender_domain
-        message.sender_role = self.sender_role
         message.recipient_domain = self.recipient_domain
         message.time_stamp = (
             message.time_stamp or datetime.now(timezone.utc).isoformat()
@@ -146,28 +163,6 @@ class ShapeshifterClient:
             logger.error(error_msg)
             raise ClientTransportException(error_msg, response=response)
 
-        # If the response was empty, don't attempt to parse it
-        if len(response.content) == 0:
-            return None
-
-        # Instantiate a SignedMessage object from the response bytes.
-        sealed_response = transport.parser.from_bytes(response.content)
-
-        # Use the static key that was provided when the client was
-        # initialized, or retrieve the key using DNS. The DNS
-        # implementation caches the DNS lookups so they are not that
-        # expensive after the first time.
-        if not (recipient_signing_key := self.recipient_signing_key):
-            recipient_signing_key = transport.get_key(
-                self.recipient_domain, self.recipient_role
-            )
-
-        # Unseal the response using the other party's public signing
-        # key and return the response message within it
-        return transport.unseal_message(
-            message=sealed_response.body, public_key=recipient_signing_key
-        )
-
     # ------------------------------------------------------------ #
     #     Methods related to queueing and scheduling outgoing      #
     #                          messages.                           #

{shapeshifter_uftp-2.2.0 → shapeshifter_uftp-2.3.0}/shapeshifter_uftp/client/cro_agr_client.py

@@ -1,4 +1,4 @@
-from ..uftp import AgrPortfolioQueryResponse, AgrPortfolioUpdateResponse
+from ..uftp import AgrPortfolioQueryResponse, AgrPortfolioUpdateResponse, UsefRole
 from .base_client import ShapeshifterClient
 
 
@@ -7,19 +7,19 @@ class ShapeshifterCroAgrClient(ShapeshifterClient):
     Client that allows the CRO to connect to the Aggregator.
     """
 
-    sender_role = "CRO"
-    recipient_role = "AGR"
+    sender_role = UsefRole.CRO
+    recipient_role = UsefRole.AGR
 
-    def send_agr_portfolio_update_response(self, message: AgrPortfolioUpdateResponse):
+    def send_agr_portfolio_update_response(self, message: AgrPortfolioUpdateResponse) -> None:
         """
         The DSOPortfolioUpdate is used by the DSO to indicate on which
         congestion points it wants to engage in flexibility trading.
         """
-        return self._send_message(message)
+        self._send_message(message)
 
-    def send_agr_portfolio_query_response(self, message: AgrPortfolioQueryResponse):
+    def send_agr_portfolio_query_response(self, message: AgrPortfolioQueryResponse) -> None:
         """
         DSOPortfolioQuery is used by DSOs to discover which AGRs represent
         connections on its registered congestion point(s).
         """
-        return self._send_message(message)
+        self._send_message(message)

{shapeshifter_uftp-2.2.0 → shapeshifter_uftp-2.3.0}/shapeshifter_uftp/client/cro_dso_client.py

@@ -1,4 +1,4 @@
-from ..uftp import DsoPortfolioQueryResponse, DsoPortfolioUpdateResponse
+from ..uftp import DsoPortfolioQueryResponse, DsoPortfolioUpdateResponse, UsefRole
 from .base_client import ShapeshifterClient
 
 
@@ -15,19 +15,19 @@ class ShapeshifterCroDsoClient(ShapeshifterClient):
     DsoPortfolioQuery, respectively.
     """
 
-    sender_role = "CRO"
-    recipient_role = "DSO"
+    sender_role = UsefRole.CRO
+    recipient_role = UsefRole.DSO
 
-    def send_dso_portfolio_update_response(self, message: DsoPortfolioUpdateResponse):
+    def send_dso_portfolio_update_response(self, message: DsoPortfolioUpdateResponse) -> None:
         """
         The DSOPortfolioUpdate is used by the DSO to indicate on which
         congestion points it wants to engage in flexibility trading.
         """
-        return self._send_message(message)
+        self._send_message(message)
 
-    def send_dso_portfolio_query_response(self, message: DsoPortfolioQueryResponse):
+    def send_dso_portfolio_query_response(self, message: DsoPortfolioQueryResponse) -> None:
         """
         DSOPortfolioQuery is used by DSOs to discover which AGRs represent
         connections on its registered congestion point(s).
         """
-        return self._send_message(message)
+        self._send_message(message)