config: T5228: add get_config_defaults options to match get_config_dict

For those cases not covered by automatic merging of defaults in
get_config_dict(..., with_defaults=True), get_config_defaults should
take arguments consistent with those of get_config_dict, for ease of
merging results.

1 files changed, 26 insertions, 1 deletions

diff --git a/python/vyos/config.py b/python/vyos/config.py
index 1b9e61651..c3bb68373 100644
--- a/python/vyos/config.py
+++ b/python/vyos/config.py
@@ -68,7 +68,7 @@ import json
 from copy import deepcopy
 
 import vyos.configtree
-from vyos.xml_ref import multi_to_list, merge_defaults
+from vyos.xml_ref import multi_to_list, merge_defaults, relative_defaults
 from vyos.utils.dict import get_sub_dict, mangle_dict_keys
 from vyos.configsource import ConfigSource, ConfigSourceSession
 
@@ -267,6 +267,31 @@ class Config(object):
 
         return conf_dict
 
+    def get_config_defaults(self, path=[], effective=False, key_mangling=None,
+                            no_tag_node_value_mangle=False, get_first_key=False,
+                            recursive=False) -> dict:
+        lpath = self._make_path(path)
+        root_dict = self.get_cached_root_dict(effective)
+        conf_dict = get_sub_dict(root_dict, lpath, get_first_key)
+
+        defaults = relative_defaults(lpath, conf_dict,
+                                     get_first_key=get_first_key,
+                                     recursive=recursive)
+        if key_mangling is None:
+            return defaults
+
+        rpath = lpath if get_first_key else lpath[:-1]
+
+        if not (isinstance(key_mangling, tuple) and \
+                (len(key_mangling) == 2) and \
+                isinstance(key_mangling[0], str) and \
+                isinstance(key_mangling[1], str)):
+            raise ValueError("key_mangling must be a tuple of two strings")
+
+        defaults = mangle_dict_keys(defaults, key_mangling[0], key_mangling[1], abs_path=rpath, no_tag_node_value_mangle=no_tag_node_value_mangle)
+
+        return defaults
+
     def is_multi(self, path):
         """
         Args: