schema: add uniques function for SList

steweg · samuel-gauthier · commit 95012d95d0aa · 2024-01-27T10:37:23.000+01:00
This patch add ability get a list of SList unique definitions. Fixes: CESNET#88 Signed-off-by: Stefan Gula <steweg@gmail.com> Signed-off-by: Samuel Gauthier <samuel.gauthier@6wind.com>
diff --git a/libyang/schema.py b/libyang/schema.py
@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: MIT
 
 from contextlib import suppress
-from typing import IO, Any, Dict, Iterator, Optional, Tuple, Union
+from typing import IO, Any, Dict, Iterator, List, Optional, Tuple, Union
 
 from _libyang import ffi, lib
 from .util import IOType, LibyangError, c2str, init_output, ly_array_iter, str2c
@@ -1416,6 +1416,13 @@ def must_conditions(self) -> Iterator[str]:
         for must in ly_array_iter(pdata.musts):
             yield c2str(must.arg.str)
 
+    def uniques(self) -> Iterator[List[SNode]]:
+        for unique in ly_array_iter(self.cdata_list.uniques):
+            nodes = []
+            for node in ly_array_iter(unique):
+                nodes.append(SNode.new(self.context, node))
+            yield nodes
+
     def __str__(self):
         return "%s [%s]" % (self.name(), ", ".join(k.name() for k in self.keys()))
 
diff --git a/tests/test_schema.py b/tests/test_schema.py
@@ -328,6 +328,22 @@ def test_list_parent(self):
         self.assertIsInstance(parent, SContainer)
         self.assertEqual(parent.name(), "conf")
 
+    def test_list_uniques(self):
+        self.ctx.load_module("yolo-nodetypes")
+        list1 = next(self.ctx.find_path("/yolo-nodetypes:conf/list1"))
+        self.assertIsInstance(list1, SList)
+        uniques = list(list1.uniques())
+        self.assertEqual(len(uniques), 1)
+        elements = [u.name() for u in uniques[0]]
+        self.assertEqual(len(elements), 2)
+        self.assertTrue("leaf2" in elements)
+        self.assertTrue("leaf3" in elements)
+
+        list2 = next(self.ctx.find_path("/yolo-nodetypes:conf/list2"))
+        self.assertIsInstance(list2, SList)
+        uniques = list(list2.uniques())
+        self.assertEqual(len(uniques), 0)
+
 
 # -------------------------------------------------------------------------------------
 class RpcTest(unittest.TestCase):
diff --git a/tests/yang/yolo/yolo-nodetypes.yang b/tests/yang/yolo/yolo-nodetypes.yang
@@ -28,5 +28,26 @@ module yolo-nodetypes {
       default 2.5;
       default 2.6;
     }
+
+    list list1 {
+      key leaf1;
+      unique "leaf2 leaf3";
+      leaf leaf1 {
+        type string;
+      }
+      leaf leaf2 {
+        type string;
+      }
+      leaf leaf3 {
+        type string;
+      }
+    }
+
+    list list2 {
+      key leaf1;
+      leaf leaf1 {
+        type string;
+      }
+    }
   }
 }
