data: add add_defaults module option

This patch adds ability for user to restrict adding off implicit default values based on specified module. Closes: #110 Signed-off-by: Stefan Gula <[email protected]> Signed-off-by: Samuel Gauthier <[email protected]>
CESNET · Aug 2, 2024 · 25d7de8 · 25d7de8
1 parent a3132f8
commit 25d7de8
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 3 deletions.
diff --git a/cffi/cdefs.h b/cffi/cdefs.h
@@ -1189,6 +1189,7 @@ LY_ERR lyd_merge_module(struct lyd_node **, const struct lyd_node *, const struc
 #define LYD_IMPLICIT_NO_DEFAULTS ...
 
 LY_ERR lyd_new_implicit_tree(struct lyd_node *, uint32_t, struct lyd_node **);
+LY_ERR lyd_new_implicit_module(struct lyd_node **, const struct lys_module *, uint32_t, struct lyd_node **);
 LY_ERR lyd_new_implicit_all(struct lyd_node **, const struct ly_ctx *, uint32_t, struct lyd_node **);
 
 LY_ERR lyd_new_meta(const struct ly_ctx *, struct lyd_node *, const struct lys_module *, const char *, const char *, uint32_t, struct lyd_meta **);

diff --git a/libyang/data.py b/libyang/data.py
@@ -340,6 +340,7 @@ def add_defaults(
         no_state: bool = False,
         output: bool = False,
         only_node: bool = False,
+        only_module: Optional[Module] = None,
     ):
         flags = implicit_flags(
             no_config=no_config,
@@ -353,7 +354,15 @@ def add_defaults(
         else:
             node_p = ffi.new("struct lyd_node **")
             node_p[0] = self.cdata
-            ret = lib.lyd_new_implicit_all(node_p, self.context.cdata, flags, ffi.NULL)
+            if only_module is not None:
+                ret = lib.lyd_new_implicit_module(
+                    node_p, only_module.cdata, flags, ffi.NULL
+                )
+            else:
+                ret = lib.lyd_new_implicit_all(
+                    node_p, self.context.cdata, flags, ffi.NULL
+                )
+
         if ret != lib.LY_SUCCESS:
             raise self.context.error("cannot get module")
 

diff --git a/tests/test_data.py b/tests/test_data.py
@@ -897,7 +897,7 @@ def test_find_all(self):
             dnode.free()
 
     def test_add_defaults(self):
-        JSON = '{"yolo-nodetypes:records": [{"id": "rec1"}]}'
+        JSON = '{"yolo-nodetypes:records": [{"id": "rec1"}], "yolo-nodetypes:conf": {}}'
         dnode = self.ctx.parse_data_mem(
             JSON, "json", validate_present=True, parse_only=True
         )
@@ -906,12 +906,25 @@ def test_add_defaults(self):
         self.assertIsInstance(node, DLeaf)
         node = dnode.find_one("name")
         self.assertIsNone(node)
+        node = dnode.find_one("/yolo-system:conf/speed")
+        self.assertIsNone(node)
+
         dnode.add_defaults(only_node=True)
         node = dnode.find_one("name")
         self.assertIsInstance(node, DLeaf)
         self.assertEqual(node.value(), "ASD")
-        node = dnode.find_path("/yolo-nodetypes:conf/speed")
+        node = dnode.find_one("/yolo-nodetypes:conf/percentage")
         self.assertIsNone(node)
+        node = dnode.find_one("/yolo-system:conf/speed")
+        self.assertIsNone(node)
+
+        dnode.add_defaults(only_module=dnode.module())
+        node = dnode.find_one("/yolo-nodetypes:conf/percentage")
+        self.assertIsInstance(node, DLeaf)
+        self.assertEqual(node.value(), 10.2)
+        node = dnode.find_one("/yolo-system:conf/speed")
+        self.assertIsNone(node)
+
         dnode.add_defaults(only_node=False)
         node = dnode.find_path("/yolo-system:conf/speed")
         self.assertIsInstance(node, DLeaf)