[Drill][KiCad 10][Added] Support for kicad-cli

set-soft · set-soft · commit 2fee6dc5e7e2 · 2026-03-19T13:04:28.000-03:00
This mitigates KiCad bug: https://gitlab.com/kicad/code/kicad/-/work_items/23268 Now we use the Python API when left/right digits are specified
diff --git a/kibot/out_any_drill.py b/kibot/out_any_drill.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
-# Copyright (c) 2020-2025 Salvador E. Tropea
-# Copyright (c) 2020-2025 Instituto Nacional de Tecnología Industrial
+# Copyright (c) 2020-2026 Salvador E. Tropea
+# Copyright (c) 2020-2026 Instituto Nacional de Tecnología Industrial
 # License: AGPL-3.0
 # Project: KiBot (formerly KiPlot)
 # Drill table contributed by Nguyen Vincent (@nguyen-v)
@@ -11,6 +11,7 @@
                     PLOT_FORMAT_PDF, wxPoint, B_Cu, F_Cu, GERBER_WRITER)
 from .error import KiPlotConfigurationError
 from .kicad.drill_info import get_full_holes_list, PLATED_DICT, HOLE_SHAPE_DICT, HOLE_TYPE_DICT
+from .kiplot import run_command
 from .optionable import Optionable
 from .out_base import VariantOptions
 from .gs import GS
@@ -166,8 +167,14 @@ def config(self, parent):
         else:
             map = self.map.type
             self._map_output = self.map.output
-        if GS.ki10 and map == 'hpgl':
-            raise KiPlotConfigurationError("KiCad 10+ doesn't support HPGL")
+        if GS.ki10:
+            if map == 'hpgl':
+                raise KiPlotConfigurationError("KiCad 10+ doesn't support HPGL")
+            if map == 'gerber':
+                self._map_cli = 'gerberx2'
+            else:
+                self._map_cli = map
+        self._map_type = map
         self._map_ext = self._map_ext[map]
         self._map = self._map_map[map]
         # Solve the report for both cases
@@ -260,12 +267,17 @@ def _get_drill_groups(unified):
         groups.extend(list(pairs))
         return groups
 
-    def get_file_names(self, output_dir):
+    def get_file_names(self, output_dir, just_drills=False, tmp_base=None):
         """ Returns a dict containing KiCad names and its replacement.
-            If no replacement is needed the replacement is empty """
+            If no replacement is needed the replacement is empty.
+            tmp_base is used to specify the `GS.pcb_basename` for a temporal variant.
+            I don't really know if variants really apply to drill files, but is currently supported """
         filenames = {}
         self._configure_writer(GS.board, wxPoint(0, 0))
         files = AnyDrill._get_drill_groups(self._unified_output)
+        force_rename = tmp_base is not None
+        if not force_rename:
+            tmp_base = GS.pcb_basename
         for d in files:
             kicad_id = '-'+d if d else d
             kibot_id = self.solve_id(d)
@@ -274,17 +286,22 @@ def get_file_names(self, output_dir):
                 kicad_id_main += '-drl'
                 if not GS.ki8:
                     kicad_id_map = kicad_id_main
-            if self.generate_drill_files:
-                k_file = self.expand_filename(output_dir, '%f'+kicad_id_main+'.%x', '', self._ext)
+            if self.generate_drill_files or just_drills:
+                k_file = self.expand_filename(output_dir, tmp_base+kicad_id_main+'.%x', '', self._ext)
                 file = ''
                 if self.output:
                     file = self.expand_filename(output_dir, self.output, kibot_id, self._ext)
+                elif force_rename:
+                    # To get the real name instead of the temporal one
+                    file = k_file.replace(tmp_base, GS.pcb_basename)
                 filenames[k_file] = file
-            if self._map is not None:
-                k_file = self.expand_filename(output_dir, '%f'+kicad_id_map+'-drl_map.%x', '', self._map_ext)
+            if self._map is not None and not just_drills:
+                k_file = self.expand_filename(output_dir, tmp_base+kicad_id_map+'-drl_map.%x', '', self._map_ext)
                 file = ''
                 if self._map_output:
                     file = self.expand_filename(output_dir, self._map_output, kibot_id+'_map', self._map_ext)
+                elif force_rename:
+                    file = k_file.replace(tmp_base, GS.pcb_basename)
                 filenames[k_file] = file
         return filenames
 
@@ -298,43 +315,70 @@ def run(self, output_dir):
             offset = GS.get_aux_origin()
         else:
             offset = wxPoint(0, 0)
-        drill_writer = self._configure_writer(GS.board, offset)
+        drill_writer, use_cli = self._configure_writer(GS.board, offset)
 
         logger.debug("Generating drill files in "+output_dir)
         gen_map = self._map is not None
-        if gen_map:
-            drill_writer.SetMapFileFormat(self._map)
-            logger.debug("Generating drill map type {} in {}".format(self._map, output_dir))
+
         if not self.generate_drill_files and not gen_map and not self._report and not self._table_output:
             logger.warning(
                 W_NODRILL +
                 "Not generating drill files nor drill maps "
                 "nor report nor drill table on "
                 f"`{self._parent.name}`"
             )
-        if GS.ki10 and isinstance(drill_writer, GERBER_WRITER):
-            # KiCad 10 inconsistency ...
-            drill_writer.CreateDrillandMapFilesSet(output_dir, self.generate_drill_files, gen_map, True)
+
+        if use_cli:
+            # Using kicad-cli
+            fname = self.save_tmp_board() if self.will_filter_pcb_components() else GS.pcb_file
+            odir = output_dir  # if self.generate_drill_files else tempfile.gettempdir()
+            cmd = [GS.kicad_cli, 'pcb', 'export', 'drill', '--output', odir] + drill_writer
+            if gen_map:
+                logger.debug("Generating drill map type {} in {}".format(self._map, output_dir))
+                cmd.extend(['--generate-map', '--map-format', self._map_cli])
+            if self._report:
+                drill_report_file = self.expand_filename(output_dir, self._report, 'drill_report', 'txt')
+                logger.debug("Generating drill report: "+drill_report_file)
+                cmd.extend(['--generate-report', '--report-path', drill_report_file])
+            run_command(cmd + [fname])
+            if self._files_to_remove:
+                self.remove_temporals()
+            tmp_base = os.path.splitext(os.path.basename(fname))[0]
+            if not self.generate_drill_files:
+                # We can't prevent kicad-cli from generating them, so just remove them
+                files = self.get_file_names(output_dir, tmp_base=tmp_base, just_drills=True)
+                for f in files.keys():
+                    os.remove(f)
         else:
-            drill_writer.CreateDrillandMapFilesSet(output_dir, self.generate_drill_files, gen_map)
+            # Using Python API
+            if gen_map:
+                drill_writer.SetMapFileFormat(self._map)
+                logger.debug("Generating drill map type {} in {}".format(self._map, output_dir))
+            if GS.ki10 and isinstance(drill_writer, GERBER_WRITER):
+                # KiCad 10 inconsistency ...
+                drill_writer.CreateDrillandMapFilesSet(output_dir, self.generate_drill_files, gen_map, True)
+            else:
+                drill_writer.CreateDrillandMapFilesSet(output_dir, self.generate_drill_files, gen_map)
+            # Generate the report
+            if self._report:
+                drill_report_file = self.expand_filename(output_dir, self._report, 'drill_report', 'txt')
+                logger.debug("Generating drill report: "+drill_report_file)
+                if GS.ki10:
+                    logger.error("No drill reports until KiCad bug https://gitlab.com/kicad/code/kicad/-/work_items/23268 "
+                                 "is fixed")
+                else:
+                    drill_writer.GenDrillReportFile(drill_report_file)
+            tmp_base = None
+
         # Rename the files
-        files = self.get_file_names(output_dir)
+        files = self.get_file_names(output_dir, tmp_base=tmp_base)
         for k_f, f in files.items():
             if f:
                 logger.debug(f"Renaming {k_f} -> {f}")
                 if not os.path.isfile(k_f):
                     GS.exit_with_error(f"Missing `{k_f}` drill file, KiCad bug? please report", DONT_STOP)
                 else:
                     os.replace(k_f, f)
-        # Generate the report
-        if self._report:
-            drill_report_file = self.expand_filename(output_dir, self._report, 'drill_report', 'txt')
-            logger.debug("Generating drill report: "+drill_report_file)
-            if GS.ki10:
-                logger.error("No drill reports until KiCad bug https://gitlab.com/kicad/code/kicad/-/work_items/23268 "
-                             "is fixed")
-            else:
-                drill_writer.GenDrillReportFile(drill_report_file)
         # Generate the drill table
         if self._table_output:
 
diff --git a/kibot/out_excellon.py b/kibot/out_excellon.py
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
-# Copyright (c) 2020-2023 Salvador E. Tropea
-# Copyright (c) 2020-2023 Instituto Nacional de Tecnología Industrial
-# License: GPL-3.0
+# Copyright (c) 2020-2026 Salvador E. Tropea
+# Copyright (c) 2020-2026 Instituto Nacional de Tecnología Industrial
+# License: AGPL-3.0
 # Project: KiBot (formerly KiPlot)
 from pcbnew import EXCELLON_WRITER
 from .out_any_drill import AnyDrill
@@ -12,6 +12,10 @@
       'SUPPRESS_LEADING': EXCELLON_WRITER.SUPPRESS_LEADING,
       'SUPPRESS_TRAILING': EXCELLON_WRITER.SUPPRESS_TRAILING,
       'KEEP_ZEROS': EXCELLON_WRITER.KEEP_ZEROS}
+ZF_CLI = {'DECIMAL_FORMAT': 'decimal',
+          'SUPPRESS_LEADING': 'suppressleading',
+          'SUPPRESS_TRAILING': 'suppresstrailing',
+          'KEEP_ZEROS': 'keep'}
 
 
 class ExcellonOptions(AnyDrill):
@@ -37,12 +41,26 @@ def __init__(self):
         self._ext = 'drl'
 
     def _configure_writer(self, board, offset):
+        self._unified_output = self.pth_and_npth_single_file
+        if GS.ki10 and self.left_digits == 0 and self.right_digits == 0:
+            options = ['--format', 'excellon',
+                       '--excellon-units', 'mm' if self.metric_units else 'in',
+                       '--excellon-zeros-format', ZF_CLI[self.zeros_format],
+                       '--excellon-oval-format', 'route' if self.route_mode_for_oval_holes else 'alternate',
+                       '--drill-origin', 'plot' if offset.x != 0 or offset.y != 0 else 'absolute']
+            if not self.pth_and_npth_single_file:
+                options.append('--excellon-separate-th')
+            if self.minimal_header:
+                options.append('--excellon-min-header')
+            if self.mirror_y_axis:
+                options.append('--excellon-mirror-y')
+            return options, True
+        # KiCad <10 or left_digits/right_digits
         drill_writer = EXCELLON_WRITER(board)
         drill_writer.SetOptions(self.mirror_y_axis, self.minimal_header, GS.p2v_k7(offset), self.pth_and_npth_single_file)
         drill_writer.SetRouteModeForOvalHoles(self.route_mode_for_oval_holes)
         drill_writer.SetFormat(self.metric_units, ZF[self.zeros_format], self.left_digits, self.right_digits)
-        self._unified_output = self.pth_and_npth_single_file
-        return drill_writer
+        return drill_writer, False
 
 
 @output_class
diff --git a/kibot/out_gerb_drill.py b/kibot/out_gerb_drill.py
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
-# Copyright (c) 2020-2023 Salvador E. Tropea
-# Copyright (c) 2020-2023 Instituto Nacional de Tecnología Industrial
-# License: GPL-3.0
+# Copyright (c) 2020-2026 Salvador E. Tropea
+# Copyright (c) 2020-2026 Instituto Nacional de Tecnología Industrial
+# License: AGPL-3.0
 # Project: KiBot (formerly KiPlot)
 from pcbnew import GERBER_WRITER
 from .gs import GS
@@ -15,11 +15,16 @@ def __init__(self):
         self._ext = 'gbr'
 
     def _configure_writer(self, board, offset):
+        if GS.ki10:
+            options = ['--format', 'gerber',
+                       '--drill-origin', 'plot' if offset.x != 0 or offset.y != 0 else 'absolute',
+                       '--gerber-precision', '6']  # Currently is always 4.6
+            return options, True
         drill_writer = GERBER_WRITER(board)
         # hard coded in UI?
         drill_writer.SetFormat(5)
         drill_writer.SetOptions(GS.p2v_k7(offset))
-        return drill_writer
+        return drill_writer, False
 
 
 @output_class
diff --git a/tests/test_plot/test_drill.py b/tests/test_plot/test_drill.py
@@ -82,9 +82,7 @@ def do_3Rs(test_dir, conf, modern, single=False):
         npth_pdf_drl = npth_pdf_drl.replace('-NPTH', '')
         npth_csv_drl = npth_csv_drl.replace('_NPTH', '')
 
-    if not context.ki10():
-        # KiCad 10 bug https://gitlab.com/kicad/code/kicad/-/work_items/23268
-        ctx.expect_out_file(os.path.join(DRILL_DIR, report))
+    ctx.expect_out_file(os.path.join(DRILL_DIR, report))
     ctx.expect_out_file(pth_drl)
     ctx.expect_out_file(npth_drl)
     ctx.expect_out_file(f1_drl)
