Merge branch 'master' into URL-does-not-get-converted-from-snake_case-responder_url-to-camelCase-responderURL

Jared-Newell-Mobility · web-flow · commit b3ac7853459d · 2024-02-14T14:39:13.000+01:00
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,35 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-lts-latest
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#   install:
+#     - requirements: docs/requirements.txt
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,9 @@
 # Change log
+
+- [#547](https://github.com/mobilityhouse/ocpp/pull/547) Feat: Handle recursively serializing a dataclasses as a dictionary Thanks [@MacDue](https://github.com/MacDue)
+- [#601](https://github.com/mobilityhouse/ocpp/issues/601) Fix case conversion for soc in non "State of Charge" context
+- [#523](https://github.com/mobilityhouse/ocpp/issues/523) The serialisation of soc to SoC should not occur in camel case if it is existing at the beginning of a field
+- [#515](https://github.com/mobilityhouse/ocpp/issues/515) Update Readthedocs configuration
 - [#602](https://github.com/mobilityhouse/ocpp/issues/602) Correct v2g serialisation/deserialisation
 - [#557](https://github.com/mobilityhouse/ocpp/issues/557) OCPP 2.0.1 Wrong data type in CostUpdated total_cost
 - [#564](https://github.com/mobilityhouse/ocpp/issues/564) Add support For Python 3.11 and 3.12
@@ -13,6 +18,9 @@
 - [#510](https://github.com/mobilityhouse/ocpp/issues/510) v2.0.1 UnitOfMeasureType - Enums missing and update docstring to allow use for variableCharacteristics
 - [#508](https://github.com/mobilityhouse/ocpp/issues/508) Exception - OccurrenceConstraintViolationError doc string correction
 
+## DEPRECATED ##
+- [#579](https://github.com/mobilityhouse/ocpp/issues/579) v2.0.1 Action enums corrected - IMPORTANT SEE UPGRADE PATH [#579](https://github.com/mobilityhouse/ocpp/issues/579)
+
 ## BREAKING ##
 - [#574](https://github.com/mobilityhouse/ocpp/issues/574) Remove v1.6 deprecated enum members - IMPORTANT see upgrade path [#574](https://github.com/mobilityhouse/ocpp/issues/574)
 - [#498](https://github.com/mobilityhouse/ocpp/issues/498) Remove support for OCPP 2.0 - IMPORTANT SEE UPGRADE PATH [#498](https://github.com/mobilityhouse/ocpp/issues/498)
diff --git a/ocpp/charge_point.py b/ocpp/charge_point.py
@@ -4,8 +4,8 @@
 import re
 import time
 import uuid
-from dataclasses import asdict
-from typing import Dict, List, Union
+from dataclasses import Field, asdict, is_dataclass
+from typing import Any, Dict, List, Union, get_args, get_origin
 
 from ocpp.exceptions import NotImplementedError, NotSupportedError, OCPPError
 from ocpp.messages import Call, MessageType, unpack, validate_payload
@@ -59,6 +59,9 @@ def snake_to_camel_case(data):
             key = key.replace("_v2x", "V2X")
             key = key.replace("ocpp_csms", "ocppCSMS")
             key = key.replace("_url", "URL")
+            key = key.replace("soc", "SoC").replace("_SoCket", "Socket")
+            key = key.replace("_v2x", "V2X")
+            key = key.replace("soc_limit_reached", "SOCLimitReached")
             key = key.replace("_v2x", "V2X").replace("_v2g", "V2G")
             components = key.split("_")
             key = components[0] + "".join(x[:1].upper() + x[1:] for x in components[1:])
@@ -76,6 +79,71 @@ def snake_to_camel_case(data):
     return data
 
 
+def _is_dataclass_instance(input: Any) -> bool:
+    """Verify if given `input` is a dataclass."""
+    return is_dataclass(input) and not isinstance(input, type)
+
+
+def _is_optional_field(field: Field) -> bool:
+    """Verify if given `field` allows `None` as value.
+
+    The fields `schema` and `host` on the following class would return `False`.
+    While the fields `post` and `query` return `True`.
+
+        @dataclass
+        class URL:
+            schema: str,
+            host: str,
+            post: Optional[str],
+            query: Union[None, str]
+
+    """
+    return get_origin(field.type) is Union and type(None) in get_args(field.type)
+
+
+def serialize_as_dict(dataclass):
+    """Serialize the given `dataclass` as a `dict` recursively.
+
+    @dataclass
+    class StatusInfoType:
+        reason_code: str
+        additional_info: Optional[str] = None
+
+    with_additional_info = StatusInfoType(
+        reason="Unknown",
+        additional_info="More details"
+    )
+
+    assert serialize_as_dict(with_additional_info) == {
+        'reason': 'Unknown',
+        'additional_info': 'More details',
+    }
+
+    without_additional_info = StatusInfoType(reason="Unknown")
+
+    assert serialize_as_dict(with_additional_info) == {
+        'reason': 'Unknown',
+        'additional_info': None,
+    }
+
+    """
+    serialized = asdict(dataclass)
+
+    for field in dataclass.__dataclass_fields__.values():
+
+        value = getattr(dataclass, field.name)
+        if _is_dataclass_instance(value):
+            serialized[field.name] = serialize_as_dict(value)
+            continue
+
+        if isinstance(value, list):
+            for item in value:
+                if _is_dataclass_instance(item):
+                    serialized[field.name] = [serialize_as_dict(item)]
+
+    return serialized
+
+
 def remove_nones(data: Union[List, Dict]) -> Union[List, Dict]:
     if isinstance(data, dict):
         return {k: remove_nones(v) for k, v in data.items() if v is not None}
@@ -249,7 +317,7 @@ async def _handle_call(self, msg):
 
             return
 
-        temp_response_payload = asdict(response)
+        temp_response_payload = serialize_as_dict(response)
 
         # Remove nones ensures that we strip out optional arguments
         # which were not set and have a default value of None
@@ -311,7 +379,7 @@ async def call(self, payload, suppress=True, unique_id=None):
         CallError.
 
         """
-        camel_case_payload = snake_to_camel_case(asdict(payload))
+        camel_case_payload = snake_to_camel_case(serialize_as_dict(payload))
 
         unique_id = (
             unique_id if unique_id is not None else str(self._unique_id_generator())
diff --git a/ocpp/v201/enums.py b/ocpp/v201/enums.py
@@ -1,3 +1,5 @@
+from warnings import warn
+
 try:
     # breaking change introduced in python 3.11
     from enum import StrEnum
@@ -11,6 +13,14 @@ class StrEnum(str, Enum):  # pragma: no cover
 class Action(StrEnum):
     """An Action is a required part of a Call message."""
 
+    def __init__(self, *args, **kwargs):
+        warn(
+            message="Action enum contains deprecated members and will be removed in "
+            "the next major release, please use snake case members.",
+            category=DeprecationWarning,
+        )
+
+    # --------- Soon to be deprecated ---------------------
     Authorize = "Authorize"
     BootNotification = "BootNotification"
     CancelReservation = "CancelReservation"
@@ -75,9 +85,72 @@ class Action(StrEnum):
     UnlockConnector = "UnlockConnector"
     UnpublishFirmware = "UnpublishFirmware"
     UpdateFirmware = "UpdateFirmware"
+    # --------------------------------------------------------
 
-
-# Enums
+    authorize = "Authorize"
+    boot_notification = "BootNotification"
+    cancel_reservation = "CancelReservation"
+    certificate_signed = "CertificateSigned"
+    change_availability = "ChangeAvailability"
+    clear_cache = "ClearCache"
+    clear_charging_profile = "ClearChargingProfile"
+    clear_display_message = "ClearDisplayMessage"
+    cleared_charging_limit = "ClearedChargingLimit"
+    clear_variable_monitoring = "ClearVariableMonitoring"
+    cost_update = "CostUpdate"
+    customer_information = "CustomerInformation"
+    data_transfer = "DataTransfer"
+    delete_certificate = "DeleteCertificate"
+    firmware_status_notification = "FirmwareStatusNotification"
+    get_15118_ev_certificate = "Get15118EVCertificate"
+    get_base_report = "GetBaseReport"
+    get_certificate_status = "GetCertificateStatus"
+    get_charging_profiles = "GetChargingProfiles"
+    get_composite_schedule = "GetCompositeSchedule"
+    get_display_messages = "GetDisplayMessages"
+    get_installed_certificate_ids = "GetInstalledCertificateIds"
+    get_local_list_version = "GetLocalListVersion"
+    get_log = "GetLog"
+    get_monitoring_report = "GetMonitoringReport"
+    get_report = "GetReport"
+    get_transaction_status = "GetTransactionStatus"
+    get_variables = "GetVariables"
+    heartbeat = "Heartbeat"
+    install_certificate = "InstallCertificate"
+    log_status_notification = "LogStatusNotification"
+    meter_values = "MeterValues"
+    notify_charging_limit = "NotifyChargingLimit"
+    notify_customer_information = "NotifyCustomerInformation"
+    notify_display_messages = "NotifyDisplayMessages"
+    notify_ev_charging_needs = "NotifyEVChargingNeeds"
+    notify_ev_charging_schedule = "NotifyEVChargingSchedule"
+    notify_event = "NotifyEvent"
+    notify_monitoring_report = "NotifyMonitoringReport"
+    notify_report = "NotifyReport"
+    publish_firmware = "PublishFirmware"
+    publish_firmware_status_notification = "PublishFirmwareStatusNotification"
+    report_charging_profiles = "ReportChargingProfiles"
+    request_start_transaction = "RequestStartTransaction"
+    request_stop_transaction = "RequestStopTransaction"
+    reservation_status_update = "ReservationStatusUpdate"
+    reserve_now = "ReserveNow"
+    reset = "Reset"
+    security_event_notification = "SecurityEventNotification"
+    send_local_list = "SendLocalList"
+    set_charging_profile = "SetChargingProfile"
+    set_display_message = "SetDisplayMessage"
+    set_monitoring_base = "SetMonitoringBase"
+    set_monitoring_level = "SetMonitoringLevel"
+    set_network_profile = "SetNetworkProfile"
+    set_variable_monitoring = "SetVariableMonitoring"
+    set_variables = "SetVariables"
+    sign_certificate = "SignCertificate"
+    status_notification = "StatusNotification"
+    transaction_event = "TransactionEvent"
+    trigger_message = "TriggerMessage"
+    unlock_connector = "UnlockConnector"
+    unpublish_firmware = "UnpublishFirmware"
+    update_firmware = "UpdateFirmware"
 
 
 class APNAuthenticationType(StrEnum):
diff --git a/tests/test_charge_point.py b/tests/test_charge_point.py
@@ -2,7 +2,12 @@
 
 import pytest
 
-from ocpp.charge_point import camel_to_snake_case, remove_nones, snake_to_camel_case
+from ocpp.charge_point import (
+    camel_to_snake_case,
+    remove_nones,
+    serialize_as_dict,
+    snake_to_camel_case,
+)
 from ocpp.messages import Call
 from ocpp.routing import after, create_route_map, on
 from ocpp.v16 import ChargePoint as cp_16
@@ -11,8 +16,15 @@
 from ocpp.v16.datatypes import MeterValue, SampledValue
 from ocpp.v16.enums import Action, RegistrationStatus
 from ocpp.v201 import ChargePoint as cp_201
-from ocpp.v201.call import SetNetworkProfile
-from ocpp.v201.datatypes import NetworkConnectionProfileType
+from ocpp.v201.call import GetVariables as v201GetVariables
+from ocpp.v201.call import SetNetworkProfile as v201SetNetworkProfile
+from ocpp.v201.datatypes import (
+    ComponentType,
+    EVSEType,
+    GetVariableDataType,
+    NetworkConnectionProfileType,
+    VariableType,
+)
 from ocpp.v201.enums import OCPPInterfaceType, OCPPTransportType, OCPPVersionType
 
 
@@ -58,6 +70,7 @@ def heartbeat(self, **kwargs):
         ({"InvalidURL": "foo.com"}, {"invalid_url": "foo.com"}),
         ({"evMinV2XEnergyRequest": 200}, {"ev_min_v2x_energy_request": 200}),
         ({"v2xChargingCtrlr": 200}, {"v2x_charging_ctrlr": 200}),
+        ({"webSocketPingInterval": 200}, {"web_socket_ping_interval": 200}),
         ({"signV2GCertificate": 200}, {"sign_v2g_certificate": 200}),
         (
             {"v2gCertificateInstallationEnabled": 200},
@@ -75,12 +88,14 @@ def test_camel_to_snake_case(test_input, expected):
     [
         ({"transaction_id": "74563478"}, {"transactionId": "74563478"}),
         ({"full_soc": 100}, {"fullSoC": 100}),
+        ({"soc_limit_reached": 200}, {"SoCLimitReached": 200}),
         ({"ev_min_v2x_energy_request": 200}, {"evMinV2XEnergyRequest": 200}),
         ({"v2x_charging_ctrlr": 200}, {"v2xChargingCtrlr": 200}),
         ({"responder_url": "foo.com"}, {"responderURL": "foo.com"}),
         ({"url": "foo.com"}, {"url": "foo.com"}),
         ({"ocpp_csms_url": "foo.com"}, {"ocppCSMSURL": "foo.com"}),
         ({"invalid_url": "foo.com"}, {"invalidURL": "foo.com"}),
+        ({"web_socket_ping_interval": 200}, {"webSocketPingInterval": 200}),
         ({"sign_v2g_certificate": 200}, {"signV2GCertificate": 200}),
         (
             {"v2g_certificate_installation_enabled": 200},
@@ -130,7 +145,9 @@ def test_nested_remove_nones():
         apn=None,
     )
 
-    payload = SetNetworkProfile(configuration_slot=1, connection_data=connection_data)
+    payload = v201SetNetworkProfile(
+        configuration_slot=1, connection_data=connection_data
+    )
     payload = asdict(payload)
 
     assert expected_payload == remove_nones(payload)
@@ -251,6 +268,50 @@ def test_remove_nones_with_list_of_strings():
     }
 
 
+def test_serialize_as_dict():
+    """
+    Test recursively serializing a dataclasses as a dictionary.
+    """
+    # Setup
+    expected = camel_to_snake_case(
+        {
+            "getVariableData": [
+                {
+                    "component": {
+                        "name": "Component",
+                        "instance": None,
+                        "evse": {
+                            "id": 1,
+                            "connectorId": None,
+                        },
+                    },
+                    "variable": {
+                        "name": "Variable",
+                        "instance": None,
+                    },
+                    "attributeType": None,
+                }
+            ],
+            "customData": None,
+        }
+    )
+
+    payload = v201GetVariables(
+        get_variable_data=[
+            GetVariableDataType(
+                component=ComponentType(
+                    name="Component",
+                    evse=EVSEType(id=1),
+                ),
+                variable=VariableType(name="Variable"),
+            )
+        ]
+    )
+
+    # Execute / Assert
+    assert serialize_as_dict(payload) == expected
+
+
 @pytest.mark.asyncio
 async def test_call_unique_id_added_to_handler_args_correctly(connection):
     """
