Fix compose crash when overriding Optional structured field set to None#3126
Open
ItsMacto wants to merge 1 commit intofacebookresearch:mainfrom
Open
Fix compose crash when overriding Optional structured field set to None#3126ItsMacto wants to merge 1 commit intofacebookresearch:mainfrom
ItsMacto wants to merge 1 commit intofacebookresearch:mainfrom
Conversation
meta-cla
bot
added
the
CLA Signed
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
1 participant
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.
Motivation
Composing an override that merges a dictionary into an Optional structured config field defaulting to None (e.g.
Optional[Child] = Noneoverridden with{"child": {}}) can raise anAssertionErrororValidationErrorduring config composition, depending on the OmegaConf version.This PR fixes the issue by defensively materializing None-valued optional structured nodes prior to merge, using the node’s structured reference type when available. A regression test is added to ensure composing such overrides no longer crashes and produces a correctly typed structured node.
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
tests/test_compose.pythat reproduces the failure case and asserts correct behavior.pytest tests/test_compose.pypytest tests/test_hydra.pyNo special setup is required beyond the standard test environment.
Related Issues and PRs