Parser for gcode files has been added

octoprint_printhistory/parser.py

@@ -0,0 +1,283 @@
+# coding=utf-8
+import re
+import os
+import io
+import unittest
+import ConfigParser
+
+VERSION_REGEX = re.compile(r"(\d+)?\.(\d+)?\.?(\*|\d+)")
+BUFFER_SIZE = 8192
+
+
+class UniversalParser:
+    def __init__(self, file_path):
+        self.parser_factory = None
+        self.name = None
+        self.version = None
+        self.file = open(file_path, "r")
+        for parser in [CuraParser(), Slic3rParser(), Simplify3DParser()]:
+            if parser.detect(self.file):
+                self.parser_factory = parser
+                self.name = parser.name
+                self.version = parser.version
+
+    def parse(self):
+        parameters = self.parser_factory.parse(self.file)
+        parameters.update({"slicer_name": self.name})
+        parameters.update({"slicer_version": self.version})
+        return parameters
+
+
+class BaseParser:
+    def parse(self, gcode_file):
+        parameters = {}
+        parameters.update(self.parse_header(gcode_file))
+        parameters.update(self.parse_bottom(gcode_file))
+        gcode_file.close()
+        return parameters
+
+
+class CuraParser(BaseParser):
+    def __init__(self):
+        self.name = "cura"
+        self.version = None
+
+    def detect(self, gcode_file):
+        detected = False
+        # on the third line
+        # ;Generated with Cura_SteamEngine 2.3.1
+        for _ in range(3):
+            line = gcode_file.readline()
+            if re.search(r"Cura_SteamEngine", line):
+                detected = True
+                self.version = VERSION_REGEX.search(line).group(0)
+        gcode_file.seek(0)
+        return detected
+
+    def parse_header(self, gcode_file):
+        parameters = {}
+        for i in range(15):
+            line = gcode_file.readline()
+            if line.startswith(";"):
+                line = line.replace(";", "")
+                if line.startswith("TIME") or line.startswith("LAYER_COUNT"):
+                    splitted = line.split(":", 1)
+                    parameters.update({splitted[0]: splitted[1].strip()})
+        gcode_file.seek(0)
+        return parameters
+
+    def parse_bottom(self, gcode_file):
+        parameters = {}
+        settings_reversed = []
+        settings = []
+        for line in reverse_readline(gcode_file):
+            if line.startswith(";SETTING_3"):
+                line = line.replace(";SETTING_3", "")
+                settings_reversed.append(line)
+            else:
+                break
+        [settings.append(x.strip()) for x in reversed(settings_reversed)]
+        settings = "".join(settings).replace("\\\\n", "\n")
+        settings = settings.replace('{"global_quality": "', "")
+        settings = settings.replace('"}', "")
+        config = ConfigParser.RawConfigParser(allow_no_value=True)
+        config.readfp(io.BytesIO(settings))
+        try:
+            for section in ["values", "metadata"]:
+                for option in config.options(section):
+                    parameters.update({option: config.get(section, option)})
+        except ConfigParser.NoOptionError:
+            pass
+        return parameters
+
+
+class Slic3rParser(BaseParser):
+    def __init__(self):
+        self.name = "slic3r"
+        self.version = None
+        self.is_parameter = re.compile(r"^[\w _]+={1}")
+
+    def detect(self, gcode_file):
+        detected = False
+        # on the first line
+        # ; generated by Slic3r 1.2.9 on 2017-01-30 at 21:53:46
+        line = gcode_file.readline()
+        gcode_file.seek(0)
+        if re.search(r"Slic3r", line):
+            self.version = VERSION_REGEX.search(line).group(0)
+            detected = True
+        return detected
+
+    def parse_header(self, gcode_file):
+        parameters = {}
+        for line in gcode_file:
+            if line.startswith(";"):
+                line = line.split(";")[1].strip()
+                if self.is_parameter.match(line):
+                    splitted = line.split("=")
+                    param = splitted[0].strip()
+                    value = splitted[1].strip()
+                    parameters.update({param: value})
+            elif line == "\n":
+                continue
+            else:
+                break
+        gcode_file.seek(0)
+        return parameters
+
+    def parse_bottom(self, gcode_file):
+        parameters = {}
+        for line in reverse_readline(gcode_file):
+            if line.startswith(";"):
+                line = line.split(";")[1].strip()
+                if self.is_parameter.match(line):
+                    splitted = line.split("=")
+                    param = splitted[0].strip()
+                    value = splitted[1].strip()
+                    parameters.update({param: value})
+            elif line == "\n":
+                continue
+            else:
+                break
+        return parameters
+
+
+class Simplify3DParser(BaseParser):
+    def __init__(self):
+        self.name = "simplify3d"
+        self.version = None
+        # checks if string starts with a word followed by a comma
+        self.is_parameter = re.compile(r"^\w+,{1}")
+        self.is_bparameter = re.compile(r"^[\w ]+:{1}")
+
+    def detect(self, gcode_file):
+        detected = False
+        # on the first line
+        # ; G-Code generated by Simplify3D(R) Version 3.1.0
+        line = gcode_file.readline()
+        gcode_file.seek(0)
+        if re.search(r"Simplify3D\(R\)", line):
+            self.version = VERSION_REGEX.search(line).group(0)
+            detected = True
+        return detected
+
+    def parse_header(self, gcode_file):
+        parameters = {}
+        for line in gcode_file:
+            if line.startswith(";"):
+                # extract a string between semicolons ; =>target string<= ;
+                line = line.split(";")[1].strip()
+                if self.is_parameter.match(line):
+                    comma_split = line.split(",")
+                    param = comma_split[0]
+                    value = ",".join(comma_split[1:])
+                    try:
+                        parameters.update({param: value})
+                    except ValueError:
+                        pass
+            # comment section is ended
+            else:
+                break
+        gcode_file.seek(0)
+        return parameters
+
+    def parse_bottom(self, gcode_file):
+        # Filament length is a duplicate
+        # ; Build Summary
+        # ;   Build time: 3 hours 30 minutes
+        # ;   Filament length: 54599.6 mm (54.60 m)
+        # ;   Plastic volume: 131327.49 mm^3 (131.33 cc)
+        # ;   Plastic weight: 164.16 g (0.36 lb)
+        # ;   Material cost: 20.52
+        parameters = {}
+        for line in reverse_readline(gcode_file):
+            if line.startswith(";"):
+                line = line.split(";")[1].strip()
+                if self.is_bparameter.match(line):
+                    splitted = line.split(":")
+                    param = splitted[0]
+                    value = splitted[1].strip()
+                    parameters.update({param: value})
+            else:
+                break
+        # Rename "Filament length"
+        return parameters
+
+def reverse_readline(fh, buf_size=BUFFER_SIZE):
+    """a generator that returns the lines of a file in reverse order
+       It's a memory-efficient way to read file backwards.
+       http://stackoverflow.com/questions/2301789/read-a-file-in-reverse-order-using-python
+    """
+    segment = None
+    offset = 0
+    fh.seek(0, os.SEEK_END)
+    file_size = remaining_size = fh.tell()
+    while remaining_size > 0:
+        offset = min(file_size, offset + buf_size)
+        fh.seek(file_size - offset)
+        buffer = fh.read(min(remaining_size, buf_size))
+        remaining_size -= buf_size
+        lines = buffer.split('\n')
+        # the first line of the buffer is probably not a complete line so
+        # we'll save it and append it to the last line of the next buffer
+        # we read
+        if segment is not None:
+            # if the previous chunk starts right from the beginning of line
+            # do not concact the segment to the last line of new chunk
+            # instead, yield the segment first
+            if buffer[-1] is not '\n':
+                lines[-1] += segment
+            else:
+                yield segment
+        segment = lines[0]
+        for index in range(len(lines) - 1, 0, -1):
+            if len(lines[index]):
+                yield lines[index]
+    # Don't yield None if the file was empty
+    if segment is not None:
+        yield segment
+
+
+class TestUniversalParser(unittest.TestCase):
+    def setUp(self):
+        self.simplify3d_file = "parser_test/simplify3d_test.gcode"
+        self.slic3r_file = "parser_test/slic3r_test.gcode"
+        self.cura_file = "parser_test/cura_test.gcode"
+
+    def test_simplify3d_detection(self):
+        uparser = UniversalParser(self.simplify3d_file)
+        self.assertEqual(uparser.name, "simplify3d")
+
+    def test_simplify3d_parse(self):
+        uparser = UniversalParser(self.simplify3d_file)
+        result = uparser.parse()
+        self.assertEqual(len(result), 187)
+        self.assertIn("Filament length", result)
+        self.assertEqual(result["slicer_version"], "3.1.0")
+
+    def test_slic3r_detection(self):
+        uparser = UniversalParser(self.slic3r_file)
+        self.assertEqual(uparser.name, "slic3r")
+
+    def test_slic3r_parse(self):
+        uparser = UniversalParser(self.slic3r_file)
+        result = uparser.parse()
+        self.assertEqual(len(result), 137)
+        self.assertIn("thin_walls", result)
+        self.assertIn("support material extrusion width", result)
+        self.assertEqual(result["slicer_version"], "1.2.9")
+
+    def test_cura_detection(self):
+        uparser = UniversalParser(self.cura_file)
+        self.assertEqual(uparser.name, "cura")
+
+    def test_cura_parse(self):
+        uparser = UniversalParser(self.cura_file)
+        result = uparser.parse()
+        self.assertEqual(len(result), 12)
+        self.assertIn("adhesion_type", result)
+        self.assertEqual(result["slicer_version"], "2.3.1")
+
+
+if __name__ == "__main__":
+    unittest.main()

octoprint_printhistory/parser_test/README.txt

@@ -0,0 +1 @@
+Do not use those files for printing, they are prepared for testing purposes.

octoprint_printhistory/parser_test/cura_test.gcode

@@ -0,0 +1,17 @@
+;FLAVOR:RepRap
+;TIME:23464
+;Generated with Cura_SteamEngine 2.3.1
+M84
+M84
+M84;M84
+;LAYER_COUNT:1476
+;LAYER:0
+;M84
+M84
+M84
+;End of Gcode
+;SETTING_3 {"global_quality": "[general]\\nversion = 2\\nname = empty\\ndefiniti
+;SETTING_3 on = custom\\n\\n[metadata]\\nquality_type = low\\ntype = quality_cha
+;SETTING_3 nges\\n\\n[values]\\ninfill_sparse_density = 30\\nadhesion_type = ski
+;SETTING_3 rt\\nspeed_travel = 150\\nspeed_print = 47\\nsupport_enable = True\\n
+;SETTING_3 material_diameter = 1.75\\n\\n"}