Merge pull request #88 from EmbroidePy/tatarize-colorblock

Colorblock correction

Author: tatarize

pyembroidery/DstReader.py

@@ -52,13 +52,18 @@ def process_header_info(out, prefix, value):
 
 def dst_read_header(f, out):
     header = f.read(512)
-    try:
-        header_string = header.decode('utf8')
-        for line in [x.strip() for x in header_string.split('\r')]:
-            if len(line) > 3:
-                process_header_info(out, line[0:2].strip(), line[3:].strip())
-    except UnicodeDecodeError:  # The header contains non-utf8 information and omitted. See #83
-        pass
+    start = 0
+    for i, element in enumerate(header):
+        if element == 13 or element == 10 or element == '\n' or element == '\r':  # 13 =='\r', 10 = '\n'
+            end = i
+            data = header[start:end]
+            start = end
+            try:
+                line = data.decode('utf8').strip()
+                if len(line) > 3:
+                    process_header_info(out, line[0:2].strip(), line[3:].strip())
+            except UnicodeDecodeError:  # Non-utf8 information. See #83
+                continue
 
 
 def dst_read_stitches(f, out, settings=None):

pyembroidery/EmbPattern.py

@@ -312,18 +312,41 @@ def get_as_command_blocks(self):
         yield self.stitches[last_pos:]
 
     def get_as_colorblocks(self):
+        """
+        Returns a generator for colorblocks. Color blocks defined with color_breaks will have
+        the command omitted whereas color blocks delimited with color_change will end with the
+        color_change command, and if delimited with needle_set, the blocks will begin the new
+        color block with the needle_set.
+        """
         thread_index = 0
-        last_pos = 0
+        colorblock_start = 0
+
         for pos, stitch in enumerate(self.stitches):
             command = stitch[2] & COMMAND_MASK
-            if command != COLOR_CHANGE and command != NEEDLE_SET:
+            if command == COLOR_BREAK:
+                if colorblock_start != pos:
+                    thread = self.get_thread_or_filler(thread_index)
+                    thread_index += 1
+                    yield self.stitches[colorblock_start:pos-1], thread
+                colorblock_start = pos + 1
                 continue
+            if command == COLOR_CHANGE:
+                thread = self.get_thread_or_filler(thread_index)
+                thread_index += 1
+                yield self.stitches[colorblock_start:pos+1], thread
+                colorblock_start = pos+1
+                continue
+            if command == NEEDLE_SET and colorblock_start != pos:
+                thread = self.get_thread_or_filler(thread_index)
+                thread_index += 1
+                yield self.stitches[colorblock_start:pos-1], thread
+                colorblock_start = pos-1
+                continue
+
+
+        if colorblock_start != len(self.stitches):
             thread = self.get_thread_or_filler(thread_index)
-            thread_index += 1
-            yield (self.stitches[last_pos:pos], thread)
-            last_pos = pos
-        thread = self.get_thread_or_filler(thread_index)
-        yield (self.stitches[last_pos:], thread)
+            yield (self.stitches[colorblock_start:], thread)
 
     def get_as_stitches(self):
         """pos, x, y, command, v1, v2, v3"""

pyembroidery/EmbThread.py

@@ -96,18 +96,35 @@ def color_distance_red_mean(
 
 class EmbThread:
 
-    def __init__(self, thread=None):
+    def __init__(self, thread=None, description=None, catalog_number=None, details=None, brand=None, chart=None, weight=None):
         self.color = 0x000000
-        self.description = None  # type: str
-        self.catalog_number = None  # type: str
-        self.details = None  # type: str
-        self.brand = None  # type: str
-        self.chart = None  # type: str
-        self.weight = None  # type: str
+        self.description = description  # type: str
+        self.catalog_number = catalog_number  # type: str
+        self.details = details  # type: str
+        self.brand = brand  # type: str
+        self.chart = chart  # type: str
+        self.weight = weight  # type: str
         # description, catalog_number, details, brand, chart, weight
         if thread is not None:
             self.set(thread)
 
+    def __repr__(self):
+        parts = list()
+        parts.append("thread='%s'" % self.hex_color())
+        if self.description is not None:
+            parts.append("description='%s'" % self.description)
+        if self.catalog_number is not None:
+            parts.append("catalog_number='%s'" % self.catalog_number)
+        if self.details is not None:
+            parts.append("details='%s'" % self.details)
+        if self.brand is not None:
+            parts.append("brand='%s'" % self.brand)
+        if self.chart is not None:
+            parts.append("chart='%s'" % self.chart)
+        if self.weight is not None:
+            parts.append("weight='%s'" % self.weight)
+        return "EmbThread(%s)" % " ,".join(parts)
+
     def __ne__(self, other):
         return not self.__eq__(other)
 

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="pyembroidery",
-    version="1.4.11",
+    version="1.4.15",
     author="Tatarize",
     author_email="[email protected]",
     description="Embroidery IO library",
@@ -16,7 +16,6 @@
     classifiers=(
         'Development Status :: 5 - Production/Stable',
         'Intended Audience :: Developers',
-        "Programming Language :: Python :: 2.7",
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
         "License :: OSI Approved :: MIT License",

test/test_embpattern.py

@@ -279,3 +279,135 @@ def test_write_csv_read_csv_encoded_command(self):
         print("csv-encoded: ", csv_pattern.stitches)
         self.assertEqual(encoded_command, csv_pattern.stitches[-1][2])
         self.addCleanup(os.remove, file1)
+
+    def test_issue_87(self):
+        """
+        Initial test raised by issue 87.
+        """
+        pattern = EmbPattern()
+        stitches_1 = [[0, 1], [2, 3]]
+        stitches_2 = [[4, 5], [6, 7]]
+        pattern.add_block(stitches_1, 0xFF0000)
+        pattern.add_block(stitches_2, 0x0000FF)
+        self.assertEqual(len(list(pattern.get_as_colorblocks())), 2)
+
+    def test_issue_87_2(self):
+        """
+        Tests a pattern arbitrarily starting with a color change.
+        With two predefined blocks. The blocks should maintain their blockness.
+        The color change should isolate 0 stitches, of an unknown color.
+        :return:
+        """
+        pattern = EmbPattern()
+        stitches_1 = [[0, 1], [2, 3]]
+        stitches_2 = [[4, 5], [6, 7]]
+
+        pattern.color_change()
+        pattern.add_thread('random')
+        pattern.add_block(stitches_1, 0xFF0000)
+        pattern.add_block(stitches_2, 0x0000FF)
+        blocks = list(pattern.get_as_colorblocks())
+        # for q in blocks:
+        #     print(q)
+        self.assertEqual(blocks[1][1].color, 0xFF0000)
+        self.assertEqual(blocks[2][1].color, 0x0000FF)
+        self.assertEqual(len(blocks), 3)
+
+        for block in blocks:
+            stitch_block = block[0]
+            for stitch in stitch_block:
+                self.assertNotEqual(stitch[2], COLOR_BREAK)
+
+        pattern = EmbPattern()
+        pattern.add_thread('random')
+        pattern.color_change()  # end block 1, empty
+        pattern.add_thread(0xFF0000)
+        pattern += stitches_1
+        pattern.color_change()  # end block 2
+        pattern.add_thread(0x0000FF)
+        pattern += stitches_2
+        blocks = list(pattern.get_as_colorblocks())
+        # end block 3, no explicit end.
+        # for q in blocks:
+        #     print(q)
+        self.assertEqual(blocks[0][0][-1][2], COLOR_CHANGE)  # Color change ends the block.
+        self.assertEqual(blocks[1][0][-1][2], COLOR_CHANGE)  # Color change ends the block.
+        self.assertEqual(blocks[1][1].color, 0xFF0000)
+        self.assertEqual(blocks[2][1].color, 0x0000FF)
+        self.assertEqual(len(blocks), 3)
+
+    def test_issue_87_3(self):
+        """
+        Tests a pattern arbitrarily starting with a needle_set.
+        With two predefined blocks. The blocks should maintain their blockness.
+        The needle set should not contribute a block. Initial needle_set, only
+        define a starting needle.
+        :return:
+        """
+        pattern = EmbPattern()
+        pattern.needle_change()
+        stitches_1 = [[0, 1], [2, 3]]
+        stitches_2 = [[4, 5], [6, 7]]
+        pattern.add_block(stitches_1, 0xFF0000)
+        pattern.add_block(stitches_2, 0x0000FF)
+        blocks = list(pattern.get_as_colorblocks())
+        # for q in blocks:
+        #     print(q)
+        self.assertEqual(blocks[0][1], 0xFF0000)
+        self.assertEqual(blocks[1][1], 0x0000FF)
+        self.assertEqual(len(blocks), 2)
+        for block in blocks:
+            stitch_block = block[0]
+            for stitch in stitch_block:
+                self.assertNotEqual(stitch[2], COLOR_BREAK)
+
+        pattern = EmbPattern()
+
+        pattern.needle_change()  # start block 0
+        pattern += stitches_1
+        pattern += EmbThread(0xFF0000)
+
+        pattern.needle_change()  # start block 1
+        pattern += stitches_1
+        pattern += EmbThread(0x0000FF)
+
+        pattern.needle_change()  # start block 2
+        pattern += EmbThread('random')
+
+        blocks = list(pattern.get_as_colorblocks())
+        # for q in blocks:
+        #     print(q)
+        # Mask is required here since needle_set automatically appends extended data.
+        self.assertEqual(blocks[0][0][0][2] & COMMAND_MASK, NEEDLE_SET)  # Needle_set starts the block.
+        self.assertEqual(blocks[1][0][0][2] & COMMAND_MASK, NEEDLE_SET)  # Needle_set starts the block.
+        self.assertEqual(blocks[0][1], 0xFF0000)
+        self.assertEqual(blocks[1][1], 0x0000FF)
+        self.assertEqual(len(blocks), 3)
+
+    def test_issue_87_4(self):
+        """
+        Tests a pattern arbitrarily starting with a color break.
+        With two predefined blocks. The blocks should maintain their blockness.
+        And ending with another arbitrary color break. This should give exactly
+        2 blocks which were defined as prepended colorbreaks postpended color breaks
+        are not to have an impact.
+        :return:
+        """
+        pattern = EmbPattern()
+        pattern += COLOR_BREAK
+        stitches_1 = [[0, 1], [2, 3]]
+        stitches_2 = [[4, 5], [6, 7]]
+        pattern.add_block(stitches_1, 0xFF0000)
+        pattern.add_block(stitches_2, 0x0000FF)
+        pattern += COLOR_BREAK
+        blocks = list(pattern.get_as_colorblocks())
+        # for q in blocks:
+        #     print(q)
+        
+        for block in blocks:
+            stitch_block = block[0]
+            for stitch in stitch_block:
+                self.assertNotEqual(stitch[2], COLOR_BREAK)
+        self.assertEqual(blocks[0][1], 0xFF0000)
+        self.assertEqual(blocks[1][1], 0x0000FF)
+        self.assertEqual(len(list(pattern.get_as_colorblocks())), 2)