refactored TelegramParser.parse to accept a str instead of list

2017-01-05 21:24:41 +01:00
parent 1373d570d2
commit f10032f701
6 changed files with 180 additions and 154 deletions
--- a/test/test_parse_v2_2.py
+++ b/test/test_parse_v2_2.py
@@ -4,28 +4,28 @@ from dsmr_parser.parsers import TelegramParserV2_2
 from dsmr_parser import telegram_specifications
 from dsmr_parser import obis_references as obis

-TELEGRAM_V2_2 = [
-    '/ISk5\2MT382-1004',
-    '',
-    '0-0:96.1.1(00000000000000)',
-    '1-0:1.8.1(00001.001*kWh)',
-    '1-0:1.8.2(00001.001*kWh)',
-    '1-0:2.8.1(00001.001*kWh)',
-    '1-0:2.8.2(00001.001*kWh)',
-    '0-0:96.14.0(0001)',
-    '1-0:1.7.0(0001.01*kW)',
-    '1-0:2.7.0(0000.00*kW)',
-    '0-0:17.0.0(0999.00*kW)',
-    '0-0:96.3.10(1)',
-    '0-0:96.13.1()',
-    '0-0:96.13.0()',
-    '0-1:24.1.0(3)',
-    '0-1:96.1.0(000000000000)',
-    '0-1:24.3.0(161107190000)(00)(60)(1)(0-1:24.2.1)(m3)',
-    '(00001.001)',
-    '0-1:24.4.0(1)',
-    '!',
-]
+TELEGRAM_V2_2 = (
+    '/ISk5\2MT382-1004\r\n'
+    '\r\n'
+    '0-0:96.1.1(00000000000000)\r\n'
+    '1-0:1.8.1(00001.001*kWh)\r\n'
+    '1-0:1.8.2(00001.001*kWh)\r\n'
+    '1-0:2.8.1(00001.001*kWh)\r\n'
+    '1-0:2.8.2(00001.001*kWh)\r\n'
+    '0-0:96.14.0(0001)\r\n'
+    '1-0:1.7.0(0001.01*kW)\r\n'
+    '1-0:2.7.0(0000.00*kW)\r\n'
+    '0-0:17.0.0(0999.00*kW)\r\n'
+    '0-0:96.3.10(1)\r\n'
+    '0-0:96.13.1()\r\n'
+    '0-0:96.13.0()\r\n'
+    '0-1:24.1.0(3)\r\n'
+    '0-1:96.1.0(000000000000)\r\n'
+    '0-1:24.3.0(161107190000)(00)(60)(1)(0-1:24.2.1)(m3)\r\n'
+    '(00001.001)\r\n'
+    '0-1:24.4.0(1)\r\n'
+    '!\r\n'
+)


 class TelegramParserV2_2Test(unittest.TestCase):
--- a/test/test_parse_v4_2.py
+++ b/test/test_parse_v4_2.py
@@ -10,45 +10,45 @@ from dsmr_parser.exceptions import InvalidChecksumError, ParseError
 from dsmr_parser.objects import CosemObject, MBusObject
 from dsmr_parser.parsers import TelegramParser, TelegramParserV4

-TELEGRAM_V4_2 = [
-    '/KFM5KAIFA-METER\r\n',
-    '\r\n',
-    '1-3:0.2.8(42)\r\n',
-    '0-0:1.0.0(161113205757W)\r\n',
-    '0-0:96.1.1(3960221976967177082151037881335713)\r\n',
-    '1-0:1.8.1(001581.123*kWh)\r\n',
-    '1-0:1.8.2(001435.706*kWh)\r\n',
-    '1-0:2.8.1(000000.000*kWh)\r\n',
-    '1-0:2.8.2(000000.000*kWh)\r\n',
-    '0-0:96.14.0(0002)\r\n',
-    '1-0:1.7.0(02.027*kW)\r\n',
-    '1-0:2.7.0(00.000*kW)\r\n',
-    '0-0:96.7.21(00015)\r\n',
-    '0-0:96.7.9(00007)\r\n',
+TELEGRAM_V4_2 = (
+    '/KFM5KAIFA-METER\r\n'
+    '\r\n'
+    '1-3:0.2.8(42)\r\n'
+    '0-0:1.0.0(161113205757W)\r\n'
+    '0-0:96.1.1(3960221976967177082151037881335713)\r\n'
+    '1-0:1.8.1(001581.123*kWh)\r\n'
+    '1-0:1.8.2(001435.706*kWh)\r\n'
+    '1-0:2.8.1(000000.000*kWh)\r\n'
+    '1-0:2.8.2(000000.000*kWh)\r\n'
+    '0-0:96.14.0(0002)\r\n'
+    '1-0:1.7.0(02.027*kW)\r\n'
+    '1-0:2.7.0(00.000*kW)\r\n'
+    '0-0:96.7.21(00015)\r\n'
+    '0-0:96.7.9(00007)\r\n'
    '1-0:99.97.0(3)(0-0:96.7.19)(000104180320W)(0000237126*s)(000101000001W)'
-    '(2147583646*s)(000102000003W)(2317482647*s)\r\n',
-    '1-0:32.32.0(00000)\r\n',
-    '1-0:52.32.0(00000)\r\n',
-    '1-0:72.32.0(00000)\r\n',
-    '1-0:32.36.0(00000)\r\n',
-    '1-0:52.36.0(00000)\r\n',
-    '1-0:72.36.0(00000)\r\n',
-    '0-0:96.13.1()\r\n',
-    '0-0:96.13.0()\r\n',
-    '1-0:31.7.0(000*A)\r\n',
-    '1-0:51.7.0(006*A)\r\n',
-    '1-0:71.7.0(002*A)\r\n',
-    '1-0:21.7.0(00.170*kW)\r\n',
-    '1-0:22.7.0(00.000*kW)\r\n',
-    '1-0:41.7.0(01.247*kW)\r\n',
-    '1-0:42.7.0(00.000*kW)\r\n',
-    '1-0:61.7.0(00.209*kW)\r\n',
-    '1-0:62.7.0(00.000*kW)\r\n',
-    '0-1:24.1.0(003)\r\n',
-    '0-1:96.1.0(4819243993373755377509728609491464)\r\n',
-    '0-1:24.2.1(161129200000W)(00981.443*m3)\r\n',
+    '(2147583646*s)(000102000003W)(2317482647*s)\r\n'
+    '1-0:32.32.0(00000)\r\n'
+    '1-0:52.32.0(00000)\r\n'
+    '1-0:72.32.0(00000)\r\n'
+    '1-0:32.36.0(00000)\r\n'
+    '1-0:52.36.0(00000)\r\n'
+    '1-0:72.36.0(00000)\r\n'
+    '0-0:96.13.1()\r\n'
+    '0-0:96.13.0()\r\n'
+    '1-0:31.7.0(000*A)\r\n'
+    '1-0:51.7.0(006*A)\r\n'
+    '1-0:71.7.0(002*A)\r\n'
+    '1-0:21.7.0(00.170*kW)\r\n'
+    '1-0:22.7.0(00.000*kW)\r\n'
+    '1-0:41.7.0(01.247*kW)\r\n'
+    '1-0:42.7.0(00.000*kW)\r\n'
+    '1-0:61.7.0(00.209*kW)\r\n'
+    '1-0:62.7.0(00.000*kW)\r\n'
+    '0-1:24.1.0(003)\r\n'
+    '0-1:96.1.0(4819243993373755377509728609491464)\r\n'
+    '0-1:24.2.1(161129200000W)(00981.443*m3)\r\n'
    '!6796\r\n'
-]
+)


 class TelegramParserV4_2Test(unittest.TestCase):
@@ -56,26 +56,25 @@ class TelegramParserV4_2Test(unittest.TestCase):

    def test_valid(self):
        # No exception is raised.
-        TelegramParserV4.validate_telegram_checksum(
-            TELEGRAM_V4_2
-        )
+        TelegramParserV4.validate_telegram_checksum(TELEGRAM_V4_2)

    def test_invalid(self):
-        # Remove one the electricty used data value. This causes the checksum to
+        # Remove the electricty used data value. This causes the checksum to
        # not match anymore.
-        telegram = [line
-                    for line in TELEGRAM_V4_2
-                    if '1-0:1.8.1' not in line]
+        corrupted_telegram = TELEGRAM_V4_2.replace(
+            '1-0:1.8.1(001581.123*kWh)\r\n',
+            ''
+        )

        with self.assertRaises(InvalidChecksumError):
-            TelegramParserV4.validate_telegram_checksum(telegram)
+            TelegramParserV4.validate_telegram_checksum(corrupted_telegram)

    def test_missing_checksum(self):
        # Remove the checksum value causing a ParseError.
-        telegram = TELEGRAM_V4_2[:-1]
+        corrupted_telegram = TELEGRAM_V4_2.replace('!6796\r\n', '')

        with self.assertRaises(ParseError):
-            TelegramParserV4.validate_telegram_checksum(telegram)
+            TelegramParserV4.validate_telegram_checksum(corrupted_telegram)

    def test_parse(self):
        parser = TelegramParser(telegram_specifications.V4)
--- a/test/test_protocol.py
+++ b/test/test_protocol.py
@@ -1,35 +1,35 @@
-"""Test DSMR serial protocol."""
-import unittest
 from unittest.mock import Mock

+import unittest
+
 from dsmr_parser import obis_references as obis
 from dsmr_parser import telegram_specifications
 from dsmr_parser.parsers import TelegramParserV2_2
 from dsmr_parser.protocol import DSMRProtocol


-TELEGRAM_V2_2 = [
-    "/ISk5\2MT382-1004",
-    "",
-    "0-0:96.1.1(00000000000000)",
-    "1-0:1.8.1(00001.001*kWh)",
-    "1-0:1.8.2(00001.001*kWh)",
-    "1-0:2.8.1(00001.001*kWh)",
-    "1-0:2.8.2(00001.001*kWh)",
-    "0-0:96.14.0(0001)",
-    "1-0:1.7.0(0001.01*kW)",
-    "1-0:2.7.0(0000.00*kW)",
-    "0-0:17.0.0(0999.00*kW)",
-    "0-0:96.3.10(1)",
-    "0-0:96.13.1()",
-    "0-0:96.13.0()",
-    "0-1:24.1.0(3)",
-    "0-1:96.1.0(000000000000)",
-    "0-1:24.3.0(161107190000)(00)(60)(1)(0-1:24.2.1)(m3)",
-    "(00001.001)",
-    "0-1:24.4.0(1)",
-    "!",
-]
+TELEGRAM_V2_2 = (
+    '/ISk5\2MT382-1004\r\n'
+    '\r\n'
+    '0-0:96.1.1(00000000000000)\r\n'
+    '1-0:1.8.1(00001.001*kWh)\r\n'
+    '1-0:1.8.2(00001.001*kWh)\r\n'
+    '1-0:2.8.1(00001.001*kWh)\r\n'
+    '1-0:2.8.2(00001.001*kWh)\r\n'
+    '0-0:96.14.0(0001)\r\n'
+    '1-0:1.7.0(0001.01*kW)\r\n'
+    '1-0:2.7.0(0000.00*kW)\r\n'
+    '0-0:17.0.0(0999.00*kW)\r\n'
+    '0-0:96.3.10(1)\r\n'
+    '0-0:96.13.1()\r\n'
+    '0-0:96.13.0()\r\n'
+    '0-1:24.1.0(3)\r\n'
+    '0-1:96.1.0(000000000000)\r\n'
+    '0-1:24.3.0(161107190000)(00)(60)(1)(0-1:24.2.1)(m3)\r\n'
+    '(00001.001)\r\n'
+    '0-1:24.4.0(1)\r\n'
+    '!\r\n'
+)


 class ProtocolTest(unittest.TestCase):
@@ -45,8 +45,7 @@ class ProtocolTest(unittest.TestCase):
    def test_complete_packet(self):
        """Protocol should assemble incoming lines into complete packet."""

-        for line in TELEGRAM_V2_2:
-            self.protocol.data_received(bytes(line + '\r\n', 'ascii'))
+        self.protocol.data_received(TELEGRAM_V2_2.encode('ascii'))

        telegram = self.protocol.telegram_callback.call_args_list[0][0][0]
        assert isinstance(telegram, dict)