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

Add the xpath to UnsafeModuleChangeCallbackType #79

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add the xpath to UnsafeModuleChangeCallbackType #79

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
4 changes: 3 additions & 1 deletion sysrepo/session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,14 +416,16 @@ def subscribe_module_change(

self.subscriptions.append(sub)

UnsafeModuleChangeCallbackType = Callable[["SysrepoSession", str, int, Any], None]
UnsafeModuleChangeCallbackType = Callable[["SysrepoSession", str, str, int, Any], None]
"""
Callback to be called when the change in the datastore occurs. Provides implicit
session object instead of list of changes. THE CALLBACK SHOULD NEVER KEEP A
REFERENCE ON THE IMPLICIT SESSION OBJECT TO AVOID USER-AFTER-FREE BUGS.

:arg session:
Implicit session (do not stop) with information about the changed data.
:arg xpath:
The xpath to the node or the module.
:arg event:
Type of the callback event that has occurred. Can be one of: "update", "change",
"done", "abort", "enabled".
Expand Down
2 changes: 1 addition & 1 deletion sysrepo/subscription.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ def module_change_callback(session, sub_id, module, xpath, event, req_id, priv):
private_data = subscription.private_data
event_name = EVENT_NAMES[event]
if subscription.unsafe:
callback(session, event_name, req_id, private_data)
callback(session, root_xpath, event_name, req_id, private_data)
return lib.SR_ERR_OK
if subscription.extra_info:
try:
Expand Down
3 changes: 2 additions & 1 deletion tests/test_subs_module_change.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,8 +314,9 @@ def test_module_change_sub_unsafe(self):
current_config = {}
expected_changes = []

def module_change_cb(session, event, req_id, private_data):
def module_change_cb(session, xpath, event, req_id, private_data):
self.assertIsInstance(session, SysrepoSession)
self.assertEqual(xpath, "/sysrepo-example:conf")
self.assertIn(event, ("change", "done", "abort"))
self.assertIsInstance(req_id, int)
self.assertIs(private_data, priv)
Expand Down