[Fixed] Some preflights might remove the DRC exclusions

This is a KiCad bug, we had a workaround, but more places needed it

See #653

kibot/gs.py

@@ -991,3 +991,17 @@ def set_global_options_tree(tree):
         glb.set_tree(tree)
         GS.globals_tree = tree
         return glb
+
+    @staticmethod
+    def save_pcb(pcb_file=None, board=None):
+        if pcb_file is None:
+            pcb_file = GS.pcb_file
+        if board is None:
+            board = GS.board
+        GS.make_bkp(pcb_file)
+        # KiCad likes to write the project every time we save the PCB
+        # But KiCad doesn't read the exclusions, so they get lost
+        # As a workaround we restore the project, there is no need to change it
+        prj = GS.read_pro()
+        board.Save(pcb_file)
+        GS.write_pro(prj)

kibot/kiplot.py

@@ -215,7 +215,7 @@ def load_board(pcb_file=None, forced=False):
             logger.debug('Removing cached text variables')
             board.SetProperties(pcbnew.MAP_STRING_STRING())
             # Save the PCB, so external tools also gets the reset, i.e. panelize, see #652
-            board.Save(pcb_file)
+            GS.save_pcb(pcb_file, board)
         if BasePreFlight.get_option('check_zone_fills'):
             GS.fill_zones(board)
         if GS.global_units and GS.ki6:

kibot/pre_annotate_pcb.py

@@ -226,8 +226,7 @@ def run(self):
                 changes[old_ref] = m.new_ref_suffix
             m.footprint.SetReference(new_ref)
         logger.debug('- Saving PCB')
-        GS.make_bkp(GS.pcb_file)
-        GS.board.Save(GS.pcb_file)
+        GS.save_pcb()
         #
         # SCH part
         #

kibot/pre_draw_stackup.py

@@ -459,5 +459,4 @@ def apply(self):
         if not GS.stackup:
             raise KiPlotConfigurationError('Unable to find the stackup information')
         if update_drawing(self._value, self):
-            GS.make_bkp(GS.pcb_file)
-            GS.board.Save(GS.pcb_file)
+            GS.save_pcb()

kibot/pre_fill_zones.py

@@ -23,10 +23,4 @@ def __init__(self):
     def apply(self):
         load_board()
         pcbnew.ZONE_FILLER(GS.board).Fill(GS.board.Zones())
-        GS.make_bkp(GS.pcb_file)
-        # KiCad likes to write the project every time we save the PCB
-        # But KiCad doesn't read the exclusions, so they get lost
-        # As a workaround we restore the project, there is no need to change it
-        prj = GS.read_pro()
-        GS.board.Save(GS.pcb_file)
-        GS.write_pro(prj)
+        GS.save_pcb()

kibot/pre_update_pcb_characteristics.py

@@ -94,5 +94,4 @@ def apply(self):
                   YESNO[GS.global_edge_plating],
                   GS.global_edge_connector.capitalize())
         if update_table(values):
-            GS.make_bkp(GS.pcb_file)
-            GS.board.Save(GS.pcb_file)
+            GS.save_pcb()

kibot/pre_update_stackup.py

@@ -254,5 +254,4 @@ def apply(self):
             raise KiPlotConfigurationError('Unable to find the stackup information')
         # Collect the information
         if update_table():
-            GS.make_bkp(GS.pcb_file)
-            GS.board.Save(GS.pcb_file)
+            GS.save_pcb()

tests/board_samples/kicad_8/fail-project.kicad_pro

@@ -289,5 +289,7 @@
     "legacy_lib_list": []
   },
   "sheets": [],
-  "text_variables": {}
-}
+  "text_variables": {
+    "DUMMY": "foobar"
+  }
+}

tests/yaml_samples/drc_filter_k6_exc.kibot.yaml

@@ -7,6 +7,9 @@ globals:
 
 preflight:
   run_drc: true
+  set_text_variables:
+    - name: 'DUMMY'
+      text: 'foobar'
   filters:
     - filter_msg: 'Ignore unconnected pad 2 of C4'
       error: unconnected_items