shapeshifter-uftp 1.1.1.dev2__tar.gz → 1.2.0__tar.gz

{shapeshifter-uftp-1.1.1.dev2 → shapeshifter-uftp-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shapeshifter-uftp
-Version: 1.1.1.dev2
+Version: 1.2.0
 Summary: Allows connections between DSO, AGR and CRO using the Shapeshifter (UFTP) protocol.
 Requires-Python: >=3.10
 Provides-Extra: dev

{shapeshifter-uftp-1.1.1.dev2 → shapeshifter-uftp-1.2.0}/README.rst

@@ -41,6 +41,13 @@ Version History
 +-------------+-------------------+----------------------------------+
 | Version     | Release Date      | Release Notes                    |
 +=============+===================+==================================+
+| 1.2.0       | 2024-04-04        | Upgrade to latest FastAPI and    |
+|             |                   | Pydantic.                        |
++-------------+-------------------+----------------------------------+
+| 1.1.2       | 2024-03-12        | Pinned dependencies after a      |
+|             |                   | breaking update to fastapi-xml   |
+|             |                   | was released.                    |
++-------------+-------------------+----------------------------------+
 | 1.1.0       | 2023-08-30        | Use the published 3.0.0 spec     |
 |             |                   | for the XSD validation and       |
 |             |                   | objects.                         |

shapeshifter-uftp-1.2.0/pyproject.toml

@@ -0,0 +1,18 @@
+[tool.pytest.ini_options]
+addopts = "-v --cov --cov-report html"
+
+[tool.coverage.run]
+include = [
+    "shapeshifter_uftp/**/*.py",
+]
+omit = [
+    "application/asgi.py",
+]
+
+[tool.coverage.report]
+skip_empty = true
+
+[tool.coverage.html]
+directory = "test_coverage"
+
+[tool.pylint.DESIGN]

{shapeshifter-uftp-1.1.1.dev2 → shapeshifter-uftp-1.2.0}/setup.py

@@ -1,40 +1,40 @@
-from setuptools import setup
-
-setup(
-    name="shapeshifter-uftp",
-    version="1.1.1.dev2",
-    python_requires=">=3.10",
-    description="Allows connections between DSO, AGR and CRO using the Shapeshifter (UFTP) protocol.",
-    packages=[
-        "shapeshifter_uftp",
-        "shapeshifter_uftp.uftp",
-        "shapeshifter_uftp.client",
-        "shapeshifter_uftp.service",
-    ],
-    install_requires=[
-        "xsdata[lxml]",
-        "pynacl",
-        "dnspython",
-        "fastapi<0.100",
-        "fastapi-xml",
-        "requests",
-        "uvicorn",
-        "termcolor",
-    ],
-    extras_require={
-        "dev": [
-            "xmlschema",
-            "pytest",
-            "pytest-cov",
-            "pylint",
-            "sphinx",
-            "sphinx-rtd-theme",
-        ]
-    },
-    entry_points={
-        "console_scripts": [
-            "shapeshifter-keypair = shapeshifter_uftp.cli:generate_signing_keypair",
-            "shapeshifter-lookup = shapeshifter_uftp.cli:perform_lookup",
-        ]
-    },
-)
+from setuptools import setup
+
+setup(
+    name="shapeshifter-uftp",
+    version="1.2.0",
+    python_requires=">=3.10",
+    description="Allows connections between DSO, AGR and CRO using the Shapeshifter (UFTP) protocol.",
+    packages=[
+        "shapeshifter_uftp",
+        "shapeshifter_uftp.uftp",
+        "shapeshifter_uftp.client",
+        "shapeshifter_uftp.service",
+    ],
+    install_requires=[
+        "xsdata[lxml]==24.4",
+        "pynacl==1.5.0",
+        "dnspython==2.6.1",
+        "fastapi==0.110",
+        "fastapi-xml==1.1.0",
+        "requests",
+        "uvicorn",
+        "termcolor",
+    ],
+    extras_require={
+        "dev": [
+            "xmlschema",
+            "pytest",
+            "pytest-cov",
+            "pylint",
+            "sphinx",
+            "sphinx-rtd-theme",
+        ]
+    },
+    entry_points={
+        "console_scripts": [
+            "shapeshifter-keypair = shapeshifter_uftp.cli:generate_signing_keypair",
+            "shapeshifter-lookup = shapeshifter_uftp.cli:perform_lookup",
+        ]
+    },
+)

{shapeshifter-uftp-1.1.1.dev2 → shapeshifter-uftp-1.2.0}/shapeshifter_uftp/client/base_client.py

@@ -1,14 +1,16 @@
-from datetime import datetime, timezone
 import sched
 import time
+from datetime import datetime, timezone
 from queue import Queue
-from threading import Thread, Event
+from threading import Event, Thread
 from uuid import uuid4
+
 import requests
-from ..uftp import PayloadMessage, PayloadMessageResponse, SignedMessage
-from ..logging import logger
-from ..exceptions import ClientTransportException
+
 from .. import transport
+from ..exceptions import ClientTransportException
+from ..logging import logger
+from ..uftp import PayloadMessage, PayloadMessageResponse, SignedMessage
 
 
 class ShapeshifterClient():

{shapeshifter-uftp-1.1.1.dev2 → shapeshifter-uftp-1.2.0}/shapeshifter_uftp/client/dso_agr_client.py

@@ -1,15 +1,8 @@
+from ..uftp import (DPrognosisResponse, FlexOfferResponse,
+                    FlexOfferRevocationResponse, FlexOrder, FlexRequest,
+                    FlexReservationUpdate, FlexSettlement, MeteringResponse,
+                    PayloadMessageResponse)
 from .base_client import ShapeshifterClient
-from ..uftp import (
-    DPrognosisResponse,
-    FlexRequest,
-    FlexOfferResponse,
-    FlexOrder,
-    FlexReservationUpdate,
-    FlexOfferRevocationResponse,
-    FlexSettlement,
-    PayloadMessageResponse,
-    MeteringResponse,
-)
 
 
 class ShapeshifterDsoAgrClient(ShapeshifterClient):

{shapeshifter-uftp-1.1.1.dev2 → shapeshifter-uftp-1.2.0}/shapeshifter_uftp/client/dso_cro_client.py

@@ -1,5 +1,5 @@
+from ..uftp import DsoPortfolioQuery, DsoPortfolioUpdate
 from .base_client import ShapeshifterClient
-from ..uftp import DsoPortfolioUpdate, DsoPortfolioQuery
 
 
 class ShapeshifterDsoCroClient(ShapeshifterClient):

{shapeshifter-uftp-1.1.1.dev2 → shapeshifter-uftp-1.2.0}/shapeshifter_uftp/service/base_service.py

@@ -1,31 +1,22 @@
+import re
 from datetime import datetime, timezone
 from queue import Queue
-from uuid import uuid4
-from time import sleep
 from threading import Thread
-import re
-import traceback
+from time import sleep
+from uuid import uuid4
 
+import uvicorn
 from fastapi import FastAPI
 from fastapi.exceptions import HTTPException
-from fastapi_xml import XmlAppResponse, NonJsonRoute
-import uvicorn
+from fastapi_xml import XmlAppResponse, XmlRoute
 
+from .. import transport
 from ..client import client_map
-from ..uftp import (
-    SignedMessage,
-    PayloadMessage,
-    PayloadMessageResponse,
-    AcceptedRejected,
-)
-from ..exceptions import (
-    FunctionalException,
-    TransportException,
-    InvalidSenderException,
-    InvalidMessageException,
-)
+from ..exceptions import (FunctionalException, InvalidMessageException,
+                          InvalidSenderException, TransportException)
 from ..logging import logger
-from .. import transport
+from ..uftp import (AcceptedRejected, PayloadMessage, PayloadMessageResponse,
+                    SignedMessage)
 
 
 class ShapeshifterService():
@@ -89,7 +80,7 @@ class ShapeshifterService():
         # (one) endpoint, and by virtue of FastAPI-XML convert the
         # python-friendly objects into XML and vice versa.
         self.app = FastAPI(default_response_class=XmlAppResponse)
-        self.app.router.route_class = NonJsonRoute
+        self.app.router.route_class = XmlRoute
         self.app.router.add_api_route(
             path,
             endpoint=self._receive_message,
@@ -251,9 +242,6 @@ class ShapeshifterService():
                     f"An error occurred during the post-processing of a {message.__class__.__name__} message."
                     f"{err.__class__.__name__}: {err}"
                 )
-                logger.error(
-                    traceback.format_exc()
-                )
             finally:
                 self.inbound_queue.task_done()
 

{shapeshifter-uftp-1.1.1.dev2 → shapeshifter-uftp-1.2.0}/shapeshifter_uftp/uftp/cro_dso.py

@@ -265,13 +265,6 @@ class DsoPortfolioQueryResponse(PayloadMessageResponse):
     class Meta:
         name = "DSOPortfolioQueryResponse"
 
-    congestion_point: Optional[DsoPortfolioQueryCongestionPoint] = field(
-        default=None,
-        metadata={
-            "name": "CongestionPoint",
-            "type": "Element",
-        }
-    )
     dso_portfolio_query_message_id: str = field(
         metadata={
             "name": "DSOPortfolioQueryMessageID",
@@ -280,6 +273,14 @@ class DsoPortfolioQueryResponse(PayloadMessageResponse):
             "pattern": r"[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}",
         }
     )
+
+    congestion_point: Optional[DsoPortfolioQueryCongestionPoint] = field(
+        default=None,
+        metadata={
+            "name": "CongestionPoint",
+            "type": "Element",
+        }
+    )
     time_zone: str = field(
         default=DEFAULT_TIME_ZONE,
         metadata={

shapeshifter-uftp-1.2.0/shapeshifter_uftp/uftp/parsing.py

@@ -0,0 +1,8 @@
+from datetime import datetime
+import re
+
+
+def parse_uftp_timestamp(timestamp_str):
+    """
+    Parses a UFTP timestamp into a Python datetime.datetime object. This can take care of the
+    """

{shapeshifter-uftp-1.1.1.dev2 → shapeshifter-uftp-1.2.0}/shapeshifter_uftp/uftp/validations.py

@@ -1,29 +1,32 @@
-from decimal import Decimal, InvalidOperation
-
-
-def validate_decimal(name: str, value: int | float | Decimal | str, digits: int):
-    """
-    Validates that the decimal is acceptable, and returns it with the correct number of digits.
-    """
-    if isinstance(value, str):
-        try:
-            value = Decimal(value)
-        except InvalidOperation as exc:
-            raise ValueError(f"{name} must be a valid numeric value, not '{value}'") from exc
-    if not isinstance(value, (int, float, Decimal)):
-        raise TypeError(f"'{name}' must be a numeric type, not {type(value)}")
-    return Decimal(f"{value:.{digits}f}")
-
-
-def validate_list(name, value, item_type, length):
-    """
-    Validates that the list is of the correct type, length and content type.
-    """
-    if not isinstance(value, list):
-        raise TypeError(f"'{name}' must be a list, not {type(value)}")
-    if len(value) < length:
-        raise ValueError(f"'Length of list '{name}' must be {length} or greater, not {len(value)}")
-    # if not all(isinstance(item, item_type) for item in value):
-    #     raise TypeError(f"'Not all items in list were of type {item_type}")
-    return value
-
+from decimal import Decimal, InvalidOperation
+
+
+def validate_decimal(name: str, value: int | float | Decimal | str, digits: int):
+    """
+    Validates that the decimal is acceptable, and returns it with the correct number of digits.
+    """
+    if isinstance(value, str):
+        try:
+            value = Decimal(value)
+        except InvalidOperation as exc:
+            raise ValueError(f"{name} must be a valid numeric value, not '{value}'") from exc
+    if not isinstance(value, (int, float, Decimal)):
+        raise TypeError(f"'{name}' must be a numeric type, not {type(value)}")
+    return Decimal(f"{value:.{digits}f}")
+
+
+def validate_list(name, value, item_type, length):
+    """
+    Validates that the list is of the correct type, length and content type.
+    """
+    if not isinstance(value, list):
+        raise TypeError(f"'{name}' must be a list, not {type(value)}")
+    if len(value) < length:
+        raise ValueError(f"'Length of list '{name}' must be {length} or greater, not {len(value)}")
+    for index, item in enumerate(value):
+        if not isinstance(item, item_type):
+            raise TypeError(
+                f"Not all items of property {name} were of type {item_type}: "
+                f"item at index {index} was of type {type(item)}"
+            )
+    return value

{shapeshifter-uftp-1.1.1.dev2 → shapeshifter-uftp-1.2.0}/shapeshifter_uftp.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shapeshifter-uftp
-Version: 1.1.1.dev2
+Version: 1.2.0
 Summary: Allows connections between DSO, AGR and CRO using the Shapeshifter (UFTP) protocol.
 Requires-Python: >=3.10
 Provides-Extra: dev

{shapeshifter-uftp-1.1.1.dev2 → shapeshifter-uftp-1.2.0}/shapeshifter_uftp.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
 README.rst
+pyproject.toml
 setup.py
 shapeshifter_uftp/__init__.py
 shapeshifter_uftp/cli.py
@@ -31,6 +32,7 @@ shapeshifter_uftp/uftp/common.py
 shapeshifter_uftp/uftp/cro_dso.py
 shapeshifter_uftp/uftp/defaults.py
 shapeshifter_uftp/uftp/metering.py
+shapeshifter_uftp/uftp/parsing.py
 shapeshifter_uftp/uftp/validations.py
 test/test_cli.py
 test/test_client_errors.py

{shapeshifter-uftp-1.1.1.dev2 → shapeshifter-uftp-1.2.0}/shapeshifter_uftp.egg-info/requires.txt

@@ -1,8 +1,8 @@
-xsdata[lxml]
-pynacl
-dnspython
-fastapi<0.100
-fastapi-xml
+xsdata[lxml]==24.4
+pynacl==1.5.0
+dnspython==2.6.1
+fastapi==0.110
+fastapi-xml==1.1.0
 requests
 uvicorn
 termcolor

{shapeshifter-uftp-1.1.1.dev2 → shapeshifter-uftp-1.2.0}/test/test_communications.py

@@ -1,57 +1,54 @@
-import pytest
-from time import sleep
-from concurrent.futures import ThreadPoolExecutor
-
-from shapeshifter_uftp.uftp import routing_map, PayloadMessageResponse, AcceptedRejected
-from shapeshifter_uftp.service.base_service import snake_case
-from .helpers.messages import messages
-from .helpers.services import DummyAgrService, DummyCroService, DummyDsoService
-
-
-# These fixtures allow us to only start up the services once and use
-# them for all the parametrized test cases, which speeds up testing.
-@pytest.fixture(scope='module')
-def agr_service():
-    with DummyAgrService() as service:
-        yield service
-
-@pytest.fixture(scope='module')
-def cro_service():
-    with DummyCroService() as service:
-        yield service
-
-@pytest.fixture(scope='module')
-def dso_service():
-    with DummyDsoService() as service:
-        yield service
-
-
-@pytest.mark.parametrize(
-    'message',
-    messages,
-    ids=[message.__class__.__name__ for message in messages]
-)
-def test_communications(message, agr_service, cro_service, dso_service):
-    service_map = {
-        "AGR": agr_service,
-        "CRO": cro_service,
-        "DSO": dso_service,
-    }
-
-    sender_role, recipient_role = routing_map[type(message)]
-    sender = service_map[sender_role]
-    recipient = service_map[recipient_role]
-    client_method = f"{recipient.sender_role.lower()}_client"
-    with ThreadPoolExecutor() as executor:
-        with getattr(sender, client_method)(recipient.sender_domain) as client:
-            sending_method = f"send_{snake_case(message.__class__.__name__)}"
-            main_future = executor.submit(getattr(client, sending_method), message)
-
-        parsed_message = recipient.request_futures[f"pre_process_{snake_case(message.__class__.__name__)}"].result()
-        breakpoint()
-        assert parsed_message == message
-
-        response_message = PayloadMessageResponse()
-        recipient.response_futures[f"pre_process_{snake_case(message.__class__.__name__)}"].set_result(response_message)
-        assert recipient.request_futures[f"process_{snake_case(message.__class__.__name__)}"].result() == message
-        assert main_future.result().result == AcceptedRejected.ACCEPTED
+import pytest
+from time import sleep
+from concurrent.futures import ThreadPoolExecutor
+
+from shapeshifter_uftp.uftp import routing_map, PayloadMessageResponse, AcceptedRejected
+from shapeshifter_uftp.service.base_service import snake_case
+from .helpers.messages import messages
+from .helpers.services import DummyAgrService, DummyCroService, DummyDsoService
+
+
+# These fixtures allow us to only start up the services once and use
+# them for all the parametrized test cases, which speeds up testing.
+@pytest.fixture(scope='module')
+def agr_service():
+    with DummyAgrService() as service:
+        yield service
+
+@pytest.fixture(scope='module')
+def cro_service():
+    with DummyCroService() as service:
+        yield service
+
+@pytest.fixture(scope='module')
+def dso_service():
+    with DummyDsoService() as service:
+        yield service
+
+
+@pytest.mark.parametrize(
+    'message',
+    messages,
+    ids=[message.__class__.__name__ for message in messages]
+)
+def test_communications(message, agr_service, cro_service, dso_service):
+    service_map = {
+        "AGR": agr_service,
+        "CRO": cro_service,
+        "DSO": dso_service,
+    }
+
+    sender_role, recipient_role = routing_map[type(message)]
+    sender = service_map[sender_role]
+    recipient = service_map[recipient_role]
+    client_method = f"{recipient.sender_role.lower()}_client"
+    with ThreadPoolExecutor() as executor:
+        with getattr(sender, client_method)(recipient.sender_domain) as client:
+            sending_method = f"send_{snake_case(message.__class__.__name__)}"
+            main_future = executor.submit(getattr(client, sending_method), message)
+
+        assert recipient.request_futures[f"pre_process_{snake_case(message.__class__.__name__)}"].result() == message
+        response_message = PayloadMessageResponse()
+        recipient.response_futures[f"pre_process_{snake_case(message.__class__.__name__)}"].set_result(response_message)
+        assert recipient.request_futures[f"process_{snake_case(message.__class__.__name__)}"].result() == message
+        assert main_future.result().result == AcceptedRejected.ACCEPTED

{shapeshifter-uftp-1.1.1.dev2 → shapeshifter-uftp-1.2.0}/shapeshifter_uftp/service/__init__.py

@@ -1,7 +1,7 @@
 from .agr_service import ShapeshifterAgrService
+from .base_service import snake_case
 from .cro_service import ShapeshifterCroService
 from .dso_service import ShapeshifterDsoService
-from .base_service import snake_case
 
 __all__ = [
     "ShapeshifterAgrService",