summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Estabrook <jestabro@vyos.io>2023-06-02 23:35:00 -0500
committerJohn Estabrook <jestabro@vyos.io>2023-06-22 20:15:07 -0500
commitd19e7e5ce633f42f2a084ebd17e8c1e3dfef6b03 (patch)
treeae031a90b924cce093f391ef81984097f1bc6dfe
parentbf1fd02453b9b82938656ac2037a61fd45ba96a2 (diff)
downloadvyos-1x-d19e7e5ce633f42f2a084ebd17e8c1e3dfef6b03.tar.gz
vyos-1x-d19e7e5ce633f42f2a084ebd17e8c1e3dfef6b03.zip
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.
-rw-r--r--python/vyos/config.py27
-rw-r--r--python/vyos/xml_ref/__init__.py6
2 files changed, 29 insertions, 4 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:
diff --git a/python/vyos/xml_ref/__init__.py b/python/vyos/xml_ref/__init__.py
index d3fb4ab07..53ca6ed98 100644
--- a/python/vyos/xml_ref/__init__.py
+++ b/python/vyos/xml_ref/__init__.py
@@ -55,10 +55,10 @@ def get_defaults(path: list, get_first_key=False, recursive=False) -> dict:
return load_reference().get_defaults(path, get_first_key=get_first_key,
recursive=recursive)
-def get_config_defaults(rpath: list, conf: dict, get_first_key=False,
- recursive=False) -> dict:
+def relative_defaults(rpath: list, conf: dict, get_first_key=False,
+ recursive=False) -> dict:
- return load_reference().relative_defaults(rpath, conf=conf,
+ return load_reference().relative_defaults(rpath, conf,
get_first_key=get_first_key,
recursive=recursive)