[Copy Files][Added] Now dest also expands %X patterns

- Can be disabled using `expand_dest`

See #873

Author: set-soft

CHANGELOG.md

@@ -29,7 +29,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - PCB Print: Workaround for KiCad 9.0.5 change in how holes are plotted when
   a layer is not included (black instead of white).
 - Export_3D: `center` option to `origin` (#871)
-- Compress: Now `dest` also expands %X patterns (can be disabled) (#873)
+- Compress/Copy Files: Now `dest` also expands %X patterns (can be disabled)
+  (#873)
 
 ### Fixed
 - User.N layer numbering. I.e. pcb_print issues with their numbering (#808)

docs/samples/generic_plot.kibot.yaml

@@ -935,6 +935,8 @@ outputs:
       # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the
       # variant
       exclude_filter: '_null'
+      # [boolean=true] Also expand the `dest` file name (using % patterns)
+      expand_dest: true
       # [list(dict)=[]] Which files will be included
       files:
         # [string=''] Destination directory inside the output dir, empty means the same of the file

docs/source/Changelog.rst

@@ -53,8 +53,8 @@ Added
 -  PCB Print: Workaround for KiCad 9.0.5 change in how holes are plotted
    when a layer is not included (black instead of white).
 -  Export_3D: ``center`` option to ``origin`` (#871)
--  Compress: Now ``dest`` also expands %X patterns (can be disabled)
-   (#873)
+-  Compress/Copy Files: Now ``dest`` also expands %X patterns (can be
+   disabled) (#873)
 
 Fixed
 ~~~~~

docs/source/configuration/outputs/Copy_FilesOptions.rst

@@ -25,6 +25,7 @@ Copy_FilesOptions parameters
    Can be used to fine-tune a variant for a particular output that needs extra filtering done before the
    variant.
 
+-  ``expand_dest`` :index:`: <pair: output - copy_files - options; expand_dest>` [:ref:`boolean <boolean>`] (default: ``true``) Also expand the `dest` file name (using % patterns).
 -  ``follow_links`` :index:`: <pair: output - copy_files - options; follow_links>` [:ref:`boolean <boolean>`] (default: ``true``) Store the file pointed by symlinks, not the symlink.
 -  ``kicad_3d_url`` :index:`: <pair: output - copy_files - options; kicad_3d_url>` [:ref:`string <string>`] (default: ``'https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'``) Base URL for the KiCad 3D models.
 -  ``kicad_3d_url_suffix`` :index:`: <pair: output - copy_files - options; kicad_3d_url_suffix>` [:ref:`string <string>`] (default: ``''``) Text added to the end of the download URL.

kibot/out_copy_files.py

@@ -92,6 +92,8 @@ def __init__(self):
             """ Store the file pointed by symlinks, not the symlink """
             self.link_no_copy = False
             """ Create symlinks instead of copying files """
+            self.expand_dest = True
+            """ Also expand the `dest` file name (using % patterns) """
         super().__init__()
         self._expand_id = 'copy'
         self._expand_ext = 'files'
@@ -202,12 +204,13 @@ def get_3d_models(self, f, mode_project, dry):
         extra_files = []
         GS.check_pcb()
         GS.load_board()
+        dest_exp = f.expand_filename_both(f.dest, make_safe=False) if self.expand_dest else f.dest
         if mode_project:
             # From the PCB point this is just the 3D models dir
             f.output_dir = '3d_models'
             f._append_mode = True
         else:
-            dest_dir = f.dest
+            dest_dir = dest_exp
             f._append_mode = False
             if dest_dir and dest_dir[-1] == '+':
                 dest_dir = dest_dir[:-1]
@@ -222,7 +225,7 @@ def get_3d_models(self, f, mode_project, dry):
         if f.save_pcb or mode_project:
             dest_dir = self.output_dir
             if mode_project:
-                dest_dir = os.path.join(dest_dir, f.dest)
+                dest_dir = os.path.join(dest_dir, dest_exp)
                 os.makedirs(dest_dir, exist_ok=True)
             fname = os.path.join(dest_dir, os.path.basename(GS.pcb_file))
             if not dry:
@@ -256,8 +259,8 @@ def get_3d_models(self, f, mode_project, dry):
             if wks[1] and not wks[1].startswith(EMBED_PREFIX):  # PCB WKS
                 extra_files.append(os.path.join(os.path.dirname(prj_name), 'pcbnew.kicad_wks'))
             if mode_project:
-                extra_files += self.copy_footprints(f.dest, dry)
-                extra_files += self.copy_symbols(f.dest, dry)
+                extra_files += self.copy_footprints(dest_exp, dry)
+                extra_files += self.copy_symbols(dest_exp, dry)
         if not self._comps:
             # We must undo the download/rename
             self.undo_3d_models_rename(GS.board)
@@ -276,7 +279,7 @@ def get_3d_models(self, f, mode_project, dry):
                     new_list.append(fn)
         if mode_project:
             # From the output point this needs to add the destination dir
-            f.output_dir = os.path.join(f.dest, f.output_dir)
+            f.output_dir = os.path.join(dest_exp, f.output_dir)
         return files_list+fnmatch.filter(new_list, f.source), extra_files
 
     def get_files(self, no_out_run=False):
@@ -326,7 +329,8 @@ def get_files(self, no_out_run=False):
                 if f.dest and not f._append_mode:
                     # A destination specified by the user
                     # All files goes to the same destination directory
-                    dest = os.path.join(f.dest, os.path.basename(fname))
+                    dest_exp = f.expand_filename_both(f.dest, make_safe=False) if self.expand_dest else f.dest
+                    dest = os.path.join(dest_exp, os.path.basename(fname))
                 elif (mode_3d or mode_project) and is_abs:
                     for d in self.rel_dirs:
                         if d is not None and fname.startswith(d):

tests/GUI/outputs

@@ -2124,6 +2124,13 @@
           ],
           null
         ],
+        [
+          "expand_dest",
+          [
+            "DataTypeBoolean"
+          ],
+          null
+        ],
         [
           "no_virtual",
           [

tests/GUI/stats

@@ -1,14 +1,14 @@
-53 outputs types with a total of 2129 different parameters
-Single type parameters: 1943 (91 %)
+53 outputs types with a total of 2130 different parameters
+Single type parameters: 1944 (91 %)
 Multi type parameters: 186 (9 %)
 Average parameters: 40
 Maximum number of parameters: 217
 Minimum number of parameters: 14
 Histogram:
   0-  9: 
  10- 19: *****
- 20- 29: ***********************
- 30- 39: ********
+ 20- 29: **********************
+ 30- 39: *********
  40- 49: *********
  50- 59: **
  60- 69: **
@@ -55,7 +55,7 @@ Outputs sorted by parameters:
 - hpgl_sch_print: 27
 - kikit_present: 27
 - stencil_for_jig: 28
-- copy_files: 29
+- copy_files: 30
 - pdf_pcb_print: 31
 - position: 31
 - report: 33
@@ -148,7 +148,7 @@ Outputs sorted by depth:
 --------------------------------------------------------------------------------
 14 different data types
 -             String:  924
--            Boolean:  537
+-            Boolean:  538
 -             Number:  290
 - ListStringSingular:  288
 -             Choice:  110
@@ -164,7 +164,7 @@ Outputs sorted by depth:
 --------------------------------------------------------------------------------
 Used as single data type:
 -             String:  760 
--            Boolean:  472 
+-            Boolean:  473 
 - ListStringSingular:  285 
 -             Number:  196 
 -             Choice:  107 
@@ -403,17 +403,17 @@ Used as single data type:
 -              Number,String:   15 
 ================================================================================
 ================================================================================
-92 totals types with a total of 2508 different parameters
-Single type parameters: 2298 (92 %)
+92 totals types with a total of 2509 different parameters
+Single type parameters: 2299 (92 %)
 Multi type parameters: 210 (8 %)
 Average parameters: 27
 Maximum number of parameters: 217
 Minimum number of parameters: 1
 Histogram:
   0-  9: ************************
  10- 19: **************
- 20- 29: ****************************
- 30- 39: *********
+ 20- 29: ***************************
+ 30- 39: **********
  40- 49: *********
  50- 59: **
  60- 69: **
@@ -498,7 +498,7 @@ Totals sorted by parameters:
 - hpgl_sch_print: 27
 - kikit_present: 27
 - stencil_for_jig: 28
-- copy_files: 29
+- copy_files: 30
 - pdf_pcb_print: 31
 - position: 31
 - report: 33
@@ -631,7 +631,7 @@ Totals sorted by depth:
 --------------------------------------------------------------------------------
 14 different data types
 -             String: 1080
--            Boolean:  637
+-            Boolean:  638
 -             Number:  340
 - ListStringSingular:  318
 -             Choice:  142
@@ -647,7 +647,7 @@ Totals sorted by depth:
 --------------------------------------------------------------------------------
 Used as single data type:
 -             String:  900 
--            Boolean:  564 
+-            Boolean:  565 
 - ListStringSingular:  315 
 -             Number:  231 
 -             Choice:  139