[Compress][Added] Now dest also expands %X patterns

- Can be disabled using `expand_dest`

Closes #873

Author: set-soft

CHANGELOG.md

@@ -29,6 +29,7 @@ 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)
 
 ### Fixed
 - User.N layer numbering. I.e. pcb_print issues with their numbering (#808)

docs/samples/generic_plot.kibot.yaml

@@ -874,6 +874,8 @@ outputs:
     options:
       # [string='auto'] [auto,stored,deflated,bzip2,lzma] Compression algorithm. Use auto to let KiBot select a suitable one
       compression: 'auto'
+      # [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 archive, empty means the same of the file

docs/source/Changelog.rst

@@ -53,6 +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)
 
 Fixed
 ~~~~~

docs/source/configuration/outputs/CompressOptions.rst

@@ -8,6 +8,7 @@ CompressOptions parameters
 -  **format** :index:`: <pair: output - compress - options; format>` [:ref:`string <string>`] (default: ``'ZIP'``) (choices: "ZIP", "TAR", "RAR") Output file format.
 -  **output** :index:`: <pair: output - compress - options; output>` [:ref:`string <string>`] (default: ``'%f-%i%I%v.%x'``) Name for the generated archive (%i=name of the output %x=according to format). Affected by global options.
 -  ``compression`` :index:`: <pair: output - compress - options; compression>` [:ref:`string <string>`] (default: ``'auto'``) (choices: "auto", "stored", "deflated", "bzip2", "lzma") Compression algorithm. Use auto to let KiBot select a suitable one.
+-  ``expand_dest`` :index:`: <pair: output - compress - options; expand_dest>` [:ref:`boolean <boolean>`] (default: ``true``) Also expand the `dest` file name (using % patterns).
 -  ``follow_links`` :index:`: <pair: output - compress - options; follow_links>` [:ref:`boolean <boolean>`] (default: ``true``) Store the file pointed by symlinks, not the symlink.
 -  ``move_files`` :index:`: <pair: output - compress - options; move_files>` [:ref:`boolean <boolean>`] (default: ``false``) Move the files to the archive. In other words: remove the files after adding them to the archive.
 -  *remove_files* :index:`: <pair: output - compress - options; remove_files>` Alias for move_files.

kibot/out_compress.py

@@ -91,6 +91,8 @@ def __init__(self):
             """ Store the file pointed by symlinks, not the symlink """
             self.skip_not_run = False
             """ Skip outputs with `run_by_default: false` """
+            self.expand_dest = True
+            """ Also expand the `dest` file name (using % patterns) """
         super().__init__()
 
     def config(self, parent):
@@ -223,7 +225,8 @@ def get_files(self, output, no_out_run=False):
                 # Compute the destination directory inside the archive
                 dest = fname
                 if f.dest:
-                    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))
                 else:
                     dest = os.path.relpath(dest, out_dir)
                 files[fname_real] = dest

tests/GUI/outputs

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

tests/GUI/stats

@@ -1,5 +1,5 @@
-53 outputs types with a total of 2128 different parameters
-Single type parameters: 1942 (91 %)
+53 outputs types with a total of 2129 different parameters
+Single type parameters: 1943 (91 %)
 Multi type parameters: 186 (9 %)
 Average parameters: 40
 Maximum number of parameters: 217
@@ -40,12 +40,12 @@ Outputs sorted by parameters:
 - download_datasheets: 23
 - jobset: 24
 - kicanvas: 24
-- compress: 25
 - dxf_sch_print: 25
 - pdf_sch_print: 25
 - ps_sch_print: 25
 - qr_lib: 25
 - svg_sch_print: 25
+- compress: 26
 - ipc2581: 26
 - kiri: 26
 - navigate_results: 26
@@ -148,7 +148,7 @@ Outputs sorted by depth:
 --------------------------------------------------------------------------------
 14 different data types
 -             String:  924
--            Boolean:  536
+-            Boolean:  537
 -             Number:  290
 - ListStringSingular:  288
 -             Choice:  110
@@ -164,7 +164,7 @@ Outputs sorted by depth:
 --------------------------------------------------------------------------------
 Used as single data type:
 -             String:  760 
--            Boolean:  471 
+-            Boolean:  472 
 - ListStringSingular:  285 
 -             Number:  196 
 -             Choice:  107 
@@ -403,8 +403,8 @@ Used as single data type:
 -              Number,String:   15 
 ================================================================================
 ================================================================================
-92 totals types with a total of 2507 different parameters
-Single type parameters: 2297 (92 %)
+92 totals types with a total of 2508 different parameters
+Single type parameters: 2298 (92 %)
 Multi type parameters: 210 (8 %)
 Average parameters: 27
 Maximum number of parameters: 217
@@ -481,14 +481,14 @@ Totals sorted by parameters:
 - jobset: 24
 - kicanvas: 24
 - kibom: 24
-- compress: 25
 - dxf_sch_print: 25
 - pdf_sch_print: 25
 - ps_sch_print: 25
 - qr_lib: 25
 - svg_sch_print: 25
 - ibom: 25
 - kicost: 25
+- compress: 26
 - ipc2581: 26
 - kiri: 26
 - navigate_results: 26
@@ -631,7 +631,7 @@ Totals sorted by depth:
 --------------------------------------------------------------------------------
 14 different data types
 -             String: 1080
--            Boolean:  636
+-            Boolean:  637
 -             Number:  340
 - ListStringSingular:  318
 -             Choice:  142
@@ -647,7 +647,7 @@ Totals sorted by depth:
 --------------------------------------------------------------------------------
 Used as single data type:
 -             String:  900 
--            Boolean:  563 
+-            Boolean:  564 
 - ListStringSingular:  315 
 -             Number:  231 
 -             Choice:  139