Add support for sections

Author: maxnz

.gitignore

@@ -1,10 +1,11 @@
-/.idea
-*.xml
+.idea/
+.tox/
+animatedledstrip_client.egg-info/
+build/
+dist/
+venv/
 *.iml
-/venv
-test.py
-/animatedledstrip_client.egg-info
-/dist
-/.tox
+*.xml
 .coverage
-build/
+.mutmut-cache
+test.py

README.md

@@ -32,7 +32,7 @@ sender.start()
 ```
 
 ## Stopping the `AnimationSender`
-An `AnimationSender` is started by calling the `end()` method on the instance.
+An `AnimationSender` is stopped by calling the `end()` method on the instance.
 
 ```python
 sender.end()

animatedledstrip/__init__.py

@@ -7,4 +7,5 @@
 from .global_vars import ANIMATION_DATA_PREFIX, ANIMATION_INFO_PREFIX, DELIMITER, \
     END_ANIMATION_PREFIX, SECTION_PREFIX, STRICT_TYPE_CHECKING, STRIP_INFO_PREFIX
 from .param_usage import ParamUsage
+from .section import Section
 from .strip_info import StripInfo

animatedledstrip/animation_sender.py

@@ -27,6 +27,7 @@
 from .animation_info import AnimationInfo
 from .end_animation import EndAnimation
 from .global_vars import *
+from .section import Section
 from .strip_info import StripInfo
 
 
@@ -40,13 +41,15 @@ def __init__(self, ip_address: str, port_num: int):
         self.connected: bool = False
         self.recv_thread: Optional['Thread'] = None
         self.running_animations: Dict[str, 'AnimationData'] = {}
+        self.sections: Dict[str, 'Section'] = {}
         self.stripInfo: Optional['StripInfo'] = None
         self.supported_animations: List['AnimationInfo'] = []
 
         self.receiveCallback: Optional[Callable[[bytes], Any]] = None
         self.newAnimationDataCallback: Optional[Callable[['AnimationData'], Any]] = None
         self.newAnimationInfoCallback: Optional[Callable[['AnimationInfo'], Any]] = None
         self.newEndAnimationCallback: Optional[Callable[['EndAnimation'], Any]] = None
+        self.newSectionCallback: Optional[Callable[['Section'], Any]] = None
         self.newStripInfoCallback: Optional[Callable[['StripInfo'], Any]] = None
 
     def start(self) -> 'AnimationSender':
@@ -141,7 +144,15 @@ def parse_data(self):
                         self.newEndAnimationCallback(data)
 
                 elif split_input.startswith(SECTION_PREFIX):
-                    pass  # TODO
+                    # Create the EndAnimation instance
+                    sect = Section.from_json(split_input)
+
+                    # Add new section to the sections dict
+                    self.sections[sect.name] = sect
+
+                    # Call callback
+                    if self.newSectionCallback:
+                        self.newSectionCallback(sect)
 
                 elif split_input.startswith(STRIP_INFO_PREFIX):
                     # Create the StripInfo instance

animatedledstrip/section.py

@@ -0,0 +1,81 @@
+#   Copyright (c) 2019-2020 AnimatedLEDStrip
+#
+#   Permission is hereby granted, free of charge, to any person obtaining a copy
+#   of this software and associated documentation files (the "Software"), to deal
+#   in the Software without restriction, including without limitation the rights
+#   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#   copies of the Software, and to permit persons to whom the Software is
+#   furnished to do so, subject to the following conditions:
+#
+#   The above copyright notice and this permission notice shall be included in
+#   all copies or substantial portions of the Software.
+#
+#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+#   THE SOFTWARE.
+
+import json
+from typing import AnyStr
+
+from animatedledstrip.utils import check_data_type
+
+
+class Section(object):
+    """Stores information about a section of the LED strip"""
+
+    def __init__(self):
+        self.name: str = ''
+        self.start_pixel: int = -1
+        self.end_pixel: int = -1
+        self.physical_start: int = -1
+        self.num_leds: int = 0
+
+    def json(self) -> str:
+        """Create a JSON representation of this instance"""
+        if self.check_data_types() is False:
+            # If something has a bad data type (and STRICT_TYPE_CHECKING is False), return an empty string
+            return ''
+        else:
+            # Otherwise, create the JSON representation and return it
+            return ''.join(['SECT:{',
+                            ','.join([
+                                '"name":"{}"'.format(self.name),
+                                '"startPixel":{}'.format(self.start_pixel),
+                                '"endPixel":{}'.format(self.end_pixel)]),
+                            '}'])
+
+    @classmethod
+    def from_json(cls, input_str: AnyStr) -> 'Section':
+        """Create a Section instance from a json representation"""
+        # Parse the JSON
+        input_json = json.loads(input_str[5:])
+
+        # Create a new StripInfo instance
+        new_instance = cls()
+
+        new_instance.name = input_json.get('name', new_instance.name)
+        new_instance.start_pixel = input_json.get('startPixel', new_instance.start_pixel)
+        new_instance.end_pixel = input_json.get('endPixel', new_instance.end_pixel)
+        new_instance.physical_start = input_json.get('physicalStart', new_instance.physical_start)
+        new_instance.num_leds = input_json.get('numLEDs', new_instance.num_leds)
+
+        # Double check that everything has the right data type
+        new_instance.check_data_types()
+
+        return new_instance
+
+    def check_data_types(self) -> bool:
+        """Check that all parameter types are correct"""
+        good_types = True
+
+        good_types = good_types and check_data_type('name', self.name, str)
+        good_types = good_types and check_data_type('start_pixel', self.start_pixel, int)
+        good_types = good_types and check_data_type('end_pixel', self.end_pixel, int)
+        good_types = good_types and check_data_type('physical_start', self.physical_start, int)
+        good_types = good_types and check_data_type('num_leds', self.num_leds, int)
+
+        return good_types

test/animatedledstrip/test_animation_sender.py

@@ -37,6 +37,7 @@ def test_constructor():
     assert sender.newAnimationDataCallback is None
     assert sender.newAnimationInfoCallback is None
     assert sender.newEndAnimationCallback is None
+    assert sender.newSectionCallback is None
     assert sender.newStripInfoCallback is None
 
 
@@ -179,6 +180,31 @@ def test_parse_data_end_animation():
             assert mock_callback.called
 
 
+def test_parse_data_section():
+    sender = AnimationSender('10.0.0.254', 5)
+
+    with mock.patch.object(sender, 'connection') as mock_socket:
+        with mock.patch.object(sender, 'newSectionCallback') as mock_callback:
+            mock_socket.recv.return_value = bytes('SECT:{"physicalStart":0,"numLEDs":240,"name":"section",'
+                                                  '"startPixel":0,"endPixel":239}',
+                                                  'utf-8')
+
+            sender.parse_data()
+
+            assert 'section' in sender.sections
+
+            sect = sender.sections['section']
+
+            assert sect.name == 'section'
+            assert sect.start_pixel == 0
+            assert sect.end_pixel == 239
+            assert sect.physical_start == 0
+            assert sect.num_leds == 240
+
+            assert mock_callback.called
+            assert mock_callback.called_with(sect)
+
+
 def test_parse_data_strip_info():
     sender = AnimationSender('10.0.0.254', 5)
 

test/animatedledstrip/test_section.py

@@ -0,0 +1,165 @@
+#   Copyright (c) 2019-2020 AnimatedLEDStrip
+#
+#   Permission is hereby granted, free of charge, to any person obtaining a copy
+#   of this software and associated documentation files (the "Software"), to deal
+#   in the Software without restriction, including without limitation the rights
+#   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#   copies of the Software, and to permit persons to whom the Software is
+#   furnished to do so, subject to the following conditions:
+#
+#   The above copyright notice and this permission notice shall be included in
+#   all copies or substantial portions of the Software.
+#
+#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+#   THE SOFTWARE.
+
+from unittest import mock
+
+from animatedledstrip import *
+
+
+def test_constructor():
+    sect = Section()
+
+    assert sect.name == ''
+    assert sect.start_pixel == -1
+    assert sect.end_pixel == -1
+    assert sect.physical_start == -1
+    assert sect.num_leds == 0
+
+
+def test_name(caplog):
+    sect = Section()
+
+    sect.name = 'Test'
+    assert sect.check_data_types() is True
+
+    sect.name = 5
+    with mock.patch('animatedledstrip.global_vars.STRICT_TYPE_CHECKING', False):
+        assert sect.check_data_types() is False
+        log_messages = {(log.msg, log.levelname) for log in caplog.records}
+        assert log_messages == {("Bad data type for name: <class 'int'> (should be <class 'str'>)", 'ERROR')}
+
+    try:
+        sect.check_data_types()
+        raise AssertionError
+    except TypeError:
+        pass
+
+
+def test_start_pixel(caplog):
+    sect = Section()
+
+    sect.start_pixel = 3
+    assert sect.check_data_types() is True
+
+    sect.start_pixel = '5'
+    with mock.patch('animatedledstrip.global_vars.STRICT_TYPE_CHECKING', False):
+        assert sect.check_data_types() is False
+        log_messages = {(log.msg, log.levelname) for log in caplog.records}
+        assert log_messages == {("Bad data type for start_pixel: <class 'str'> (should be <class 'int'>)", 'ERROR')}
+
+    try:
+        sect.check_data_types()
+        raise AssertionError
+    except TypeError:
+        pass
+
+
+def test_end_pixel(caplog):
+    sect = Section()
+
+    sect.end_pixel = 3
+    assert sect.check_data_types() is True
+
+    sect.end_pixel = '5'
+    with mock.patch('animatedledstrip.global_vars.STRICT_TYPE_CHECKING', False):
+        assert sect.check_data_types() is False
+        log_messages = {(log.msg, log.levelname) for log in caplog.records}
+        assert log_messages == {("Bad data type for end_pixel: <class 'str'> (should be <class 'int'>)", 'ERROR')}
+
+    try:
+        sect.check_data_types()
+        raise AssertionError
+    except TypeError:
+        pass
+
+
+def test_physical_start(caplog):
+    sect = Section()
+
+    sect.physical_start = 3
+    assert sect.check_data_types() is True
+
+    sect.physical_start = '5'
+    with mock.patch('animatedledstrip.global_vars.STRICT_TYPE_CHECKING', False):
+        assert sect.check_data_types() is False
+        log_messages = {(log.msg, log.levelname) for log in caplog.records}
+        assert log_messages == {("Bad data type for physical_start: <class 'str'> (should be <class 'int'>)", 'ERROR')}
+
+    try:
+        sect.check_data_types()
+        raise AssertionError
+    except TypeError:
+        pass
+
+
+def test_num_leds(caplog):
+    sect = Section()
+
+    sect.num_leds = 3
+    assert sect.check_data_types() is True
+
+    sect.num_leds = '5'
+    with mock.patch('animatedledstrip.global_vars.STRICT_TYPE_CHECKING', False):
+        assert sect.check_data_types() is False
+        log_messages = {(log.msg, log.levelname) for log in caplog.records}
+        assert log_messages == {("Bad data type for num_leds: <class 'str'> (should be <class 'int'>)", 'ERROR')}
+
+    try:
+        sect.check_data_types()
+        raise AssertionError
+    except TypeError:
+        pass
+
+
+def test_json():
+    sect = Section()
+
+    sect.name = 'TEST'
+    sect.start_pixel = 40
+    sect.end_pixel = 50
+
+    assert sect.json() == 'SECT:{"name":"TEST","startPixel":40,"endPixel":50}'
+
+
+def test_json_bad_type():
+    sect = Section()
+    sect.start_pixel = 'bad'
+
+    with mock.patch('animatedledstrip.global_vars.STRICT_TYPE_CHECKING', False):
+        assert sect.json() == ''
+
+    try:
+        sect.json()
+        raise AssertionError
+    except TypeError:
+        pass
+
+
+def test_from_json():
+    json_data = 'SECT:{"physicalStart":0,"numLEDs":240,"name":"section","startPixel":0,"endPixel":239}'
+
+    sect = Section.from_json(json_data)
+    assert sect.name == 'section'
+    assert sect.start_pixel == 0
+    assert sect.end_pixel == 239
+    assert sect.physical_start == 0
+    assert sect.num_leds == 240
+
+    assert sect.json() == 'SECT:{"name":"section","startPixel":0,"endPixel":239}'