Merge pull request #129 from CadQuery/debug-fix

Debug fix

Author: adam-urbanczyk

cq_editor/widgets/debugger.py

@@ -185,6 +185,32 @@ def _exec(self, code, locals_dict, globals_dict):
             if self.preferences['Change working dir to script dir'] and p:
                 stack.enter_context(p)
             exec(code, locals_dict, globals_dict)
+            
+    def _inject_locals(self,module):
+        
+        cq_objects = {}
+        
+        def _show_object(obj,name=None, options={}):
+
+            if name:
+                cq_objects.update({name : SimpleNamespace(shape=obj,options=options)})
+            else:
+                cq_objects.update({str(id(obj)) : SimpleNamespace(shape=obj,options=options)})
+                
+        def _debug(obj,name=None):
+            
+            _show_object(obj,name,options=dict(color='red',alpha=0.2))
+
+        module.__dict__['show_object'] = _show_object
+        module.__dict__['debug'] = _debug
+        module.__dict__['log'] = lambda x: info(str(x))
+        module.__dict__['cq'] = cq
+        
+        return cq_objects, set(module.__dict__)-{'cq'}
+    
+    def _cleanup_locals(self,module,injected_names):
+        
+        for name in injected_names: module.__dict__.pop(name)
 
     @pyqtSlot(bool)
     def render(self):
@@ -193,37 +219,25 @@ def render(self):
             reload_cq()
 
         cq_script = self.get_current_script()
-        cq_code,t = self.compile_code(cq_script)
+        cq_code,module = self.compile_code(cq_script)
 
         if cq_code is None: return
-
-        cq_objects = {}
-
-        def _show_object(obj,name=None, options={}):
-
-            if name:
-                cq_objects.update({name : SimpleNamespace(shape=obj,options=options)})
-            else:
-                cq_objects.update({str(id(obj)) : SimpleNamespace(shape=obj,options=options)})
-
-        t.__dict__['show_object'] = _show_object
-        t.__dict__['debug'] = lambda x: info(str(x))
-        t.__dict__['cq'] = cq
+        
+        cq_objects,injected_names = self._inject_locals(module)
 
         try:
-            self._exec(cq_code, t.__dict__, t.__dict__)
+            self._exec(cq_code, module.__dict__, module.__dict__)
 
             #remove the special methods
-            t.__dict__.pop('show_object')
-            t.__dict__.pop('debug')
+            self._cleanup_locals(module,injected_names)
 
-            #collect all CQ objects if no explicti show_object was called
+            #collect all CQ objects if no explicit show_object was called
             if len(cq_objects) == 0:
-                cq_objects = find_cq_objects(t.__dict__)
+                cq_objects = find_cq_objects(module.__dict__)
             self.sigRendered.emit(cq_objects)
             self.sigTraceback.emit(None,
                                    cq_script)
-            self.sigLocals.emit(t.__dict__)
+            self.sigLocals.emit(module.__dict__)
         except Exception:
             self.sigTraceback.emit(sys.exc_info(),
                                    cq_script)
@@ -241,6 +255,8 @@ def debug(self,value):
                 self.sigDebugging.emit(False)
                 self._actions['Run'][1].setChecked(False)
                 return
+            
+            cq_objects,injected_names = self._inject_locals(module)
 
             self.breakpoints = [ el[0] for el in self.get_breakpoints()]
 
@@ -257,6 +273,13 @@ def debug(self,value):
                 sys.settrace(None)
                 self.sigDebugging.emit(False)
                 self._actions['Run'][1].setChecked(False)
+                
+                if len(cq_objects) == 0:
+                    cq_objects = find_cq_objects(module.__dict__)
+                self.sigRendered.emit(cq_objects)
+                
+                self._cleanup_locals(module,injected_names)
+                self.sigLocals.emit(module.__dict__)
         else:
             sys.settrace(None)
             self.inner_event_loop.exit(0)

cq_editor/widgets/object_tree.py

@@ -223,6 +223,20 @@ def addLines(self):
 
         self.sigObjectsAdded.emit(ais_list)
 
+    def _current_properties(self):
+
+        current_params = {}
+        for i in range(self.CQ.childCount()):
+            child = self.CQ.child(i)
+            current_params[child.properties['Name']] = child.properties
+
+        return current_params
+
+    def _restore_properties(self,obj,properties):
+
+        for p in properties[obj.properties['Name']]:
+            obj.properties[p.name()] = p.value()
+
     @pyqtSlot(dict,bool)
     @pyqtSlot(dict)
     def addObjects(self,objects,clean=False,root=None):
@@ -234,10 +248,7 @@ def addObjects(self,objects,clean=False,root=None):
         preserve_props = self.preferences['Preserve properties on reload']
 
         if preserve_props:
-            old_params = {}
-            for i in range(self.CQ.childCount()):
-                child = self.CQ.child(i)
-                old_params[child.properties['Name']] = child.properties
+            current_props = self._current_properties()
 
         if clean or self.preferences['Clear all before each run']:
             self.removeObjects()
@@ -256,9 +267,8 @@ def addObjects(self,objects,clean=False,root=None):
                                    ais=ais,
                                    sig=self.sigObjectPropertiesChanged)
 
-            if preserve_props and name in old_params:
-                for p in old_params[name]:
-                    child.properties[p.name()] = p.value()
+            if preserve_props and name in current_props:
+                self._restore_properties(child,current_props)
 
             if child.properties['Visible']:
                 ais_list.append(ais)

tests/test_app.py

@@ -42,7 +42,7 @@
 result = result.box(3, 3, 0.5)
 result = result.edges("|Z").fillet(0.125)
 
-debug('test')
+log('test')
 show_object(result,name='test')
 '''
 
@@ -55,6 +55,15 @@
 show_object(result.val())
 '''
 
+code_debug_Workplane = \
+'''import cadquery as cq
+result = cq.Workplane("XY" )
+result = result.box(3, 3, 0.5)
+result = result.edges("|Z").fillet(0.125)
+
+debug(result)
+'''
+
 code_multi = \
 '''import cadquery as cq
 result1 = cq.Workplane("XY" ).box(3, 3, 0.5)
@@ -85,6 +94,13 @@ def get_bottom_left(widget):
 
     return pos
 
+def get_rgba(ais):
+        
+    alpha = ais.Transparency()
+    color = get_occ_color(ais)
+        
+    return color.redF(),color.redF(),color.redF(),alpha
+
 @pytest.fixture
 def main(qtbot,mocker):
 
@@ -335,24 +351,24 @@ def patch_debugger(debugger,event_loop_mock):
     assert(number_visible_items(viewer) == 3)
 
     #test step through
-    ev = event_loop([lambda: (assert_func(variables.model().rowCount() == 0),
+    ev = event_loop([lambda: (assert_func(variables.model().rowCount() == 4),
                               assert_func(number_visible_items(viewer) == 3),
                               step.triggered.emit()),
-                     lambda: (assert_func(variables.model().rowCount() == 1),
+                     lambda: (assert_func(variables.model().rowCount() == 4),
                               assert_func(number_visible_items(viewer) == 3),
                               step.triggered.emit()),
-                     lambda: (assert_func(variables.model().rowCount() == 2),
+                     lambda: (assert_func(variables.model().rowCount() == 5),
                               assert_func(number_visible_items(viewer) == 3),
                               step.triggered.emit()),
-                     lambda: (assert_func(variables.model().rowCount() == 2),
+                     lambda: (assert_func(variables.model().rowCount() == 5),
                               assert_func(number_visible_items(viewer) == 4),
                               cont.triggered.emit())])
 
     patch_debugger(debugger,ev)
 
     debug.triggered.emit(True)
     assert(variables.model().rowCount() == 2)
-    assert(number_visible_items(viewer) == 3)
+    assert(number_visible_items(viewer) == 4)
 
     #test exit debug
     ev = event_loop([lambda: (step.triggered.emit(),),
@@ -369,7 +385,7 @@ def patch_debugger(debugger,event_loop_mock):
 
     #test breakpoint
     ev = event_loop([lambda: (cont.triggered.emit(),),
-                     lambda: (assert_func(variables.model().rowCount() == 2),
+                     lambda: (assert_func(variables.model().rowCount() == 5),
                               assert_func(number_visible_items(viewer) == 4),
                               cont.triggered.emit(),)])
 
@@ -380,7 +396,45 @@ def patch_debugger(debugger,event_loop_mock):
     debug.triggered.emit(True)
 
     assert(variables.model().rowCount() == 2)
-    assert(number_visible_items(viewer) == 3)
+    assert(number_visible_items(viewer) == 4)
+    
+    #test breakpoint without using singals
+    ev = event_loop([lambda: (cont.triggered.emit(),),
+                     lambda: (assert_func(variables.model().rowCount() == 5),
+                              assert_func(number_visible_items(viewer) == 4),
+                              cont.triggered.emit(),)])
+
+    patch_debugger(debugger,ev)
+
+    editor.set_breakpoints([(4,None)])
+
+    debugger.debug(True)
+
+    assert(variables.model().rowCount() == 2)
+    assert(number_visible_items(viewer) == 4)
+    
+    #test debug() without using singals
+    ev = event_loop([lambda: (cont.triggered.emit(),),
+                     lambda: (assert_func(variables.model().rowCount() == 5),
+                              assert_func(number_visible_items(viewer) == 4),
+                              cont.triggered.emit(),)])
+
+    patch_debugger(debugger,ev)
+
+    editor.set_text(code_debug_Workplane)
+    editor.set_breakpoints([(4,None)])
+
+    debugger.debug(True)
+    
+    CQ = obj_tree.CQ
+    
+    # object 1 (defualt color)
+    r,g,b,a = get_rgba(CQ.child(0).ais)
+    assert( a == pytest.approx(0.2) )
+    assert( r == 1.0 )
+
+    assert(variables.model().rowCount() == 2)
+    assert(number_visible_items(viewer) == 4)
 
     # restore the tracing function
     sys.settrace(trace_function)
@@ -884,13 +938,6 @@ def test_render_colors(main_clean):
 
     editor.set_text(code_color)
     debugger._actions['Run'][0].triggered.emit()
-
-    def get_rgba(ais):
-        
-        alpha = ais.Transparency()
-        color = get_occ_color(ais)
-        
-        return color.redF(),color.redF(),color.redF(),alpha
 
     CQ = obj_tree.CQ