schema: support LYS_GETNEXT_WITH{CASE,CHOICE}

Add support for LYS_GETNEXT_WITH{CASE,CHOICE} for Module, Container,
Choice and Case. To do so, introduce a new iter_children_options
function that translates booleans to lys_getnext options.

The Rpc children function is updated to use the iter_children_options
mecanism. The lib.LYS_CHOICE and lib.LYS_CASE are added by to the
default types in iter_children, as it does not change the behavior.

Fixes: #91
Signed-off-by: Stefan Gula <steweg@gmail.com>
Signed-off-by: Samuel Gauthier <samuel.gauthier@6wind.com>

Author: steweg

cffi/cdefs.h

@@ -691,6 +691,7 @@ struct lysc_ext {
 #define LYS_GETNEXT_WITHCASE ...
 #define LYS_GETNEXT_INTONPCONT ...
 #define LYS_GETNEXT_OUTPUT ...
+#define LYS_GETNEXT_WITHSCHEMAMOUNT ...
 
 const struct lysc_node* lys_find_child(const struct lysc_node *, const struct lys_module *, const char *, size_t, uint16_t, uint32_t);
 const struct lysc_node* lysc_node_child(const struct lysc_node *);

libyang/schema.py

@@ -137,8 +137,12 @@ def get_module_from_prefix(self, prefix: str) -> Optional["Module"]:
     def __iter__(self) -> Iterator["SNode"]:
         return self.children()
 
-    def children(self, types: Optional[Tuple[int, ...]] = None) -> Iterator["SNode"]:
-        return iter_children(self.context, self.cdata, types=types)
+    def children(
+        self, types: Optional[Tuple[int, ...]] = None, with_choice: bool = False
+    ) -> Iterator["SNode"]:
+        return iter_children(
+            self.context, self.cdata, types=types, with_choice=with_choice
+        )
 
     def __str__(self) -> str:
         return self.name()
@@ -1401,8 +1405,12 @@ def presence(self) -> Optional[str]:
     def __iter__(self) -> Iterator[SNode]:
         return self.children()
 
-    def children(self, types: Optional[Tuple[int, ...]] = None) -> Iterator[SNode]:
-        return iter_children(self.context, self.cdata, types=types)
+    def children(
+        self, types: Optional[Tuple[int, ...]] = None, with_choice: bool = False
+    ) -> Iterator[SNode]:
+        return iter_children(
+            self.context, self.cdata, types=types, with_choice=with_choice
+        )
 
 
 # -------------------------------------------------------------------------------------
@@ -1411,8 +1419,10 @@ class SChoice(SNode):
     def __iter__(self) -> Iterator[SNode]:
         return self.children()
 
-    def children(self, types: Optional[Tuple[int, ...]] = None) -> Iterator[SNode]:
-        return iter_children(self.context, self.cdata, types=types)
+    def children(
+        self, types: Optional[Tuple[int, ...]] = None, with_case: bool = False
+    ) -> Iterator[SNode]:
+        return iter_children(self.context, self.cdata, types=types, with_case=with_case)
 
 
 # -------------------------------------------------------------------------------------
@@ -1421,8 +1431,12 @@ class SCase(SNode):
     def __iter__(self) -> Iterator[SNode]:
         return self.children()
 
-    def children(self, types: Optional[Tuple[int, ...]] = None) -> Iterator[SNode]:
-        return iter_children(self.context, self.cdata, types=types)
+    def children(
+        self, types: Optional[Tuple[int, ...]] = None, with_choice: bool = False
+    ) -> Iterator[SNode]:
+        return iter_children(
+            self.context, self.cdata, types=types, with_choice=with_choice
+        )
 
 
 # -------------------------------------------------------------------------------------
@@ -1442,9 +1456,18 @@ def __iter__(self) -> Iterator[SNode]:
         return self.children()
 
     def children(
-        self, skip_keys: bool = False, types: Optional[Tuple[int, ...]] = None
+        self,
+        skip_keys: bool = False,
+        types: Optional[Tuple[int, ...]] = None,
+        with_choice: bool = False,
     ) -> Iterator[SNode]:
-        return iter_children(self.context, self.cdata, skip_keys=skip_keys, types=types)
+        return iter_children(
+            self.context,
+            self.cdata,
+            skip_keys=skip_keys,
+            types=types,
+            with_choice=with_choice,
+        )
 
     def keys(self) -> Iterator[SNode]:
         node = lib.lysc_node_child(self.cdata)
@@ -1512,9 +1535,7 @@ def children(self, types: Optional[Tuple[int, ...]] = None) -> Iterator[SNode]:
         yield from iter_children(self.context, self.cdata, types=types)
         # With libyang2, you can get only input or output
         # To keep behavior, we iter 2 times witt output options
-        yield from iter_children(
-            self.context, self.cdata, types=types, options=lib.LYS_GETNEXT_OUTPUT
-        )
+        yield from iter_children(self.context, self.cdata, types=types, output=True)
 
 
 # -------------------------------------------------------------------------------------
@@ -1539,13 +1560,43 @@ class SAnydata(SNode):
     pass
 
 
+# -------------------------------------------------------------------------------------
+def iter_children_options(
+    with_choice: bool = False,
+    no_choice: bool = False,
+    with_case: bool = False,
+    into_non_presence_container: bool = False,
+    output: bool = False,
+    with_schema_mount: bool = False,
+) -> int:
+    options = 0
+    if with_choice:
+        options |= lib.LYS_GETNEXT_WITHCHOICE
+    if no_choice:
+        options |= lib.LYS_GETNEXT_NOCHOICE
+    if with_case:
+        options |= lib.LYS_GETNEXT_WITHCASE
+    if into_non_presence_container:
+        options |= lib.LYS_GETNEXT_INTONPCONT
+    if output:
+        options |= lib.LYS_GETNEXT_OUTPUT
+    if with_schema_mount:
+        options |= lib.LYS_GETNEXT_WITHSCHEMAMOUNT
+    return options
+
+
 # -------------------------------------------------------------------------------------
 def iter_children(
     context: "libyang.Context",
     parent,  # C type: Union["struct lys_module *", "struct lys_node *"]
     skip_keys: bool = False,
     types: Optional[Tuple[int, ...]] = None,
-    options: int = 0,
+    with_choice: bool = False,
+    no_choice: bool = False,
+    with_case: bool = False,
+    into_non_presence_container: bool = False,
+    output: bool = False,
+    with_schema_mount: bool = False,
 ) -> Iterator[SNode]:
     if types is None:
         types = (
@@ -1556,6 +1607,8 @@ def iter_children(
             lib.LYS_LEAF,
             lib.LYS_LEAFLIST,
             lib.LYS_NOTIF,
+            lib.LYS_CHOICE,
+            lib.LYS_CASE,
         )
 
     def _skip(node) -> bool:
@@ -1576,6 +1629,14 @@ def _skip(node) -> bool:
     else:
         module = ffi.NULL
 
+    options = iter_children_options(
+        with_choice=with_choice,
+        no_choice=no_choice,
+        with_case=with_case,
+        into_non_presence_container=into_non_presence_container,
+        output=output,
+        with_schema_mount=with_schema_mount,
+    )
     child = lib.lys_getnext(ffi.NULL, parent, module, options)
     while child:
         if not _skip(child):

tests/test_schema.py

@@ -271,6 +271,10 @@ def test_cont_iter(self):
     def test_cont_children_leafs(self):
         leafs = list(self.container.children(types=(SNode.LEAF,)))
         self.assertEqual(len(leafs), 9)
+        without_choice = [c.name() for c in self.container.children(with_choice=False)]
+        with_choice = [c.name() for c in self.container.children(with_choice=True)]
+        self.assertTrue("pill" not in without_choice)
+        self.assertTrue("pill" in with_choice)
 
     def test_cont_parent(self):
         self.assertIsNone(self.container.parent())