fix issue #940 - KeyError in get_dict_from_list #947
Merged
Conversation
This file contains 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
- cause of error : defaultdict added more defaultdict while attempting to traverse the tree, but once a 'potential leaf' node was added, it was added as a dict, not a defaultdict.
- two possible solutions:
- 1 - change everywhere that adds a 'potential' leaf node to add a defaultdict (ie nested_dict()) - this occurs in several places, but not many.
- 2 - change get_dict_from_list to add a default dict (not defaultdict) when traversing the tree, for the case where a multi-level node is added on top of an existing node. This requires only changing a single location, and means that the dictionaries returned by accessing the tree will behave like normal dict (ie, won't by default add missing keys).
|
Also, probably addresses #925 |
|
Good stuff. I see you went with option 2. I'll try to add a test for the failed case tomorrow and then merge it. Thanks for handling it! 👍 |
|
I added a test case following the steps here and can confirm that this PR fixes the exception. 👍 |
m3nu
approved these changes
Apr 12, 2021
|
Yes, I went with option 2 so that all nodes in the nested dictionary were the same type (dict vs defaultdict), and didn't run into potential future confusion over the dictionaries auto-adding keys when not expected. This option only auto-adds keys while building the nested dictionaries. Thanks for looking into the test case. I ran out of time this weekend, but wanted to at least present the PR so people knew it was being worked on. |
|
It's perfect. 2 issues closed with 2 lines changed 😄 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
example: (annotated output from 'borg diff --info --log-json repo::archive1 archive2')
added directory home/rblenis/tmp/borgtest <-- 'home','rblenis','tmp' added as defaultdict, 'borgtest' added as dict
added 6.93 kB home/rblenis/tmp/borgtest/CircleFit.cpp <-- 'CircleFit.cpp' added as dict
added 1.61 kB home/rblenis/tmp/borgtest/CircleFit.h <-- 'CircleFit.h' added as dict
added directory home/rblenis/tmp/borgtest/folder2 <-- 'folder2' added as dict
added 6.93 kB home/rblenis/tmp/borgtest/folder2/CircleFit.cpp <-- 'CircleFit.cpp' added as dict
added 1.61 kB home/rblenis/tmp/borgtest/folder2/CircleFit.h <-- 'CirclFit.h' added as dict
removed directory home/rblenis/tmp/borgtest/foo/bar1 <-- 'borgtest' is dict, so trying to traverse to non existent foo/bar1 throws KeyError.