[bugfix] Fix sanitize function for nd_rest module (DCNE-684)#210
Open
gmicol wants to merge 2 commits intoCiscoDevNet:masterfrom
Open
[bugfix] Fix sanitize function for nd_rest module (DCNE-684)#210gmicol wants to merge 2 commits intoCiscoDevNet:masterfrom
gmicol wants to merge 2 commits intoCiscoDevNet:masterfrom
Conversation
…when The API-returned object to sanitize is None.
gmicol
requested review from
akinross,
anvitha-jain,
lhercot,
sajagana,
samiib and
shrsr
as code owners
akinross
reviewed
Mar 30, 2026
plugins/module_utils/nd.py
Outdated
| """Clean up a Python object of type list or dict from specific keys, values and None values if specified""" | ||
| if isinstance(obj_to_sanitize, dict): | ||
| if obj_to_sanitize is None: | ||
| return {} |
Collaborator
There was a problem hiding this comment.
Why determine to return a dict and not a list because the function cleans list or dict? Why not return None in this case?
Collaborator
Author
There was a problem hiding this comment.
None makes definitely more sense. Changed it
Collaborator
There was a problem hiding this comment.
@gmicol I checked the modules to see where sanitize() is being used and looks like nd_rest is the only module using it so far. However, In nd_rest could you please verify whether we could replace:
if sanitize(nd.result["jsondata"], ND_REST_KEYS_TO_SANITIZE) != nd.previous and method != "GET":
nd.result["changed"] = True
with
if nd.existing != nd.previous and method != "GET":
nd.result["changed"] = True
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
fix #181
The
sanitizefunction will now return an empty dict when theobj_to_sanitizeis None: Deals with cases where the API returns None.