config: T5443: add config merge_defaults method

Drop low-level merge_defaults function in favor of Config method for
a middle-grained level of control when merging defaults.

2 files changed, 48 insertions, 60 deletions

diff --git a/python/vyos/xml_ref/__init__.py b/python/vyos/xml_ref/__init__.py
index 9f7a31e2c..02bbaffd8 100644
--- a/python/vyos/xml_ref/__init__.py
+++ b/python/vyos/xml_ref/__init__.py
@@ -13,9 +13,12 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this library.  If not, see <http://www.gnu.org/licenses/>.
 
-from typing import Optional, Union
+from typing import Optional, Union, TYPE_CHECKING
 from vyos.xml_ref import definition
 
+if TYPE_CHECKING:
+    from vyos.config import ConfigDict
+
 def load_reference(cache=[]):
     if cache:
         return cache[0]
@@ -49,9 +52,6 @@ def is_leaf(path: list) -> bool:
 def cli_defined(path: list, node: str, non_local=False) -> bool:
     return load_reference().cli_defined(path, node, non_local=non_local)
 
-def from_source(d: dict, path: list) -> bool:
-    return load_reference().from_source(d, path)
-
 def component_version() -> dict:
     return load_reference().component_version()
 
@@ -72,8 +72,8 @@ def relative_defaults(rpath: list, conf: dict, get_first_key=False,
                                               get_first_key=get_first_key,
                                               recursive=recursive)
 
-def merge_defaults(path: list, conf: dict, get_first_key=False,
-                   recursive=False) -> dict:
-    return load_reference().merge_defaults(path, conf,
-                                           get_first_key=get_first_key,
-                                           recursive=recursive)
+def from_source(d: dict, path: list) -> bool:
+    return definition.from_source(d, path)
+
+def ext_dict_merge(source: dict, destination: Union[dict, 'ConfigDict']):
+    return definition.ext_dict_merge(source, destination)
diff --git a/python/vyos/xml_ref/definition.py b/python/vyos/xml_ref/definition.py
index b0b8a2605..38e07f0a7 100644
--- a/python/vyos/xml_ref/definition.py
+++ b/python/vyos/xml_ref/definition.py
@@ -20,6 +20,45 @@ from typing import Optional, Union, Any, TYPE_CHECKING
 if TYPE_CHECKING:
     from vyos.config import ConfigDict
 
+def set_source_recursive(o: Union[dict, str, list], b: bool):
+    d = {}
+    if not isinstance(o, dict):
+        d = {'_source': b}
+    else:
+        for k, v in o.items():
+            d[k] = set_source_recursive(v, b)
+        d |= {'_source': b}
+    return d
+
+def source_dict_merge(src: dict, dest: dict):
+    from copy import deepcopy
+    dst = deepcopy(dest)
+    from_src = {}
+
+    for key, value in src.items():
+        if key not in dst:
+            dst[key] = value
+            from_src[key] = set_source_recursive(value, True)
+        elif isinstance(src[key], dict):
+            dst[key], f = source_dict_merge(src[key], dst[key])
+            f |= {'_source': False}
+            from_src[key] = f
+
+    return dst, from_src
+
+def ext_dict_merge(src: dict, dest: Union[dict, 'ConfigDict']):
+    d, f = source_dict_merge(src, dest)
+    if hasattr(d, '_from_defaults'):
+        setattr(d, '_from_defaults', f)
+    return d
+
+def from_source(d: dict, path: list) -> bool:
+    for key in path:
+        d  = d[key] if key in d else {}
+        if not d or not isinstance(d, dict):
+            return False
+    return d.get('_source', False)
+
 class Xml:
     def __init__(self):
         self.ref = {}
@@ -221,43 +260,6 @@ class Xml:
             return False
         return True
 
-    def _set_source_recursive(self, o: Union[dict, str, list], b: bool):
-        d = {}
-        if not isinstance(o, dict):
-            d = {'_source': b}
-        else:
-            for k, v in o.items():
-                d[k] = self._set_source_recursive(v, b)
-            d |= {'_source': b}
-        return d
-
-    # use local copy of function in module configdict, to avoid circular
-    # import
-    #
-    # extend dict_merge to keep track of keys only in source
-    def _dict_merge(self, source, destination):
-        from copy import deepcopy
-        dest = deepcopy(destination)
-        from_source = {}
-
-        for key, value in source.items():
-            if key not in dest:
-                dest[key] = value
-                from_source[key] = self._set_source_recursive(value, True)
-            elif isinstance(source[key], dict):
-                dest[key], f = self._dict_merge(source[key], dest[key])
-                f |= {'_source': False}
-                from_source[key] = f
-
-        return dest, from_source
-
-    def from_source(self, d: dict, path: list) -> bool:
-        for key in path:
-            d  = d[key] if key in d else {}
-            if not d or not isinstance(d, dict):
-                return False
-        return d.get('_source', False)
-
     def _relative_defaults(self, rpath: list, conf: dict, recursive=False) -> dict:
         res: dict = {}
         res = self.get_defaults(rpath, recursive=recursive,
@@ -298,17 +300,3 @@ class Xml:
                 res = {}
 
         return res
-
-    def merge_defaults(self, path: list, conf: Union[dict, 'ConfigDict'],
-                       get_first_key=False, recursive=False) -> dict:
-        """Return config dict with defaults non-destructively merged
-
-        This merges non-recursive defaults relative to the config dict.
-        """
-        d = self.relative_defaults(path, conf, get_first_key=get_first_key,
-                                   recursive=recursive)
-        d, f = self._dict_merge(d, conf)
-        d = type(conf)(d)
-        if hasattr(d, '_from_defaults'):
-            setattr(d, '_from_defaults', f)
-        return d