Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancing Choice/Case options #91

Closed
wants to merge 1 commit into from
Closed

Enhancing Choice/Case options #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions cffi/cdefs.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 *);
Expand Down
89 changes: 75 additions & 14 deletions libyang/schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down Expand Up @@ -1357,8 +1361,12 @@ def must_conditions(self) -> Iterator[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
)


# -------------------------------------------------------------------------------------
Expand All @@ -1367,8 +1375,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)


# -------------------------------------------------------------------------------------
Expand All @@ -1377,8 +1387,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
)


# -------------------------------------------------------------------------------------
Expand All @@ -1398,9 +1412,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)
Expand Down Expand Up @@ -1462,9 +1485,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)


# -------------------------------------------------------------------------------------
Expand All @@ -1489,13 +1510,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 = (
Expand All @@ -1506,6 +1557,8 @@ def iter_children(
lib.LYS_LEAF,
lib.LYS_LEAFLIST,
lib.LYS_NOTIF,
lib.LYS_CHOICE,
lib.LYS_CASE,
)

def _skip(node) -> bool:
Expand All @@ -1526,6 +1579,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):
Expand Down
4 changes: 4 additions & 0 deletions tests/test_schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,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())
Expand Down
Loading