support 'config --print-path'

Added new flag `config --print-path` (`-p`) for easy determination of
the currently active configuration. The path is printed on console.

Author: thorsten-klein

src/west/app/config.py

@@ -100,6 +100,8 @@ def do_add_parser(self, parser_adder):
             "action to perform (give at most one)"
         ).add_mutually_exclusive_group()
 
+        group.add_argument('-p', '--print-path', action='store_true',
+                           help='print path from the active west config file')
         group.add_argument('-l', '--list', action='store_true',
                            help='list all options and their values')
         group.add_argument('-d', '--delete', action='store_true',
@@ -135,14 +137,16 @@ def do_run(self, args, user_args):
         if args.list:
             if args.name:
                 self.parser.error('-l cannot be combined with name argument')
-        elif not args.name:
+        elif not args.name and not args.print_path:
             self.parser.error('missing argument name '
                               '(to list all options and values, use -l)')
         elif args.append:
             if args.value is None:
                 self.parser.error('-a requires both name and value')
 
-        if args.list:
+        if args.print_path:
+            self.print_path(args)
+        elif args.list:
             self.list(args)
         elif delete:
             self.delete(args)
@@ -153,6 +157,11 @@ def do_run(self, args, user_args):
         else:
             self.write(args)
 
+    def print_path(self, args):
+        config_path = self.config.get_path(args.configfile or LOCAL)
+        if config_path:
+            print(config_path)
+
     def list(self, args):
         what = args.configfile or ALL
         for option, value in self.config.items(configfile=what):

src/west/configuration.py

@@ -178,6 +178,16 @@ def __init__(self, topdir: PathType | None = None):
         self._global = _InternalCF.from_path(self._global_path)
         self._local = _InternalCF.from_path(self._local_path)
 
+    def get_path(self, configfile: ConfigFile = ConfigFile.LOCAL):
+        if configfile == ConfigFile.ALL:
+            raise RuntimeError(f'{configfile} not allowed for get_path')
+        elif configfile == ConfigFile.LOCAL:
+            return self._local_path
+        elif configfile == ConfigFile.SYSTEM:
+            return self._system_path
+        elif configfile == ConfigFile.GLOBAL:
+            return self._global_path
+
     def get(self, option: str,
             default: str | None = None,
             configfile: ConfigFile = ConfigFile.ALL) -> str | None:

tests/test_config.py

@@ -82,6 +82,20 @@ def test_config_global():
     assert glb['pytest']['global2'] == 'foo2'
     assert 'pytest' not in lcl
 
+def test_config_print_path():
+    stdout = cmd('config --local --print-path')
+    assert os.environ["WEST_CONFIG_LOCAL"] == stdout.rstrip()
+
+    stdout = cmd('config --global --print-path')
+    assert os.environ["WEST_CONFIG_GLOBAL"] == stdout.rstrip()
+
+    stdout = cmd('config --system --print-path')
+    assert os.environ["WEST_CONFIG_SYSTEM"] == stdout.rstrip()
+
+    del os.environ['WEST_CONFIG_LOCAL']
+    stdout = cmd('config --local --print-path')
+    assert "" == stdout.rstrip()
+
 def test_config_local():
     # test_config_system for local variables.
     cmd('config --local pytest.local foo')