From 8aa86f66199a2657ab01ac1a8c52ed1312be2804 Mon Sep 17 00:00:00 2001 From: Lex Neva Date: Thu, 28 Mar 2019 14:47:05 -0400 Subject: set up debug logging --- lib/debug.py | 84 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 lib/debug.py (limited to 'lib/debug.py') diff --git a/lib/debug.py b/lib/debug.py new file mode 100644 index 00000000..33d30d4f --- /dev/null +++ b/lib/debug.py @@ -0,0 +1,84 @@ +from datetime import datetime +import os +import socket +import sys +import time + + +class Debug(object): + def __init__(self): + self.last_log_time = None + + def enable(self): + self.enable_log() + self.enable_debugger() + + def enable_log(self): + self.log = self._log + self.raw_log = self._raw_log + self.log_file = open(os.path.join(os.path.dirname(os.path.dirname(__file__)), "debug.log"), "w") + self.log("Debug logging enabled.") + + def enable_debugger(self): + # How to debug Ink/Stitch: + # + # 1. Install LiClipse (liclipse.com) -- no need to install Eclipse first + # 2. Start debug server as described here: http://www.pydev.org/manual_adv_remote_debugger.html + # * follow the "Note:" to enable the debug server menu item + # 3. Create a file named "DEBUG" next to inkstitch.py in your git clone. + # 4. Run any extension and PyDev will start debugging. + + try: + import pydevd + except ImportError: + self.log("importing pydevd failed (debugger disabled)") + + # pydevd likes to shout about errors to stderr whether I want it to or not + with open(os.devnull, 'w') as devnull: + stderr = sys.stderr + sys.stderr = devnull + + try: + pydevd.settrace() + except socket.error, error: + self.log("Debugging: connection to pydevd failed: %s", error) + self.log("Be sure to run 'Start debugging server' in PyDev to enable debugging.") + else: + self.log("Enabled PyDev debugger.") + + sys.stderr = stderr + + def _noop(self, *args, **kwargs): + pass + + log = _noop + raw_log = _noop + + def _log(self, message, *args): + if self.last_log_time: + message = "(+%s) %s" % (datetime.now() - self.last_log_time, message) + + self.raw_log(message, *args) + + def _raw_log(self, message, *args): + now = datetime.now() + timestamp = now.isoformat() + self.last_log_time = now + + print >> self.log_file, timestamp, message % args + self.log_file.flush() + + def time(self, func): + def decorated(*args, **kwargs): + self.raw_log("entering %s()", func.func_name) + start = time.time() + result = func(*args, **kwargs) + end = time.time() + self.raw_log("leaving %s(), duration = %s", func.func_name, round(end - start, 6)) + return result + + return decorated + + +debug = Debug() +enable = debug.enable -- cgit v1.2.3 From 19950150210e5a3d7a76881b96e9b8b49e663309 Mon Sep 17 00:00:00 2001 From: Lex Neva Date: Thu, 28 Mar 2019 15:52:37 -0400 Subject: add SVG debugging with LineStrings --- lib/debug.py | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) (limited to 'lib/debug.py') diff --git a/lib/debug.py b/lib/debug.py index 33d30d4f..05c367f0 100644 --- a/lib/debug.py +++ b/lib/debug.py @@ -1,17 +1,27 @@ +import atexit from datetime import datetime import os import socket import sys import time +from inkex import etree +import inkex +from simplestyle import formatStyle + +from svg import line_strings_to_path +from svg.tags import INKSCAPE_GROUPMODE, INKSCAPE_LABEL + class Debug(object): def __init__(self): self.last_log_time = None + self.current_layer = None def enable(self): self.enable_log() self.enable_debugger() + self.enable_svg() def enable_log(self): self.log = self._log @@ -48,6 +58,23 @@ class Debug(object): sys.stderr = stderr + def enable_svg(self): + self.svg = etree.Element("svg", nsmap=inkex.NSS) + atexit.register(self.save_svg) + + def save_svg(self): + tree = etree.ElementTree(self.svg) + with open(os.path.join(os.path.dirname(os.path.dirname(__file__)), "debug.svg"), "w") as debug_svg: + tree.write(debug_svg) + + def add_layer(self, name="Debug"): + layer = etree.Element("g", { + INKSCAPE_GROUPMODE: "layer", + INKSCAPE_LABEL: name + }) + self.svg.append(layer) + self.current_layer = layer + def _noop(self, *args, **kwargs): pass @@ -79,6 +106,21 @@ class Debug(object): return decorated + def log_svg_element(self, element): + if self.current_layer is None: + self.add_layer() + + self.current_layer.append(element) + + def log_line_string(self, line_string, color="#000000"): + """Add a Shapely LineString to the SVG log.""" + self.log_line_strings(self, [line_string]) + + def log_line_strings(self, line_strings, color="#000000"): + path = line_strings_to_path(line_strings) + path.set('style', formatStyle({"stroke": color, "stroke-width": "0.3"})) + self.log_svg_element(path) + debug = Debug() enable = debug.enable -- cgit v1.2.3 From 90a16fb7f9a44f4274d85cc693a51be9354737ec Mon Sep 17 00:00:00 2001 From: Lex Neva Date: Fri, 29 Mar 2019 15:03:28 -0400 Subject: more debug logging --- lib/debug.py | 102 +++++++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 78 insertions(+), 24 deletions(-) (limited to 'lib/debug.py') diff --git a/lib/debug.py b/lib/debug.py index 05c367f0..13b2f2bc 100644 --- a/lib/debug.py +++ b/lib/debug.py @@ -13,23 +13,32 @@ from svg import line_strings_to_path from svg.tags import INKSCAPE_GROUPMODE, INKSCAPE_LABEL +def check_enabled(func): + def decorated(self, *args, **kwargs): + if self.enabled: + func(self, *args, **kwargs) + + return decorated + + class Debug(object): def __init__(self): + self.enabled = False self.last_log_time = None self.current_layer = None + self.group_stack = [] def enable(self): - self.enable_log() - self.enable_debugger() - self.enable_svg() + self.enabled = True + self.init_log() + self.init_debugger() + self.init_svg() - def enable_log(self): - self.log = self._log - self.raw_log = self._raw_log + def init_log(self): self.log_file = open(os.path.join(os.path.dirname(os.path.dirname(__file__)), "debug.log"), "w") self.log("Debug logging enabled.") - def enable_debugger(self): + def init_debugger(self): # How to debug Ink/Stitch: # # 1. Install LiClipse (liclipse.com) -- no need to install Eclipse first @@ -58,7 +67,7 @@ class Debug(object): sys.stderr = stderr - def enable_svg(self): + def init_svg(self): self.svg = etree.Element("svg", nsmap=inkex.NSS) atexit.register(self.save_svg) @@ -67,6 +76,7 @@ class Debug(object): with open(os.path.join(os.path.dirname(os.path.dirname(__file__)), "debug.svg"), "w") as debug_svg: tree.write(debug_svg) + @check_enabled def add_layer(self, name="Debug"): layer = etree.Element("g", { INKSCAPE_GROUPMODE: "layer", @@ -75,19 +85,28 @@ class Debug(object): self.svg.append(layer) self.current_layer = layer - def _noop(self, *args, **kwargs): - pass + @check_enabled + def open_group(self, name="Group"): + group = etree.Element("g", { + INKSCAPE_LABEL: name + }) - log = _noop - raw_log = _noop + self.log_svg_element(group) + self.group_stack.append(group) - def _log(self, message, *args): + @check_enabled + def close_group(self): + if self.group_stack: + self.group_stack.pop() + + @check_enabled + def log(self, message, *args): if self.last_log_time: message = "(+%s) %s" % (datetime.now() - self.last_log_time, message) self.raw_log(message, *args) - def _raw_log(self, message, *args): + def raw_log(self, message, *args): now = datetime.now() timestamp = now.isoformat() self.last_log_time = now @@ -97,30 +116,65 @@ class Debug(object): def time(self, func): def decorated(*args, **kwargs): - self.raw_log("entering %s()", func.func_name) - start = time.time() + if self.enabled: + self.raw_log("entering %s()", func.func_name) + start = time.time() + result = func(*args, **kwargs) - end = time.time() - self.raw_log("leaving %s(), duration = %s", func.func_name, round(end - start, 6)) + + if self.enabled: + end = time.time() + self.raw_log("leaving %s(), duration = %s", func.func_name, round(end - start, 6)) + return result return decorated + @check_enabled def log_svg_element(self, element): if self.current_layer is None: self.add_layer() - self.current_layer.append(element) + if self.group_stack: + self.group_stack[-1].append(element) + else: + self.current_layer.append(element) - def log_line_string(self, line_string, color="#000000"): + @check_enabled + def log_line_string(self, line_string, name=None, color=None): """Add a Shapely LineString to the SVG log.""" - self.log_line_strings(self, [line_string]) + self.log_line_strings([line_string], name, color) - def log_line_strings(self, line_strings, color="#000000"): + @check_enabled + def log_line_strings(self, line_strings, name=None, color=None): path = line_strings_to_path(line_strings) - path.set('style', formatStyle({"stroke": color, "stroke-width": "0.3"})) + path.set('style', formatStyle({"stroke": color or "#000000", "stroke-width": "0.3"})) + + if name is not None: + path.set(INKSCAPE_LABEL, name) + self.log_svg_element(path) + @check_enabled + def log_line(self, start, end, name="line", color=None): + self.log_svg_element(etree.Element("path", { + "d": "M%s,%s %s,%s" % (start + end), + "style": formatStyle({"stroke": color or "#000000", "stroke-width": "0.3"}), + INKSCAPE_LABEL: name + })) + + @check_enabled + def log_graph(self, graph, name="Graph", color=None): + self.open_group(name) + + for edge in graph.edges: + self.log_line(edge[0], edge[1], color=color) + + self.close_group() + debug = Debug() -enable = debug.enable + + +def enable(): + debug.enable() -- cgit v1.2.3 From 513850c975368f0e323e3cfc173398081245127a Mon Sep 17 00:00:00 2001 From: Lex Neva Date: Fri, 29 Mar 2019 15:42:11 -0400 Subject: add vertical travel edges for less jagged travel paths --- lib/debug.py | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'lib/debug.py') diff --git a/lib/debug.py b/lib/debug.py index 13b2f2bc..fa3bd606 100644 --- a/lib/debug.py +++ b/lib/debug.py @@ -1,4 +1,5 @@ import atexit +from contextlib import contextmanager from datetime import datetime import os import socket @@ -80,7 +81,8 @@ class Debug(object): def add_layer(self, name="Debug"): layer = etree.Element("g", { INKSCAPE_GROUPMODE: "layer", - INKSCAPE_LABEL: name + INKSCAPE_LABEL: name, + "style": "display: none" }) self.svg.append(layer) self.current_layer = layer @@ -172,6 +174,17 @@ class Debug(object): self.close_group() + @contextmanager + def time_this(self, label="code block"): + if self.enabled: + start = time.time() + self.raw_log("begin %s", label) + + yield + + if self.enabled: + self.raw_log("completed %s, duration = %s", label, time.time() - start) + debug = Debug() -- cgit v1.2.3 From 1f7b69980c439c2be00033f566de38c35468782c Mon Sep 17 00:00:00 2001 From: Lex Neva Date: Thu, 4 Apr 2019 19:57:40 -0400 Subject: render graphs as a single path to avoid killing inkscape --- lib/debug.py | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'lib/debug.py') diff --git a/lib/debug.py b/lib/debug.py index fa3bd606..6ce67697 100644 --- a/lib/debug.py +++ b/lib/debug.py @@ -167,12 +167,16 @@ class Debug(object): @check_enabled def log_graph(self, graph, name="Graph", color=None): - self.open_group(name) + d = "" for edge in graph.edges: - self.log_line(edge[0], edge[1], color=color) + d += "M%s,%s %s,%s" % (edge[0] + edge[1]) - self.close_group() + self.log_svg_element(etree.Element("path", { + "d": d, + "style": formatStyle({"stroke": color or "#000000", "stroke-width": "0.3"}), + INKSCAPE_LABEL: name + })) @contextmanager def time_this(self, label="code block"): -- cgit v1.2.3