Fix root leaf handling in traverse_util - #5565
Draft
tandede wants to merge 1 commit into
Draft
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
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
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.
What does this PR do?
flatten_dict()allowsis_leafto select the root dictionary. Without a separator this produces the valid flat representation{(): value}, butunflatten_dict()previously indexed the empty path and raisedIndexErrorinstead of restoring the original dictionary.This change recognizes a sole empty tuple path as the root value. It also rejects a root path combined with other paths, since such an input cannot represent one tree unambiguously.
When a string separator is requested, the empty root path and a real empty-string key both encode as
"". Root-leaf selection in that mode now raises a descriptiveValueErrorrather than silently restoring a different structure. Existing empty-string keys continue to round-trip unchanged.Validation
uv run pytest -q tests/traverse_util_test.py tests/serialization_test.py tests/struct_test.py— 127 passed, 4 skippeduv run pre-commit run --files flax/traverse_util.py tests/traverse_util_test.py— all hooks passedSummaryTest.test_tabulate_enumbecause Rich emitted plain text while the test expects ANSI color escapesChecklist