[CLI][Added] Option to also list sub-PCBs found in variants

CHANGELOG.md

@@ -20,6 +20,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Testpoints_by_attr, Testpoints_by_attr_CSV, Testpoints_by_attr_HTML,
     Testpoints_by_value, Testpoints_by_value_CSV and Testpoints_by_value_HTML:
     Used to generate testpoint reports (#638)
+- Command line:
+  - Option to also list sub-PCBs found in variants
 - BoM: logo file name can contain env vars and/or ~ (#620)
 - Datasheet: option to classify the datasheets by reference.
 - KiCost: option to specify a configuration file (#615)

docs/source/Changelog.rst

@@ -41,6 +41,10 @@ Added
       Testpoints_by_value_CSV and Testpoints_by_value_HTML: Used to
       generate testpoint reports (#638)
 
+-  Command line:
+
+   -  Option to also list sub-PCBs found in variants
+
 -  BoM: logo file name can contain env vars and/or ~ (#620)
 -  Datasheet: option to classify the datasheets by reference.
 -  KiCost: option to specify a configuration file (#615)

docs/source/usage.txt

@@ -9,7 +9,7 @@ Usage:
          [-E DEF] ... [--defs-from-env] [--config-outs]
          [--only-pre|--only-groups] [--only-names] [--output-name-first] --list
   kibot [-v...] [-c PLOT_CONFIG] [--banner N] [-E DEF] ... [--only-names]
-         --list-variants
+        [--sub-pcbs] --list-variants
   kibot [-v...] [-b BOARD] [-d OUT_DIR] [-p | -P] [--banner N] --example
   kibot [-v...] [--start PATH] [-d OUT_DIR] [--dry] [--banner N]
          [-t, --type TYPE]... --quick-start
@@ -65,6 +65,7 @@ Options:
   -P, --copy-and-expand            As -p but expand the list of layers
   -q, --quiet                      Remove information logs
   -s PRE, --skip-pre PRE           Skip preflights, comma separated or `all`
+  --sub-pcbs                       When listing variants also include sub-PCBs
   -v, --verbose                    Show debugging information
   -V, --version                    Show program's version number and exit
   -w, --no-warn LIST               Exclude the mentioned warnings (comma sep)

kibot/__main__.py

@@ -16,7 +16,7 @@
          [-E DEF] ... [--defs-from-env] [--config-outs]
          [--only-pre|--only-groups] [--only-names] [--output-name-first] --list
   kibot [-v...] [-c PLOT_CONFIG] [--banner N] [-E DEF] ... [--only-names]
-         --list-variants
+        [--sub-pcbs] --list-variants
   kibot [-v...] [-b BOARD] [-d OUT_DIR] [-p | -P] [--banner N] --example
   kibot [-v...] [--start PATH] [-d OUT_DIR] [--dry] [--banner N]
          [-t, --type TYPE]... --quick-start
@@ -72,6 +72,7 @@
   -P, --copy-and-expand            As -p but expand the list of layers
   -q, --quiet                      Remove information logs
   -s PRE, --skip-pre PRE           Skip preflights, comma separated or `all`
+  --sub-pcbs                       When listing variants also include sub-PCBs
   -v, --verbose                    Show debugging information
   -V, --version                    Show program's version number and exit
   -w, --no-warn LIST               Exclude the mentioned warnings (comma sep)
@@ -204,19 +205,28 @@ def list_pre_and_outs(logger, outputs, do_config, only_names, only_pre, only_gro
         logger.info("")
 
 
-def list_variants(logger, only_names):
+def list_variants(logger, only_names, sub_pcbs):
     variants = RegOutput.get_variants()
     if not variants:
         if not only_names:
             logger.info('No variants defined')
         return
     if only_names:
         for name in sorted(variants.keys()):
-            logger.info(name)
+            v = variants[name]
+            if sub_pcbs and v.sub_pcbs:
+                for s in v.sub_pcbs:
+                    logger.info(f'{name}[{s.name}]')
+            else:
+                logger.info(name)
         return
     logger.info("Available variants: 'comment/description' (name) [type]")
     for name in sorted(variants.keys()):
         logger.info('- '+str(variants[name]))
+        v = variants[name]
+        if sub_pcbs and v.sub_pcbs:
+            for s in v.sub_pcbs:
+                logger.info(f'  - {s.name}')
 
 
 def solve_config(a_plot_config, quiet=False):
@@ -569,7 +579,7 @@ def main():
         sys.exit(0)
 
     if args.list_variants:
-        list_variants(logger, args.only_names)
+        list_variants(logger, args.only_names, args.sub_pcbs)
         sys.exit(0)
 
     if args.makefile: