Improve remove_nones to handle nested data structures (#272)

Author: proelke

ocpp/charge_point.py

@@ -71,11 +71,18 @@ def snake_to_camel_case(data):
 
 
 def remove_nones(dict_to_scan):
-    dict_to_scan = {
-        k: v for k, v in dict_to_scan.items()
-        if v is not None
-    }
-    return dict_to_scan
+    new_dict = {}
+    for k, v in dict_to_scan.items():
+        if isinstance(v, dict):
+            v = remove_nones(v)
+        if isinstance(v, list):
+            new_list = []
+            for item in v:
+                new_list.append(remove_nones(item))
+            v = new_list
+        if v is not None:
+            new_dict[k] = v
+    return new_dict
 
 
 class ChargePoint:

tests/test_charge_point.py

@@ -1,8 +1,17 @@
+from dataclasses import asdict
+
 import pytest
 from ocpp.v20 import ChargePoint as cp
 from ocpp.routing import on, create_route_map
+from ocpp.v16.call import BootNotificationPayload, MeterValuesPayload
 from ocpp.v16.enums import Action
-from ocpp.charge_point import camel_to_snake_case, snake_to_camel_case
+from ocpp.v16.datatypes import MeterValue, SampledValue
+from ocpp.v201.call import SetNetworkProfilePayload
+from ocpp.v201.enums import (OCPPVersionType, OCPPTransportType,
+                             OCPPInterfaceType)
+from ocpp.v201.datatypes import NetworkConnectionProfileType
+from ocpp.charge_point import (
+    camel_to_snake_case, snake_to_camel_case, remove_nones)
 
 
 def test_getters_should_not_be_called_during_routemap_setup():
@@ -58,3 +67,84 @@ def test_camel_to_snake_case(test_input, expected):
 def test_snake_to_camel_case(test_input, expected):
     result = snake_to_camel_case(test_input)
     assert result == expected
+
+
+def test_remove_nones():
+    expected_payload = {'charge_point_model': 'foo',
+                        'charge_point_vendor': 'bar'}
+
+    payload = BootNotificationPayload(
+        charge_point_model='foo', charge_point_vendor='bar',
+        charge_box_serial_number=None)
+    payload = asdict(payload)
+
+    assert expected_payload == remove_nones(payload)
+
+
+def test_nested_remove_nones():
+    expected_payload = {'configuration_slot': 1,
+                        'connection_data': {
+                            'ocpp_version': 'OCPP20', 'ocpp_transport': 'JSON',
+                            'ocpp_csms_url': 'wss://localhost:9000',
+                            'message_timeout': 60, 'security_profile': 1,
+                            'ocpp_interface': 'Wired0'}}
+
+    connection_data = NetworkConnectionProfileType(
+        ocpp_version=OCPPVersionType.ocpp20,
+        ocpp_transport=OCPPTransportType.json,
+        ocpp_csms_url='wss://localhost:9000', message_timeout=60,
+        security_profile=1, ocpp_interface=OCPPInterfaceType.wired0,
+        vpn=None, apn=None)
+
+    payload = SetNetworkProfilePayload(configuration_slot=1,
+                                       connection_data=connection_data)
+    payload = asdict(payload)
+
+    assert expected_payload == remove_nones(payload)
+
+
+def test_nested_list_remove_nones():
+    expected_payload = {
+        'connector_id': 3,
+        'meter_value': [{
+            'timestamp': '2017-08-17T07:08:06.186748+00:00',
+            'sampled_value': [
+                {'value': '10', 'context': 'Sample.Periodic',
+                 'measurand': 'Power.Active.Import', 'unit': 'W'},
+                {'value': '50000', 'context': 'Sample.Periodic',
+                 'measurand': 'Power.Active.Import', 'phase': 'L1',
+                 'unit': 'W'}]},
+            {'timestamp': '2017-08-17T07:07:07.186748+00:00',
+             'sampled_value': [
+                 {'value': '10', 'context': 'Sample.Periodic',
+                  'measurand': 'Power.Active.Import', 'unit': 'W'},
+                 {'value': '50000', 'context': 'Sample.Periodic',
+                  'measurand': 'Power.Active.Import', 'phase': 'L1',
+                  'unit': 'W'}]}],
+        'transaction_id': 5}
+
+    payload = MeterValuesPayload(connector_id=3, meter_value=[
+        MeterValue(timestamp='2017-08-17T07:08:06.186748+00:00',
+                   sampled_value=[
+                        SampledValue(value='10', context='Sample.Periodic',
+                                     format=None,
+                                     measurand='Power.Active.Import',
+                                     phase=None, location=None, unit='W'),
+                        SampledValue(value='50000', context='Sample.Periodic',
+                                     format=None,
+                                     measurand='Power.Active.Import',
+                                     phase='L1', location=None, unit='W')]),
+        MeterValue(timestamp='2017-08-17T07:07:07.186748+00:00',
+                   sampled_value=[
+                       SampledValue(value='10', context='Sample.Periodic',
+                                    format=None,
+                                    measurand='Power.Active.Import',
+                                    phase=None, location=None, unit='W'),
+                       SampledValue(value='50000', context='Sample.Periodic',
+                                    format=None,
+                                    measurand='Power.Active.Import',
+                                    phase='L1', location=None, unit='W')])],
+        transaction_id=5)
+
+    payload = asdict(payload)
+    assert expected_payload == remove_nones(payload)